Display Name: SummarizeWithin

Description: The SummarizeWithin task helps you to summarize and find statistics on the point, line, or polygon features (or portions of these features) that are within the boundaries of polygons in another layer. For example:Given a layer of watershed boundaries and a layer of land-use boundaries by land-use type, calculate total acreage of land-use type for each watershed.Given a layer of parcels in a county and a layer of city boundaries, summarize the average value of vacant parcels within each city boundary.Given a layer of counties and a layer of roads, summarize the total mileage of roads by road type within each county.

Category:

Help URL: https://terra.library.brocku.ca/arcgis/rest/directories/arcgisoutput/System/SpatialAnalysisTools_GPServer/System_SpatialAnalysisTools/SummarizeWithin.htm

Execution Type: esriExecutionTypeAsynchronous

Parameters:

Parameter: sumWithinLayer

Data Type: GPFeatureRecordSetLayer
Display Name sumWithinLayer
Description: A polygon feature layer or featurecollection. Features, or portions of features, in the summaryLayer (below) that fall within the boundaries of these polygons will be summarized.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None

Features: None.



Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: summaryLayer

Data Type: GPFeatureRecordSetLayer
Display Name summaryLayer
Description: Point, line, or polygon features that will be summarized for each polygon in the sumWithinLayer.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None

Features: None.



Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: sumShape

Data Type: GPBoolean
Display Name sumShape
Description: A boolean value that instructs the task to calculate count of points, length of lines or areas of polygons of the summaryLayer within each polygon in sumWithinLayer.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: shapeUnits

Data Type: GPString
Display Name shapeUnits
Description: Specify units to summarize the length or areas when sumShape is set to true. Units is not required to summarize points.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ Acres, Hectares, SquareMeters, SquareKilometers, SquareFeet, SquareYards, SquareMiles, Meters, Kilometers, Feet, Yards, Miles ]

Parameter: summaryFields

Data Type: GPMultiValue:GPString
Display Name summaryFields
Description: A list of field names and statistical summary type that you wish to calculate for all features in the summaryLayer that are within each polygon in the sumWithinLayer . Eg: ["fieldname1 summary", "fieldname2 summary"]
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: groupByField

Data Type: GPString
Display Name groupByField
Description: Specify a field from the summaryLayer features to calculate statistics separately for each unique attribute value.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: minorityMajority

Data Type: GPBoolean
Display Name minorityMajority
Description: This boolean parameter is applicable only when a groupByField is specified. If true, the minority (least dominant) or the majority (most dominant) attribute values within each group, within each boundary will be calculated.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: percentShape

Data Type: GPBoolean
Display Name percentShape
Description: This boolean parameter is applicable only when a groupByField is specified. If set to true, the percentage of shape (eg. length for lines) for each unique groupByField value is calculated.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: outputName

Data Type: GPString
Display Name outputName
Description: Additional properties such as output feature service name.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: context

Data Type: GPString
Display Name context
Description: Additional settings such as processing extent and output spatial reference.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: binType

Data Type: GPString
Display Name binType
Description:
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: SQUARE
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ SQUARE, HEXAGON ]

Parameter: binSize

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


Parameter: binSizeUnit

Data Type: GPString
Display Name binSizeUnit
Description:
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ Meters, Kilometers, Feet, Yards, Miles, NauticalMiles ]

Parameter: resultLayer

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


Parameter: groupBySummary

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

Supported Operations:   Submit Job

Child Resources:   Metadata