<?xml version="1.0" encoding="UTF-8"?><metadata>
<Esri>
<CreaDate>20200330</CreaDate>
<CreaTime>09180900</CreaTime>
<ArcGISFormat>1.0</ArcGISFormat>
<SyncOnce>TRUE</SyncOnce>
<ModDate>20200820</ModDate>
<ModTime>151310</ModTime>
</Esri>
<dataIdInfo>
<idCitation>
<resTitle>SummarizeRasterWithin</resTitle>
<date>
<createDate>20200330</createDate>
</date>
</idCitation>
<idAbs>
<para>Calculates statistics on values of a raster within the zones of another dataset.</para>
</idAbs>
<descKeys KeyTypCd="005">
<keyTyp>
<keyTyp>005</keyTyp>
</keyTyp>
<keyword>Average</keyword>
<keyword>Statistics</keyword>
<keyword>Zonal</keyword>
<keyword>Zonalstats</keyword>
<keyword>Zone</keyword>
<keyword/>
</descKeys>
</dataIdInfo>
<distInfo>
<distributor>
<distorFormat>
<formatName>ArcToolbox Tool</formatName>
</distorFormat>
</distributor>
</distInfo>
<mdDateSt>20200427</mdDateSt>
<mdContact>
<rpOrgName>Environmental Systems Research Institute, Inc. (Esri)</rpOrgName>
<rpCntInfo>
<cntAddress>
<delPoint>380 New York Street</delPoint>
<city>Redlands</city>
<adminArea>California</adminArea>
<postCode>92373-8100</postCode>
<eMailAdd>info@esri.com</eMailAdd>
<country>United States</country>
</cntAddress>
<cntPhone>
<voiceNum>909-793-2853</voiceNum>
<faxNum>909-793-5953</faxNum>
</cntPhone>
<cntOnlineRes>
<linkage>http://www.esri.com</linkage>
</cntOnlineRes>
</rpCntInfo>
<role>
<RoleCd>007</RoleCd>
</role>
</mdContact>
<tool displayname="SummarizeRasterWithin" name="SummarizeRasterWithin" softwarerestriction="none" toolboxalias="ra">
<summary>
<para>Calculates statistics on values of a raster within the zones of another dataset.</para>
</summary>
<alink_name>SummarizeRasterWithin_ra</alink_name>
<toolIllust alt="Summarize Raster Within tool" src="withheld" type="dialog"/>
<toolIllust alt="Summarize Raster Within tool" src="withheld" type="illustration"/>
<parameters>
<param datatype="String" direction="Input" displayname="inputZoneLayer" expression="inputZoneLayer" name="inputZoneLayer" sync="true" type="Required">
<pythonReference>
<para>The input that defines the zones.</para>
<para>Both raster and feature can be used for the zone input.</para>
</pythonReference>
<dialogReference>
<para>The input that defines the zones.</para>
<para>Both raster and feature can be used for the zone input.</para>
</dialogReference>
</param>
<param datatype="String" direction="Input" displayname="zoneField" expression="zoneField" name="zoneField" sync="true" type="Required">
<pythonReference>
<para>The field that defines each zone.</para>
<para>It can be an integer or a string field of the zone dataset.</para>
</pythonReference>
<dialogReference>
<para>The field that defines each zone.</para>
<para>It can be an integer or a string field of the zone dataset.</para>
</dialogReference>
</param>
<param datatype="String" direction="Input" displayname="inputRasterLayertoSummarize" expression="inputRasterLayertoSummarize" name="inputRasterLayertoSummarize" sync="true" type="Required">
<pythonReference>
<para>Raster that contains the values on which to summarize a statistic.</para>
</pythonReference>
<dialogReference>
<para>Raster that contains the values on which to summarize a statistic.</para>
</dialogReference>
</param>
<param datatype="String" direction="Input" displayname="outputName" expression="outputName" name="outputName" sync="true" type="Required">
<pythonReference>
<para>The name of the output raster service.</para>
<para>If the image service layer already exists, you will be prompted to provide another name.</para>
</pythonReference>
<dialogReference>
<para>The name of the output raster service.</para>
<para>If the image service layer already exists, you will be prompted to provide another name.</para>
</dialogReference>
</param>
<param datatype="String" direction="Input" displayname="statisticType" expression="{Mean | Majority | Maximum | Median | Minimum | Minority | Percentile | Range | STD | Sum | Variety}" name="statisticType" sync="true" type="Optional">
<pythonReference>
<para>Choose the statistic to calculate.</para>
<para>The available options when the summarize raster is integer are Average, Majority, Maximum, Median, Minimum, Minority, Range, Standard deviation, Sum, and Variety.</para>
<para>If the summarize raster is float, the options are Average, Maximum, Minimum, Range, Standard deviation, and Sum.</para>
<bulletList>
<bullet_item>MEAN— Calculates the average of all cells in the raster layer to be summarized that belong to the same zone as the output cell. This is the default.</bullet_item>
<bullet_item>MAJORITY— Determines the value that occurs most often of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>MAXIMUM— Determines the largest value of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>MEDIAN— Determines the median value of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>MINIMUM— Determines the smallest value of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>MINORITY— Determines the value that occurs least often of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>RANGE— Calculates the difference between the largest and smallest value of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>STD— Calculates the standard deviation of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>SUM— Calculates the total value of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>VARIETY— Calculates the number of unique values for all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
</bulletList>
</pythonReference>
<dialogReference>
<para>Choose the statistic to calculate.</para>
<para>The available options when the summarize raster is integer are Average, Majority, Maximum, Median, Minimum, Minority, Range, Standard deviation, Sum, and Variety.</para>
<para>If the summarize raster is float, the options are Average, Maximum, Minimum, Range, Standard deviation, and Sum.</para>
<bulletList>
<bullet_item>Average— Calculates the average of all cells in the raster layer to be summarized that belong to the same zone as the output cell. This is the default.</bullet_item>
<bullet_item>Majority— Determines the value that occurs most often of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>Maximum— Determines the largest value of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>Median— Determines the median value of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>Minimum— Determines the smallest value of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>Minority— Determines the value that occurs least often of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>Range— Calculates the difference between the largest and smallest value of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>Standard deviation— Calculates the standard deviation of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>Sum— Calculates the total value of all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
<bullet_item>Variety— Calculates the number of unique values for all cells in the raster layer to be summarized that belong to the same zone as the output cell.</bullet_item>
</bulletList>
</dialogReference>
<enumcorrespondence>
<enum label="Average" name="MEAN"/>
<enum label="Majority" name="MAJORITY"/>
<enum label="Maximum" name="MAXIMUM"/>
<enum label="Median" name="MEDIAN"/>
<enum label="Minimum" name="MINIMUM"/>
<enum label="Minority" name="MINORITY"/>
<enum label="Range" name="RANGE"/>
<enum label="Standard deviation" name="STD"/>
<enum label="Sum" name="SUM"/>
<enum label="Variety" name="VARIETY"/>
</enumcorrespondence>
</param>
<param datatype="Boolean" direction="Input" displayname="ignoreMissingValues" expression="{true | false}" name="ignoreMissingValues" sync="true" type="Optional">
<pythonReference>
<para>Denotes whether missing values in the image service layer to summarize will influence the results of the zones that they fall within.</para>
<bulletList>
<bullet_item>DATA—Within any particular zone, only cells that have a value in the image service layer being summarized will be used in determining the output value for that zone. Any missing or NoData cells will be ignored in the statistic calculation. This is the default.</bullet_item>
<bullet_item>NODATA—Within any particular zone, if any cells in the image service layer being summarized do not have a value, it is deemed that there is insufficient information to perform statistical calculations for all the cells in that zone; therefore, the entire zone will receive the NoData value on the output image service.</bullet_item>
</bulletList>
</pythonReference>
<dialogReference>
<para>Denotes whether missing values in the image service layer to summarize will influence the results of the zones that they fall within.</para>
<bulletList>
<bullet_item>Checked—Within any particular zone, only cells that have a value in the image service layer being summarized will be used in determining the output value for that zone. Any missing or NoData cells will be ignored in the statistic calculation. This is the default.</bullet_item>
<bullet_item>Unchecked—Within any particular zone, if any cells in the image service layer being summarized do not have a value, it is deemed that there is insufficient information to perform statistical calculations for all the cells in that zone; therefore, the entire zone will receive the NoData value on the output image service.</bullet_item>
</bulletList>
</dialogReference>
</param>
<param datatype="Boolean" direction="Input" displayname="processAsMultidimensional" expression="{CURRENT_SLICE | ALL_SLICES}" name="processAsMultidimensional" sync="true" type="Optional">
<pythonReference>
<para>Determines how the input rasters will be processed if they are multidimensional.</para>
<bulletList>
<bullet_item>Unchecked—Statistics will be calculated from the current slice of a multidimensional image service. This is the default.</bullet_item>
<bullet_item>Checked—Statistics will be calculated for all dimensions (such as time or depth) of a multidimensional image service.</bullet_item>
</bulletList>
<bulletList>
<bullet_item>CURRENT_SLICE— Statistics will be calculated from the current slice of a multidimensional image service. This is the default.</bullet_item>
<bullet_item>ALL_SLICES— Statistics will be calculated for all dimensions (such as time or depth) of a multidimensional image service.</bullet_item>
</bulletList>
</pythonReference>
<dialogReference>
<para>Determines how the input rasters will be processed if they are multidimensional.</para>
<bulletList>
<bullet_item>Unchecked—Statistics will be calculated from the current slice of a multidimensional image service. This is the default.</bullet_item>
<bullet_item>Checked—Statistics will be calculated for all dimensions (such as time or depth) of a multidimensional image service.</bullet_item>
</bulletList>
<bulletList>
<bullet_item>CURRENT_SLICE— Statistics will be calculated from the current slice of a multidimensional image service. This is the default.</bullet_item>
<bullet_item>ALL_SLICES— Statistics will be calculated for all dimensions (such as time or depth) of a multidimensional image service.</bullet_item>
</bulletList>
</dialogReference>
</param>
<param datatype="Double" direction="Input" displayname="percentileValue" expression="{percentileValue}" name="percentileValue" type="Optional"/>
<param datatype="String" direction="Input" displayname="percentileInterpolationType" expression="{AUTO_DETECT | NEAREST | LINEAR}" name="percentileInterpolationType" type="Optional"/>
<param datatype="String" direction="Input" displayname="context" expression="{context}" name="context" type="Optional"/>
</parameters>
<returnvalues/>
<environments>
<environment label="Cell size" name="cellSize"/>
<environment label="Output extent" name="extent"/>
<environment label="Mask" name="mask"/>
<environment label="Output coordinate system" name="outputCoordinateSystem"/>
<environment label="Snap raster" name="snapRaster"/>
</environments>
<usage>
<bullet_item>
<para>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.</para>
</bullet_item>
<bullet_item>
<para>If the Input Zone Layer ( inputZoneLayer
in
Python) is an image service, it must be an integer image service.</para>
<para>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.</para>
</bullet_item>
<bullet_item>
<para>When
the Cell
size of the Input Zone Layer ( inputZoneLayer
in
Python) and the Input Raster Layer to Summarize (inputRasterLayertoSummarize
in
Python) 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.</para>
<para>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.</para>
</bullet_item>
<bullet_item>
<para>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.</para>
</bullet_item>
<bullet_item>
<para>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).</para>
</bullet_item>
<bullet_item>
<para>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.</para>
<para>An alternative method is to process the zonal operation iteratively for each of the polygon zones and collate the results.</para>
</bullet_item>
<bullet_item>
<para>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.</para>
</bullet_item>
<bullet_item>
<para>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.</para>
</bullet_item>
<bullet_item>
<para> Supported multidimensional dataset types include multidimensional image service.</para>
</bullet_item>
</usage>
<scriptExamples>
<scriptExample>
<title>SummarizeRasterWithin example 1 (Python window)</title>
<para>This example determines for each zone the average of cell values in the raster layer to be summarized.</para>
<code xml:space="preserve">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')
</code>
</scriptExample>
<scriptExample>
<title>SummarizeRasterWithin example 2 (stand-alone script)</title>
<para>This example determines for each zone the mean value in the raster layer to be summarized.</para>
<code xml:space="preserve">#-------------------------------------------------------------------------------
# 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)
</code>
</scriptExample>
</scriptExamples>
<shortdesc>ArcGIS geoprocessing tool that summarizes rasters within boundaries.</shortdesc>
<arcToolboxHelpPath>withheld</arcToolboxHelpPath>
</tool>
</metadata>
