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

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

All Implemented Interfaces:

GPTool

public class ExtractByRectangle
extends AbstractGPTool

Extracts the cells of a raster based on a rectangle. The Extract by Rectangle tool is contained in the Spatial Analyst Tools tool box.

Software restrictions: none

Usage tips:

• If the input raster is integer, the output raster will be integer. If the input is floating point, the output will be floating point.
• The center of the cell is used to determine whether a cell is inside or outside a rectangle. If the center is within the outline of a rectangle, the cell is considered fully inside even if portions of the cell fall outside the rectangle.
• Cell locations that are not selected are assigned values of NoData.
• 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.
• 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

ExtractByRectangle()
Creates the Extract by Rectangle tool with defaults.

ExtractByRectangle(Object inRaster, Object rectangle, Object outRaster)
Creates the Extract by Rectangle tool with the required parameters.

Method Summary

String	getExtractionArea() Returns the Extraction area parameter of this tool .
Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getOutRaster() Returns the Output raster parameter of this tool .
Object	getRectangle() Returns the Rectangle 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	setExtractionArea(String extractionArea) Sets the Extraction area 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 .
void	setRectangle(Object rectangle) Sets the Rectangle 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

ExtractByRectangle

public ExtractByRectangle()

Creates the Extract by Rectangle tool with defaults.

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

ExtractByRectangle

public ExtractByRectangle(Object inRaster,
                          Object rectangle,
                          Object outRaster)

Creates the Extract by Rectangle 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.

rectangle - Envelope, the coordinates are specified in the same map units as the in_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.

getRectangle

public Object getRectangle()

Returns the Rectangle parameter of this tool . This parameter is Envelope, the coordinates are specified in the same map units as the in_raster. This is a required parameter.

Returns:

the Rectangle

setRectangle

public void setRectangle(Object rectangle)

Sets the Rectangle parameter of this tool . This parameter is Envelope, the coordinates are specified in the same map units as the in_raster. This is a required parameter.

Parameters:

rectangle - Envelope, the coordinates are specified in the same map units as the in_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.

getExtractionArea

public String getExtractionArea()

Returns the Extraction area parameter of this tool . This parameter is String, identifies whether to extract cells inside or outside the input rectangle. This is an optional parameter.

Returns:

the Extraction area

setExtractionArea

public void setExtractionArea(String extractionArea)

Sets the Extraction area parameter of this tool . This parameter is String, identifies whether to extract cells inside or outside the input rectangle. This is an optional parameter.

Parameters:

extractionArea - String, identifies whether to extract cells inside or outside the input rectangle.

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