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

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

All Implemented Interfaces:

GPTool

public class ExtractByPolygon
extends AbstractGPTool

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

Usage tips:

• To extract based on a polygon in a feature class instead of providing a series of x,y pairs, you can use the tool.
• The center of the cell is used to determine whether a cell is inside or outside a polygon. If the center is within the arcs of the polygon, the cell is considered fully inside even if portions of the cell fall outside the polygon.
• The polygon has a limit of 1,000 vertices. Polygon vertices must be entered in a clockwise order. The first and last vertex must be the same to close the polygon if multiple polygons are to be used. If the last points are not identicle, the polygon will be closed automatically. The arcs of the polygon can cross one another, but convoluted polygons are not recommended.
• Cell locations that are not selected are assigned a value of NoData.
• When a 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 . 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.
• If the input raster is integer, the output raster will be integer. If the input is floating point, the output will be floating point.

Field Summary

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

vals

Constructor Summary

ExtractByPolygon()
Creates the Extract by Polygon tool with defaults.

ExtractByPolygon(Object inRaster, Object polygon, Object outRaster)
Creates the Extract by Polygon 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	getPolygon() Returns the Polygon 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	setPolygon(Object polygon) Sets the Polygon 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

ExtractByPolygon

public ExtractByPolygon()

Creates the Extract by Polygon tool with defaults.

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

ExtractByPolygon

public ExtractByPolygon(Object inRaster,
                        Object polygon,
                        Object outRaster)

Creates the Extract by Polygon 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 - the input raster from which cells will be extracted.

polygon - a polygon (or polygons) that defines the area of the input raster to be extracted. each polygon part is a list of vertices defined by Point classes. Optionally a Polygon class can be used to define a list of polygon parts. the points are specified as x,y coordinate pairs. The form of the object is: note that the last coordinate should be the same as the first in order to close the polygon.

outRaster - the output raster containing the cell values extracted from the input raster.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is 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 the input raster from which cells will be extracted. This is a required parameter.

Parameters:

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

getPolygon

public Object getPolygon()

Returns the Polygon parameter of this tool . This parameter is a polygon (or polygons) that defines the area of the input raster to be extracted. each polygon part is a list of vertices defined by Point classes. Optionally a Polygon class can be used to define a list of polygon parts. the points are specified as x,y coordinate pairs. The form of the object is: note that the last coordinate should be the same as the first in order to close the polygon. This is a required parameter.

Returns:

the Polygon

setPolygon

public void setPolygon(Object polygon)

Sets the Polygon parameter of this tool . This parameter is a polygon (or polygons) that defines the area of the input raster to be extracted. each polygon part is a list of vertices defined by Point classes. Optionally a Polygon class can be used to define a list of polygon parts. the points are specified as x,y coordinate pairs. The form of the object is: note that the last coordinate should be the same as the first in order to close the polygon. This is a required parameter.

Parameters:

polygon - a polygon (or polygons) that defines the area of the input raster to be extracted. each polygon part is a list of vertices defined by Point classes. Optionally a Polygon class can be used to define a list of polygon parts. the points are specified as x,y coordinate pairs. The form of the object is: note that the last coordinate should be the same as the first in order to close the polygon.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster containing the cell values extracted from the input raster. 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 the output raster containing the cell values extracted from the input raster. This is a required parameter.

Parameters:

outRaster - the output raster containing the cell values extracted from the input raster.

getExtractionArea

public String getExtractionArea()

Returns the Extraction area parameter of this tool . This parameter is identifies whether to extract cells inside or outside the input polygon. 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 identifies whether to extract cells inside or outside the input polygon. This is an optional parameter.

Parameters:

extractionArea - identifies whether to extract cells inside or outside the input polygon.

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