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 new raster dataset. The Raster Catalog To Raster Dataset tool is contained in the Data Management Tools tool box.

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 new raster dataset. This tool cannot mosaic data into an existing 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 BIL, BIP, BMP, BSQ, DAT, GIF, GRID, IMG, JPEG, JPEG 2000, PNG, TIFF, or any geodatabase raster dataset.
• When storing your raster dataset to a JPEG file, a JPEG 2000 file, or a geodatabase, you can specify a Compression type and Compression Quality within 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 color map, if the raster dataset uses one. For example, you can keep the color map of the last raster dataset used in the mosaic.
• For mosaicking of discrete data, First, Minimum, or Maximum Mosaic Operator options will provide the most meaningful results. The Blend and Mean Mosaic Operator options are best suited for continuous data.
• Whenever possible, use the Last Mosaic Operator to mosaic raster datasets to an existing raster dataset in a file geodatabase or ArcSDE geodatabase; it is by far the most effective way to mosaic.
• When mosaicking with raster datasets containing color maps, it is important to note differences across the color maps for each raster dataset you choose to mosaic. In this situation, use the tool for raster with different color maps; however, you must choose the proper Mosaic Colormap Mode operator. 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 or when cells are not aligned, it is recommended to resample all the data using bilinear interpolation or cubic convolution before running Mosaic. Otherwise, Mosaic will automatically resample the raster datasets using nearest neighbor resampling, which is not appropriate for continuous data types.
• Color matching and color correction can be used to make the raster mosaic more seamless.

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 Operator 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 Operator 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 - the raster catalog that will be mosaicked to a raster dataset.

outRasterDataset - the name and extension of the output raster dataset mosaic. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality.

Method Detail

getInRasterCatalog

public Object getInRasterCatalog()

Returns the Input Raster Catalog parameter of this tool . This parameter is 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 the raster catalog that will be mosaicked to a raster dataset. This is a required parameter.

Parameters:

inRasterCatalog - 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 the name and extension of the output raster dataset mosaic. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality. 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 the name and extension of the output raster dataset mosaic. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality. This is a required parameter.

Parameters:

outRasterDataset - the name and extension of the output raster dataset mosaic. when storing the raster dataset in a file format, you need to specify the file extension: when storing a raster dataset in a geodatabase, no file extension should be added to the name of the raster dataset. when storing your raster dataset to a JPEG file, a JPEG 2000 file, a TIFF file, or a geodatabase, you can specify a compression type and compression quality.

getWhereClause

public Object getWhereClause()

Returns the Expression parameter of this tool . This parameter is 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 enter the appropriate SQL statement to select specific rows in the raster catalog. This is an optional parameter.

Parameters:

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

getMosaicType

public String getMosaicType()

Returns the Mosaic Operator parameter of this tool . This parameter is the method used to mosaic overlapping areas. for more information about each mosaic operator, refer to Mosaic Operator. This is an optional parameter.

Returns:

the Mosaic Operator

setMosaicType

public void setMosaicType(String mosaicType)

Sets the Mosaic Operator parameter of this tool . This parameter is the method used to mosaic overlapping areas. for more information about each mosaic operator, refer to Mosaic Operator. This is an optional parameter.

Parameters:

mosaicType - the method used to mosaic overlapping areas. for more information about each mosaic operator, refer to Mosaic Operator.

getColormap

public String getColormap()

Returns the Mosaic Colormap Mode parameter of this tool . This parameter is the method used to choose which colormap from the input rasters will be applied to the mosaic output. for more information about each colormap mode, refer to Mosaic colormap mode. 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 the method used to choose which colormap from the input rasters will be applied to the mosaic output. for more information about each colormap mode, refer to Mosaic colormap mode. This is an optional parameter.

Parameters:

colormap - the method used to choose which colormap from the input rasters will be applied to the mosaic output. for more information about each colormap mode, refer to Mosaic colormap mode.

getOrderByField

public String getOrderByField()

Returns the Order by Field parameter of this tool . This parameter is 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 define the field by which to order the raster catalog items. This is an optional parameter.

Parameters:

orderByField - 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 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 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 - 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 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 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 - 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 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 is an optional parameter.

Parameters:

matchingMethod - null

getReferenceRaster

public String getReferenceRaster()

Returns the Reference Raster parameter of this tool . This parameter is if color matching is applied, choose how to specify the reference raster. older scripts and models may still use the old keyword. With the ArcGIS 10.0 release, this keyword was replaced with "CALCULATE_FROM_ALL" . Both keywords will continue to work, though for clarity it may be worthwhile to update it to the new keyword. 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 if color matching is applied, choose how to specify the reference raster. older scripts and models may still use the old keyword. With the ArcGIS 10.0 release, this keyword was replaced with "CALCULATE_FROM_ALL" . Both keywords will continue to work, though for clarity it may be worthwhile to update it to the new keyword. This is an optional parameter.

Parameters:

referenceRaster - if color matching is applied, choose how to specify the reference raster. older scripts and models may still use the old keyword. With the ArcGIS 10.0 release, this keyword was replaced with "CALCULATE_FROM_ALL" . Both keywords will continue to work, though for clarity it may be worthwhile to update it to the new keyword.

getOID

public int getOID()

Returns the Reference Raster OID parameter of this tool . This parameter is 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 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 - 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