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

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

All Implemented Interfaces:

GPTool

public class IsNull
extends AbstractGPTool

Returns 1 if the input value is NoData and 0 for cells that are not, on a cell-by-cell basis within the Analysis window. The Is Null tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Is Null works

Software restrictions: none

Illustration:

Usage tips:

• Input values can be positive or negative.
• The output value types are always integer. The values are either 1 or 0. Cells in the input that have a value are given 0 on the output. Cells that are NoData in the input are given a value of 1 on the output.
• The following environment settings affect this tool:

Field Summary

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

vals

Constructor Summary

IsNull()
Creates the Is Null tool with defaults.

IsNull(Object inRaster, Object outRaster)
Creates the Is Null 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.
void	setInRaster(Object inRaster) Sets the Input raster parameter of this tool .
void	setOutRaster(Object outRaster) Sets the Output raster 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

IsNull

public IsNull()

Creates the Is Null tool with defaults.

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

IsNull

public IsNull(Object inRaster,
              Object outRaster)

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

inRaster - Composite Geodataset, the input being tested to identify the cells that are NoData (null).

outRaster - Raster Dataset, the raster to be created.

Method Detail

getInRaster

public Object getInRaster()

Returns the Input raster parameter of this tool . This parameter is Composite Geodataset, the input being tested to identify the cells that are NoData (null). 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 Composite Geodataset, the input being tested to identify the cells that are NoData (null). This is a required parameter.

Parameters:

inRaster - Composite Geodataset, the input being tested to identify the cells that are NoData (null).

getOutRaster

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

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