== (Relational Equal To) operator

Summary

Performs a relational equal-to operation on two inputs on a cell-by-cell basis within the Analysis window.

Discussion

Returns 1 for cells where the first raster equals the second raster and 0 for cells where it does not.

When using an operator with a raster input, the result will be a raster. However, if all inputs are numbers, the result is a number.

When there are multiple operators in an expression, the operators are not necessarily run in left-to-right order. The operator with the highest precedence value will be run first. For more information, see the operator precedence table in Work with operators in map algebra. Use parentheses to control the run 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 run first. To change the order in which the operators are run, use parentheses.

When multiple Relational or Boolean operators are used consecutively in a single expression, the expression may fail to run in some cases. To avoid, use appropriate parentheses in the expression so that the run order of the operators is explicitly defined. For more information, see Complex statement rules.

Two inputs are necessary for the evaluation to take place.

The order of the input is irrelevant for this operator.

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 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 the same number of variables, the operator will perform the operation for all slices with the same dimension value, and the output will be a multidimensional raster. The variables in the inputs must have the same dimensions or a common dimension but no uncommon dimensions.

If both inputs have one variable but different names, set the Match Multidimensional Variable 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

 Operand Explanation Data Type in_raster_or_constant1 The input that will be compared to for equality by the second input.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 input that will be compared from for equality by the first input.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

Code sample

== (Equal To) example 1 (Python window)

This sample performs an Equal To operation on two input rasters.

``````import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outEqualTo = Raster("degs") == Raster("negs")
outEqualTo.save("C:/sapyexamples/output/outequalto.tif")``````
== (Equal To) example 2 (stand-alone script)

This sample performs an Equal To operation on two input rasters.

``````# Name: Op_EqualTo_Ex_02.py
# Description: Performs a relational equal-to operation on two inputs
#              on a cell-by-cell basis within the Analysis window
# 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 EqualTo
outEqualTo = inRaster1 == inRaster2

# Save the output
outEqualTo.save("C:/sapyexamples/output/outequalto")``````