Skip To Content

Bitwise XOr

Available with Spatial Analyst license.

Available with Image Analyst license.

Summary

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

Learn more about how Bitwise Math tools work

Illustration

Bitwise XOr illustration
OutRas = BitwiseXOr(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 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.

  • See Analysis environments and Spatial Analyst for additional details on the geoprocessing environments that apply to this tool.

Syntax

BitwiseXOr (in_raster_or_constant1, in_raster_or_constant2)
ParameterExplanationData 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

NameExplanationData Type
out_raster

The output raster.

The cell values are the result of a Bitwise eXclusive Or operation on the two inputs.

Raster

Code sample

BitwiseXOr example 1 (Python window)

This example performs a Bitwise XOr operation on two Grid rasters.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outBitwiseXOr = BitwiseXOr("degs", "negs")
outBitwiseXOr.save("C:/sapyexamples/output/outbitxor")
BitwiseXOr example 2 (stand-alone script)

This example performs a Bitwise XOr operation on two Grid rasters and outputs the result as an IMG raster.

# Name: BitwiseXOr_Ex_02.py
# Description: Performs a Bitwise XOr operation on the binary values
#              of two input rasters
# Requirements: Spatial Analyst Extension

# 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"

# Execute BitwiseXOr
outBitwiseXOr = BitwiseXOr(inRaster1, inRaster2)

# Save the output 
outBitwiseXOr.save("C:/sapyexamples/output/outbitwisexor.img")

Licensing information

  • ArcGIS Desktop Basic: Requires Spatial Analyst or Image Analyst
  • ArcGIS Desktop Standard: Requires Spatial Analyst or Image Analyst
  • ArcGIS Desktop Advanced: Requires Spatial Analyst or Image Analyst

Related topics