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

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

All Implemented Interfaces:

GPTool

public class ConTool
extends AbstractGPTool

Performs a conditional if/else evaluation on each of the input cells of an input raster. The Con tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• If either the true raster or optional false raster is floating point, the output raster will be floating point. If both the true expression and optional false raster are integer, the output raster will be integer.
• If the evaluation of the expression is nonzero, it is treated as True.
• If no input false raster or constant is specified, NoData will be assigned to those cells that do not result in True from the expression.
• If NoData does not satisfy the expression, it does not receive the value of the input false raster; it remains NoData.
• The maximum length of the expression is 4096 characters.
• From the Command Line, the {where_clause} should be enclosed in quotes, for example, "Value > 5".

Field Summary

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

vals

Constructor Summary

ConTool()
Creates the Con tool with defaults.

ConTool(Object inConditionalRaster, Object inTrueRasterOrConstant, Object outRaster)
Creates the Con tool with the required parameters.

Method Summary

Object	getInConditionalRaster() Returns the Input conditional raster parameter of this tool .
Object	getInFalseRasterOrConstant() Returns the Input false raster or constant value parameter of this tool .
Object	getInTrueRasterOrConstant() Returns the Input true raster or constant value 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 Expression parameter of this tool .
void	setInConditionalRaster(Object inConditionalRaster) Sets the Input conditional raster parameter of this tool .
void	setInFalseRasterOrConstant(Object inFalseRasterOrConstant) Sets the Input false raster or constant value parameter of this tool .
void	setInTrueRasterOrConstant(Object inTrueRasterOrConstant) Sets the Input true raster or constant value parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster parameter of this tool .
void	setWhereClause(Object whereClause) Sets the Expression 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

ConTool

public ConTool()

Creates the Con tool with defaults.

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

ConTool

public ConTool(Object inConditionalRaster,
               Object inTrueRasterOrConstant,
               Object outRaster)

Creates the Con 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:

inConditionalRaster - input raster representing the true or false result of the desired condition. it can be of integer or floating point type.

inTrueRasterOrConstant - the input whose values will be used as the output cell values if the condition is true. it can be an integer or a floating point raster, or a constant value.

outRaster - the output raster.

Method Detail

getInConditionalRaster

public Object getInConditionalRaster()

Returns the Input conditional raster parameter of this tool . This parameter is input raster representing the true or false result of the desired condition. it can be of integer or floating point type. This is a required parameter.

Returns:

the Input conditional raster

setInConditionalRaster

public void setInConditionalRaster(Object inConditionalRaster)

Sets the Input conditional raster parameter of this tool . This parameter is input raster representing the true or false result of the desired condition. it can be of integer or floating point type. This is a required parameter.

Parameters:

inConditionalRaster - input raster representing the true or false result of the desired condition. it can be of integer or floating point type.

getInTrueRasterOrConstant

public Object getInTrueRasterOrConstant()

Returns the Input true raster or constant value parameter of this tool . This parameter is the input whose values will be used as the output cell values if the condition is true. it can be an integer or a floating point raster, or a constant value. This is a required parameter.

Returns:

the Input true raster or constant value

setInTrueRasterOrConstant

public void setInTrueRasterOrConstant(Object inTrueRasterOrConstant)

Sets the Input true raster or constant value parameter of this tool . This parameter is the input whose values will be used as the output cell values if the condition is true. it can be an integer or a floating point raster, or a constant value. This is a required parameter.

Parameters:

inTrueRasterOrConstant - the input whose values will be used as the output cell values if the condition is true. it can be an integer or a floating point raster, or a constant value.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output 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. This is a required parameter.

Parameters:

outRaster - the output raster.

getInFalseRasterOrConstant

public Object getInFalseRasterOrConstant()

Returns the Input false raster or constant value parameter of this tool . This parameter is the input whose values will be used as the output cell values if the condition is false. it can be an integer or a floating point raster, or a constant value. This is an optional parameter.

Returns:

the Input false raster or constant value

setInFalseRasterOrConstant

public void setInFalseRasterOrConstant(Object inFalseRasterOrConstant)

Sets the Input false raster or constant value parameter of this tool . This parameter is the input whose values will be used as the output cell values if the condition is false. it can be an integer or a floating point raster, or a constant value. This is an optional parameter.

Parameters:

inFalseRasterOrConstant - the input whose values will be used as the output cell values if the condition is false. it can be an integer or a floating point raster, or a constant value.

getWhereClause

public Object getWhereClause()

Returns the Expression parameter of this tool . This parameter is a logical expression that determnines which of the input cells are to be true or false. an SQL expression used to select a subset of raster cells. For information on SQL syntax, see SQL Reference. This is an optional parameter.

Returns:

the Expression

setWhereClause

public void setWhereClause(Object whereClause)

Sets the Expression parameter of this tool . This parameter is a logical expression that determnines which of the input cells are to be true or false. an SQL expression used to select a subset of raster cells. For information on SQL syntax, see SQL Reference. This is an optional parameter.

Parameters:

whereClause - a logical expression that determnines which of the input cells are to be true or false. an SQL expression used to select a subset of raster cells. For information on SQL syntax, see SQL Reference.

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