// (Integer Division) (arcpy.sa)

Summary

Performs an integer divide on the values of two rasters on a cell-by-cell basis.

Illustration

Divide illustration
OutRas = Raster("InRas1") // Raster("InRas2")

Discussion

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

When multiple operators are used in an expression, they are not necessarily executed in left-to-right order. The operator with the highest precedence value will be executed first. For more information on operator precedence, see operator precedence table. You can use parentheses to control the execution order.

The order of input is relevant for this operator.

When a number is divided by zero, the output result is NoData.

If both inputs are integers, the output contains integer values. For example, if 5 is divided by 2, the output will be 2 (the remainder is discarded).

If either input is of floating-point type, the output quotient will be floating-point. For example, if 5.3 is divided by 2, the output is 2.0 (the remainder of 0.65 is discarded).

Another way to perform the integer divide operation is a //= b, which is an alternative way to write a = a // b.

Syntax

in_raster_or_constant1 // in_raster_or_constant2
OperandExplanationData Type
in_raster_or_constant1

The input whose values will be divided by the second input.

If the first input is a raster and the second is a scalar, an output raster is created with each input raster value being divided by the scalar value.

Raster Layer | Constant
in_raster_or_constant2

The input whose values the first input are to be divided by.

If the first input is a scalar and the second is a raster, an output raster is created with each input raster value being divided into the scalar value.

Raster Layer | Constant

Return Value

NameExplanationData Type
out_raster

The output raster object.

The cell values are the quotient of the first input raster (dividend) divided by the second input (divisor).

Raster

Code Sample

// (Integer Division) example 1 (Python window)

This sample divides the values of the first input raster by the second.

import arcpy
from arcpy import env
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
outDivide = Raster("degs") // Raster("negs")
outDivide.save("C:/sapyexamples/output/outdivide")
// (Integer Division) example 2 (stand-alone script)

This sample divides the values of the first input raster by the second.

# Name: Op_IntegerDivide_Ex_02.py
# Description: Divides the values of two rasters on a cell-by-cell basis
# 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
inRaster01 = Raster("elevation")
inRaster02 = Raster("landuse")

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

# Execute Integer Divide
outDivide = inRaster01 // inRaster02

# Save the output 
outDivide.save("C:/sapyexamples/output/outdivide2")

Environments

Related Topics

3/7/2014