Block Statistics (Spatial Analyst)

License Level:BasicStandardAdvanced

Summary

Partitions the input into non-overlapping blocks and calculates the statistic of the values within each block. The value is assigned to all of the cells in each block in the output.

Learn more about how Block Statistics works

Illustration

Block Statistics with Maximum option illustration
OutRas = BlockStatistics(InRas1, NbrRectangle(3,3,MAP), "MAXIMUM", "")

Usage

Syntax

BlockStatistics (in_raster, {neighborhood}, {statistics_type}, {ignore_nodata})
ParameterExplanationData Type
in_raster

The raster on which to perform the Block Statistics calculations.

Raster Layer
neighborhood
(Optional)

The Neighborhood class dictates the shape of the area around each cell used to calculate the statistic.

The different types of neighborhood available are NbrAnnulus, NbrCircle, NbrRectangle, NbrWedge, NbrIrregular, and NbrWeight.

The following are the forms of the neighborhoods:

  • NbrAnnulus({innerRadius}, {outerRadius}, {CELL | MAP})
  • NbrCircle({radius}, {CELL | MAP}
  • NbrRectangle({width}, {height}, {CELL | MAP})
  • NbrWedge({radius}, {start_angle}, {end_angle}, {CELL | MAP})
  • NbrIrregular(kernel_file)
  • NbrWeight(kernel_file)

The {CELL | MAP} parameter defines the distance units as either being Cell units or Map units.

The default neighborhood is a square NbrRectangle with a width and height of 3 cells.

Neighborhood
statistics_type
(Optional)

The statistic type to be calculated.

  • MEAN Calculates the mean (average value) of the cells in the neighborhood.
  • MAJORITY Calculates the majority (value that occurs most often) of the cells in the neighborhood.
  • MAXIMUM Calculates the maximum (largest value) of the cells in the neighborhood.
  • MEDIAN Calculates the median of the cells in the neighborhood.
  • MINIMUM Calculates the minimum (smallest value) of the cells in the neighborhood.
  • MINORITY Calculates the minority (value that occurs least often) of the cells in the neighborhood.
  • RANGE Calculates the range (difference between largest and smallest value) of the cells in the neighborhood.
  • STD Calculates the standard deviation of the cells in the neighborhood.
  • SUM Calculates the sum (total of all values) of the cells in the neighborhood.
  • VARIETY Calculates the variety (the number of unique values) of the cells in the neighborhood.

The default statistic type is MEAN.

String
ignore_nodata
(Optional)

Denotes whether NoData values are ignored by the statistic calculation.

  • DATA Specifies that if a NoData value exists within a block neighborhood, the NoData value will be ignored. Only cells within the neighborhood that have data values will be used in determining the output value. This is the default.
  • NODATA Specifies that if any cell in a neighborhood has a value of NoData, the output for each cell in the corresponding block will receive NoData. With this option, the presence of a NoData value implies that there is insufficient information to determine the statistic value for the neighborhood.
Boolean

Return Value

NameExplanationData Type
out_raster

The output block statistics raster.

Raster

Code Sample

BlockStatistics example 1 (Python window)

This sample calculates the minimum cell value within each non-overlapping annulus (doughnut-shaped) neighborhood in the input GRID raster.

import arcpy
from arcpy import env  
from arcpy.sa import *
env.workspace = "C:/sapyexamples/data"
nbr = NbrAnnulus(1, 3, "MAP")
outBlockStat = BlockStatistics("block", nbr, "MINIMUM", "")
outBlockStat.save("C:/sapyexamples/output/blockstat")
BlockStatistics example 2 (stand-alone script)

This sample calculates the minimum cell value within each non-overlapping annulus (doughnut-shaped) neighborhood in the input GRID raster.

# Name: BlockStatistics_Ex_02.py
# Description: Calculates statistics for a nonoverlapping 
#              neighborhood.
# Requirements: Spatial Analyst Extension

# Import system modules
import arcpy
from arcpy import env
from arcpy.sa import *

# Set environment settings
env.workspace = "C:/sapyexamples/data"

# Set local variables
inRaster = "block"
nbr = NbrAnnulus(1, 3, "MAP")

# Check out the ArcGIS Spatial Analyst extension license
arcpy.CheckOutExtension("Spatial")

# Execute BlockStatistics
outBlockStat = BlockStatistics(inRaster, nbr, "MINIMUM", "NODATA")

# Save the output 
outBlockStat.save("C:/sapyexamples/output/blockstat")

Environments

Related Topics

Licensing Information

ArcGIS for Desktop Basic: Requires Spatial Analyst
ArcGIS for Desktop Standard: Requires Spatial Analyst
ArcGIS for Desktop Advanced: Requires Spatial Analyst
11/8/2012