Bitwise Or (Spatial Analyst)

Summary

Performs a Bitwise Or operation on the binary values of two input rasters.

Learn more about how Bitwise Math tools work

Illustration

OutRas = BitwiseOr(InRas1, InRas2)

Usage

• Two inputs are necessary for this bitwise operation to take place.

• The order of inputs is irrelevant for this tool.

• If an input is floating-point, the values are converted to integer values through truncation before the bitwise operation is performed.

• 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 (positive or negative) of the value. If the integer is positive, the bit position is 0; if it's negative, the bit position is 1.

• The Bitwise Or 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.

Syntax

BitwiseOr (in_raster_or_constant1, in_raster_or_constant2)

Parameter	Explanation	Data Type
in_raster_or_constant1	The first input to use in this bitwise operation. A number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.	Raster Layer | Constant
in_raster_or_constant2	The second input to use in this bitwise operation. A number can be used as an input for this parameter, provided a raster is specified for the other parameter. To be able to specify a number for both inputs, the cell size and extent must first be set in the environment.	Raster Layer | Constant

Return Value

Name	Explanation	Data Type
out_raster	The output raster. The cell values are the result of a Bitwise Or operation on the two inputs.	Raster

Code Sample

BitwiseOr example 1 (Python window)

This example performs a Bitwise Or operation on two GRID rasters.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outBitwiseOr = BitwiseOr("degs", "negs")
outBitwiseOr.save("C:/sapyexamples/output/outbitor")

BitwiseOr example 2 (stand-alone script)

This example performs a Bitwise Or operation on two GRID rasters and outputs the result as a TIFF.

# Name: BitwiseOr_Ex_02.py
# Description: Performs a Bitwise Or operation on the binary values
#              of two input rasters
# Requirements: Spatial Analyst Extension
# Author: ESRI

# Import system modules
import arcpy
from arcpy import env
from arcpy.sa import *

# Set environment settings
env.workspace = "C:/sapyexamples/data"

# Set local variables
inRaster1 = "degs"
inRaster2 = "negs"

# Check out the ArcGIS Spatial Analyst extension license
arcpy.CheckOutExtension("Spatial")

# Execute BitwiseOr
outBitwiseOr = BitwiseOr(inRaster1, inRaster2)

# Save the output 
outBitwiseOr.save("C:/sapyexamples/output/outbitwiseor.tif")

Environments

Cell Size, Current Workspace, Mask, Output Coordinate System, Extent, Scratch Workspace, Snap Raster

Licensing Information

ArcView: Requires Spatial Analyst

ArcEditor: Requires Spatial Analyst

ArcInfo: Requires Spatial Analyst