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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by 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.

Software restrictions: none

Usage tips:


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 - Composite Geodataset, the input raster from which cells will be extracted.
polygon - Point, x,Y coordinates define the vertices of the polygon.
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.

getPolygon

public Object getPolygon()
Returns the Polygon parameter of this tool . This parameter is Point, x,Y coordinates define the vertices of 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 Point, x,Y coordinates define the vertices of the polygon. This is a required parameter.

Parameters:
polygon - Point, x,Y coordinates define the vertices of the polygon.

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 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 String, identifies whether to extract cells inside or outside the input polygon. This is an optional parameter.

Parameters:
extractionArea - String, 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