| Operand | Explanation | Data 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 |
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
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, see the operator precedence table in Work with operators in Map Algebra. 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 section of Build complex statements.
Two inputs are necessary for the Boolean evaluation to take place.
The order of the 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.
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 operator 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 operator will perform the operation against the constant value for each band in the multiband input, and the output will be a multiband raster.
If both inputs are multidimensional rasters with same number of variables, the operator will perform the operation for all slices with same dimension value, and the output will be a multidimensional raster. The variables in the inputs must have same dimensions or common dimension but no uncommon dimensions.
If both inputs have one variable but different names, set the matchMultidimensionalVariable geoprocessing environment to False to perform the operation.
If one of the inputs is a multidimensional raster and the other input is a constant, the operator will perform the operation for all slices for all variables against the constant value, and the output will be a multidimensional raster.
Parameters
Code sample
This sample performs a Boolean Or operation on two input rasters.
import arcpy
from arcpy import env
from arcpy.ia import *
env.workspace = "C:/iapyexamples/data"
outBooleanOr = Raster("degs") | Raster("negs")
outBooleanOr.save("C:/iapyexamples/output/outboolor2")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: Image Analyst Extension
# Import system modules
import arcpy
from arcpy import env
from arcpy.ia import *
# Set environment settings
env.workspace = "C:/iapyexamples/data"
# Set local variables
inRaster1 = Raster("degs")
inRaster2 = Raster("negs")
# Execute BooleanOr
outBooleanOr = inRaster1 | inRaster2
# Save the output
outBooleanOr.save("C:/iapyexamples/output/outboolor")