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

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

Software restrictions: none

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 Mosaic tool; used in the model will not run.
• When working with a large number of raster datasets, the Workspace to Raster Dataset performs more efficiently than Mosaic to New Raster Dataset.
• The Mosaic tool; has more parameters available when combining datasets into an existing raster, such as 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 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, a JPEG 2000 file, or a geodatabase, you can specify a compression type and compression quality within the Raster Storage Settings in the Environment Settings dialog box.
• The GIF format only supports single-band raster datasets.
• When mosaicking with raster datasets containing colormaps, it is important to note differences across the colormaps for each raster you choose to mosaic. You can still use the Mosaic tool; 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.
• When you are entering commands and variables in the Command Line window and you come to a variable you do not know how to enter, press F8. You may need to do this when entering the coordinate system variable.
• 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; output coordinate system; output extent; (not with ArcSDE), and output CONFIG keyword;

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 Coordinate system for the 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 Method 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 Coordinate system for the 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 Method 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 - Raster layer, the input raster datasets.

outputLocation - Workspace |Raster catalog, the path to contain the raster dataset. The path can be to a folder or geodatabase.

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

numberOfBands - Long, the number of bands to be contained by the raster dataset.

Method Detail

getInputRasters

public Object getInputRasters()

Returns the Input Rasters parameter of this tool . This parameter is Raster layer, 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 Raster layer, the input raster datasets. This is a required parameter.

Parameters:

inputRasters - Raster layer, the input raster datasets.

getOutputLocation

public Object getOutputLocation()

Returns the Output Location parameter of this tool . This parameter is Workspace |Raster catalog, 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 Workspace |Raster catalog, the path to contain the raster dataset. The path can be to a folder or geodatabase. This is a required parameter.

Parameters:

outputLocation - Workspace |Raster catalog, 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 String, 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 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 String, 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:

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

getCoordinateSystemForTheRaster

public Object getCoordinateSystemForTheRaster()

Returns the Coordinate system for the raster parameter of this tool . This parameter is Coordinate System, when entering values in the Command Line window, press F8 to enter this value. This is an optional parameter.

Returns:

the Coordinate system for the raster

setCoordinateSystemForTheRaster

public void setCoordinateSystemForTheRaster(Object coordinateSystemForTheRaster)

Sets the Coordinate system for the raster parameter of this tool . This parameter is Coordinate System, when entering values in the Command Line window, press F8 to enter this value. This is an optional parameter.

Parameters:

coordinateSystemForTheRaster - Coordinate System, when entering values in the Command Line window, press F8 to enter this value.

getPixelType

public String getPixelType()

Returns the Pixel type parameter of this tool . This parameter is String, 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. This is an optional parameter.

Returns:

the Pixel type

setPixelType

public void setPixelType(String pixelType)

Sets the Pixel type parameter of this tool . This parameter is String, 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. This is an optional parameter.

Parameters:

pixelType - String, 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.

getCellsize

public double getCellsize()

Returns the Cellsize parameter of this tool . This parameter is Double, 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 Double, the cell size for the new raster dataset. This is an optional parameter.

Parameters:

cellsize - Double, the cell size for the new raster dataset.

getNumberOfBands

public int getNumberOfBands()

Returns the Number of bands parameter of this tool . This parameter is Long, the number of bands to be contained by the raster dataset. 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 parameter is Long, the number of bands to be contained by the raster dataset. This is a required parameter.

Parameters:

numberOfBands - Long, the number of bands to be contained by the raster dataset.

getMosaicMethod

public String getMosaicMethod()

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

Returns:

the Mosaic Method

setMosaicMethod

public void setMosaicMethod(String mosaicMethod)

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

Parameters:

mosaicMethod - String, help topic.

getMosaicColormapMode

public String getMosaicColormapMode()

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

setMosaicColormapMode

public void setMosaicColormapMode(String mosaicColormapMode)

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

Parameters:

mosaicColormapMode - String, help topic.

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