Calculate Statistics (Data Management)

License Level:BasicStandardAdvanced

Summary

Calculates statistics for a raster dataset or mosaic dataset.

Statistics are required for your raster and mosaic datasets to perform certain tasks, such as applying a contrast stretch or classifying your data.

Usage

Syntax

CalculateStatistics_management (in_raster_dataset, {x_skip_factor}, {y_skip_factor}, {ignore_values}, {skip_existing}, {area_of_interest})
ParameterExplanationData Type
in_raster_dataset

The input raster dataset or mosaic dataset.

Mosaic Dataset; Mosaic Layer; Raster Dataset
x_skip_factor
(Optional)

The number of horizontal pixels between samples.

The value must be greater than zero and less than or equal to the number of columns in the raster dataset. The default is 1 or the last skip factor used.

The skip factors for raster datasets stored in a file geodatabase or an ArcSDE geodatabase are different. First, if the x and y skip factors are different, the smaller skip factor will be used for both the x and y skip factors. Second, the skip factor is related to the pyramid level that most closely fits the skip factor chosen. If the skip factor value is not equal to the number of pixels in a pyramid layer, the number is rounded down to the next pyramid level, and those statistics are used.

Long
y_skip_factor
(Optional)

The number of vertical pixels between samples.

The value must be greater than zero and less than or equal to the number of rows in the raster. The default is 1 or the last y skip factor used.

The skip factors for raster datasets stored in a file geodatabase or an ArcSDE geodatabase are different. First, if the x and y skip factors are different, the smaller skip factor will be used for both the x and y skip factors. Second, the skip factor is related to the pyramid level that most closely fits the skip factor chosen. If the skip factor value is not equal to the number of pixels in a pyramid layer, the number is rounded down to the next pyramid level, and those statistics are used.

Long
ignore_values
[ignore_value,...]
(Optional)

The pixel values that are not to be included in the statistics calculation.

The default is no value, or the last ignore values used.

Long
skip_existing
(Optional)

Specify whether to calculate statistics only where they are missing or regenerate them even if they exist.

  • OVERWRITEStatistics will be calculated even if they already exist; therefore, existing statistics will be overwritten. This is the default.
  • SKIP_EXISTINGStatistics will only be calculated if they do not already exist.
Boolean
area_of_interest
(Optional)

Specify a feature class that represents area in the dataset from where you want the statistics to be calculated, so they are not generated from the entire dataset.

Feature Set

Code Sample

CalculateStatistics example 1 (Python window)

This is a Python sample for CalculateStatistics.

import arcpy
arcpy.CalculateStatistics_management(
     "C:/data/image.tif", "5", "5", "0;255", 
     "SKIP_EXISTING", "c:/data/aoi.shp")
CalculateStatistics example 2 (stand-alone window)

This is a Python script sample for CalculateStatistics.

# Calculate Statistics for single raster dataset

import arcpy
arcpy.env.workspace = "C:/Workspace"
    
arcpy.CalculateStatistics_management("image.tif", "4", "6", "0;255;21")

Environments

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Yes
ArcGIS for Desktop Standard: Yes
ArcGIS for Desktop Advanced: Yes
11/18/2013