ArgStatistics

Summary

Creates a raster object where each pixel contains the band index at which that pixel reached the statistical argument. If the input raster is multidimensional, the output raster object will contain dimension values instead of band indices.

Discussion

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

ArgStatistics (rasters, {stat_type}, {min_value}, {max_value}, {multiple_occurrence_value}, {ignore_nodata})
ParameterExplanationData Type
rasters
[rasters,...]

The input raster or list of rasters.

Raster
stat_type

Specifies the statistical argument to extract.

  • MAX The band index or dimension value at which the maximum pixel value is reached will be extracted.
  • MIN The band index or dimension value at which the minimum pixel value is reached will be extracted.
  • MEDIAN The band index or dimension value at which the median pixel value is reached will be extracted.
  • DURATION The longest dimension duration for which the pixel values fall between the minimum and maximum values.

(The default value is None)

String
min_value

The minimum pixel value to be used to extract the duration. This argument is required when the stat_type argument is set to DURATION.

(The default value is None)

Double
max_value

The maximum pixel value to be used to extract the duration. This argument is required when the stat_type argument is set to DURATION.

(The default value is None)

Double
multiple_occurrence_value

The pixel value to use to indicate that a given argument statistic was reached more than once in the input raster dataset. This argument is required when the stat_type argument is set to MIN or MAX.

(The default value is 100)

Integer
ignore_nodata

Specifies whether to ignore NoData values 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.

(The default value is True)

Boolean
Return Value
Data TypeExplanation
Raster

The output raster.

Code sample

ArgStatistics example

Extracts the dimension value at which the maximum temperature was reached for the input multidimensional raster.

import arcpy

argstat_raster = arcpy.sa.ArgStatistics("Temperature_30_years.crf", "MAX","","", 9999)

Related topics