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

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

• 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 circle. If the center is within the arc of the circle, the cell is considered fully inside even if portions of the cell fall outside the circle.
• Cell locations that are not selected are assigned a value 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.

Field Summary

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

vals

Constructor Summary

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

ExtractByCircle(java.lang.Object inRaster, java.lang.Object centerPoint, double radius, java.lang.Object outRaster)
Creates the Extract by Circle tool with the required parameters.

Method Summary

java.lang.Object	getCenterPoint() Returns the Center point parameter of this tool .
java.lang.String	getExtractionArea() Returns the Extraction area parameter of this tool .
java.lang.Object	getInRaster() Returns the Input raster parameter of this tool .
java.lang.Object	getOutRaster() Returns the Output raster parameter of this tool .
double	getRadius() Returns the Radius parameter of this tool .
java.lang.String	getToolboxAlias() Returns the alias of the tool box containing this tool.
java.lang.String	getToolboxName() Returns the name of the tool box containing this tool.
java.lang.String	getToolName() Returns the name of this tool.
void	setCenterPoint(java.lang.Object centerPoint) Sets the Center point parameter of this tool .
void	setExtractionArea(java.lang.String extractionArea) Sets the Extraction area parameter of this tool .
void	setInRaster(java.lang.Object inRaster) Sets the Input raster parameter of this tool .
void	setOutRaster(java.lang.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(java.lang.Object inRaster,
                       java.lang.Object centerPoint,
                       double radius,
                       java.lang.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, input raster.

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 java.lang.Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, input raster. This is a required parameter.

Returns:

the Input raster

setInRaster

public void setInRaster(java.lang.Object inRaster)

Sets the Input raster parameter of this tool . This parameter is Composite Geodataset, input raster. This is a required parameter.

Parameters:

inRaster - Composite Geodataset, input raster.

getCenterPoint

public java.lang.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(java.lang.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 java.lang.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(java.lang.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 java.lang.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(java.lang.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.

• INSIDE — A keyword specifying that the cells inside the input circle should be selected and written to the output raster. All cells outside the circle will receive NoData on the output raster.
• OUTSIDE — A keyword specifying that the cells outside the input circle should be selected and written to the output raster. All cells inside the circle will receive NoData on the output raster.

getToolName

public java.lang.String getToolName()

Returns the name of this tool.

Returns:

the tool name

getToolboxName

public java.lang.String getToolboxName()

Returns the name of the tool box containing this tool.

Returns:

the tool box name

getToolboxAlias

public java.lang.String getToolboxAlias()

Returns the alias of the tool box containing this tool.

Returns:

the tool box alias