Skip to main content

Make Location-Allocation Analysis Layer (Network Analyst Tools)

Summary

Makes a location-allocation network analysis layer and sets its analysis properties. A location-allocation analysis layer is useful for choosing a given number of facilities from a set of potential locations so that a demand will be allocated to facilities in an optimal and efficient manner. The layer can be created using a local network dataset or a service hosted online or in a portal.

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

  • When ArcGIS Online or an ArcGIS Enterprise portal whose routing services are configured using ArcGIS Online is used as the input network data source, solving the analysis will consume credits and will be subject to certain limits, such as the number of allowed inputs.

    Learn more about credit consumption and analysis limits in network analysis

  • 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.

Parameters

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 URL for ArcGIS Online or an ArcGIS Enterprise portal configured with standard routing services

To use a portal URL, you must be signed in to the portal with an account that has routing privileges.

Learn more about network analysis using routing services

When using ArcGIS Online or an ArcGIS Enterprise portal whose routing services are configured using ArcGIS Online as the input network, solving the analysis will consume credits and will be subject to certain limits, such as the number of allowed inputs.

Learn more about credit consumption and analysis limits in network analysis

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.

String

Travel Direction

(Optional)

Specifies the direction of travel between facilities and demand points when calculating the network costs.

The direction of travel may affect the allocation of the demand points to the facilities on a network with one-way restrictions and different impedances based on direction of travel. For instance, it may take 15 minutes to drive from the demand point to the facility but only 10 minutes when driving from the facility to the demand point.

  • Away from facilitiesDirection of travel is from facilities to demand points. This is the default. Fire departments commonly use this setting, since they are concerned with the time it takes to travel from the fire station to the location of the emergency.

  • Toward facilitiesDirection of travel is from demand points to facilities. Retail stores commonly use this setting, since they are concerned with the time it takes the shoppers to reach the store.

String

Problem Type

(Optional)

The problem type that will be solved. The choice of the problem type depends on the kind of facility being located. Different kinds of facilities have different priorities and constraints.

  • Minimize impedanceThis option solves the warehouse location problem. It selects a set of facilities so that the total sum of weighted impedances (demand at a location times the impedance to the closest facility) is minimized. This problem type is often known as the P-Median problem. This is the default problem type.

  • Maximize coverageThis option solves the fire station location problem. It selects facilities so that all or the greatest amount of demand is within a specified impedance cutoff.

  • Maximize capacitated coverageThis option solves the location problem in which facilities have a finite capacity. It selects facilities so that all or the greatest amount of demand can be served without exceeding the capacity of any facility. In addition to honoring capacity, it selects facilities so that the total sum of weighted impedance (demand allocated to a facility multiplied by the impedance to or from the facility) is minimized.

  • Minimize facilitiesThis option solves the fire station location problem. It selects the minimum number of facilities needed to cover all or the greatest amount of demand within a specified impedance cutoff.

  • Maximize attendanceThis option solves the neighborhood store location problem in which the proportion of demand allocated to the nearest chosen facility falls with increasing distance. The set of facilities that maximize the total allocated demand is selected. Demand greater than the specified impedance cutoff does not affect the selected set of facilities.

  • Maximize market shareThis option solves the competitive facility location problem. It selects facilities to maximize market share in the presence of competitive facilities. Gravity model concepts are used to determine the proportion of demand allocated to each facility. The set of facilities that maximizes the total allocated demand is selected.

  • Target market shareThis option solves the competitive facility location problem. It selects facilities to reach a specified target market share in the presence of competitive facilities. Gravity model concepts are used to determine the proportion of demand allocated to each facility. The minimum number of facilities needed to reach the specified target market share is selected.

String

Cutoff

(Optional)

The maximum impedance at which a demand point can be allocated to a facility in the units of the impedance attribute used by the specified Travel Mode value. The maximum impedance is measured by the least-cost path along the network. If a demand point is outside the cutoff, it is left unallocated. This parameter can be used to model the maximum distance that people are willing to travel to visit stores or the maximum time that is permitted for a fire department to reach anyone in the community.

This cutoff value can be overridden on a per-demand-point basis by specifying individual cutoff values in the demand points sublayer in the Cutoff_ [Impedance] property. For example, it may show that people in rural areas are willing to travel up to 10 miles to reach a facility, while people in the city are only willing to travel up to 2 miles. You can model this behavior by setting the cutoff value of the analysis layer to 10 and setting the Cutoff_Miles value of each demand point in urban areas to 2.

By default, no cutoff value is used for the analysis.

Double

Number of Facilities to Find

(Optional)

The number of facilities that the solver will locate. The default value is 1.

The facilities with a FacilityType value of Required are always part of the solution when there are more facilities to find than required facilities; any excess facilities to choose are picked from candidate facilities.

Any facilities that have a FacilityType value of Chosen before solving are treated as candidate facilities at solve time.

This parameter value is not considered for the Minimize facilities problem type since the solver searches for the minimum number of facilities to locate to maximize coverage.

This parameter value is overridden for the Target market share problem type because the solver searches for the minimum number of facilities required to capture the specified market share.

Long

Decay Function Type

(Optional)

The equation that will be used for transforming the network cost between facilities and demand points. This parameter, along with the Decay Function Parameter Value parameter, specifies how severely the network impedance between facilities and demand points influences the solver's selection of facilities.

Demand points have an ImpedanceTransformation property, which, if set, overrides the Decay Function Parameter Value parameter of the analysis layer on a per-demand-point basis. You may determine that the decay function should be different for urban and rural residents. You can model this by setting the impedance transformation for the analysis layer to match that of rural residents and setting the impedance transformation for the individual demand points located in urban areas to match that of urbanites.

  • LinearThe transformed network impedance between the facility and the demand point is the same as the shortest-path network impedance between them. With this option, the impedance parameter is always set to 1. This is the default.

  • PowerThe transformed network impedance between the facility and the demand point is equal to the shortest-path network impedance raised to the power specified by the impedance parameter. Use this option with a positive impedance parameter to specify higher weight to nearby facilities.

  • ExponentialThe transformed network impedance between the facility and the demand point is equal to the mathematical constant e raised to the power specified by the shortest-path network impedance multiplied with the impedance parameter. Use this option with a positive impedance parameter to specify a very high weight to nearby facilities.Exponential transformations are commonly used in conjunction with an impedance cutoff.

String

Decay Function Parameter Value

(Optional)

A parameter value for the equations specified in the Decay Function Type parameter. This parameter value is ignored when the Decay Function Type parameter is set to Linear. For the Power and Exponential options, the value should not be zero.

Demand points have an ImpedanceTransformation property, which, if set, overrides the Decay Function Parameter Value parameter of the analysis layer on a per-demand-point basis. You may determine that the decay function should be different for urban and rural residents. You can model this by setting the impedance transformation for the analysis layer to match that of rural residents and setting the impedance transformation for the individual demand points located in urban areas to match that of urbanites.

Double

Target Market Share

(Optional)

The target market share, as a percentage, to solve for when the Problem Type parameter is set to Target market share. It is the percentage of the total demand weight that you want the solution facilities to capture. The solver selects the minimum number of facilities required to capture the target market share specified by this numeric value.

Double

Capacity

(Optional)

The default capacity of facilities when the Problem Type parameter is set to Maximize capacitated coverage. This parameter is ignored for all other problem types.

Facilities have a Capacity property, which, if set to a nonnull value, overrides the Capacity parameter value for that facility.

Double

Time of Day

(Optional)

The time and date of departure. The departure time can be from facilities or demand points, depending on whether Travel Direction is set to Toward facilities or Away from facilities.

If you chose a traffic-based impedance attribute, the solution will be generated given dynamic traffic conditions at the time of day specified here. A date and time can be specified as 5/14/2012 10:30 AM.

Configure the analysis to use one of the following special dates to model a day of the week or the current date instead of a specific, static date:

  • Today—12/30/1899

  • Sunday—12/31/1899

  • Monday—1/1/1900

  • Tuesday—1/2/1900

  • Wednesday—1/3/1900

  • Thursday—1/4/1900

  • Friday—1/5/1900

  • Saturday—1/6/1900

Learn more about how dates and times are used and interpreted in a network analysis

Date

Time Zone

(Optional)

The time zone of the Time of Day parameter.

  • Local time at locationsThe time of day parameter refers to the time zone in which the facilities or demand points are located. If the travel direction is facilities to demand points, this is the time zone of the facilities. If the travel direction is demand points to facilities, this is the time zone of the demand points. This is the default.

  • UTCThe time of day parameter refers to coordinated universal time (UTC). Choose this option if you want the best location for a specific time, such as now, but aren't certain in which time zone the facilities or demand points will be located.

String

Line Shape

(Optional)

Specifies the output line shape.

Regardless of the output shape type specified, the best route is always determined by the network impedance, not Euclidean distance. This means that only the route shapes are different, not the underlying traversal of the network.

  • No linesNo shape will be generated for the output of the analysis. This is useful if you are solving a very large problem and are interested only in a solution table and are not interested in visualizing the results on a map.

  • Straight linesThe output line shapes will be straight lines connecting the solution facilities to their allocated demand points. This is the default.

String

Accumulate Attributes

(Optional)

A list of cost attributes to be accumulated during analysis. These accumulated attributes are for reference only; the solver only uses the cost attribute used by the designated travel mode when solving the analysis.

For each cost attribute that is accumulated, a Total_ [Impedance] property is populated in the network analysis output features.

This parameter is not available if the network data source is an ArcGIS Online service or the network data source is a service on a version of Portal for ArcGIS that does not support accumulation.

String

Ignore Invalid Locations at Solve Time

(Optional)

Specifies whether invalid input locations will be ignored. Typically, locations are invalid if they cannot be located on the network. When invalid locations are ignored, the solver will skip them and attempt to perform the analysis using the remaining locations.

  • CheckedInvalid input locations will be ignored and only valid locations will be used. This is the default.

  • UncheckedAll input locations will be used. Invalid locations will cause the analysis to fail.

Boolean

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 newly created network analysis layer.

Network Analyst Layer

Environments

Current Workspace

Licensing information

  • Basic: Yes
  • Standard: Yes
  • Advanced: Yes