Summarizes the values of a raster within the zones of another dataset.
<DIV STYLE="text-align:Left;"><DIV><DIV><UL><LI><P><SPAN>A zone is defined as all areas in the input that have the same value. The areas do not have to be contiguous. Both image and feature services can be used for the zone input. </SPAN></P></LI><LI><P><SPAN>If the Input Zone Layer is an image service, it must be an integer image service. </SPAN></P></LI><LI><P><SPAN>If the zone is a feature service, it will be converted to a raster internally, using the cell size and cell alignment from the value raster. </SPAN></P></LI><LI><P><SPAN>When the Cell size of the Input Zone Layer and the Input Raster Layer to Summarize is different, the output cell size will be the Maximum Of Inputs, and the value raster image service will be used as the Snap Raster internally. If the cell size is same, but the cells are not aligned, the value raster image service will be used as the snap raster internally. Either of these cases will trigger an internal resampling before the zonal operation is performed. </SPAN></P></LI><LI><P><SPAN>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 the tool execution. </SPAN></P></LI><LI><P><SPAN>If the Input Zone Layer does not overlap with the cell center of the input value raster image service, the zone will become NoData. To overcome this, you need to determine an appropriate raster resolution that will represent the detail of your image or feature service zone input, and use this resolution as the cell size in the Environment. </SPAN></P></LI><LI><P><SPAN>If the Input Zone Layer is a point feature service, it is possible to have more than one point contained within any particular cell of the value input raster. For such cells, the zone value is determined by the point with the lowest ObjectID field (for example, OID or FID). </SPAN></P></LI><LI><P><SPAN>If the Input Zone Layer has overlapping polygons, the zonal analysis will not be performed for each individual polygon. Since the feature service input is converted to a raster, each location can only have one value. </SPAN></P></LI><LI><P><SPAN>An alternative method is to process the zonal operation iteratively for each of the polygon zones and collate the results. </SPAN></P></LI><LI><P><SPAN>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. </SPAN></P></LI><LI><P><SPAN>The Input Raster Layer to Summarize can be either integer or floating point. However, when it is floating-point type, the options for calculating majority, median, minority, and variety will not be available. For majority and minority calculations, when there is a tie, the output for the zone is based on the lowest of the tied values. </SPAN></P></LI><LI><P><SPAN>The supported statistics type depends on the data type of the Input Value Raster value, and the statistics calculation type specified by the Calculate Circular Statistics parameter. </SPAN></P></LI><LI><P><SPAN>If the data type is integer, the arithmetic statistics calculation supports the Mean, Majority, Majority count, Majority percentage, Maximum, Median, Minimum, Minority, Minority count, Minority percentage, Percentile, Range, Standard deviation, Sum, and Variety options. The circular statistics calculation supports the Mean, Majority, Minority, Standard deviation, and Variety options. </SPAN></P></LI><LI><P><SPAN>If the data type is float, the arithmetic statistics calculation supports the Mean, Maximum, Median, Minimum, Percentile, Range, Standard deviation, and Sum options. The circular statistics calculation supports the Mean and Standard deviation options. </SPAN></P></LI><LI><P><SPAN>For majority and minority calculations, when there is a tie, the output will be the lowest of the tied values. </SPAN></P></LI><LI><P><SPAN>To calculate circular statistics, check the Calculate Circular Statistics parameter and specify a value for the Circular Wrap Value parameter. </SPAN></P></LI></UL></DIV></DIV></DIV>
Parameter | Explanation |
---|---|
inputZoneRasterOrFeatures |
The input that defines the boundaries of the zones, or areas. |
zoneField |
The field that contains the values that define each zone. |
inputValueRaster |
The dataset that contains the cell values that will be used to calculate statistics. |
outputName |
The name of the zonal statistics raster layer that will be created. |
statisticType (Optional) |
Specifies the statistic type that will be calculated. |
percentileValue (Optional) |
Specifies the percentile value that will be calculated. |
percentileInterpolationType (Optional) |
Specifies the method that will be used when the number of values from the input raster to be calculated is an even number. |
circularCalculation (Optional) | <DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Specifies how the Input value raster cell values will be processed for circular data. </SPAN></P><UL><LI><P><SPAN>False—Ordinary arithmetic (linear) statistics will be calculated. </SPAN></P></LI><LI><P><SPAN>True—Circular statistics will be calculated. </SPAN></P></LI></UL></DIV></DIV></DIV> |
circularWrapValue (Optional) |
Specifies the value that will be used to round a linear value to the range of a given circular statistic. |
ignoreNodata (Optional) | <DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Specifies whether NoData cells in the Input value raster will be ignored in the results of the zones they fall within. </SPAN></P><UL><LI><P><SPAN>True—NoData cells in the value raster will be ignored in the statistic calculation. </SPAN></P></LI><LI><P><SPAN>False—NoData cells will not be ignored, and the entire zone will receive the NoData value on the output raster. </SPAN></P></LI></UL></DIV></DIV></DIV> |
processAsMultidemensional (Optional) | <DIV STYLE="text-align:Left;"><DIV><DIV><P><SPAN>Specifies how the input rasters will be processed if they are multidimensional. </SPAN></P><UL><LI><P><SPAN>False—The statistics will be calculated from the current slice of the input multidimensional dataset. </SPAN></P></LI><LI><P><SPAN>True—The statistics will be calculated for all dimensions of the input multidimensional dataset. </SPAN></P></LI></UL></DIV></DIV></DIV> |
context (Optional) |
Specifies the analysis environments. |
There are no code samples for this tool.
There are no tags for this item.
There are no credits for this item.
There are no use limitations for this item.