Make Waste Collection Analysis Layer (Network Analyst Tools)

Summary

Creates a waste collection network analysis layer and sets its analysis properties. A waste collection analysis layer is useful for optimizing a set of routes using a fleet of vehicles to pick up municipal waste. The layer can be created using a network dataset.

Usage

This tool is typically used as the first step in a network analysis workflow. Once the layer is created, you can add inputs to it using the Add Locations tool and solve the analysis using the Solve tool.

Learn more about the network analysis layer workflow
The analysis network used for a waste collection analysis must have at least one travel mode, one cost attribute with time units, and one cost attribute with distance units.
By default, the new analysis layer's data will be created in a new, automatically-named feature dataset in the Current Workspace geoprocessing environment, which is usually the project geodatabase. Table-based data will be created at the root level of the same geodatabase because tables cannot be stored in a feature dataset. You can override this behavior using the Analysis Geodatabase and Analysis Feature Dataset Name parameters.
Although this tool can be used in a Python script, the recommended best practice for performing network analysis in Python is to use the solver classes in the arcpy.nax module instead.

Learn more about performing network analysis in Python.

Label	Explanation	Data type
Network Data Source	The network dataset or service on which the network analysis will be performed. The parameter can be specified using the following: The catalog path to a network dataset. A network dataset layer The network must have at least one travel mode, one cost attribute with time units, and one cost attribute with distance units.	Network Dataset Layer; String
Layer Name (Optional)	The name of the network analysis layer that will be created.	String
Travel Mode (Optional)	The name of the travel mode that will be used in the analysis. The travel mode represents a collection of network settings, such as travel restrictions and U-turn policies, that determine how a pedestrian, car, truck, or other medium of transportation moves through the network. Travel modes are defined on your network data source. An `arcpy.na.TravelMode` object and a string containing the valid JSON representation of a travel mode can also be used as input to this parameter. The travel mode's impedance attribute must have units of time. For waste collection analysis, U-turns must be allowed at dead ends. If the travel mode does not allow any U-turns, the solver will relax the travel mode's U-turn policy to allow U-turns at dead ends.	String
Time Units (Optional)	Specifies the time units that will be used by the analysis layer's properties and the temporal fields of the analysis layer's sublayers and tables (network analysis classes). This value does not need to match the units of the time cost attribute. Minutes—The time units will be minutes. This is the default. Seconds—The time units will be seconds. Hours—The time units will be hours. Days—The time units will be days.	String
Distance Units (Optional)	Specifies the distance units that will be used by the analysis layer's properties and the distance fields of the analysis layer's sublayers and tables (network analysis classes). This value does not need to match the units of the optional distance cost attribute. Miles—The distance units will be miles. This is the default. Kilometers—The distance units will be kilometers. Feet—The distance units will be feet. Yards—The distance units will be yards. Meters—The distance units will be meters. Inches—The distance units will be inches. Centimeters—The distance units will be centimeters. Millimeters—The distance units will be millimeters. Decimeters—The distance units will be decimeters. Nautical Miles—The distance units will be nautical miles.	String
Route Start Time (Optional)	The default start time for routes. This time of day is used for all routes for which the `StartTime` field in the Routes sublayer is null. When no parameter value is specified, all rows in the Routes sublayer must specify a value in the `StartTime` field. Although you can specify both a date and a time for this parameter, only the time is used.	Date
Max Route Total Time (Optional)	The maximum allowed total time for each route. The value can be any positive number. This value will be used for all routes for which the `MaxTotalTime` field in the Routes sublayer is null. When no value is specified, all rows in the Routes sublayer must specify a value in the `MaxTotalTime` field. The value is interpreted in the units specified in the Time Units parameter.	Double
Stop Collection Mode (Optional)	Specifies the default stop collection mode for each stop. This value can be one of the options listed below, or it can be left blank (the default). This value will be used for all stops for which the `CollectionMode` field in the Stops sublayer is null. When no value is specified, all rows in the Stops sublayer must specify a value in the `CollectionMode` field. One Side—The two sides of the street on which this stop is located will be collected separately with different passes down the street edge. Both Sides—Both sides of the street on which this stop is located will be collected at once with a single pass down the street edge.	String
Analysis Geodatabase (Optional)	The file geodatabase workspace where the new network analysis layer's sublayer data will be stored. When this parameter is not specified, the sublayer data will be created in the Current Workspace geoprocessing environment, which is usually the project geodatabase. Learn more about the analysis data source of a network analysis layer	Workspace
Analysis Feature Dataset Name (Optional)	The name to use for the new feature dataset that the tool will create in the analysis geodatabase to store the network analysis layer's sublayer data. When not specified, the feature dataset will be created with a random unique name. Learn more about the analysis data source of a network analysis layer	String

Derived output

Label	Explanation	Data type
Network Analyst Layer	The new network analysis layer.	Network Analyst Layer

arcpy.na.MakeWasteCollectionAnalysisLayer(network_data_source, {layer_name}, {travel_mode}, {time_units}, {distance_units}, {route_start_time}, {max_route_total_time}, {stop_collection_mode}, {analysis_geodatabase}, {analysis_feature_dataset_name})

Name	Explanation	Data type
network_data_source	The network dataset or service on which the network analysis will be performed. The parameter can be specified using the following: The catalog path to the network dataset A network dataset layer object The string name of the network dataset layer The network must have at least one travel mode, one cost attribute with time units, and one cost attribute with distance units.	Network Dataset Layer; String
layer_name (Optional)	The name of the network analysis layer that will be created.	String
travel_mode (Optional)	The name of the travel mode that will be used in the analysis. The travel mode represents a collection of network settings, such as travel restrictions and U-turn policies, that determine how a pedestrian, car, truck, or other medium of transportation moves through the network. Travel modes are defined on your network data source. An `arcpy.na.TravelMode` object and a string containing the valid JSON representation of a travel mode can also be used as input to this parameter. The travel mode's impedance attribute must have units of time. For waste collection analysis, U-turns must be allowed at dead ends. If the travel mode does not allow any U-turns, the solver will relax the travel mode's U-turn policy to allow U-turns at dead ends.	String
time_units (Optional)	Specifies the time units that will be used by the analysis layer's properties and the temporal fields of the analysis layer's sublayers and tables (network analysis classes). This value does not need to match the units of the time cost attribute. `Minutes`—The time units will be minutes. This is the default. `Seconds`—The time units will be seconds. `Hours`—The time units will be hours. `Days`—The time units will be days.	String
distance_units (Optional)	Specifies the distance units that will be used by the analysis layer's properties and the distance fields of the analysis layer's sublayers and tables (network analysis classes). This value does not need to match the units of the optional distance cost attribute. `Miles`—The distance units will be miles. This is the default. `Kilometers`—The distance units will be kilometers. `Feet`—The distance units will be feet. `Yards`—The distance units will be yards. `Meters`—The distance units will be meters. `Inches`—The distance units will be inches. `Centimeters`—The distance units will be centimeters. `Millimeters`—The distance units will be millimeters. `Decimeters`—The distance units will be decimeters. `NauticalMiles`—The distance units will be nautical miles.	String
route_start_time (Optional)	The default start time for routes. This time of day is used for all routes for which the `StartTime` field in the Routes sublayer is null. When no parameter value is specified, all rows in the Routes sublayer must specify a value in the `StartTime` field. Specify this parameter value using a `datetime.time` object.	Date
max_route_total_time (Optional)	The maximum allowed total time for each route. The value can be any positive number. This value will be used for all routes for which the `MaxTotalTime` field in the Routes sublayer is null. When no value is specified, all rows in the Routes sublayer must specify a value in the `MaxTotalTime` field. The value is interpreted in the units specified in the `time_units` parameter.	Double
stop_collection_mode (Optional)	Specifies the default stop collection mode for each stop. This value can be one of the options listed below, or it can be left blank (the default). This value will be used for all stops for which the `CollectionMode` field in the Stops sublayer is null. When no value is specified, all rows in the Stops sublayer must specify a value in the `CollectionMode` field. `ONE_SIDE`—The two sides of the street on which this stop is located will be collected separately with different passes down the street edge. `BOTH_SIDES`—Both sides of the street on which this stop is located will be collected at once with a single pass down the street edge.	String
analysis_geodatabase (Optional)	The file geodatabase workspace where the new network analysis layer's sublayer data will be stored. When this parameter is not specified, the sublayer data will be created in the Current Workspace geoprocessing environment, which is usually the project geodatabase. Learn more about the analysis data source of a network analysis layer	Workspace
analysis_feature_dataset_name (Optional)	The name to use for the new feature dataset that the tool will create in the analysis geodatabase to store the network analysis layer's sublayer data. When not specified, the feature dataset will be created with a random unique name. Learn more about the analysis data source of a network analysis layer	String

Derived output

Name	Explanation	Data type
out_network_analysis_layer	The new network analysis layer.	Network Analyst Layer

Code sample

Tip:

Although this tool can be used in a Python script, the recommended best practice for performing network analysis in Python is to use the solver classes in the arcpy.nax module instead. Learn more about performing network analysis in Python.

MakeWasteCollectionAnalysisLayer example 1 (Python window)

Run the MakeWasteCollectionAnalysisLayer function specifying a subset of parameters.

import datetime

arcpy.na.MakeWasteCollectionAnalysisLayer(
    r"C:\Data\SanFrancisco.gdb\Transportation\Streets_ND",
    "Waste Collection Option B",
    "Garbage Truck Time",
    time_units="Hours",
    max_route_total_time=6.5,
    route_start_time=datetime.time(6, 30, 0),
)

Environments

Current Workspace

Licensing information

Basic: Yes
Standard: Yes
Advanced: Yes

Make Waste Collection Analysis Layer (Network Analyst Tools)

Summary

Usage

Parameters

Derived output

Environments

Licensing information

Related topics