Boolean Not (Image 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

Boolean Not 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.

  • If the input is multidimensional raster data, all slices from all variables will be processed. The output will be a multidimensional raster in CRF format.

  • In map algebra, the equivalent operator symbol for this tool is "~" (link).

Parameters

LabelExplanationData 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

LabelExplanationData Type
Output raster

The output raster.

The output cell values will be either 0 or 1.

Raster

BooleanNot(in_raster_or_constant)
NameExplanationData 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

NameExplanationData 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.ia import *
env.workspace = "C:/iapyexamples/data"
outBooleanNot = BooleanNot("degs")
outBooleanNot.save("C:/iapyexamples/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
#              pixel values of an input raster
# 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
inRaster = "degs"

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

# Execute BooleanNot
outBooleanNot = BooleanNot(inRaster)

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

Licensing information

  • Basic: Requires Image Analyst or Spatial Analyst
  • Standard: Requires Image Analyst or Spatial Analyst
  • Advanced: Requires Image Analyst or Spatial Analyst

Related topics