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

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

All Implemented Interfaces:

GPTool

public class SetNull
extends AbstractGPTool

Set Null sets identified cell locations to NoData based on a specified criteria. It returns NoData if a conditional evaluation is true, and returns the value specified by another raster if it is false. The Set Null tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• If the evaluation of the where clause is true, the cell location on the output raster will be assigned NoData. If the evaluation is false, the output raster will be defined by the input false raster or constant value.
• If no where clause is specified, the output raster will have NoData wherever the conditional raster is greater than zero.
• The input conditional raster does not affect whether the output data type is integer or floating point. If the input false raster or constant value contains floating-point values, the output raster will be floating point. If it contains all integer values, the output will be an integer raster.

Field Summary

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

vals

Constructor Summary

SetNull()
Creates the Set Null tool with defaults.

SetNull(java.lang.Object inConditionalRaster, java.lang.Object inFalseRasterOrConstant, java.lang.Object outRaster)
Creates the Set Null tool with the required parameters.

Method Summary

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

SetNull

public SetNull()

Creates the Set Null tool with defaults.

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

SetNull

public SetNull(java.lang.Object inConditionalRaster,
               java.lang.Object inFalseRasterOrConstant,
               java.lang.Object outRaster)

Creates the Set Null 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 must be of integer type.

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

outRaster - the output raster. if the conditional evaluation is true, NoData is returned. If false, the value of the second input raster is returned.

Method Detail

getInConditionalRaster

public java.lang.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 must be of integer type. This is a required parameter.

Returns:

the Input conditional raster

setInConditionalRaster

public void setInConditionalRaster(java.lang.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 must be of integer type. This is a required parameter.

Parameters:

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

getInFalseRasterOrConstant

public java.lang.Object getInFalseRasterOrConstant()

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

Returns:

the Input false raster or constant value

setInFalseRasterOrConstant

public void setInFalseRasterOrConstant(java.lang.Object inFalseRasterOrConstant)

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

Parameters:

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

getOutRaster

public java.lang.Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. if the conditional evaluation is true, NoData is returned. If false, the value of the second input raster is returned. 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 the output raster. if the conditional evaluation is true, NoData is returned. If false, the value of the second input raster is returned. This is a required parameter.

Parameters:

outRaster - the output raster. if the conditional evaluation is true, NoData is returned. If false, the value of the second input raster is returned.

getWhereClause

public java.lang.Object getWhereClause()

Returns the Expression parameter of this tool . This parameter is 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(java.lang.Object whereClause)

Sets the Expression parameter of this tool . This parameter is 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 - an SQL expression used to select a subset of raster cells. For information on SQL syntax, see SQL Reference.

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