Display Name: SummarizeNearby

Description: The SummarizeNearby task finds features that are within a specified distance of features in the input layer. Distance can be measured as a straight-line distance, a drive-time distance (for example, within 10 minutes), or a drive distance (within 5 kilometers). Statistics are then calculated for the nearby features. For example:Calculate the total population within five minutes of driving time of a proposed new store location.Calculate the number of freeway access ramps within a one-mile driving distance of a proposed new store location to use as a measure of store accessibility.

Category:

Help URL: https://spatialags.vhb.com/arcgis/rest/directories/arcgisoutput/System/SpatialAnalysisTools_GPServer/System_SpatialAnalysisTools/SummarizeNearby.htm

Execution Type: esriExecutionTypeAsynchronous

Parameters:

Parameter: sumNearbyLayer

Data Type: GPFeatureRecordSetLayer
Display Name sumNearbyLayer
Description: Point, line, or polygon features from which distances will be measured to features in the summarizeLayer.
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: summaryLayer

Data Type: GPFeatureRecordSetLayer
Display Name summaryLayer
Description: Point, line, or polygon features. Features in this layer that are within the specified distance to features in the sumNearbyLayer 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: esriGPParameterTypeRequired
Category:


Parameter: nearType

Data Type: GPString
Display Name nearType
Description: Defines what kind of distance measurement you want to use to create areas around the nearbyLayer features.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: StraightLine
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: distances

Data Type: GPMultiValue:GPDouble
Display Name distances
Description: An array of double values that defines the search distance for creating areas mentioned above
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: units

Data Type: GPString
Display Name units
Description: The linear unit for distances parameter above. Eg. Miles, Kilometers, Minutes Seconds etc
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: Meters
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ Meters, Kilometers, Feet, Yards, Miles, Seconds, Minutes, Hours ]

Parameter: timeOfDay

Data Type: GPDate
Display Name timeOfDay
Description: For timeOfDay, set the time and day according to the number of milliseconds elapsed since the Unix epoc (January 1, 1970 UTC). When specified and if relevant for the nearType parameter, the traffic conditions during the time of the day will be considered.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: timeZoneForTimeOfDay

Data Type: GPString
Display Name timeZoneForTimeOfDay
Description: Determines if the value specified for timeOfDay is specified in UTC or in a time zone that is local to the location of the origins.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: GeoLocal
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ UTC, GeoLocal ]

Parameter: returnBoundaries

Data Type: GPBoolean
Display Name returnBoundaries
Description: If true, will return a result layer of areas that contain the requested summary information. The resulting areas are defined by the specified nearType. For example, if using a StraightLine of 5 miles, your result will contain areas with a 5 mile radius around the input features and specified summary information.If false, the resulting layer will return the same features as the input analysis layer with requested summary information.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
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: [ Meters, Kilometers, Feet, Yards, Miles, Acres, Hectares, SquareMeters, SquareKilometers, SquareFeet, SquareYards, SquareMiles ]

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 value of the field.
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: 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