|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object com.esri.arcgis.geoprocessing.AbstractGPTool com.esri.arcgis.geoprocessing.tools.spatialanalysttools.SetNull
public class SetNull
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.
Field Summary |
---|
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool |
---|
vals |
Constructor Summary | |
---|---|
SetNull()
Creates the Set Null tool with defaults. |
|
SetNull(Object inConditionalRaster,
Object inFalseRasterOrConstant,
Object outRaster)
Creates the Set Null 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 |
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 |
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 |
---|
public SetNull()
Initializes the array of tool parameters with the default values specified when the tool was created.
public SetNull(Object inConditionalRaster, Object inFalseRasterOrConstant, Object outRaster)
Initializes the array of tool parameters with the values as specified for the required parameters and with the default values for the other 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 |
---|
public Object getInConditionalRaster()
public void setInConditionalRaster(Object inConditionalRaster)
inConditionalRaster
- input raster representing the true or false result of the desired condition. it must be of integer type.public Object getInFalseRasterOrConstant()
public void setInFalseRasterOrConstant(Object inFalseRasterOrConstant)
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.public Object getOutRaster()
public void setOutRaster(Object outRaster)
outRaster
- the output raster. if the conditional evaluation is true, NoData is returned. If false, the value of the second input raster is returned.public Object getWhereClause()
public void setWhereClause(Object whereClause)
whereClause
- an SQL expression used to select a subset of raster cells. For information on SQL syntax, see SQL Reference.public String getToolName()
public String getToolboxName()
public String getToolboxAlias()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |