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://dcgis.dekalbcountyga.gov/hosted/rest/directories/arcgisoutput/DelinquentParcelsByZipcode_GPServer/DelinquentParcelsByZipcode/SummarizeWithin.htm
Execution Type: esriExecutionTypeAsynchronous
Parameters:
Parameter: in_polygons
Data Type: GPString
Display Name Input Polygons
Description: The polygons used to summarize the features, or portions of features, in the input summary layer.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: DeKalb Zip Code
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ EGISPUB.GIS.DelinquentParcelsByZipcode, DeKalb Zip Code, DeKalbZipCode_SummarizeWithin ]
Parameter: in_sum_features
Data Type: GPString
Display Name Input Summary Features
Description: The point, line, or polygon features that will be summarized for each polygon in the input polygons.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value: EGISPUB.GIS.DelinquentTaxPoint
Parameter Type: esriGPParameterTypeRequired
Category:
Choice List: [ EGISPUB.GIS.DelinquentParcelsByZipcode, DeKalb Zip Code, DeKalbZipCode_SummarizeWithin, EGISPUB.GIS.DelinquentTaxPoint ]
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 with additional new attributes for the number points, length of lines, and area of polygons inside each input polygon and statistics about those features.
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
Geometry Type: esriGeometryPolygon
HasZ: false
HasM: false
Spatial Reference: 102100
(3857)
LatestVCSWkid(0)
Fields:
-
OBJECTID
(
type: esriFieldTypeOID, alias: OBJECTID
)
-
ZIP_CODE
(
type: esriFieldTypeString, alias: ZIP Code, length: 10
)
-
PO_NAME
(
type: esriFieldTypeString, alias: Post Office Name, length: 100
)
-
STATE
(
type: esriFieldTypeString, alias: State Abbreviation, length: 50
)
-
POPULATION
(
type: esriFieldTypeInteger, alias: 2021 Total Population
)
-
POP_SQMI
(
type: esriFieldTypeDouble, alias: People per square mile
)
-
SQMI
(
type: esriFieldTypeDouble, alias: Area in square miles
)
-
Point_Count
(
type: esriFieldTypeInteger, alias: Count of Points
)
-
Shape_Length
(
type: esriFieldTypeDouble, alias: Shape_Length
)
-
Shape_Area
(
type: esriFieldTypeDouble, alias: Shape_Area
)
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
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: sum_fields
Data Type: GPValueTable
Display Name Summary Fields
Description: A list of attribute field names from the input summary features, as well as statistical summary types that will be calculated for those attribute fields for all points in each polygon.Summary fields must be numeric. Text and other attribute field types are not supported.The following are the statistic types:Sum—The total value of all the points in each polygon will be calculated.Mean—The average of all the points in each polygon will be calculated.Min—The smallest value of all the points in each polygon will be identified.Max—The largest value of all the points in each polygon will be identified.Stddev—The standard deviation of all the points in each polygon will be calculated.
Direction: esriGPParameterDirectionInput
Filter:
Dependency: in_sum_features
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter Infos:
Name: Field
Data Type: Field
Display Name: Field
Filter:
Type: Field
List:
- esriFieldTypeSmallInteger
- esriFieldTypeInteger
- esriFieldTypeSingle
- esriFieldTypeDouble
Name: Statistic
Data Type: GPString
Display Name: Statistic
Filter:
Choice List: [ Sum, Mean ]
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.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
Filter:
Dependency:
Default Value: true
Parameter Type: esriGPParameterTypeOptional
Category:
Parameter: shape_unit
Data Type: GPString
Display Name Shape Unit
Description: 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
Filter:
Dependency:
Default Value: SQUAREKILOMETERS
Parameter Type: esriGPParameterTypeOptional
Category:
Choice List: [ ACRES, HECTARES, SQUAREMETERS, SQUAREKILOMETERS, SQUAREFEET, SQUAREYARDS, SQUAREMILES, METERS, KILOMETERS, FEET, YARDS, MILES ]
Parameter: group_field
Data Type: Field
Display Name Group Field
Description: An attribute field from the input summary features that is 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 specified, the Output Grouped Table parameter is required.
Direction: esriGPParameterDirectionInput
Filter:
Type: Field
List:
- esriFieldTypeSmallInteger
- esriFieldTypeInteger
- esriFieldTypeSingle
- esriFieldTypeDouble
- esriFieldTypeString
Dependency: in_sum_features
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 specified 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
Filter:
Dependency:
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 specified 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
Filter:
Dependency:
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 of the summary fieldsPercentage fieldThis parameter is required when the Group Field parameter value is specified.
Direction: esriGPParameterDirectionOutput
Filter:
Dependency:
Default Value:
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 optional feature service to create on the federated server containing the result of this tool. If no name is specified an output feature service will not be created.
Direction: esriGPParameterDirectionInput
Filter:
Dependency:
Default Value:
Parameter Type: esriGPParameterTypeOptional
Category:
Supported Operations:
Submit Job
Child Resources:
Metadata