com.esri.arcgis.geoprocessing.tools.spatialanalysttools
Class ExtractByMask

java.lang.Object
  com.esri.arcgis.geoprocessing.AbstractGPTool
      com.esri.arcgis.geoprocessing.tools.spatialanalysttools.ExtractByMask

All Implemented Interfaces:

GPTool

public class ExtractByMask
extends AbstractGPTool

Extracts the cells of a raster that correspond to the areas defined by a mask. The Extract by Mask tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Illustration:

Usage tips:

• If the input raster values are integer, the output raster will be integer. If the input is floating point, the output will be floating point.
• When input raster or feature mask data is raster, the values for non-NoData input cell locations are copied to the output raster. Tools that can create the mask raster include Con, Test, and the extraction group.
• Extract by Mask is similar to setting the Mask option in the environment, except that the mask used in Extract by Mask is only used on the immediate instance, while a mask set in the environment is applied to all tools until it is changed or disabled.
• When a multiband raster; is specified as input, a new multiband raster will be created as output. Each individual band in the input multiband raster will be analyzed accordingly. The default output format is an ESRI grid stack. Note that the name of an ESRI grid stack; cannot start with a number, use spaces, or be more than 9 characters in length.
• When a multiband raster is specified for the input raster mask, only the first band will be used in the operation
• If the input is a layer created from a multiband raster with more than three bands, the extraction operation will only consider the bands that were loaded (symbolized) by the layer. As a result, the output multiband raster can only have three bands, corresponding to those used in the display of the input layer.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

ExtractByMask()
Creates the Extract by Mask tool with defaults.

ExtractByMask(Object inRaster, Object inMaskData, Object outRaster)
Creates the Extract by Mask tool with the required parameters.

Method Summary

Object	getInMaskData() Returns the Input raster or feature mask data parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getOutRaster() 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	setInMaskData(Object inMaskData) Sets the Input raster or feature mask data parameter of this tool .
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setOutRaster(Object outRaster) 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

ExtractByMask

public ExtractByMask()

Creates the Extract by Mask tool with defaults.

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

ExtractByMask

public ExtractByMask(Object inRaster,
                     Object inMaskData,
                     Object outRaster)

Creates the Extract by Mask 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:

inRaster - Composite Geodataset, the input raster from which cells will be extracted.

inMaskData - Composite Geodataset, when the in_mask_data is a raster, NoData cells on the mask will be assigned NoData values on the output raster.

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, the input raster from which cells will be extracted. This is a required parameter.

Returns:

the Input raster

setInRaster

public void setInRaster(Object inRaster)

Sets the Input raster parameter of this tool . This parameter is Composite Geodataset, the input raster from which cells will be extracted. This is a required parameter.

Parameters:

inRaster - Composite Geodataset, the input raster from which cells will be extracted.

getInMaskData

public Object getInMaskData()

Returns the Input raster or feature mask data parameter of this tool . This parameter is Composite Geodataset, when the in_mask_data is a raster, NoData cells on the mask will be assigned NoData values on the output raster. This is a required parameter.

Returns:

the Input raster or feature mask data

setInMaskData

public void setInMaskData(Object inMaskData)

Sets the Input raster or feature mask data parameter of this tool . This parameter is Composite Geodataset, when the in_mask_data is a raster, NoData cells on the mask will be assigned NoData values on the output raster. This is a required parameter.

Parameters:

inMaskData - Composite Geodataset, when the in_mask_data is a raster, NoData cells on the mask will be assigned NoData values on the output raster.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Returns:

the Output raster

setOutRaster

public void setOutRaster(Object outRaster)

Sets the Output raster parameter of this tool . This parameter is Raster Dataset, the raster to be created. This is a required parameter.

Parameters:

outRaster - Raster Dataset, the raster to be created.

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