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

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

All Implemented Interfaces:

GPTool

public class MosaicToNewRaster
extends AbstractGPTool

Mosaics multiple raster datasets into a new raster dataset. The Mosaic To New Raster tool is contained in the Data Management Tools tool box.

Usage tips:

• The input raster datasets are all the raster datasets you would like to mosaic together. The inputs must have the same number of bands and same bit depth; otherwise, the tool will exit with an error message.
• When working with a large number of raster datasets, the tool performs more efficiently.
• The tool has more parameters available when combining datasets into an existing raster, such as options to ignore background and nodata values.
• 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 may be incorrect.
• 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.
• 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.
• This tool does not honor the environment setting for SDE. If you want a specific extent for your output raster, consider using the tool. You can either clip the input rasters prior to using this tool, or clip the output of this tool.

Field Summary

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

vals

Constructor Summary

MosaicToNewRaster()
Creates the Mosaic To New Raster tool with defaults.

MosaicToNewRaster(Object inputRasters, Object outputLocation, String rasterDatasetNameWithExtension, int numberOfBands)
Creates the Mosaic To New Raster tool with the required parameters.

Method Summary

double	getCellsize() Returns the Cellsize parameter of this tool .
Object	getCoordinateSystemForTheRaster() Returns the Spatial Reference for Raster parameter of this tool .
Object	getInputRasters() Returns the Input Rasters parameter of this tool .
String	getMosaicColormapMode() Returns the Mosaic Colormap Mode parameter of this tool .
String	getMosaicMethod() Returns the Mosaic Operator parameter of this tool .
int	getNumberOfBands() Returns the Number of Bands parameter of this tool .
Object	getOutputLocation() Returns the Output Location parameter of this tool .
Object	getOutputRasterDataset() Returns the Output Raster Dataset parameter of this tool (Read only).
String	getPixelType() Returns the Pixel Type parameter of this tool .
String	getRasterDatasetNameWithExtension() Returns the Raster Dataset Name with Extension 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.
void	setCellsize(double cellsize) Sets the Cellsize parameter of this tool .
void	setCoordinateSystemForTheRaster(Object coordinateSystemForTheRaster) Sets the Spatial Reference for Raster parameter of this tool .
void	setInputRasters(Object inputRasters) Sets the Input Rasters parameter of this tool .
void	setMosaicColormapMode(String mosaicColormapMode) Sets the Mosaic Colormap Mode parameter of this tool .
void	setMosaicMethod(String mosaicMethod) Sets the Mosaic Operator parameter of this tool .
void	setNumberOfBands(int numberOfBands) Sets the Number of Bands parameter of this tool .
void	setOutputLocation(Object outputLocation) Sets the Output Location parameter of this tool .
void	setPixelType(String pixelType) Sets the Pixel Type parameter of this tool .
void	setRasterDatasetNameWithExtension(String rasterDatasetNameWithExtension) Sets the Raster Dataset Name with Extension 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

MosaicToNewRaster

public MosaicToNewRaster()

Creates the Mosaic To New Raster tool with defaults.

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

MosaicToNewRaster

public MosaicToNewRaster(Object inputRasters,
                         Object outputLocation,
                         String rasterDatasetNameWithExtension,
                         int numberOfBands)

Creates the Mosaic To New Raster 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:

inputRasters - the input raster datasets.

outputLocation - the path to contain the raster dataset. The path can be to a folder or geodatabase.

rasterDatasetNameWithExtension - the name and extension of the raster dataset to be created. 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.

numberOfBands - null

Method Detail

getInputRasters

public Object getInputRasters()

Returns the Input Rasters parameter of this tool . This parameter is the input raster datasets. This is a required parameter.

Returns:

the Input Rasters

setInputRasters

public void setInputRasters(Object inputRasters)

Sets the Input Rasters parameter of this tool . This parameter is the input raster datasets. This is a required parameter.

Parameters:

inputRasters - the input raster datasets.

getOutputLocation

public Object getOutputLocation()

Returns the Output Location parameter of this tool . This parameter is the path to contain the raster dataset. The path can be to a folder or geodatabase. This is a required parameter.

Returns:

the Output Location

setOutputLocation

public void setOutputLocation(Object outputLocation)

Sets the Output Location parameter of this tool . This parameter is the path to contain the raster dataset. The path can be to a folder or geodatabase. This is a required parameter.

Parameters:

outputLocation - the path to contain the raster dataset. The path can be to a folder or geodatabase.

getRasterDatasetNameWithExtension

public String getRasterDatasetNameWithExtension()

Returns the Raster Dataset Name with Extension parameter of this tool . This parameter is the name and extension of the raster dataset to be created. 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 Raster Dataset Name with Extension

setRasterDatasetNameWithExtension

public void setRasterDatasetNameWithExtension(String rasterDatasetNameWithExtension)

Sets the Raster Dataset Name with Extension parameter of this tool . This parameter is the name and extension of the raster dataset to be created. 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:

rasterDatasetNameWithExtension - the name and extension of the raster dataset to be created. 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.

getCoordinateSystemForTheRaster

public Object getCoordinateSystemForTheRaster()

Returns the Spatial Reference for Raster parameter of this tool . This parameter is specifies the map projection of the output raster mosaic. This is an optional parameter.

Returns:

the Spatial Reference for Raster

setCoordinateSystemForTheRaster

public void setCoordinateSystemForTheRaster(Object coordinateSystemForTheRaster)

Sets the Spatial Reference for Raster parameter of this tool . This parameter is specifies the map projection of the output raster mosaic. This is an optional parameter.

Parameters:

coordinateSystemForTheRaster - specifies the map projection of the output raster mosaic.

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

getCellsize

public double getCellsize()

Returns the Cellsize parameter of this tool . This parameter is the cell size for the new raster dataset. This is an optional parameter.

Returns:

the Cellsize

setCellsize

public void setCellsize(double cellsize)

Sets the Cellsize parameter of this tool . This parameter is the cell size for the new raster dataset. This is an optional parameter.

Parameters:

cellsize - the cell size for the new raster dataset.

getNumberOfBands

public int getNumberOfBands()

Returns the Number of Bands parameter of this tool . This is a required parameter.

Returns:

the Number of Bands

setNumberOfBands

public void setNumberOfBands(int numberOfBands)

Sets the Number of Bands parameter of this tool . This is a required parameter.

Parameters:

numberOfBands - null

getMosaicMethod

public String getMosaicMethod()

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

setMosaicMethod

public void setMosaicMethod(String mosaicMethod)

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:

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

getMosaicColormapMode

public String getMosaicColormapMode()

Returns the Mosaic Colormap Mode parameter of this tool . This parameter is applies when the input raster datasets have a 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. This is an optional parameter.

Returns:

the Mosaic Colormap Mode

setMosaicColormapMode

public void setMosaicColormapMode(String mosaicColormapMode)

Sets the Mosaic Colormap Mode parameter of this tool . This parameter is applies when the input raster datasets have a 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. This is an optional parameter.

Parameters:

mosaicColormapMode - applies when the input raster datasets have a 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.

getOutputRasterDataset

public Object getOutputRasterDataset()

Returns the Output Raster Dataset parameter of this tool (Read only). This is an derived parameter.

Returns:

the Output Raster Dataset

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