Sum

Synthèse

Creates a raster object in which each pixel contains the sum of values across multiple rasters.

Discussion

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

Syntaxe

Sum (rasters, {extent_type}, {cellsize_type}, {ignore_nodata}, {process_as_multiband})
ParamètreExplicationType de données
rasters
[rasters,...]

The list of input rasters.

Raster
extent_type

The method that will be used to compute the extent of the output when the input rasters have different extents.

  • FirstOfThe output extent will be defined using the extent of the first input raster.
  • LastOfThe output extent will be defined using the extent of the last input raster.
  • IntersectionOfThe output extent will be defined as the intersecting area of the input rasters.
  • UnionOfThe output extent will be defined as the total extent of the input rasters.

(La valeur par défaut est FirstOf)

String
cellsize_type

The method that will be used to compute the pixel size of the output when the input rasters have different pixel sizes.

  • FirstOfThe output pixel size will be defined using the pixel size of the first input raster.
  • LastOfThe output pixel size will be defined using the pixel size of the last input raster.
  • MaxOfThe output pixel size will be defined using the maximum pixel size of the input rasters.
  • MeanOfThe output pixel size will be defined using the mean of both input rasters.
  • MinOfThe output pixel size will be defined using the minimum pixel size of the input rasters.

(La valeur par défaut est FirstOf)

String
ignore_nodata

Specifies whether NoData values will be ignored in the calculation.

  • True—The analysis will include all valid pixels in the input rasters and ignore any NoData pixels.
  • False—The analysis will result in NoData if there are any NoData values for the pixels in the input rasters.

(La valeur par défaut est False)

Boolean
process_as_multiband

Specifies how the bands of the input rasters will be processed.

  • True—Each multiband raster will be processed as a multiband raster. The operation will be performed for each band from one input using the corresponding band number from other inputs.
  • False—Each band from a multiband raster input will be processed separately as a single-band raster.

(La valeur par défaut est False)

Boolean
Valeur renvoyée
Type de donnéesExplication
Raster

The output raster.

Exemple de code

Sum example

Calculates the sum of values across three multiband rasters.

from arcpy.ia import * 

rc = RasterCollection([landsat_1, landsat_2, landsat_3]) 

range_raster = Sum(rc, extent_type = "UnionOf", cellsize_type = "MinOf", 
	ignore_nodata = True, process_as_multiband = True)