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

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

All Implemented Interfaces:

GPTool

public class BitwiseNot
extends AbstractGPTool

Performs a Bitwise Not (complement) operation on the binary value of an input raster. The Bitwise Not tool is contained in the Spatial Analyst Tools tool box.

Usage tips:

• In Bitwise operations:
  • Binary values are stored in two's complement.
  • The tools work on 32-bit integers.
  • The leftmost bit position is reserved for the sign of the value (positive or negative). If the integer is positive, the bit position is 0; if it's negative, the bit position is 1.
• The Bitwise Not operation treats the sign bit as it would any other bit. If the input for a cell location is negative, the output is negative; if the input is positive, the output is positive.

Field Summary

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

vals

Constructor Summary

BitwiseNot()
Creates the Bitwise Not tool with defaults.

BitwiseNot(Object inRasterOrConstant, Object outRaster)
Creates the Bitwise Not tool with the required parameters.

Method Summary

Object	getInRasterOrConstant() Returns the Input 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.
void	setInRasterOrConstant(Object inRasterOrConstant) Sets the Input raster or constant value 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

BitwiseNot

public BitwiseNot()

Creates the Bitwise Not tool with defaults.

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

BitwiseNot

public BitwiseNot(Object inRasterOrConstant,
                  Object outRaster)

Creates the Bitwise Not 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:

inRasterOrConstant - the input raster on which to perform the Bitwise Not (complement) operation. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. if the input is floating-point, the values are converted to integer values through truncation before the bitwise operation is performed.

outRaster - the output raster. the cell values are the result of a Bitwise Not operation on the input.

Method Detail

getInRasterOrConstant

public Object getInRasterOrConstant()

Returns the Input raster or constant value parameter of this tool . This parameter is the input raster on which to perform the Bitwise Not (complement) operation. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. if the input is floating-point, the values are converted to integer values through truncation before the bitwise operation is performed. This is a required parameter.

Returns:

the Input raster or constant value

setInRasterOrConstant

public void setInRasterOrConstant(Object inRasterOrConstant)

Sets the Input raster or constant value parameter of this tool . This parameter is the input raster on which to perform the Bitwise Not (complement) operation. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. if the input is floating-point, the values are converted to integer values through truncation before the bitwise operation is performed. This is a required parameter.

Parameters:

inRasterOrConstant - the input raster on which to perform the Bitwise Not (complement) operation. in order to use a number as an input for this parameter, the cell size and extent must first be set in the environment. if the input is floating-point, the values are converted to integer values through truncation before the bitwise operation is performed.

getOutRaster

public Object getOutRaster()

Returns the Output raster parameter of this tool . This parameter is the output raster. the cell values are the result of a Bitwise Not operation on the input. 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. the cell values are the result of a Bitwise Not operation on the input. This is a required parameter.

Parameters:

outRaster - the output raster. the cell values are the result of a Bitwise Not operation on the input.

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