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

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

All Implemented Interfaces:

GPTool

public class Mosaic
extends AbstractGPTool

Mosaics multiple input rasters into an existing raster dataset. The Mosaic tool is contained in the Data Management Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• The target raster must be an existing raster dataset, which can be an empty raster dataset or one already containing data.
• Mosaic is useful when a set of adjacent raster datasets needs to be merged into one entity and also when minimizing the abrupt changes along the boundaries of overlapping rasters.
• 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.
• The Target layer is considered the first raster in the list of Input Rasters.
• 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 a file geodatabase or ArcSDE geodatabase; it is by far the most effective way to mosaic.
• The pixel type will be the same as the target raster dataset.
• For file-based rasters and personal geodatabase rasters, the Ignore Background Value must be set to the same value as NoData in order for the background value to be ignored. File geodatabase rasters and SDE rasters will simply work without this extra step.
• 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.
• The color matching method allows you to choose an algorithm to color match the datasets in your mosaic.
• 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).
• The Mosaic 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 the output extent does need to be adjusted, the Clip tool; can achieve that operation.
• The following environments affect this tool: current workspace; and scratch workspace;

Field Summary

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

vals

Constructor Summary

Mosaic()
Creates the Mosaic tool with defaults.

Mosaic(Object inputs, Object target)
Creates the Mosaic tool with the required parameters.

Method Summary

double	getBackgroundValue() Returns the Ignore Background Value parameter of this tool .
String	getColormap() Returns the Mosaic Colormap Mode parameter of this tool .
Object	getInputs() Returns the Input Rasters parameter of this tool .
String	getMatchingMethod() Returns the Color Matching Method parameter of this tool .
double	getMosaickingTolerance() Returns the Mosaicking Tolerance parameter of this tool .
String	getMosaicType() Returns the Mosaic Method parameter of this tool .
double	getNodataValue() Returns the NoData Value parameter of this tool .
String	getOnebitToEightbit() Returns the Convert 1 bit data to 8 bit parameter of this tool .
Object	getOutput() Returns the Output Raster parameter of this tool (Read only).
Object	getTarget() Returns the Target 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	setBackgroundValue(double backgroundValue) Sets the Ignore Background Value parameter of this tool .
void	setColormap(String colormap) Sets the Mosaic Colormap Mode parameter of this tool .
void	setInputs(Object inputs) Sets the Input Rasters parameter of this tool .
void	setMatchingMethod(String matchingMethod) Sets the Color Matching Method parameter of this tool .
void	setMosaickingTolerance(double mosaickingTolerance) Sets the Mosaicking Tolerance parameter of this tool .
void	setMosaicType(String mosaicType) Sets the Mosaic Method parameter of this tool .
void	setNodataValue(double nodataValue) Sets the NoData Value parameter of this tool .
void	setOnebitToEightbit(String onebitToEightbit) Sets the Convert 1 bit data to 8 bit parameter of this tool .
void	setTarget(Object target) Sets the Target 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

Mosaic

public Mosaic()

Creates the Mosaic tool with defaults.

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

Mosaic

public Mosaic(Object inputs,
              Object target)

Creates the 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:

inputs - Raster layer, the input raster datasets.

target - Raster dataset, this raster dataset must already exist. The Target layer is considered the first raster in the list of Input Rasters.

Method Detail

getInputs

public Object getInputs()

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

setInputs

public void setInputs(Object inputs)

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

Parameters:

inputs - Raster layer, the input raster datasets.

getTarget

public Object getTarget()

Returns the Target Raster parameter of this tool . This parameter is Raster dataset, this raster dataset must already exist. The Target layer is considered the first raster in the list of Input Rasters. This is a required parameter.

Returns:

the Target Raster

setTarget

public void setTarget(Object target)

Sets the Target Raster parameter of this tool . This parameter is Raster dataset, this raster dataset must already exist. The Target layer is considered the first raster in the list of Input Rasters. This is a required parameter.

Parameters:

target - Raster dataset, this raster dataset must already exist. The Target layer is considered the first raster in the list of Input Rasters.

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.

getBackgroundValue

public double getBackgroundValue()

Returns the Ignore Background Value parameter of this tool . This parameter is Double, for file-based rasters and personal geodatabase rasters, the Ignore Background Value must be set to the same value as NoData in order for the background value to be ignored. File geodatabase rasters and SDE rasters will simply work without this extra step. This is an optional parameter.

Returns:

the Ignore Background Value

setBackgroundValue

public void setBackgroundValue(double backgroundValue)

Sets the Ignore Background Value parameter of this tool . This parameter is Double, for file-based rasters and personal geodatabase rasters, the Ignore Background Value must be set to the same value as NoData in order for the background value to be ignored. File geodatabase rasters and SDE rasters will simply work without this extra step. This is an optional parameter.

Parameters:

backgroundValue - Double, for file-based rasters and personal geodatabase rasters, the Ignore Background Value must be set to the same value as NoData in order for the background value to be ignored. File geodatabase rasters and SDE rasters will simply work without this extra step.

getNodataValue

public double getNodataValue()

Returns the NoData Value parameter of this tool . This parameter is Double, all the pixels with the specified value will be set to NoData in the output raster dataset. This is an optional parameter.

Returns:

the NoData Value

setNodataValue

public void setNodataValue(double nodataValue)

Sets the NoData Value parameter of this tool . This parameter is Double, all the pixels with the specified value will be set to NoData in the output raster dataset. This is an optional parameter.

Parameters:

nodataValue - Double, all the pixels with the specified value will be set to NoData in the output raster dataset.

getOnebitToEightbit

public String getOnebitToEightbit()

Returns the Convert 1 bit data to 8 bit parameter of this tool . This parameter is String, choose whether the input 1-bit raster dataset will be converted to an 8-bit raster dataset. In this conversion, the value 1 in the input raster dataset will be changed to 255 in the output raster dataset. This is useful when importing a 1-bit raster dataset to ArcSDE. One-bit raster datasets have 8-bit pyramid layers when stored in a file system, but in ArcSDE, 1-bit raster datasets can only have 1-bit pyramid layers, which makes the display unpleasant. By converting the data to 8-bit in ArcSDE, the pyramid layers are built as 8-bit instead of 1-bit, resulting in a proper raster dataset in the display. This is an optional parameter.

Returns:

the Convert 1 bit data to 8 bit

setOnebitToEightbit

public void setOnebitToEightbit(String onebitToEightbit)

Sets the Convert 1 bit data to 8 bit parameter of this tool . This parameter is String, choose whether the input 1-bit raster dataset will be converted to an 8-bit raster dataset. In this conversion, the value 1 in the input raster dataset will be changed to 255 in the output raster dataset. This is useful when importing a 1-bit raster dataset to ArcSDE. One-bit raster datasets have 8-bit pyramid layers when stored in a file system, but in ArcSDE, 1-bit raster datasets can only have 1-bit pyramid layers, which makes the display unpleasant. By converting the data to 8-bit in ArcSDE, the pyramid layers are built as 8-bit instead of 1-bit, resulting in a proper raster dataset in the display. This is an optional parameter.

Parameters:

onebitToEightbit - String, choose whether the input 1-bit raster dataset will be converted to an 8-bit raster dataset. In this conversion, the value 1 in the input raster dataset will be changed to 255 in the output raster dataset. This is useful when importing a 1-bit raster dataset to ArcSDE. One-bit raster datasets have 8-bit pyramid layers when stored in a file system, but in ArcSDE, 1-bit raster datasets can only have 1-bit pyramid layers, which makes the display unpleasant. By converting the data to 8-bit in ArcSDE, the pyramid layers are built as 8-bit instead of 1-bit, resulting in a proper raster dataset in the display.

getMosaickingTolerance

public double getMosaickingTolerance()

Returns the Mosaicking Tolerance parameter of this tool . This parameter is Double, for example, the source and target pixels have a misalignment of 0.25. If the mosaicking tolerance is set to 0.2, resampling will take place, since the pixel misalignment is greater than the tolerance. If the mosaicking tolerance is set to 0.3, the pixels will be shifted. This is an optional parameter.

Returns:

the Mosaicking Tolerance

setMosaickingTolerance

public void setMosaickingTolerance(double mosaickingTolerance)

Sets the Mosaicking Tolerance parameter of this tool . This parameter is Double, for example, the source and target pixels have a misalignment of 0.25. If the mosaicking tolerance is set to 0.2, resampling will take place, since the pixel misalignment is greater than the tolerance. If the mosaicking tolerance is set to 0.3, the pixels will be shifted. This is an optional parameter.

Parameters:

mosaickingTolerance - Double, for example, the source and target pixels have a misalignment of 0.25. If the mosaicking tolerance is set to 0.2, resampling will take place, since the pixel misalignment is greater than the tolerance. If the mosaicking tolerance is set to 0.3, the pixels will be shifted.

getOutput

public Object getOutput()

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

Returns:

the Output Raster

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

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