Summarize Nearby (Standard Feature Analysis)

Summary

Finds features that are within a specified distance of features in the input layer.

Distance can be measured as a straight-line distance or by a specified travel mode. Statistics are then calculated for the nearby features, as in the following examples:

• Calculate the total population within 5 minutes of driving time of a proposed new store location.
• Calculate the number of freeway access ramps within a 1-mile driving distance of a proposed new store location to use as a measure of store accessibility.

Illustration

Usage

• This tool requires two input layers: a layer from which distances will be measured and a layer to summarize. Both layers can be points, lines, or areas. The first input layer can contain up to 1,000 features.

• The nearby distance can be based on a line distance or several different travel modes using time or distance as the measure. Travel modes are only enabled when the first input layer contains point features. You can create multiple output areas by inputting multiple distances or times.

• Some travel modes have an option for using traffic conditions. When traffic conditions are used, they can be based on live conditions or typical conditions for a specified day of the week and time. Live traffic conditions can be offset up to 12 hours from the current time. Times for typical conditions can be set by 15-minute intervals for the entire day and night.

• Travel modes can be configured by the administrator of your organization. The administrator can also add new travel modes or remove travel modes that are not necessary for your organization. The default distance measure will be in miles or kilometers, depending on the units setting in your profile.

Parameters

Dialog

Label	Explanation	Data Type
Input Nearby Layer	Point, line, or polygon features from which distances will be measured to features in the input summary layer.	Feature Set
Input Summary Features	Point, line, or polygon features. Features in this layer that are within the specified distance to features in the input nearby layer will be summarized.	Feature Set
Output Name	The name of the output layer that will be created on your portal.	String
Distance Measurement	Specifies the distance measurement that will be used: straight-line distance or by measuring travel time or travel distance along a street network using various modes of transportation known as travel modes. Straight-line—Straight-line Euclidean measurement of distance will be used. This is the default. Driving distance—Distance as driven in an automobile will be used. Driving time—Distance covered during a specified driving time in an automobile will be used. Trucking distance—Distance as driven in a truck will be used. Trucking time—Distance covered during a specified driving time in a truck will be used. Walking distance—Distance as walked along a street will be used. Walking time—Distance covered during a specified walking time will be used.	String
Distances (Optional)	A list of double values that defines the search distance (for straight-line and distance-based travel modes) or time (for time-based travel modes). A single distance value or multiple values can be provided. Features that are within (or equal to) the distances provided will be summarized. The units of the distance values is supplied by the Distance Units parameter value.	Double
Distance Units (Optional)	If the distance is straight-line or a distance-based travel mode, this is the linear unit that will be used with the distance values specified in the Distances parameter. The options are miles, feet, kilometers, meters, and yards. If the distance is a time-based travel mode, the options are seconds, minutes, and hours. Miles—The units will be miles. Feet—The units will be feet. Kilometers—The units will be kilometers. Meters—The units will be meters. Yards—The units will be yards. Seconds—The units will be seconds. Minutes—The units will be minutes. Hours—The units will be hours.	String
Time Of Day (Optional)	The time and date when travel times will consider traffic conditions. To use traffic in the analysis, you must set the distance to a travel time-based mode. The time of day value represents the time at which travel begins, or departs, from the input points. Two kinds of traffic are supported: typical and live. Typical traffic references travel speeds that are composed of historical averages for each 5-minute interval spanning a week. Live traffic retrieves speeds from a traffic feed that processes phone probe records, sensors, and other data sources to record actual travel speeds and predict speeds for the near future. To ensure that the task uses typical traffic in locations where it is available, provide a time and day of the week and convert the day of the week to one of the following dates from 1990: Monday—1/1/1990 Tuesday—1/2/1990 Wednesday—1/3/1990 Thursday—1/4/1990 Friday—1/5/1990 Saturday—1/6/1990 Sunday—1/7/1990 Although the dates representing days of the week are from 1990, typical traffic is calculated from recent traffic trends—usually over the last several months. To use live traffic when and where it is available, choose a date and time within 12 hours of the current time. Esrisaves live traffic data for 12 hours and references predictive data extending 12 hours into the future. If the time and date you provide for this parameter are outside the 24-hour time window, or the travel time in the analysis continues past the predictive data window, the task will use typical traffic speeds.	Date
Time Zone (Optional)	Specifies the time zone or zones of the specified time of day. Geolocal—The time of day value refers to the time zone or zones where the input points are located. This option causes the analysis to have rolling start times across time zones. This is the default. Coordinated Universal Time (UTC)—The time of day value refers to coordinated universal time (UTC). The start times for all points are simultaneous, regardless of time zones.	String
Return boundaries (Optional)	Specifies whether the input geometries or the straight-line or travel mode buffer geometry will be returned. Checked—The output layer will contain areas defined by the Distance Measurement parameter value. For example, if using a straight-line distance of 5 miles, the output will contain areas within a 5-mile radius around the input nearby layer features. This is the default. Unchecked—The output layer will contain the same features as the input nearby layer.	Boolean
Add shape summary attributes (Optional)	Specifies whether statistics will be calculated based on the shape of the Input Summary Features parameter value, such as the length of lines or areas of polygons of the summary features within each polygon in the input summary layer. Checked—Statistics will be calculated based on the shape summary attributes. This is the default. Unchecked—Statistics will not be calculated based on the shape summary attributes.	Boolean
Shape Unit (Optional)	Specifies the units that will be used for the shape summary. When the input summary features are polygons, the valid options are acres, hectares, square meters, square kilometers, square feet, square yards, and square miles. When the input summary features are lines, the valid options are miles, feet, kilometers, meters, and yards. Miles—The units will be miles. Feet—The units will be feet. Kilometers—The units will be kilometers. Meters—The units will be meters. Yards—The units will be yards. Acres—The units will be acres. Hectares—The units will be hectares. Square meters—The units will be square meters. Square kilometers—The units will be square kilometers. Square feet—The units will be square feet. Square yards—The units will be square yards. Square miles—The units will be square miles.	String
Summary Fields (Optional)	A list of field names and statistical summary type that will be calculated for all points within each polygon. The count of points within each polygon is always returned. The following statistic types are supported: Sum—The total value will be calculated. Minimum—The smallest value will be identified. Max—The largest value will be identified. Mean—The average or mean value will be calculated. Standard deviation—The standard deviation will be calculated.	Value Table
Group By Field (Optional)	A field from the input summary features that will be used to calculate statistics separately for each unique attribute value. For example, the input summary features contain point locations of businesses that store hazardous materials, and the HazardClass field contains codes that describe the type of hazardous material stored. To calculate summaries by each unique value of the HazardClass field, use it as the group by field.	Field
Add minority and majority attributes (Optional)	Specifies whether minority and majority fields will be added to the output. This parameter only applies when using a group by field. Unchecked—Minority and majority fields will not be added to the output. This is the default. Checked—The minority (least dominant) or the majority (most dominant) attribute values for each group field within each boundary will be calculated, and two new fields prefixed with Minority_ and Majority_ will be added to the output.	Boolean
Add group percentages (Optional)	Specifies whether group percentage fields will be added to the output. This parameter only applies when using a group by field. Unchecked—Percentage fields will not be added to the output. This is the default. Checked—The percentage of each unique group value will be calculated for each input nearby feature, and percentage fields will be added to the output.	Boolean

Derived Output

Label	Explanation	Data Type
Output Feature Service	The output summarized layer.	Feature Set
Output Group Table	If a group by field was provided, the tool will output a table that contains the calculated statistics for each unique group.	Record Set

Python

arcpy.sfa.SummarizeNearby(sumNearbyLayer, summaryLayer, outputName, nearType, {distances}, {units}, {timeOfDay}, {timeZoneForTimeOfDay}, {returnBoundaries}, {sumShape}, {shapeUnits}, {summaryFields}, {groupByField}, {minorityMajority}, {percentShape})

Name	Explanation	Data Type
sumNearbyLayer	Point, line, or polygon features from which distances will be measured to features in the input summary layer.	Feature Set
summaryLayer	Point, line, or polygon features. Features in this layer that are within the specified distance to features in the input nearby layer will be summarized.	Feature Set
outputName	The name of the output layer that will be created on your portal.	String
nearType	Specifies the distance measurement that will be used: straight-line distance or by measuring travel time or travel distance along a street network using various modes of transportation known as travel modes. STRAIGHTLINE—Straight-line Euclidean measurement of distance will be used. This is the default. DRIVINGDISTANCE—Distance as driven in an automobile will be used. DRIVINGTIME—Distance covered during a specified driving time in an automobile will be used. TRUCKINGDISTANCE—Distance as driven in a truck will be used. TRUCKINGTIME—Distance covered during a specified driving time in a truck will be used. WALKINGDISTANCE—Distance as walked along a street will be used. WALKINGTIME—Distance covered during a specified walking time will be used.	String
distances [distances,...] (Optional)	A list of double values that defines the search distance (for straight-line and distance-based travel modes) or time (for time-based travel modes). A single distance value or multiple values can be provided. Features that are within (or equal to) the distances provided will be summarized. The units of the distance values is supplied by the units parameter value.	Double
units (Optional)	If the distance is straight-line or a distance-based travel mode, this is the linear unit that will be used with the distance values specified in the distances parameter. The options are miles, feet, kilometers, meters, and yards. If the distance is a time-based travel mode, the options are seconds, minutes, and hours. MILES—The units will be miles. FEET—The units will be feet. KILOMETERS—The units will be kilometers. METERS—The units will be meters. YARDS—The units will be yards. SECONDS—The units will be seconds. MINUTES—The units will be minutes. HOURS—The units will be hours.	String
timeOfDay (Optional)	The time and date when travel times will consider traffic conditions. To use traffic in the analysis, you must set the distance to a travel time-based mode. The time of day value represents the time at which travel begins, or departs, from the input points. Two kinds of traffic are supported: typical and live. Typical traffic references travel speeds that are composed of historical averages for each 5-minute interval spanning a week. Live traffic retrieves speeds from a traffic feed that processes phone probe records, sensors, and other data sources to record actual travel speeds and predict speeds for the near future. To ensure that the task uses typical traffic in locations where it is available, provide a time and day of the week and convert the day of the week to one of the following dates from 1990: Monday—1/1/1990 Tuesday—1/2/1990 Wednesday—1/3/1990 Thursday—1/4/1990 Friday—1/5/1990 Saturday—1/6/1990 Sunday—1/7/1990 Although the dates representing days of the week are from 1990, typical traffic is calculated from recent traffic trends—usually over the last several months. To use live traffic when and where it is available, choose a date and time within 12 hours of the current time. Esrisaves live traffic data for 12 hours and references predictive data extending 12 hours into the future. If the time and date you provide for this parameter are outside the 24-hour time window, or the travel time in the analysis continues past the predictive data window, the task will use typical traffic speeds.	Date
timeZoneForTimeOfDay (Optional)	Specifies the time zone or zones of the specified time of day. GEOLOCAL—The time of day value refers to the time zone or zones where the input points are located. This option causes the analysis to have rolling start times across time zones. This is the default. UTC—The time of day value refers to coordinated universal time (UTC). The start times for all points are simultaneous, regardless of time zones.	String
returnBoundaries (Optional)	Specifies whether the input geometries or the straight-line or travel mode buffer geometry will be returned. RETURN_BOUNDARIES—The output layer will contain areas defined by the nearType parameter value. For example, if using a straight-line distance of 5 miles, the output will contain areas within a 5-mile radius around the input nearby layer features. This is the default. RETURN_INPUT—The output layer will contain the same features as the input nearby layer.	Boolean
sumShape (Optional)	Specifies whether statistics will be calculated based on the shape of the summaryLayer parameter value, such as the length of lines or areas of polygons of the summary features within each polygon in the input summary layer. ADD_SHAPE_SUM—Statistics will be calculated based on the shape summary attributes. This is the default. NO_SHAPE_SUM—Statistics will not be calculated based on the shape summary attributes.	Boolean
shapeUnits (Optional)	Specifies the units that will be used for the shape summary. When the input summary features are polygons, the valid options are acres, hectares, square meters, square kilometers, square feet, square yards, and square miles. When the input summary features are lines, the valid options are miles, feet, kilometers, meters, and yards. MILES—The units will be miles. FEET—The units will be feet. KILOMETERS—The units will be kilometers. METERS—The units will be meters. YARDS—The units will be yards. ACRES—The units will be acres. HECTARES—The units will be hectares. SQUAREMETERS—The units will be square meters. SQUAREKILOMETERS—The units will be square kilometers. SQUAREFEET—The units will be square feet. SQUAREYARDS—The units will be square yards. SQUAREMILES—The units will be square miles.	String
summaryFields [[Field, Statistic],...] (Optional)	A list of field names and statistical summary type that will be calculated for all points within each polygon. The count of points within each polygon is always returned. The following statistic types are supported: SUM—The total value will be calculated. MIN—The smallest value will be identified. MAX—The largest value will be identified. MEAN—The average or mean value will be calculated. STD—The standard deviation will be calculated.	Value Table
groupByField (Optional)	A field from the input summary features that will be used to calculate statistics separately for each unique attribute value. For example, the input summary features contain point locations of businesses that store hazardous materials, and the HazardClass field contains codes that describe the type of hazardous material stored. To calculate summaries by each unique value of the HazardClass field, use it as the group by field.	Field
minorityMajority (Optional)	Specifies whether minority and majority fields will be added to the output. This parameter only applies when using a group by field. NO_MIN_MAJ—Minority and majority fields will not be added to the output. This is the default. ADD_MIN_MAJ—The minority (least dominant) or the majority (most dominant) attribute values for each group field within each boundary will be calculated, and two new fields prefixed with Minority_ and Majority_ will be added to the output.	Boolean
percentShape (Optional)	Specifies whether group percentage fields will be added to the output. This parameter only applies when using a group by field. NO_PERCENT—Percentage fields will not be added to the output. This is the default. ADD_PERCENT—The percentage of each unique group value will be calculated for each input nearby feature, and percentage fields will be added to the output.	Boolean

Derived Output

Name	Explanation	Data Type
resultLayer	The output summarized layer.	Feature Set
groupBySummary	If a group by field was provided, the tool will output a table that contains the calculated statistics for each unique group.	Record Set

Environments

Extent

Licensing information

• Basic: Requires your account in ArcGIS Enterprise to have the Perform Analysis privilege
• Standard: Requires your account in ArcGIS Enterprise to have the Perform Analysis privilege
• Advanced: Requires your account in ArcGIS Enterprise to have the Perform Analysis privilege