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

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

All Implemented Interfaces:

GPTool

public class BitwiseXOr

extends AbstractGPTool

Performs a Bitwise Exclusive Or operation on the binary values of two input rasters. The Bitwise XOr tool is contained in the Spatial Analyst Tools tool box.
Learn more about how Bitwise XOr works

Software restrictions: none

Illustration:

Usage tips:

• The bitwise operators work on 32-bit integers.
• If floating-point values are input, they are converted to integer values through truncation before the bitwise operation is performed. The output values are always integer.
• Two inputs (rasters or numbers) are necessary for the bitwise operation to take place.
• The order of input is irrelevant in the Bitwise XOr expression.
• Binary values are stored in two's complement.
• The leftmost bit position is reserved for the sign of the value (positive or negative). If the integer is positive, the bit position is zero; if it's negative, the bit position is one.
• The Bitwise XOr operation treats the sign bit as it would any other bit. If one or both inputs for a cell location are negative, the output is negative; if both inputs are positive, the output is positive.
• The bitwise operators are useful for setting flags of on or off status. They can also be used in conjunction with other geoprocessing tools that evaluate the binary representation of a value, such as Focal Flow.
• A number can be used as input to the tool; however, the cell size and extent must first be set in the environment.

Field Summary

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

vals

Constructor Summary

BitwiseXOr()
Creates the Bitwise XOr tool with defaults.

BitwiseXOr(java.lang.Object inRasterOrConstant1, java.lang.Object inRasterOrConstant2, java.lang.Object outRaster)
Creates the Bitwise XOr tool with the required parameters.

Method Summary

java.lang.Object	getInRasterOrConstant1() Returns the Input raster or constant value 1 parameter of this tool .
java.lang.Object	getInRasterOrConstant2() Returns the Input raster or constant value 2 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.
void	setInRasterOrConstant1(java.lang.Object inRasterOrConstant1) Sets the Input raster or constant value 1 parameter of this tool .
void	setInRasterOrConstant2(java.lang.Object inRasterOrConstant2) Sets the Input raster or constant value 2 parameter of this tool .
void	setOutRaster(java.lang.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

BitwiseXOr

public BitwiseXOr()

Creates the Bitwise XOr tool with defaults.

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

BitwiseXOr

public BitwiseXOr(java.lang.Object inRasterOrConstant1,
                  java.lang.Object inRasterOrConstant2,
                  java.lang.Object outRaster)

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

inRasterOrConstant1 - Composite Geodataset, the first input integer or floating-point raster.

inRasterOrConstant2 - Composite Geodataset, the second input integer or floating-point raster.

outRaster - Raster Dataset, the output raster.

Method Detail

getInRasterOrConstant1

public java.lang.Object getInRasterOrConstant1()

Returns the Input raster or constant value 1 parameter of this tool . This parameter is Composite Geodataset, the first input integer or floating-point raster. This is a required parameter.

Returns:

the Input raster or constant value 1

setInRasterOrConstant1

public void setInRasterOrConstant1(java.lang.Object inRasterOrConstant1)

Sets the Input raster or constant value 1 parameter of this tool . This parameter is Composite Geodataset, the first input integer or floating-point raster. This is a required parameter.

Parameters:

inRasterOrConstant1 - Composite Geodataset, the first input integer or floating-point raster.

getInRasterOrConstant2

public java.lang.Object getInRasterOrConstant2()

Returns the Input raster or constant value 2 parameter of this tool . This parameter is Composite Geodataset, the second input integer or floating-point raster. This is a required parameter.

Returns:

the Input raster or constant value 2

setInRasterOrConstant2

public void setInRasterOrConstant2(java.lang.Object inRasterOrConstant2)

Sets the Input raster or constant value 2 parameter of this tool . This parameter is Composite Geodataset, the second input integer or floating-point raster. This is a required parameter.

Parameters:

inRasterOrConstant2 - Composite Geodataset, the second input integer or floating-point raster.

getOutRaster

public java.lang.Object getOutRaster()

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

Parameters:

outRaster - Raster Dataset, the output raster.

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