Display Name: SummarizeRasterWithin

Description: Calculates statistics on values of a raster within the zones of another dataset.

Category:

Help URL: https://gis.cityoffargo.com/arcgis/rest/directories/arcgisoutput/System/RasterAnalysisTools_GPServer/System_RasterAnalysisTools/SummarizeRasterWithin.htm

Execution Type: esriExecutionTypeAsynchronous

Parameters:

Parameter: inputZoneLayer

Data Type: GPString
Display Name inputZoneLayer
Description: The input that defines the zones.Both raster and feature can be used for the zone input.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: zoneField

Data Type: GPString
Display Name zoneField
Description: The field that defines each zone.It can be an integer or a string field of the zone dataset.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Value
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: inputRasterLayertoSummarize

Data Type: GPString
Display Name inputRasterLayertoSummarize
Description: Raster that contains the values on which to summarize a statistic.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: outputName

Data Type: GPString
Display Name outputName
Description: The name of the output raster service.If the image service layer already exists, you will be prompted to provide another name.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: statisticType

Data Type: GPString
Display Name statisticType
Description: Choose the statistic to calculate.The available options when the summarize raster is integer are Average, Majority, Maximum, Median, Minimum, Minority, Range, Standard deviation, Sum, and Variety.If the summarize raster is float, the options are Average, Maximum, Minimum, Range, Standard deviation, and Sum.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.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.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.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.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.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.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.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.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.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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Mean
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ Mean, Majority, Maximum, Median, Minimum, Minority, Percentile, Range, STD, Sum, Variety ]

Parameter: ignoreMissingValues

Data Type: GPBoolean
Display Name ignoreMissingValues
Description: Denotes whether missing values in the image service layer to summarize will influence the results of the zones that they fall within.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. 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.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: processAsMultidimensional

Data Type: GPBoolean
Display Name processAsMultidimensional
Description: Determines how the input rasters will be processed if they are multidimensional.Unchecked—Statistics will be calculated from the current slice of a multidimensional image service. This is the default.Checked—Statistics will be calculated for all dimensions (such as time or depth) of a multidimensional image service.CURRENT_SLICE— Statistics will be calculated from the current slice of a multidimensional image service. This is the default.ALL_SLICES— Statistics will be calculated for all dimensions (such as time or depth) of a multidimensional image service.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: percentileValue

Data Type: GPDouble
Display Name percentileValue
Description:
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: 90
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: percentileInterpolationType

Data Type: GPString
Display Name percentileInterpolationType
Description:
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: AUTO_DETECT
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ AUTO_DETECT, NEAREST, LINEAR ]

Parameter: context

Data Type: GPString
Display Name context
Description:
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: outputRaster

Data Type: GPString
Display Name outputRaster
Description:
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeDerived
Category:

Supported Operations:   Submit Job

Child Resources:   Metadata