Display Name: Zonal Statistics as Table
Description: Summarizes the values of a raster within the zones of another dataset and reports the results as a table.
Category:
Help URL: https://gis1.wim.usgs.gov/server/rest/directories/arcgisoutput/GLCWRA/ZonalStatisticsAsTable_GPServer/GLCWRA_ZonalStatisticsAsTable/ZonalStatisticsAsTable.htm
Execution Type: esriExecutionTypeAsynchronous
Parameters:
Parameter: in_zone_data
Data Type: GPString
Display Name Input Raster or Feature Zone Data
Description: The dataset that defines the zones.The zones can be defined by an integer raster or a feature layer.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: fake_polygon
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ fake_polygon, SBRA_IndexComposite.tif ]
Parameter: zone_field
Data Type: Field
Display Name Zone Field
Description: The field that contains the values that define each zone.It can be an integer or a string field of the zone dataset.
Direction: esriGPParameterDirectionInput
Filter:
Type: Field
List:
- esriFieldTypeSmallInteger
- esriFieldTypeInteger
- esriFieldTypeOID
- esriFieldTypeString
Dependency: in_zone_data
Default Value: Id
(
type: esriFieldTypeInteger, alias: Id, editable: true, nullable: false, length: 6
)
Parameter Type: esriGPParameterTypeRequired
Category:
Parameter: in_value_raster
Data Type: GPString
Display Name Input Value Raster
Description: The raster that contains the values for which a statistic will be calculated.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: SBRA_IndexComposite.tif
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ SBRA_IndexComposite.tif ]
Parameter: out_table
Data Type: GPRecordSet
Display Name Output Table
Description: The output table that will contain the summary of the values in each zone.The format of the table is determined by the output location and path. By default, the output will be a geodatabase table if in a geodatabase workspace, and a dBASE table if in a file workspace.
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Fields:
-
OBJECTID
(
type: esriFieldTypeOID, alias: OBJECTID
)
-
Id
(
type: esriFieldTypeInteger, alias: Id
)
-
COUNT
(
type: esriFieldTypeDouble, alias: COUNT
)
-
AREA
(
type: esriFieldTypeDouble, alias: AREA
)
-
MEAN
(
type: esriFieldTypeDouble, alias: MEAN
)
Features: None.
Parameter Type: esriGPParameterTypeRequired
Category:
Parameter: ignore_nodata
Data Type: GPBoolean
Display Name Ignore NoData in Calculations
Description: Specifies whether NoData values in the value input will be ignored in the results of the zone that they fall within.Checked—Within any particular zone, only cells that have a value in the input value raster will be used in determining the output value for that zone. NoData cells in the value raster will be ignored in the statistic calculation. This is the default.Unchecked—Within any particular zone, if NoData cells exist in the value raster, they will not be ignored and their existence indicates that there is insufficient information to perform statistical calculations for all the cells in that zone. Consequently, the entire zone will receive the NoData value on the output raster.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: statistics_type
Data Type: GPString
Display Name Statistics Type
Description: Specifies the statistic type to be calculated.All—All of the statistics will be calculated. This is the default.Mean—The average of all cells in the value raster that belong to the same zone as the output cell will be calculated.Majority—The value that occurs most often for all cells in the value raster that belong to the same zone as the output cell will be calculated.Majority count—The frequency of all cells that contain the majority value in the value raster that belong to the same zone as the output cell will be calculated.Majority percentage—The percentage of cells that contain the majority value in the value raster that belong to the same zone as the output cell will be calculated.Maximum—The largest value of all cells in the value raster that belong to the same zone as the output cell will be calculated.Median—The median value of all cells in the value raster that belong to the same zone as the output cell will be calculated.Minimum—The smallest value of all cells in the value raster that belong to the same zone as the output cell will be calculated.Minority—The value that occurs least often for all cells in the value raster that belong to the same zone as the output cell will be calculated.Minority count—The frequency of all cells that contain the minority value in the value raster that belong to the same zone as the output cell will be calculated.Minority percentage—The percentage of cells that contain the minority value in the value raster that belong to the same zone as the output cell will be calculated.Percentile—The percentile of all cells in the value raster that belong to the same zone as the output cell will be calculated. The 90th percentile is calculated by default. You can specify other values (from 0 to 100) using the Percentile values parameter.Range—The difference between the largest and smallest value of all cells in the value raster that belong to the same zone as the output cell will be calculated.Standard deviation—The standard deviation of all cells in the value raster that belong to the same zone as the output cell will be calculated.Sum—The total value of all cells in the value raster that belong to the same zone as the output cell will be calculated.Variety—The number of unique values for all cells in the value raster that belong to the same zone as the output cell will be calculated.Minimum and Maximum—Both the minimum and maximum statistics will be calculated.Mean and Standard deviation—Both the mean and standard deviation statistics will be calculated.Minimum, Maximum, and Mean—The minimum, maximum, and mean statistics will be calculated.Majority value, count, and percentage—The majority value, count, and percentage statistics will be calculated.Minority value, count, and percentage—The minority value, count, and percentage statistics will be calculated.
Direction: esriGPParameterDirectionInput
Filter:
Dependency: in_value_raster
Default Value: Mean
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ All, Mean, Majority, Majority count, Majority percentage, Maximum, Median, Minimum, Minority, Minority count, Minority percentage, Percentile, Range, Standard deviation, Sum, Variety, Minimum and Maximum, Mean and Standard deviation, Minimum, Maximum, and Mean, Majority value, count, and percentage, Minority value, count, and percentage ]
Parameter: process_as_multidimensional
Data Type: GPBoolean
Display Name Process as Multidimensional
Description: Specifies how the input rasters will be calculated if they are multidimensional.Unchecked—Statistics will be calculated from the current slice of the input multidimensional dataset. This is the default.Checked—Statistics will be calculated for all dimensions of the input multidimensional dataset.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: percentile_values
Data Type: GPMultiValue:GPDouble
Display Name Percentile Values
Description: The percentile that will be calculated. 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 parameter is only available if the Statistics type parameter is set to Percentile or All.
Direction: esriGPParameterDirectionInput
Filter:
Dependency: in_zone_data
Default Value: [
90
]
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter Infos:
Name:
Data Type: GPDouble
Display Name:
Filter:
Parameter: percentile_interpolation_type
Data Type: GPString
Display Name Percentile Interpolation Type
Description: Specifies the method of interpolation that will be used when the percentile value falls between two cell values from the input value raster.Auto-detect—If the input value raster is of integer pixel type, the Nearest method will be used. If the input value raster is of floating point pixel type, the Linear method will be used. This is the default.Nearest—The nearest available value to the desired percentile is used.Linear—The weighted average of the two surrounding values from the desired percentile is used.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Auto-detect
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ Auto-detect, Nearest, Linear ]
Parameter: circular_calculation
Data Type: GPBoolean
Display Name Calculate Circular Statistics
Description: Specifies how the input raster will be processed for circular data.Unchecked—Ordinary linear statistics will be calculated. This is the default.Checked—The statistics for angles or other cyclic quantities, such as compass direction in degrees, daytimes, and fractional parts of real numbers, will be calculated.
Direction: esriGPParameterDirectionInput
Filter:
Dependency: in_zone_data
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: circular_wrap_value
Data Type: GPDouble
Display Name Circular Wrap Value
Description: The value that will be used to round a linear value to the range of a given circular statistic. Its value must be a positive integer or a floating-point value. The default value is 360 degrees.This parameter is only supported if the Calculate Circular Statistics parameter is checked.
Direction: esriGPParameterDirectionInput
Filter:
Dependency: zone_field
Default Value: 360
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: out_join_layer
Data Type: GPFeatureRecordSetLayer
Display Name Output Join Layer
Description: The output layer that will be created by joining the output table to the input zone data.
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None
Features: None.
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: esri_out_feature_service_name
Data Type: GPString
Display Name Output Feature Service Name
Description: The name of the hosted feature service containing all the feature or table results of the tool. When no name is specified, standard feature or table results will still be available.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:
Supported Operations:
Submit Job
Child Resources:
Metadata