Summary
Calculates statistics on values of a raster within the zones of another dataset.
Illustration
Usage
A zone is defined as all areas in the input with the same value. The areas do not have to be contiguous. Both raster and feature can be used for the zone input.
This raster analysis portal tool is available when you are signed in to an ArcGIS Enterprise
portal that has an ArcGIS Image Server configured for Raster Analysis . When the tool is invoked, ArcGIS Pro serves as a client and the processing occurs in the servers federated with ArcGIS Enterprise. The portal tool accepts layers from your portal as input and creates output in your portal.The input raster layer supports a layer from the portal, a URI or URL to an image service, or the output from the Make Image Server Layer tool. The input feature layer can be a layer from the portal or a URI or URL to a feature service. This tool does not support local raster data or layers. While you can use local feature data and layers as input to this portal tool, best practice is to use layers from your portal as input.
If the Input Zone Layer (inputZoneLayer in Python) is a raster, it must be of integer data type.
If the zone input is a feature, it will be converted to a raster internally using the cell size and cell alignment from the value raster.
When the cell size of the Input Zone Layer (inputZoneLayer in Python) and the Input Raster Layer to Summarize (inputRasterLayertoSummarize in Python) are different, the output cell size will be the Maximum Of Inputs value, and the value raster will be used as the snap raster internally. If the cell size is the same but the cells are not aligned, the value raster will be used as the snap raster internally. Either of these cases will trigger an internal resampling before the zonal operation is performed.
When the zone and value inputs are both rasters of the same cell size and the cells are aligned, they will be used directly in the tool and will not be resampled internally during tool execution.
If a particular zone from the Input Zone Layer does not overlap any cell centers of the input value raster, the zone will become NoData. In this case, determine an appropriate raster resolution that will retain the detail of your zone input and use this resolution as the cell size in the environment. Specifying a smaller cell size will generate a larger output raster. The higher resolution output will not necessarily be as high quality a result as it seems, since the additional detail does not exist in the Input Raster Layer to Summarize input.
If the Input Zone Layer has overlapping polygons, the zonal analysis will not be performed for each individual polygon. Since the feature input is converted to a raster, each location can have only one value.
An alternative method is to process the zonal operation iteratively for each polygon zone and collate the results.
If the Input Zone Layer is a point feature, it is possible to have more than one point contained within any particular cell of the input value raster. For such cells, the zone value is determined by the point with the lowest ObjectID field (for example, OID or FID).
When specifying the Input Zone Layer, the default zone field will be the first available integer or text field. If no other valid fields exist, the ObjectID field (for example, OID or FID) will be the default.
The Input Raster Layer to Summarize can be of either integer or floating data type. However, when it is floating data type, the options for calculating majority, minority, and variety will not be available. For majority and minority statistics, when there is a tie, the output for the zone is based on the lowest of the tied values.
Syntax
arcpy.ra.SummarizeRasterWithin(inputZoneLayer, zoneField, inputRasterLayertoSummarize, outputName, {statisticType}, {ignoreMissingValues}, {processAsMultidimensional}, {percentileValue}, {percentileInterpolationType})| Parameter | Explanation | Data Type |
inputZoneLayer | The input that defines the zones. Both raster and feature data can be used for the zone input. | Raster Layer; Feature Layer |
zoneField | The field that defines each zone. It can be an integer or a string field of the zone dataset. | String |
inputRasterLayertoSummarize | The raster that contains the values on which to summarize a statistic. | Raster Layer |
outputName | The name of the output raster service. If the image service layer already exists, you will be prompted to provide another name. | String |
statisticType (Optional) | Specifies the statistic type to calculate. The available options when the raster to summarize is of integer data type are Average, Majority, Maximum, Median, Minimum, Minority, Percentile, Range, Standard deviation, Sum, and Variety. If the raster to summarize is of float data type, the options are Average, Maximum, Median, Minimum, Percentile, Range, Standard deviation, and Sum.
| String |
ignoreMissingValues (Optional) | Specifies whether missing values in the raster layer to summarize will be ignored in the results of the zones that they fall within.
| Boolean |
processAsMultidimensional (Optional) | Specifies how the input rasters will be processed if they are multidimensional.
| Boolean |
percentileValue (Optional) | The percentile to calculate. The default is 90, indicating the 90th percentile. The values can range from 0 to 100. The 0th percentile is essentially equivalent to the minimum statistic, and the 100th percentile is equivalent to maximum. A value of 50 will produce essentially the same result as the median statistic. This option is only available if the statisticType parameter is set to PERCENTILE. | Double |
percentileInterpolationType (Optional) | Specifies the method of percentile interpolation to be used when the number of values from the input raster to be calculated are even.
| String |
Derived Output
| Name | Explanation | Data Type |
| outputRaster | The output raster. | Raster Layer |
Code sample
This example determines for each zone the average of cell values in the raster layer to be summarized.
import arcpy
arcpy.SummarizeRasterWithin_ra('https://MyPortal.esri.com/server/rest/services/Hosted/landuse/ImageServer',
'Landuse', 'https://MyPortal.esri.com/server/rest/services/Hosted/elevation/ImageServer',
'outRaster', 'MEAN', 'DATA')This example determines for each zone the mean value in the raster layer to be summarized.
#-------------------------------------------------------------------------------
# Name: SummarizeRasterWithin_Ex_02.py
# Description: Calculates the maximum sea-surface temperature at different ecological zones.
# Requirements: ArcGIS Image Server
# Import system modules
import arcpy
# Set local variables
inputZoneLayer = 'https://MyPortal.esri.com/server/rest/services/Hosted/zones/ImageServer'
zoneField = 'temperature'
inputRasterLayertoSummarize = 'https://MyPortal.esri.com/server/rest/services/Hosted/seaSurfaceTemperature/ImageServer'
outputName = 'outSSTRaster'
statisticType = 'MAXIMUM'
ignoreMissingValues = ''
processAsMultidimensional = 'ALL_SLICES'
# Execute Multidimensional Summarize Raster Within operation
arcpy.SummarizeRasterWithin_ra(inputZoneLayer, zoneField, inputRasterLayertoSummarize,
outputName, statisticType, ignoreMissingValues)Environments
Licensing information
- Basic: Requires ArcGIS Image Server
- Standard: Requires ArcGIS Image Server
- Advanced: Requires ArcGIS Image Server