Skip To Content

|

Available with Spatial Analyst license.

Available with Image Analyst license.

Summary

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

Illustration

Boolean Or illustration
OutRas = Raster("InRas1") | Raster("InRas2")

Discussion

The | operator will perform a Boolean Or operation when one or more input (operand) is a raster. If both inputs (operands) are numbers then the | operator will perform a Bitwise Or operation. For more information on how to work with operators, refer to Working with operators.

When multiple operators are used in an expression, they are not necessarily executed in left-to-right order. The operator with the highest precedence value will be executed first. For more information on operator precedence, see operator precedence table. You can use parentheses to control the execution order.

Boolean (~, &, ^, |) operators have a higher precedence level than Relational (<, <=, >, >=, ==, !=) operators. Therefore, when Boolean operators are used in the same expression as Relational operators, the Boolean operators will be executed first. To change the order of execution, use parentheses.

When multiple Relational and/or Boolean operators are used consecutively in a single expression, in some cases it may fail to execute. To avoid this potential problem, use appropriate parentheses in the expression so that the execution order of the operators is explicitly defined. For more information, see Complex Statement Rules.

Two inputs are necessary for the Boolean evaluation to take place.

The order of input is irrelevant for this operator.

If the input values are floating point, they are converted to integer values by truncation before the Boolean operation is performed. The output values are always integer.

Another way to perform the Boolean Or operation is a |= b which is an alternative way to write a = a | b.

Syntax

in_raster_or_constant1 | in_raster_or_constant2
OperandExplanationData Type
in_raster_or_constant1

The first input to use in the Boolean Or operation.

If one of the inputs is a raster and the other is a scalar, an output raster is created with the evaluation being performed for each cell in the input raster.

Raster Layer | Constant
in_raster_or_constant2

The second input to use in the Boolean Or operation.

If one of the inputs is a raster and the other is a scalar, an output raster is created with the evaluation being performed for each cell in the input raster.

Raster Layer | Constant

Return Value

NameExplanationData Type
out_raster

The output raster object.

The output values will be either 0 or 1.

Raster

Code sample

| (Boolean Or) example 1 (Python window)

This sample performs a Boolean Or operation on two input rasters.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outBooleanOr = Raster("degs") | Raster("negs")
outBooleanOr.save("C:/sapyexamples/output/outboolor2")
| (Boolean Or) example 2 (stand-alone script)

This sample performs a Boolean Or operation on two input rasters.

# Name: Op_BooleanOr_Ex_02.py
# Description: Performs a Boolean 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 = Raster("degs")
inRaster2 = Raster("negs")

# Execute BooleanOr
outBooleanOr = inRaster1 | inRaster2

# Save the output 
outBooleanOr.save("C:/sapyexamples/output/outboolor")

Related topics