Equal To (Spatial Analyst)

Summary

Performs a Relational equal-to operation on two inputs on a cell-by-cell basis.

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

Learn more about how the Relational Math tools work

Illustration

OutRas = EqualTo(InRas1, Const2Ras)

Usage

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

• The order of inputs is irrelevant for this tool.

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

Syntax

EqualTo (in_raster_or_constant1, in_raster_or_constant2)

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

Name	Explanation	Data Type
out_raster	The output raster. The output cell values will be either integer 0 or 1; or NoData if any input cell value is NoData.	Raster

Code Sample

EqualTo example 1 (Python window)

This example performs a Relational equal-to operation on two GRID rasters and outputs the result as a TIFF raster.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outEqualTo = EqualTo("degs", "negs")
outEqualTo.save("C:/sapyexamples/output/outequalto.tif")

EqualTo example 2 (stand-alone script)

This example performs a Relational equal-to operation on two GRID rasters.

# Name: 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 = "degs"
inRaster2 = "negs"

# Check out the ArcGIS Spatial Analyst extension license
arcpy.CheckOutExtension("Spatial")

# Execute EqualTo
outEqualTo = EqualTo(inRaster1, inRaster2)

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

Environments

Cell Size, Current Workspace, Mask, Output Coordinate System, Extent, Scratch Workspace, Snap Raster

Licensing Information

ArcGIS for Desktop Basic: Requires Spatial Analyst

ArcGIS for Desktop Standard: Requires Spatial Analyst

ArcGIS for Desktop Advanced: Requires Spatial Analyst