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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialanalysttools.ExtractByCircle
All Implemented Interfaces:
GPTool

public class ExtractByCircle
extends AbstractGPTool

Extracts the cells of a raster based on a circle. The Extract by Circle 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
ExtractByCircle()
          Creates the Extract by Circle tool with defaults.
ExtractByCircle(Object inRaster, Object centerPoint, double radius, Object outRaster)
          Creates the Extract by Circle tool with the required parameters.
 
Method Summary
 Object getCenterPoint()
          Returns the Center point parameter of this tool .
 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 .
 double getRadius()
          Returns the Radius 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 setCenterPoint(Object centerPoint)
          Sets the Center point parameter 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 setRadius(double radius)
          Sets the Radius 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

ExtractByCircle

public ExtractByCircle()
Creates the Extract by Circle tool with defaults.

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


ExtractByCircle

public ExtractByCircle(Object inRaster,
                       Object centerPoint,
                       double radius,
                       Object outRaster)
Creates the Extract by Circle 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.
centerPoint - Point, the coordinates are specified in the same map units as the in_raster.
radius - Double, the radius is specified in map units and is in the same 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.

getCenterPoint

public Object getCenterPoint()
Returns the Center point parameter of this tool . This parameter is Point, the coordinates are specified in the same map units as the in_raster. This is a required parameter.

Returns:
the Center point

setCenterPoint

public void setCenterPoint(Object centerPoint)
Sets the Center point parameter of this tool . This parameter is Point, the coordinates are specified in the same map units as the in_raster. This is a required parameter.

Parameters:
centerPoint - Point, the coordinates are specified in the same map units as the in_raster.

getRadius

public double getRadius()
Returns the Radius parameter of this tool . This parameter is Double, the radius is specified in map units and is in the same units as the in_raster. This is a required parameter.

Returns:
the Radius

setRadius

public void setRadius(double radius)
Sets the Radius parameter of this tool . This parameter is Double, the radius is specified in map units and is in the same units as the in_raster. This is a required parameter.

Parameters:
radius - Double, the radius is specified in map units and is in the same 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 circle. 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 circle. This is an optional parameter.

Parameters:
extractionArea - String, identifies whether to extract cells inside or outside the input circle.

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