com.esri.arcgis.geoprocessing.tools.datamanagementtools
Class WorkspaceToRasterDataset
java.lang.Object
com.esri.arcgis.geoprocessing.AbstractGPTool
com.esri.arcgis.geoprocessing.tools.datamanagementtools.WorkspaceToRasterDataset
- All Implemented Interfaces:
- GPTool
public class WorkspaceToRasterDataset
- extends AbstractGPTool
Mosaics all the raster datasets stored within the specified workspace into one raster dataset.
The Workspace To Raster Dataset tool is contained in the Data Management Tools tool box.
Usage tips:
- The target raster dataset must already exist for the tool to run.
- If a target raster dataset does not already exist, use the tool to create a new raster dataset.
- Since mosaicking will take place, you will need to specify the mosaic method and colormap mode to use.
- If the target raster dataset is an empty raster dataset, the cell size and spatial reference of the first input raster dataset will be applied to the mosaic.
- 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.
- 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.
- The color matching method drop-down arrow allows you to choose an algorithm to color match the datasets in your mosaic.
- 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 ArcSDE rasters will simply work without this extra step.
- 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.
Constructor Summary |
WorkspaceToRasterDataset()
Creates the Workspace To Raster Dataset tool with defaults. |
WorkspaceToRasterDataset(java.lang.Object inWorkspace,
java.lang.Object inRasterDataset)
Creates the Workspace To Raster Dataset tool with the required parameters. |
Method Summary |
double |
getBackgroundValue()
Returns the Ignore Background Value parameter of this tool . |
java.lang.String |
getColormap()
Returns the Mosaic Colormap Mode parameter of this tool . |
java.lang.String |
getColormapToRGB()
Returns the Colormap to RGB parameter of this tool . |
java.lang.String |
getIncludeSubdirectories()
Returns the Include Sub-directories parameter of this tool . |
java.lang.Object |
getInRasterDataset()
Returns the Target Raster Dataset parameter of this tool . |
java.lang.Object |
getInWorkspace()
Returns the Input Workspace parameter of this tool . |
java.lang.String |
getMatchingMethod()
Returns the Color Matching Method parameter of this tool . |
double |
getMosaickingTolerance()
Returns the Mosaicking Tolerance parameter of this tool . |
java.lang.String |
getMosaicType()
Returns the Mosaic Operator parameter of this tool . |
double |
getNodataValue()
Returns the NoData Value parameter of this tool . |
java.lang.String |
getOnebitToEightbit()
Returns the Convert 1 bit data to 8 bit parameter of this tool . |
java.lang.Object |
getOutRasterDataset()
Returns the Output Raster Dataset parameter of this tool (Read only). |
java.lang.String |
getToolboxAlias()
Returns the alias of the tool box containing this tool. |
java.lang.String |
getToolboxName()
Returns the name of the tool box containing this tool. |
java.lang.String |
getToolName()
Returns the name of this tool. |
void |
setBackgroundValue(double backgroundValue)
Sets the Ignore Background Value parameter of this tool . |
void |
setColormap(java.lang.String colormap)
Sets the Mosaic Colormap Mode parameter of this tool . |
void |
setColormapToRGB(java.lang.String colormapToRGB)
Sets the Colormap to RGB parameter of this tool . |
void |
setIncludeSubdirectories(java.lang.String includeSubdirectories)
Sets the Include Sub-directories parameter of this tool . |
void |
setInRasterDataset(java.lang.Object inRasterDataset)
Sets the Target Raster Dataset parameter of this tool . |
void |
setInWorkspace(java.lang.Object inWorkspace)
Sets the Input Workspace parameter of this tool . |
void |
setMatchingMethod(java.lang.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(java.lang.String mosaicType)
Sets the Mosaic Operator parameter of this tool . |
void |
setNodataValue(double nodataValue)
Sets the NoData Value parameter of this tool . |
void |
setOnebitToEightbit(java.lang.String onebitToEightbit)
Sets the Convert 1 bit data to 8 bit parameter of this tool . |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
WorkspaceToRasterDataset
public WorkspaceToRasterDataset()
- Creates the Workspace To Raster Dataset tool with defaults.
Initializes the array of tool parameters with the default values specified when the tool was created.
WorkspaceToRasterDataset
public WorkspaceToRasterDataset(java.lang.Object inWorkspace,
java.lang.Object inRasterDataset)
- Creates the Workspace 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:
inWorkspace
- the workspace that contains all the raster datasets to be mosaicked into the raster dataset.inRasterDataset
- the raster dataset that will have all the rasters from the workspace mosaicked into it. The raster dataset must already exist.
getInWorkspace
public java.lang.Object getInWorkspace()
- Returns the Input Workspace parameter of this tool .
This parameter is the workspace that contains all the raster datasets to be mosaicked into the raster dataset.
This is a required parameter.
- Returns:
- the Input Workspace
setInWorkspace
public void setInWorkspace(java.lang.Object inWorkspace)
- Sets the Input Workspace parameter of this tool .
This parameter is the workspace that contains all the raster datasets to be mosaicked into the raster dataset.
This is a required parameter.
- Parameters:
inWorkspace
- the workspace that contains all the raster datasets to be mosaicked into the raster dataset.
getInRasterDataset
public java.lang.Object getInRasterDataset()
- Returns the Target Raster Dataset parameter of this tool .
This parameter is the raster dataset that will have all the rasters from the workspace mosaicked into it. The raster dataset must already exist.
This is a required parameter.
- Returns:
- the Target Raster Dataset
setInRasterDataset
public void setInRasterDataset(java.lang.Object inRasterDataset)
- Sets the Target Raster Dataset parameter of this tool .
This parameter is the raster dataset that will have all the rasters from the workspace mosaicked into it. The raster dataset must already exist.
This is a required parameter.
- Parameters:
inRasterDataset
- the raster dataset that will have all the rasters from the workspace mosaicked into it. The raster dataset must already exist.
getIncludeSubdirectories
public java.lang.String getIncludeSubdirectories()
- Returns the Include Sub-directories parameter of this tool .
This parameter is specify whether to include subdirectories.
This is an optional parameter.
- Returns:
- the Include Sub-directories
setIncludeSubdirectories
public void setIncludeSubdirectories(java.lang.String includeSubdirectories)
- Sets the Include Sub-directories parameter of this tool .
This parameter is specify whether to include subdirectories.
This is an optional parameter.
- Parameters:
includeSubdirectories
- specify whether to include subdirectories.
getMosaicType
public java.lang.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(java.lang.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 java.lang.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(java.lang.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.
getBackgroundValue
public double getBackgroundValue()
- Returns the Ignore Background Value parameter of this tool .
This parameter is use this option to remove the unwanted values created around the raster data. The value specified will be distinguished from other valuable data in the raster dataset. For example, a value of zero along the raster dataset's borders will be distinguished from zero values within the raster dataset. the pixel value specified will be set to NoData in the output 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. ArcSDE and file geodatabase rasters will 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 use this option to remove the unwanted values created around the raster data. The value specified will be distinguished from other valuable data in the raster dataset. For example, a value of zero along the raster dataset's borders will be distinguished from zero values within the raster dataset. the pixel value specified will be set to NoData in the output 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. ArcSDE and file geodatabase rasters will work without this extra step.
This is an optional parameter.
- Parameters:
backgroundValue
- use this option to remove the unwanted values created around the raster data. The value specified will be distinguished from other valuable data in the raster dataset. For example, a value of zero along the raster dataset's borders will be distinguished from zero values within the raster dataset. the pixel value specified will be set to NoData in the output 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. ArcSDE and file geodatabase rasters will work without this extra step.
getNodataValue
public double getNodataValue()
- Returns the NoData Value parameter of this tool .
This parameter is 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 all the pixels with the specified value will be set to NoData in the output raster dataset.
This is an optional parameter.
- Parameters:
nodataValue
- all the pixels with the specified value will be set to NoData in the output raster dataset.
getOnebitToEightbit
public java.lang.String getOnebitToEightbit()
- Returns the Convert 1 bit data to 8 bit parameter of this tool .
This parameter is 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 dataset 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(java.lang.String onebitToEightbit)
- Sets the Convert 1 bit data to 8 bit parameter of this tool .
This parameter is 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 dataset 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
- 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 dataset 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 when mosaicking takes place, the target and the source pixels do not always line up exactly. When there is a misalignment of pixels, a decision needs to be made whether resampling takes place, or whether the data should be shifted. The mosaicking tolerance controls whether resampling of the pixels take place, or if the pixels should be shifted. if the difference in pixel alignment (of the incoming dataset and the target dataset) is greater than the tolerance, resampling will take place. If the difference in pixel alignment (of the incoming dataset and the target dataset) is less than the tolerance, resampling will not take place (instead, a shift is performed). the unit of tolerance is a pixel; the valid value range is 0 to 0.9999. The maximum a pixel can be shifted is 0.5, so anything you set that is greater than 0.5 will guarantee a shift takes place. A tolerance of zero guarantees resampling, if there is a misalignment in pixels. for example, the source and target pixels have a misalignment of 0.25. If the mosaicking tolerance is set to 0.2, then resampling will take place since the pixel misalignment is greater than the tolerance. If the mosaicking tolerance is set to 0.3, then 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 when mosaicking takes place, the target and the source pixels do not always line up exactly. When there is a misalignment of pixels, a decision needs to be made whether resampling takes place, or whether the data should be shifted. The mosaicking tolerance controls whether resampling of the pixels take place, or if the pixels should be shifted. if the difference in pixel alignment (of the incoming dataset and the target dataset) is greater than the tolerance, resampling will take place. If the difference in pixel alignment (of the incoming dataset and the target dataset) is less than the tolerance, resampling will not take place (instead, a shift is performed). the unit of tolerance is a pixel; the valid value range is 0 to 0.9999. The maximum a pixel can be shifted is 0.5, so anything you set that is greater than 0.5 will guarantee a shift takes place. A tolerance of zero guarantees resampling, if there is a misalignment in pixels. for example, the source and target pixels have a misalignment of 0.25. If the mosaicking tolerance is set to 0.2, then resampling will take place since the pixel misalignment is greater than the tolerance. If the mosaicking tolerance is set to 0.3, then the pixels will be shifted.
This is an optional parameter.
- Parameters:
mosaickingTolerance
- when mosaicking takes place, the target and the source pixels do not always line up exactly. When there is a misalignment of pixels, a decision needs to be made whether resampling takes place, or whether the data should be shifted. The mosaicking tolerance controls whether resampling of the pixels take place, or if the pixels should be shifted. if the difference in pixel alignment (of the incoming dataset and the target dataset) is greater than the tolerance, resampling will take place. If the difference in pixel alignment (of the incoming dataset and the target dataset) is less than the tolerance, resampling will not take place (instead, a shift is performed). the unit of tolerance is a pixel; the valid value range is 0 to 0.9999. The maximum a pixel can be shifted is 0.5, so anything you set that is greater than 0.5 will guarantee a shift takes place. A tolerance of zero guarantees resampling, if there is a misalignment in pixels. for example, the source and target pixels have a misalignment of 0.25. If the mosaicking tolerance is set to 0.2, then resampling will take place since the pixel misalignment is greater than the tolerance. If the mosaicking tolerance is set to 0.3, then the pixels will be shifted.
getMatchingMethod
public java.lang.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(java.lang.String matchingMethod)
- Sets the Color Matching Method parameter of this tool .
This is an optional parameter.
- Parameters:
matchingMethod
- null
getColormapToRGB
public java.lang.String getColormapToRGB()
- Returns the Colormap to RGB parameter of this tool .
This is an optional parameter.
- Returns:
- the Colormap to RGB
setColormapToRGB
public void setColormapToRGB(java.lang.String colormapToRGB)
- Sets the Colormap to RGB parameter of this tool .
This is an optional parameter.
- Parameters:
colormapToRGB
- null
getOutRasterDataset
public java.lang.Object getOutRasterDataset()
- Returns the Output Raster Dataset parameter of this tool (Read only).
This is an derived parameter.
- Returns:
- the Output Raster Dataset
getToolName
public java.lang.String getToolName()
- Returns the name of this tool.
- Returns:
- the tool name
getToolboxName
public java.lang.String getToolboxName()
- Returns the name of the tool box containing this tool.
- Returns:
- the tool box name
getToolboxAlias
public java.lang.String getToolboxAlias()
- Returns the alias of the tool box containing this tool.
- Returns:
- the tool box alias