Display Name: Summarize Within

Description: Overlays a polygon layer with another layer to summarize the number of points, length of the lines, or area of the polygons within each polygon, and calculate attribute field statistics about the features within the polygons.

Category:

Help URL: https://njmaps1.rad.rutgers.edu/arcgis/rest/directories/arcgisoutput/Tools/SummarizeWithin_Tracts_GPServer/Tools_SummarizeWithin_Tracts/SummarizeWithin.htm

Execution Type: esriExecutionTypeSynchronous

Parameters:

Parameter: in_polygons

Data Type: GPFeatureRecordSetLayer
Display Name Input Polygons
Description: The polygons that will be used to summarize the features, or portions of features, in the input summary layer.
Direction: esriGPParameterDirectionInput
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields: None

Features: None.



Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: out_feature_class

Data Type: GPFeatureRecordSetLayer
Display Name Output Feature Class
Description: The output polygon feature class containing the same geometries and attributes as the input polygons. The feature class will include additional attributes for the number of points, length of lines, and area of polygons inside each input polygon and statistics about those features.
Direction: esriGPParameterDirectionOutput
Default Value:
Geometry Type:
HasZ: false
HasM: false
Spatial Reference: N/A
Fields:
• Shape_length ( type: esriFieldTypeDouble , alias: Shape_length )
• Shape_area ( type: esriFieldTypeDouble , alias: Shape_area )
• Sum_Area_SQUAREFEET ( type: esriFieldTypeDouble , alias: Summarized area in SQUAREFEET )
Features: None.



Parameter Type: esriGPParameterTypeRequired
Category:


Parameter: keep_all_polygons

Data Type: GPBoolean
Display Name Keep all input polygons
Description: Specifies whether all input polygons or only those intersecting or containing at least one input summary feature will be copied to the output feature class.Checked—All input polygons will be copied to the output feature class. This is the default.Unchecked—Only input polygons that intersect or contain at least one input summary feature will be copied to the output feature class.
Direction: esriGPParameterDirectionInput
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: sum_shape

Data Type: GPBoolean
Display Name Add shape summary attributes
Description: Specifies whether attributes for the number of points, length of lines, and area of polygon features summarized in each input polygon will be added to the output feature class.Checked—Shape summary attributes will be added to the output feature class. This is the default.Unchecked—Shape summary attributes will not be added to the output feature class.
Direction: esriGPParameterDirectionInput
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: shape_unit

Data Type: GPString
Display Name Shape Unit
Description: Specifies the unit that will be used when calculating shape summary attributes. If the input summary features are points, no shape unit is necessary, since only the count of points in each input polygon is added.If the input summary features are lines, specify a linear unit. If the input summary features are polygons, specify an areal unit.Meters—The unit will be meters.Kilometers—The unit will be kilometers.Feet—The unit will be feet.Yards—The unit will be yards.Miles—The unit will be miles.Acres—The unit will be acres.Hectares—The unit will be hectares.Square meters—The unit will be square meters.Square kilometers—The unit will be square kilometers.Square feet—The unit will be square feet.Square yards—The unit will be square yards.Square miles—The unit will be square miles.
Direction: esriGPParameterDirectionInput
Default Value: Square feet
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ Acres, Hectares, Square meters, Square kilometers, Square feet, Square yards, Square miles ]

Parameter: group_field

Data Type: GPString
Display Name Group Field
Description: An attribute field from the input summary features that will be used for grouping. Features that have the same group field value will be combined and summarized with other features with the same group field value.When a group field is provided, the Output Grouped Table parameter value is required.
Direction: esriGPParameterDirectionInput
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: add_min_maj

Data Type: GPBoolean
Display Name Add minority and majority attributes
Description: Specifies whether minority and majority fields will be added to the output. This parameter allows you to determine which group field value is the minority (least dominant) and the majority (most dominant) within each input polygon.This parameter is active if you provided a Group Field parameter value.Unchecked—Minority and majority fields will not be added to the output. This is the default.Checked—Minority and majority fields will be added to the output.
Direction: esriGPParameterDirectionInput
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: add_group_percent

Data Type: GPBoolean
Display Name Add group percentages
Description: Specifies whether a percentage attribute field will be added to the output. This parameter allows you to determine the percentage of each attribute value in each group.This parameter is active if you provided a Group Field parameter value.Unchecked—A percentage attribute field will not be added to the output. This is the default.Checked—A percentage attribute field will be added to the output.
Direction: esriGPParameterDirectionInput
Default Value: false
Parameter Type: esriGPParameterTypeOptional
Category:


Parameter: out_group_table

Data Type: GPRecordSet
Display Name Output Grouped Table
Description: An output table that includes summary fields for each group of summary features for each input polygon.The table will have the following attribute fields:Join_ID—An ID corresponding to an ID field added to the output feature classThe group fieldA shape summary fieldOne field for each summary fieldA percentage fieldThis parameter is required when the Group Field parameter value is provided.
Direction: esriGPParameterDirectionOutput
Default Value:
Fields: None

Features: None.



Parameter Type: esriGPParameterTypeOptional
Category:

Supported Operations:   Execute Task