Summarize Within

The Summarize Within tool calculates statistics in areas where an input layer overlaps a boundary layer.

The output is a hosted feature layer and an optional group by summary table.

Example

An analyst has been asked to create a report on cycling networks for Toulouse, France, to support the city's sustainable development plan. The total length of cycling paths for each township can be calculated using Summarize Within.

Try the Summarize cycling routes within townships tutorial for the complete workflow.

Usage notes

Summarize Within includes configurations for features to summarize, summary areas, calculating statistics, and the result layer.

Features to summarize

The Features to summarize group includes the Input features parameter, which is used to choose the point, line, or polygon layer to be summarized.

For feature inputs, a count of features is displayed below the layer name. The count includes all features in the layer, except features that have been removed using a filter. Environment settings, such as Processing extent, are not reflected in the feature count.

Summary areas

The Summary areas group includes the following parameters:

• Area type specifies the type of boundaries in which the features will be summarized. The boundaries can be an input polygon layer, square bins, or hexagon bins.

• Summary polygon layer identifies the input polygon layer in which the features will be summarized. This parameter is available when Polygon layer is specified for Area type. You can choose a layer using the Layer button, or you can create a sketch layer to use as the input using the Draw input features button.

  For feature inputs, a count of features is displayed below the layer name. The count includes all features in the layer, except features that have been removed using a filter. Environment settings, such as Processing extent, are not reflected in the feature count.

• Bin size is the size of the generated bins. For square bins, the value is equal to the height and width of the bins. For hexagon bins, the value determines the distance between parallel sides. This parameter is available when Square bins or Hexagon bins is specified for Area type.

  

• Bin size units are the distance units that will be used for generating the bins. Supported units are meters, kilometers, feet, yards, miles, and nautical miles.

Calculate statistics

The Calculate statistics group includes the following parameters:

• Include summarized geometry of features determines whether the geometry (total length or total area) is summarized for the input features. This parameter is available when line or polygon features are chosen for Input features.
• Summarized length units and Summarized area units determine the units with which the summarized geometry is calculated. Length units include miles, yards, feet, kilometers, and meters. Area units include square miles, square yards, square feet, hectares, square kilometers, and square meters. This parameter is available when Include summarized geometry of features is enabled.

• Field statistics determines which number fields from the input layer to summarize. Supported summary statistics include sum, minimum, maximum, mean, and standard deviation. The statistics are calculated for each boundary separately.

  Learn more about summary statistics
• Group by field is used to select a categorical field to create groups for statistical calculations. For example, when summarizing invasive plant species near a national park, the Group by field parameter can be used to calculate the statistics by species. When statistics are grouped by a field, the statistics are calculated for both the area as a whole and for each group.
• Include minority and majority values returns the group with the highest and lowest counts within each bounding area. This parameter is available when a field is chosen in Group by field.
• Include percentage of summarized feature specifies whether the percentage of features in the minority and majority groups will be calculated for each boundary and included in the output. This parameter is available when a field is chosen in Group by field.

Result layer

The Result layer group includes the following parameters:

• Output name specifies the name of the layer that is created and displayed. The name must be unique. If a layer with the same name already exists in your organization, the tool will fail and you will be prompted to use a different name.
• Save in folder specifies the name of a folder in My content where the result will be saved.

Limitations

The following limitations apply to the tool:

• The boundary input must be polygon features.
• Lines and polygons are summarized using proportions; it is best to summarize absolute data (such as population) rather than relative data (such as average income) when lines or polygons are being summarized.
• There is no option to remove boundaries that do not overlap any points, lines, or polygons.
• The Draw input features button is not available in Scene Viewer.

Environments

Analysis environment settings are additional parameters that affect a tool's results. You can access the tool's analysis environment settings from the Environment settings parameter group.

This tool honors the following analysis environments:

• Output coordinate system
• Processing extent

  Note:

  The default processing extent is Full extent. This default is different from Map Viewer Classic in which Use current map extent is enabled by default.

Credits

This tool consumes credits.

Use Estimate credits to calculate the number of credits that will be required to run the tool. For more information, see Understand credits for spatial analysis.

Outputs

This tool includes the following outputs:

• One polygon layer showing the summarized features. The type of features (point, line, or polygon) depends on the input features. Depending on the tool configurations, the polygon layer will include fields with the following information:
  • Count of features
  • Summarized length or summarized area. This field is included when Include summarized geometry of features is enabled.
  • Summary statistic field (for example, Sum <field_name>). This field is included when a field is provided for Field statistics.
  • <Group by field name>. This field is included when a field is provided for Group by field.
  • Minority value. This field is included when Include minority and majority values is enabled.
  • Majority value. This field is included when Include minority and majority values is enabled.
  • Minority percent. This field is included when both Include minority and majority values and Include percentage of summarized feature are enabled.
  • Majority percent. This field is included when both Include minority and majority values and Include percentage of summarized feature are enabled.
  • Area
  • Join ID. This field is included when a field is provided for Group by field.
  • Grid ID. This field is included when the Area type value is square or hexagon bins.
• One table layer listing each feature and statistic by the Group by field value. The table output is only created if a field is provided for the Group by field parameter. Depending on the tool configurations, the table layer will include fields with the following information:
  • Group by value.
  • Summary statistics.
  • Count of features.
  • Percent of point count or percent of length or percent of area. This field depends on the geometry of the Input features value.
  • Summarized length or summarized area. This field is included when Include summarized geometry of features is enabled.

Licensing requirements

This tool requires the following user type and configurations:

• Creator, Professional, or Professional Plus user type
• Publisher, Facilitator, or Administrator role, or an equivalent custom role

Resources

Use the following resources to learn more:

• Summary statistics
• Summarize Within in ArcGIS REST API
• summarize-within in ArcGIS API for Python
• Aggregate Points in ArcGIS Online
• Spatial Join in ArcGIS Pro
• Summary Statistics in ArcGIS Pro