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

java.lang.Object
  extended by com.esri.arcgis.geoprocessing.AbstractGPTool
      extended by com.esri.arcgis.geoprocessing.tools.spatialanalysttools.BitwiseRightShift
All Implemented Interfaces:
GPTool

public class BitwiseRightShift
extends AbstractGPTool

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

Software restrictions: none

Illustration:

Usage tips:


Field Summary
 
Fields inherited from class com.esri.arcgis.geoprocessing.AbstractGPTool
vals
 
Constructor Summary
BitwiseRightShift()
          Creates the Bitwise Right Shift tool with defaults.
BitwiseRightShift(Object inRasterOrConstant1, Object inRasterOrConstant2, Object outRaster)
          Creates the Bitwise Right Shift tool with the required parameters.
 
Method Summary
 Object getInRasterOrConstant1()
          Returns the Input raster or constant value 1 parameter of this tool .
 Object getInRasterOrConstant2()
          Returns the Input raster or constant value 2 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 setInRasterOrConstant1(Object inRasterOrConstant1)
          Sets the Input raster or constant value 1 parameter of this tool .
 void setInRasterOrConstant2(Object inRasterOrConstant2)
          Sets the Input raster or constant value 2 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

BitwiseRightShift

public BitwiseRightShift()
Creates the Bitwise Right Shift tool with defaults.

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


BitwiseRightShift

public BitwiseRightShift(Object inRasterOrConstant1,
                         Object inRasterOrConstant2,
                         Object outRaster)
Creates the Bitwise Right Shift 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 input can be integer or floating-point, but floating point values will be converted to integer before the bitwise operation is performed.
inRasterOrConstant2 - Composite Geodataset, the input can be integer or floating-point, but floating point values will be converted to integer before the bitwise operation is performed.
outRaster - Raster Dataset, the output raster.
Method Detail

getInRasterOrConstant1

public Object getInRasterOrConstant1()
Returns the Input raster or constant value 1 parameter of this tool . This parameter is Composite Geodataset, the input can be integer or floating-point, but floating point values will be converted to integer before the bitwise operation is performed. This is a required parameter.

Returns:
the Input raster or constant value 1

setInRasterOrConstant1

public void setInRasterOrConstant1(Object inRasterOrConstant1)
Sets the Input raster or constant value 1 parameter of this tool . This parameter is Composite Geodataset, the input can be integer or floating-point, but floating point values will be converted to integer before the bitwise operation is performed. This is a required parameter.

Parameters:
inRasterOrConstant1 - Composite Geodataset, the input can be integer or floating-point, but floating point values will be converted to integer before the bitwise operation is performed.

getInRasterOrConstant2

public Object getInRasterOrConstant2()
Returns the Input raster or constant value 2 parameter of this tool . This parameter is Composite Geodataset, the input can be integer or floating-point, but floating point values will be converted to integer before the bitwise operation is performed. This is a required parameter.

Returns:
the Input raster or constant value 2

setInRasterOrConstant2

public void setInRasterOrConstant2(Object inRasterOrConstant2)
Sets the Input raster or constant value 2 parameter of this tool . This parameter is Composite Geodataset, the input can be integer or floating-point, but floating point values will be converted to integer before the bitwise operation is performed. This is a required parameter.

Parameters:
inRasterOrConstant2 - Composite Geodataset, the input can be integer or floating-point, but floating point values will be converted to integer before the bitwise operation is performed.

getOutRaster

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