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

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

All Implemented Interfaces:

GPTool

public class ExtractByAttributes
extends AbstractGPTool

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

Usage tips:

• If the Where clause evaluates to true, the original input value is returned for the cell location. If it evaluates to false, the cell location is assigned NoData.
• If the input raster is floating point, the query must reference Value. For example: value > 10
• Any extra items (other than Value and Count) of the input raster are dropped for the output raster.
• If an item other than Value of input raster is specified in the Where clause, the original input value is returned for the cell location.
• 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

ExtractByAttributes()
Creates the Extract by Attributes tool with defaults.

ExtractByAttributes(Object inRaster, Object whereClause, Object outRaster)
Creates the Extract by Attributes tool with the required parameters.

Method Summary

Object	getInRaster() Returns the Input raster parameter of this tool .
Object	getOutRaster() Returns the Output raster 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.
Object	getWhereClause() Returns the Where clause 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	setWhereClause(Object whereClause) Sets the Where clause 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

ExtractByAttributes

public ExtractByAttributes()

Creates the Extract by Attributes tool with defaults.

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

ExtractByAttributes

public ExtractByAttributes(Object inRaster,
                           Object whereClause,
                           Object outRaster)

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

whereClause - an SQL expression used to select a subset of raster cells. for information on SQL syntax, see the SQL Reference.

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.

getWhereClause

public Object getWhereClause()

Returns the Where clause parameter of this tool . This parameter is an SQL expression used to select a subset of raster cells. for information on SQL syntax, see the SQL Reference. This is a required parameter.

Returns:

the Where clause

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Where clause parameter of this tool . This parameter is an SQL expression used to select a subset of raster cells. for information on SQL syntax, see the SQL Reference. This is a required parameter.

Parameters:

whereClause - an SQL expression used to select a subset of raster cells. for information on SQL syntax, see the SQL Reference.

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.

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