com.esri.arcgis.geoprocessing.tools.samples
Class WorkspaceToMosaic

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.samples.WorkspaceToMosaic

All Implemented Interfaces:

GPTool

public class WorkspaceToMosaic
extends AbstractGPTool

Mosaics all the raster datasets in a workspace, or geodatabase, to an output raster dataset. The output raster dataset must already exist. The Workspace to Mosaic tool is contained in the Samples tool box.

Usage tips:

• Mosaic is useful when two or more adjacent raster datasets need to be merged into one entity. Some mosaic techniques can help minimize the abrupt changes along the boundaries of the overlapping rasters.
• 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.
• 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.
• The output raster dataset must already exist since the input raster datasets will all be mosaicked into it. This raster dataset cell size determines the cell size for the entire mosaic.
• If an output raster dataset does not already exist, you can use the Mosaic to New Raster tool, or create an empty raster dataset prior to running this tool.
• This sample tool was created using Python. The code can be viewed and edited, to help you write your own scripts.
• The Raster Analysis Environment Settings are not valid for this tool.

Field Summary

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

vals

Constructor Summary

WorkspaceToMosaic()
Creates the Workspace to Mosaic tool with defaults.

WorkspaceToMosaic(Object inputWorkspace, Object outputRaster, String mosaicColormapMode)
Creates the Workspace to Mosaic tool with the required parameters.

Method Summary

String	getConvert1BitDataTo8Bit() Returns the Convert 1 bit data to 8 bit parameter of this tool .
Object	getDerivedOutputRaster() Returns the Derived Output Raster parameter of this tool (Read only).
double	getIgnoreBackgroundValue() Returns the Ignore Background Value parameter of this tool .
Object	getInputWorkspace() Returns the Input Workspace 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 .
double	getMosaicTolerance() Returns the Mosaic Tolerance parameter of this tool .
double	getNodataValue() Returns the Nodata Value parameter of this tool .
Object	getOutputRaster() Returns the Output 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.
void	setConvert1BitDataTo8Bit(String convert1BitDataTo8Bit) Sets the Convert 1 bit data to 8 bit parameter of this tool .
void	setIgnoreBackgroundValue(double ignoreBackgroundValue) Sets the Ignore Background Value parameter of this tool .
void	setInputWorkspace(Object inputWorkspace) Sets the Input Workspace 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	setMosaicTolerance(double mosaicTolerance) Sets the Mosaic Tolerance parameter of this tool .
void	setNodataValue(double nodataValue) Sets the Nodata Value parameter of this tool .
void	setOutputRaster(Object outputRaster) Sets the Output Raster 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

WorkspaceToMosaic

public WorkspaceToMosaic()

Creates the Workspace to Mosaic tool with defaults.

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

WorkspaceToMosaic

public WorkspaceToMosaic(Object inputWorkspace,
                         Object outputRaster,
                         String mosaicColormapMode)

Creates the Workspace to Mosaic 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:

inputWorkspace - null

outputRaster - null

mosaicColormapMode - null

Method Detail

getInputWorkspace

public Object getInputWorkspace()

Returns the Input Workspace parameter of this tool . This is a required parameter.

Returns:

the Input Workspace

setInputWorkspace

public void setInputWorkspace(Object inputWorkspace)

Sets the Input Workspace parameter of this tool . This is a required parameter.

Parameters:

inputWorkspace - null

getOutputRaster

public Object getOutputRaster()

Returns the Output Raster parameter of this tool . This is a required parameter.

Returns:

the Output Raster

setOutputRaster

public void setOutputRaster(Object outputRaster)

Sets the Output Raster parameter of this tool . This is a required parameter.

Parameters:

outputRaster - null

getMosaicMethod

public String getMosaicMethod()

Returns the Mosaic Method parameter of this tool . This is an optional parameter.

Returns:

the Mosaic Method

setMosaicMethod

public void setMosaicMethod(String mosaicMethod)

Sets the Mosaic Method parameter of this tool . This is an optional parameter.

Parameters:

mosaicMethod - null

getMosaicColormapMode

public String getMosaicColormapMode()

Returns the Mosaic Colormap Mode parameter of this tool . This is a required parameter.

Returns:

the Mosaic Colormap Mode

setMosaicColormapMode

public void setMosaicColormapMode(String mosaicColormapMode)

Sets the Mosaic Colormap Mode parameter of this tool . This is a required parameter.

Parameters:

mosaicColormapMode - null

getIgnoreBackgroundValue

public double getIgnoreBackgroundValue()

Returns the Ignore Background Value parameter of this tool . This is an optional parameter.

Returns:

the Ignore Background Value

setIgnoreBackgroundValue

public void setIgnoreBackgroundValue(double ignoreBackgroundValue)

Sets the Ignore Background Value parameter of this tool . This is an optional parameter.

Parameters:

ignoreBackgroundValue - null

getNodataValue

public double getNodataValue()

Returns the Nodata Value parameter of this tool . This is an optional parameter.

Returns:

the Nodata Value

setNodataValue

public void setNodataValue(double nodataValue)

Sets the Nodata Value parameter of this tool . This is an optional parameter.

Parameters:

nodataValue - null

getConvert1BitDataTo8Bit

public String getConvert1BitDataTo8Bit()

Returns the Convert 1 bit data to 8 bit parameter of this tool . This is an optional parameter.

Returns:

the Convert 1 bit data to 8 bit

setConvert1BitDataTo8Bit

public void setConvert1BitDataTo8Bit(String convert1BitDataTo8Bit)

Sets the Convert 1 bit data to 8 bit parameter of this tool . This is an optional parameter.

Parameters:

convert1BitDataTo8Bit - null

getMosaicTolerance

public double getMosaicTolerance()

Returns the Mosaic Tolerance parameter of this tool . This is an optional parameter.

Returns:

the Mosaic Tolerance

setMosaicTolerance

public void setMosaicTolerance(double mosaicTolerance)

Sets the Mosaic Tolerance parameter of this tool . This is an optional parameter.

Parameters:

mosaicTolerance - null

getDerivedOutputRaster

public Object getDerivedOutputRaster()

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

Returns:

the Derived Output Raster

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