BandArithmetic

Summary

Performs an arithmetic operation on the bands of a multiband raster object and returns a raster object with the operation applied.

Discussion

For more information about the methods and band orders used with this function, see the Band Arithmetic raster function.

The referenced raster dataset for the raster object is temporary. To make it permanent, you can call the raster object's save method.

Syntax

BandArithmetic (raster, band_ids, {method})
ParameterExplanationData Type
raster

The input raster.

Raster
band_ids

The band IDs to use in the arithmetic operation, separated by a space. Band IDs are indexed using one-based indexing, so that the first band in a list of bands in a multiband raster object has an index of 1.

The bands should be provided in the order that is required by the arithmetic method. For information about the order of bands needed for each method, see Band Arithmetic.

String
method

The arithmetic operation to apply to the bands.

A custom operation can also be defined.

  • 1 NDVI
  • 2SAVI
  • 3 TSAVI
  • 4MSAVI
  • 5GEMI
  • 6PVI
  • 7GVITM
  • 8Sultan
  • 9VARI
  • 10GNDVI
  • 11SR
  • 12NDVIre
  • 13SRre
  • 14MTVI2
  • 15RTVICore
  • 16CIre
  • 17CIg
  • 18NDWI
  • 19EVI
  • 20Iron oxide
  • 21Ferrous minerals
  • 22Clay minerals
  • 23WNDWI

(The default value is 1)

Integer
Return Value
Data TypeExplanation
Raster

The output raster object with the band arithmetic applied.

Code sample

BandArithmetic example 1

Calculates the Simple Ratio (SR) for a Landsat 8 image.

import arcpy

SimpleRatio = arcpy.sa.BandArithmetic("Landsat8.tif","5 4", 11)
BandArithmetic example 2

Calculates a custom operator for a Landsat 8 image.

import arcpy

BandAddition_raster = arcpy.sa.BandArithmetic("Landsat8.tif","B2+B3", 0)

Related topics