Boolean Not (Spatial Analyst)
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.
Illustration
 |
OutRas = BooleanNot(InRas1) |
Usage
The Boolean math tools interpret the inputs as Boolean values, where non-zero 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 be an integer 1. For example, input float values of 0.6, 32.22 and -4.2 will all be treated as being 1. The output values are always integer.
-
In Map Algebra, the equivalent operator symbol for this tool is "~" (link).
Syntax
| Parameter | Explanation | Data Type |
in_raster_or_constant |
The input to use in this Boolean operation. In order 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 values will be either 0 or 1. | Raster |
Code Sample
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")
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"
# Check out the ArcGIS Spatial Analyst extension license
arcpy.CheckOutExtension("Spatial")
# Execute BooleanNot
outBooleanNot = BooleanNot(inRaster)
# Save the output
outBooleanNot.save("C:/sapyexamples/output/outboolnot")