ExtractBand

Summary

Creates a raster object by extracting one or more bands from, or reordering the bands in, a multiband raster.

Discussion

For more information about how this function works, see the Extract Bands 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

ExtractBand (raster, {band_ids}, {band_names}, {band_wavelengths}, {missing_band_action}, {wavelength_match_tolerance})
ParameterExplanationData Type
raster

The input raster.

Raster
band_ids
[band_ids,...]

Extracts bands using the band ID.

(The default value is None)

Integer
band_names
[band_names,...]

Extracts bands using the name of the bands.

(The default value is None)

String
band_wavelengths
[band_wavelengths,...]

Extracts bands using the band wavelengths.

(The default value is None)

Double
missing_band_action

Specifies the action that will occur when a band within the extract band list is not available.

  • BestMatchThis option will try to find the best available band to use in place of the missing one, so that the function will not fail.
  • FailAny mosaic dataset item that is missing a specified band will fail, since the extract band was invalid.

(The default value is BestMatch)

Integer
wavelength_match_tolerance

Specifies the margin of error when extracting bands using the band_wavelengths method.

(The default value is None)

Double
Return Value
Data TypeExplanation
Raster

The output raster.

Code sample

ExtractBand example 1

Extracts bands from the input raster using the band_ids method.

import arcpy

out_bands_raster = arcpy.sa.ExtractBand("in_raster.tif", [1, 2])
ExtractBand example 2

Extracts bands from the input raster using the band_wavelengths method.

import arcpy

out_bands_raster = arcpy.sa.ExtractBand("in_raster.tif", band_wavelengths=[500.00])