Boolean Not (Spatial Analyst)

Available with Spatial Analyst license.

Available with Image Analyst license.

Summary

Performs a Boolean Not (complement) operation on the cell values of the input raster.

If the input values are true (non-zero), the output value is 0. If the input values are false (zero), the output is 1.

Learn more about how the Boolean math tools work

Illustration

OutRas = BooleanNot(InRas1)

Usage

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

• Only a single input is necessary for this Boolean evaluation to take place.

• 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 the input is a multiband raster, the output will be a multiband raster. The tool will perform the operation on each band in the input.

• In ArcPy, if the input is a multidimensional raster, all slices from all variables will be processed, 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	The input to use in this Boolean operation. To use a number as an input for this parameter, 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

BooleanNot(in_raster_or_constant)

Name	Explanation	Data Type
in_raster_or_constant	The input to use in this Boolean operation. To use a number as an input for this parameter, 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

BooleanNot example 1 (Python window)

This example performs a Boolean Not (complement) operation on a Grid raster and outputs the result as a TIFF raster.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outBooleanNot = BooleanNot("degs")
outBooleanNot.save("C:/sapyexamples/output/outboolnot.tif")

BooleanNot example 2 (stand-alone script)

This example performs a Boolean Not (complement) operation on a Grid raster.

# Name: BooleanNot_Ex_02.py
# Description: Performs a Boolean complement (NOT) operation on the
#              cell values of an input raster
# 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
inRaster = "degs"

# Execute BooleanNot
outBooleanNot = BooleanNot(inRaster)

# Save the output 
outBooleanNot.save("C:/sapyexamples/output/outboolnot")

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