Boolean XOr (Spatial Analyst)

Available with Spatial Analyst license.

Available with Image Analyst license.

Summary

Performs a Boolean eXclusive Or operation on the cell values of two input rasters.

If one input value is true (non-zero) and the other false (zero), the output is 1. If both input values are true or both are false, the output is 0.

Learn more about how the Boolean math tools work

Illustration

OutRas = BooleanXOr(InRas1, InRas2)

Usage

• The Boolean math tools interpret the inputs as Boolean values in which nonzero values are considered true and zero is considered false.

• Two inputs are necessary for this Boolean evaluation to take place.

• The order of inputs is irrelevant for this tool.

• If the input values are floating point, they are converted to integer values of either 0 or 1 before the operation is performed. If the input value is a floating point 0.0, it is converted to an integer 0. If the input is any value other than 0.0, it is converted to an integer 1. For example, input float values of 0.6, 32.22 and -4.2 will all be treated as 1. The output values are always integer.

• If both inputs are single-band rasters or one of the inputs is a constant, the output will be a single-band raster.

• If both inputs are multiband rasters, the tool will perform the operation on each band from one input, and the output will be a multiband raster. The number of bands in each multiband input must be the same.

• If one of the inputs is a multiband raster and the other input is a constant, the tool will perform the operation using the constant value for each band in the multiband input, and the output will be a multiband raster.

• If both inputs are multidimensional raster data with the same number of variables, the tool will perform the operation for all slices with the same dimension value. The output will be a multidimensional raster in CRF format. The variables in the inputs must have at least one common dimension and one common dimensional value for this tool to process; otherwise, an error will occur.

  If both inputs have one variable but different names, uncheck the Match Multidimensional Variable geoprocessing environment (set arcpy.env.matchMultidimensionalVariable = False in Python) before running the tool.

  If one of the inputs is a multidimensional raster and the other input is a constant, the tool will perform the operation for all slices for all variables using the constant value, and the output will be a multidimensional raster.

• In Map Algebra, the equivalent operator symbol for this tool is "^" (link).

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

Parameters

Dialog

Label	Explanation	Data Type
Input raster or constant value 1	The first input to use in this Boolean operation. A number can be used as an input for this parameter, provided a raster is specified for the other parameter. To specify a number for both inputs, the cell size and extent must first be set in the environment.	Raster Layer; Constant
Input raster or constant value 2	The second input to use in this Boolean operation. A number can be used as an input for this parameter, provided a raster is specified for the other parameter. To specify a number for both inputs, the cell size and extent must first be set in the environment.	Raster Layer; Constant

Return Value

Label	Explanation	Data Type
Output raster	The output raster. The output cell values will be either 0 or 1.	Raster

Python

BooleanXOr(in_raster_or_constant1, in_raster_or_constant2)

Name	Explanation	Data Type
in_raster_or_constant1	The first input to use in this Boolean operation. A number can be used as an input for this parameter, provided a raster is specified for the other parameter. 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 Boolean operation. A number can be used as an input for this parameter, provided a raster is specified for the other parameter. 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 output cell values will be either 0 or 1.	Raster

Code sample

BooleanXOr example 1 (Python window)

This example performs a Boolean XOr operation on two Grid rasters and outputs a TIFF raster.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outBooleanXOr = BooleanXOr("degs", "negs")
outBooleanXOr.save("C:/sapyexamples/output/outboolxor.tif")

BooleanXOr example 2 (stand-alone script)

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

# Name: BooleanXOr_Ex_02.py
# Description: Performs a Boolean Exclusive Or operation on the
#              cell 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 BooleanXOr
outBooleanXOr = BooleanXOr(inRaster1, inRaster2)

# Save the output 
outBooleanXOr.save("C:/sapyexamples/output/outboolxor")

Environments

Auto Commit, Cell Size, Cell Size Projection Method, Compression, Current Workspace, Extent, Geographic Transformations, Mask, Output CONFIG Keyword, Output Coordinate System, Scratch Workspace, Snap Raster, Tile Size

Licensing information

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