com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class RasterCatalogToRasterDataset

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.datamanagementtools.RasterCatalogToRasterDataset

All Implemented Interfaces:

GPTool

public class RasterCatalogToRasterDataset
extends AbstractGPTool

Mosaics the contents of a raster catalog into a raster dataset. The Raster Catalog To Raster Dataset tool is contained in the Data Management Tools tool box.

Software restrictions: none

Usage tips:

• This tool allows you to convert your geodatabase raster catalog into a raster dataset; the input is a raster catalog and the output is a raster dataset.
• There are several advantages of using a mosaicked raster dataset: it tends to display faster at any scale, saves space since there is no overlapping data, and the data tends to display with fewer seams.
• You must set the pixel type to match your existing input raster datasets. If you do not set the pixel type, the 8-bit default will be used and your output might turn out incorrectly.
• You can save your output to BMP, GIF, GRID, IMG, JPEG, JPEG 2000, PNG, TIFF, or any geodatabase raster dataset.
• When storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. When storing the raster dataset in a file format, you need to specify the file extension: .bmp for BMP, .gif for GIF, .img for an ERDAS IMAGINE file, .jpg for JPEG, .jp2 for JPEG 2000, .png for PNG, .tif for TIFF, or no extension for GRID.
• When storing your raster dataset to a JPEG file or a JPEG 2000 file, you can specify the compression quality within the Raster Storage Settings in the Environment Settings.
• The GIF format only supports single-band raster datasets.
• The overlapping areas of the mosaic can be handled in several ways; for example, you can set the tool to keep only the first raster dataset's data, or you can blend the overlapping cell values. There are also several options to determine how to handle a colormap, if the raster dataset uses one. For example, you can keep the colormap of the last raster dataset used in the mosaic.
• For mosaicking of discrete data, the First, Last, Minimum, and Maximum options give the most meaningful results. The Blend and Mean options are best suited for continuous data.
• Whenever possible, use the Last mosaic option to mosaic raster datasets to an existing raster dataset in file geodatabase or ArcSDE geodatabase; it is by far the most effective way to mosaic.
• When mosaicking with raster datasets containing colormaps, it is important to note differences across the colormaps for each raster dataset you choose to mosaic. You are still able to use the Mosaic tool even if the raster datasets have different colormaps; however, you must choose the proper colormap mode. If an improper colormap mode is chosen, your output might not turn out as you expected.
• For floating-point input raster datasets of different resolutions, it is recommended that you resample all the data using bilinear interpolation or cubic convolution before running Mosaic. Otherwise, Mosaic will automatically resample the rasters using nearest neighbor (which is not appropriate for the continuous type of data).
• Color matching and color correction can be used to make the raster mosaic more seamless.
• This tool doesn't use the output extent; , because the tool tends to create very large raster datasets and the output extent setting might accidentally clip your data. If output extent does need to be adjusted, the Clip tool; can achieve that operation.
• The following environments affect this tool: current workspace; scratch workspace; , and snap raster;

Field Summary

Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

vals

Constructor Summary

RasterCatalogToRasterDataset()
Creates the Raster Catalog To Raster Dataset tool with defaults.

RasterCatalogToRasterDataset(Object inRasterCatalog, Object outRasterDataset)
Creates the Raster Catalog To Raster Dataset tool with the required parameters.

Method Summary

String	getAscending() Returns the Ascending parameter of this tool .
String	getColorBalancing() Returns the Color Balancing parameter of this tool .
String	getColormap() Returns the Mosaic Colormap Mode parameter of this tool .
Object	getInRasterCatalog() Returns the Input Raster Catalog parameter of this tool .
String	getMatchingMethod() Returns the Color Matching Method parameter of this tool .
String	getMosaicType() Returns the Mosaic Method parameter of this tool .
int	getOID() Returns the Reference Raster OID parameter of this tool .
String	getOrderByField() Returns the Order by Field parameter of this tool .
Object	getOutRasterDataset() Returns the Output Raster Dataset parameter of this tool .
String	getPixelType() Returns the Pixel Type parameter of this tool .
String	getReferenceRaster() Returns the Reference Raster parameter of this tool .
String	getToolboxAlias() Returns the alias of the tool box containing this tool.
String	getToolboxName() Returns the name of the tool box containing this tool.
String	getToolName() Returns the name of this tool.
Object	getWhereClause() Returns the Expression parameter of this tool .
void	setAscending(String ascending) Sets the Ascending parameter of this tool .
void	setColorBalancing(String colorBalancing) Sets the Color Balancing parameter of this tool .
void	setColormap(String colormap) Sets the Mosaic Colormap Mode parameter of this tool .
void	setInRasterCatalog(Object inRasterCatalog) Sets the Input Raster Catalog parameter of this tool .
void	setMatchingMethod(String matchingMethod) Sets the Color Matching Method parameter of this tool .
void	setMosaicType(String mosaicType) Sets the Mosaic Method parameter of this tool .
void	setOID(int oID) Sets the Reference Raster OID parameter of this tool .
void	setOrderByField(String orderByField) Sets the Order by Field parameter of this tool .
void	setOutRasterDataset(Object outRasterDataset) Sets the Output Raster Dataset parameter of this tool .
void	setPixelType(String pixelType) Sets the Pixel Type parameter of this tool .
void	setReferenceRaster(String referenceRaster) Sets the Reference Raster parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Expression parameter of this tool .

Methods inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool

getParameterValues, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

RasterCatalogToRasterDataset

public RasterCatalogToRasterDataset()

Creates the Raster Catalog To Raster Dataset tool with defaults.

Initializes the array of tool parameters with the default values specified when the tool was created.

RasterCatalogToRasterDataset

public RasterCatalogToRasterDataset(Object inRasterCatalog,
                                    Object outRasterDataset)

Creates the Raster Catalog To Raster Dataset tool with the required parameters.

Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other parameters.

Parameters:

inRasterCatalog - Raster catalog, the raster catalog that will be mosaicked to a raster dataset.

outRasterDataset - Raster dataset, when storing your raster dataset to a JPEG file, a JPEG 2000 file, or a geodatabase, you can specify a compression type.

Method Detail

getInRasterCatalog

public Object getInRasterCatalog()

Returns the Input Raster Catalog parameter of this tool . This parameter is Raster catalog, the raster catalog that will be mosaicked to a raster dataset. This is a required parameter.

Returns:

the Input Raster Catalog

setInRasterCatalog

public void setInRasterCatalog(Object inRasterCatalog)

Sets the Input Raster Catalog parameter of this tool . This parameter is Raster catalog, the raster catalog that will be mosaicked to a raster dataset. This is a required parameter.

Parameters:

inRasterCatalog - Raster catalog, the raster catalog that will be mosaicked to a raster dataset.

getOutRasterDataset

public Object getOutRasterDataset()

Returns the Output Raster Dataset parameter of this tool . This parameter is Raster dataset, when storing your raster dataset to a JPEG file, a JPEG 2000 file, or a geodatabase, you can specify a compression type. This is a required parameter.

Returns:

the Output Raster Dataset

setOutRasterDataset

public void setOutRasterDataset(Object outRasterDataset)

Sets the Output Raster Dataset parameter of this tool . This parameter is Raster dataset, when storing your raster dataset to a JPEG file, a JPEG 2000 file, or a geodatabase, you can specify a compression type. This is a required parameter.

Parameters:

outRasterDataset - Raster dataset, when storing your raster dataset to a JPEG file, a JPEG 2000 file, or a geodatabase, you can specify a compression type.

getWhereClause

public Object getWhereClause()

Returns the Expression parameter of this tool . This parameter is SQL expression, enter the appropriate SQL statement to select specific rows in the raster catalog. This is an optional parameter.

Returns:

the Expression

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Expression parameter of this tool . This parameter is SQL expression, enter the appropriate SQL statement to select specific rows in the raster catalog. This is an optional parameter.

Parameters:

whereClause - SQL expression, enter the appropriate SQL statement to select specific rows in the raster catalog.

getMosaicType

public String getMosaicType()

Returns the Mosaic Method parameter of this tool . This parameter is String, help topic. This is an optional parameter.

Returns:

the Mosaic Method

setMosaicType

public void setMosaicType(String mosaicType)

Sets the Mosaic Method parameter of this tool . This parameter is String, help topic. This is an optional parameter.

Parameters:

mosaicType - String, help topic.

getColormap

public String getColormap()

Returns the Mosaic Colormap Mode parameter of this tool . This parameter is String, help topic. This is an optional parameter.

Returns:

the Mosaic Colormap Mode

setColormap

public void setColormap(String colormap)

Sets the Mosaic Colormap Mode parameter of this tool . This parameter is String, help topic. This is an optional parameter.

Parameters:

colormap - String, help topic.

getOrderByField

public String getOrderByField()

Returns the Order by Field parameter of this tool . This parameter is Field, define the field by which to order the raster catalog items. This is an optional parameter.

Returns:

the Order by Field

setOrderByField

public void setOrderByField(String orderByField)

Sets the Order by Field parameter of this tool . This parameter is Field, define the field by which to order the raster catalog items. This is an optional parameter.

Parameters:

orderByField - Field, define the field by which to order the raster catalog items.

getAscending

public String getAscending()

Returns the Ascending parameter of this tool . This parameter is String, choose whether to use the ascending value of the Order By field. If the Ascending option is not used, the descending order will be used. This is an optional parameter.

Returns:

the Ascending

setAscending

public void setAscending(String ascending)

Sets the Ascending parameter of this tool . This parameter is String, choose whether to use the ascending value of the Order By field. If the Ascending option is not used, the descending order will be used. This is an optional parameter.

Parameters:

ascending - String, choose whether to use the ascending value of the Order By field. If the Ascending option is not used, the descending order will be used.

getPixelType

public String getPixelType()

Returns the Pixel Type parameter of this tool . This is an optional parameter.

Returns:

the Pixel Type

setPixelType

public void setPixelType(String pixelType)

Sets the Pixel Type parameter of this tool . This is an optional parameter.

Parameters:

pixelType - null

getColorBalancing

public String getColorBalancing()

Returns the Color Balancing parameter of this tool . This parameter is String, choose whether or not to use a dodging technique to color correct the raster catalog items. All pixels in the raster catalog will be used to determine the gamma and contrast values for the color-balancing algorithm. This is an optional parameter.

Returns:

the Color Balancing

setColorBalancing

public void setColorBalancing(String colorBalancing)

Sets the Color Balancing parameter of this tool . This parameter is String, choose whether or not to use a dodging technique to color correct the raster catalog items. All pixels in the raster catalog will be used to determine the gamma and contrast values for the color-balancing algorithm. This is an optional parameter.

Parameters:

colorBalancing - String, choose whether or not to use a dodging technique to color correct the raster catalog items. All pixels in the raster catalog will be used to determine the gamma and contrast values for the color-balancing algorithm.

getMatchingMethod

public String getMatchingMethod()

Returns the Color Matching Method parameter of this tool . This parameter is String, choose the color matching method to apply to the raster catalog items. This is an optional parameter.

Returns:

the Color Matching Method

setMatchingMethod

public void setMatchingMethod(String matchingMethod)

Sets the Color Matching Method parameter of this tool . This parameter is String, choose the color matching method to apply to the raster catalog items. This is an optional parameter.

Parameters:

matchingMethod - String, choose the color matching method to apply to the raster catalog items.

getReferenceRaster

public String getReferenceRaster()

Returns the Reference Raster parameter of this tool . This parameter is String, if color matching is applied, choose how to specify the reference raster. This is an optional parameter.

Returns:

the Reference Raster

setReferenceRaster

public void setReferenceRaster(String referenceRaster)

Sets the Reference Raster parameter of this tool . This parameter is String, if color matching is applied, choose how to specify the reference raster. This is an optional parameter.

Parameters:

referenceRaster - String, if color matching is applied, choose how to specify the reference raster.

getOID

public int getOID()

Returns the Reference Raster OID parameter of this tool . This parameter is Long, the object ID (OID) of the reference raster. The OID is a unique key field in the raster catalog. This is an optional parameter.

Returns:

the Reference Raster OID

setOID

public void setOID(int oID)

Sets the Reference Raster OID parameter of this tool . This parameter is Long, the object ID (OID) of the reference raster. The OID is a unique key field in the raster catalog. This is an optional parameter.

Parameters:

oID - Long, the object ID (OID) of the reference raster. The OID is a unique key field in the raster catalog.

getToolName

public String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias