ServiceAreaSolverProperties

Resumen

Provides access to analysis properties from a service area network analysis layer. The GetSolverProperties function is used to obtain a ServiceAreaSolverProperties object from a service area network analysis layer.

Debate

The ServiceAreaSolverProperties object provides read and write access to all the analysis properties of a service area network analysis layer. The object can be used to modify the desired analysis properties of the service area layer, and the corresponding layer can be resolved to determine the appropriate results. A new service area layer can be created using the Make Service Area Analysis Layer geoprocessing tool. Obtaining the ServiceAreaSolverProperties object from a new service area layer allows you to reuse the existing layer for subsequent analyses rather than create a layer for each analysis, which can be slow.

After modifying the properties of the ServiceAreaSolverProperties object, the corresponding layer can be immediately used with other functions and geoprocessing tools. There is no refresh or update of the layer required to honor the changes modified through the object.

Propiedades

Propiedad	Explicación	Tipo de datos
accumulators (Lectura y escritura)	Provides the ability to get or set a list of network cost attributes that are accumulated as part of the analysis. An empty list, [], indicates that no cost attributes are accumulated.	String
attributeParameters (Lectura y escritura)	Provides the ability to get or set the parameterized attributes to be used in the analysis. The property returns a Python dictionary. The dictionary key is a two-value tuple consisting of the attribute name and the parameter name. The value for each item in the dictionary is the parameter value. Parameterized network attributes are used to model some dynamic aspect of an attribute's value. For example, a tunnel with a height restriction of 12 feet can be modeled using a parameter. In this case, the vehicle's height in feet should be specified as the parameter value. If the vehicle is taller than 12 feet, this restriction will then evaluate to True, thereby restricting travel through the tunnel. Similarly, a bridge could have a parameter to specify a weight restriction. Attempting to modify the attributeParameters property in place won't result in updated values. Instead, you should always use a new dictionary object to set values for the property. The following two code blocks demonstrate the difference between these two approaches. Do not attempt to modify the attributeParameters property in place; this coding method will not work. solverProps.attributeParameters[('HeightRestriction', 'RestrictionUsage')] = "PROHIBITED" Modify the attributeParameters property using a new dictionary object. params = solverProps.attributeParameters params[('HeightRestriction', 'RestrictionUsage')] = "PROHIBITED" solverProps.attributeParameters = params If the network analysis layer does not have parameterized attributes, this property returns None.	Dictionary
defaultBreaks (Lectura y escritura)	Provides the ability to get or set the impedance values, indicating the extent of the service area to be calculated. Multiple polygon breaks can be set to create concentric service areas. For instance, to find 2-, 3-, and 5-minute service areas for the same facility, specify the value as [2, 3, 5].	Double
excludeSources (Lectura y escritura)	Provides the ability to get or set the list of network sources to be excluded when generating the polygons. The geometry of traversed elements from the excluded sources will be omitted from all polygons. An empty list, [], indicates that no network sources are excluded.	String
ignoreInvalidLocations (Lectura y escritura)	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. SKIP—Invalid input locations will be ignored so that the analysis will succeed using only valid locations. This value may also be specified using a Boolean value of True. HALT—Invalid locations will not be ignored and will cause the analysis to fail. This value may also be specified using a Boolean value of False.	String
impedance (Lectura y escritura)	Provides the ability to get or set the network cost attribute used as impedance. This cost attribute is accumulated while determining the service area.	String
includeNetworkSourceFields (Lectura y escritura)	Controls whether additional fields from the underlying source features traversed during the analysis are added to the service area lines. The following is a list of possible values: LINES_SOURCE_FIELDS— Add the SourceID, SourceOID, FromPosition, and ToPosition fields to the service area lines to hold information about the underlying source features traversed during the analysis. This can be useful to join the results of the service area lines to the original source data. A value of True can also be used to specify this option. NO_LINES_SOURCE_FIELDS—Do not add the source fields (SourceID, SourceOID, FromPosition, and ToPosition) to the service area lines. A value of False can also be used to specify this option.	String
lineOverlap (Lectura y escritura)	Controls whether overlapping lines are generated when the service area lines are computed. The following is a list of possible values: OVERLAP— Include a separate line feature for each facility when the facilities have service area lines that are coincident. A value of True can also be used to specify this option. NON_OVERLAP— Include each service area line once and associate it with its closest (least impedance) facility. A value of False can also be used to specify this option.	String
lineType (Lectura y escritura)	Provides the ability to get or set the type of service area lines to be generated from the analysis. The following is a list of possible values: NO_LINES—Do not generate lines. TRUE_LINES—Lines are generated without measures. TRUE_LINES_WITH_MEASURES—Lines are generated with measures. The measure values are generated based on the impedance value on each end of the edge with the intermediate vertices interpolated. Do not use this option if faster performance is desired.	String
polygonMerge (Lectura y escritura)	Controls whether polygons that share similar break values are merged. This option is applicable only when generating polygons for multiple facilities. The following is a list of possible values: NO_MERGE—Create individual polygons for each facility. The polygons can overlap each other. NO_OVERLAP—Create individual polygons that are closest for each facility. The polygons do not overlap each other. MERGE— Join the polygons of multiple facilities that have the same break value.	String
polygonNesting (Lectura y escritura)	Controls whether concentric service area polygons are created as disks or rings. This option is applicable only when multiple break values are specified for the facilities. The following is a list of possible values: RINGS—Do not include the area of the smaller breaks. This creates polygons going between consecutive breaks. Use this option if you want to find the area from one break to another. A value of True can also be used to specify this option. DISKS— Create the polygons going from the facility to the break. For instance, If you create 5- and 10-minute service areas, then the 10-minute service area polygon will include the area under the 5-minute service area polygon. Use this option if you want to find the entire area from the facility to the break for each break. A value of False can also be used to specify this option.	String
polygonType (Lectura y escritura)	Provides the ability to get or set the type of polygons to be generated. The following is a list of possible values: SIMPLE_POLYS—Create generalized polygons that are generated quickly and are fairly accurate, except on the fringes. DETAILED_POLYS—Create detailed polygons that accurately model the service area lines and may contain islands of unreached areas. This option is a lot slower than generating generalized polygons. NO_POLYS—Turns off polygon generation for the case in which only service area lines are desired.	String
restrictions (Lectura y escritura)	Provides the ability to get or set a list of restriction attributes that are applied for the analysis. An empty list, [], indicates that no restriction attributes are used for the analysis.	String
solverName (Sólo lectura)	Returns the name of the solver being referenced by the network analysis layer used to obtain the solver properties object. The property always returns the string value Service Area Solver when accessed from a ServiceAreaSolverProperties object.	String
splitLinesAtBreaks (Lectura y escritura)	Controls whether service area lines are split when they cross a break value. The following is a list of possible values: SPLIT—Split every line between two breaks into two lines, each lying within its break. This is useful if you want to symbolize the service area lines by break; otherwise, use the NO_SPLIT option for optimal performance. NO_SPLIT—The lines are not split at the boundaries of the breaks.	String
timeOfDay (Lectura y escritura)	Provides the ability to get or set the time to depart from or arrive at the facilities. The interpretation of this value depends on whether travel is toward or away from the facilities. It represents the departure time if the travelDirection property is set to TRAVEL_FROM and represents the arrival time if the travelDirection property is set to TRAVEL_TO. A value of None can be used to specify that no date and time should be used. Instead of using a particular date, a day of the week can be specified using the following dates: Hoy, 30/12/1899 Domingo, 31/12/1899 Lunes, 1/1/1900 Martes, 2/1/1900 Miércoles, 3/1/1900 Jueves, 4/1/1900 Viernes, 5/1/1900 Sábado, 6/1/1900 For example, to specify that the departure from facilities should occur at 8:00 a.m. on Friday, specify the value as datetime.datetime(1900, 1, 5, 8,0,0). The timeZoneUsage parameter specifies whether the date and time refer to UTC or the time zone in which the facilities are located.	DateTime
timeZoneUsage (Lectura y escritura)	Specifies the time zone or zones of the timeOfDay parameter. GEO_LOCAL—The timeOfDay parameter refers to the time zone or zones in which the facilities are located. Therefore, the start or end times of the service areas are staggered by time zone.Setting timeOfDay to 9:00 a.m., choosing GEO_LOCAL, then solving causes service areas to be generated for 9:00 a.m. Eastern Time for any facilities in the Eastern Time Zone, 9:00 a.m. Central Time for facilities in the Central Time Zone, 9:00 a.m. Mountain Time for facilities in the Mountain Time Zone, and so on, for facilities in different time zones. The time is always 9:00 a.m. local time, but staggered in real time.If stores in a chain that span the U.S. open at 9:00 a.m. local time, this parameter value could be chosen to find market territories at opening time for all stores in one solve. First, the stores in the Eastern Time Zone open and a polygon is generated, stores open an hour later in Central Time, and so on. UTC—The timeOfDay parameter refers to Coordinated Universal Time (UTC). Therefore, all facilities are reached or departed from simultaneously, regardless of the time zone or zones they are in.Setting timeOfDay to 2:00 p.m., choosing UTC, then solving causes service areas to be generated for 9:00 a.m. Eastern Standard Time for any facilities in the Eastern Time Zone, 8:00 a.m. Central Standard Time for facilities in the Central Time Zone, 7:00 a.m. Mountain Standard Time for facilities in the Mountain Time Zone, and so on, for facilities in different time zones. Nota: The scenario above assumes standard time. During daylight saving time, the Eastern, Central, and Mountain times would each be one hour ahead (that is, 10:00, 9:00, and 8:00 a.m., respectively). One of the cases in which the UTC option is useful is to visualize emergency-response coverage for a jurisdiction that is split into two time zones. The emergency vehicles are loaded as facilities. timeOfDay is set to now in UTC. (You need to determine the current time and date in UTC to correctly use this option.) Other properties are set, and the analysis is solved. Even though a time-zone boundary divides the vehicles, the results show areas that can be reached given current traffic conditions. This same process can be used for other times as well, not just for now. Irrespective of the timeZoneUsage setting, all facilities must be in the same time zone when timeOfDay has a nonnull value and polygonMerge is set to create merged or nonoverlapping polygons.	String
travelDirection (Lectura y escritura)	Controls the direction in which the impedance is accumulated during service area analysis. The following is a list of possible values: TRAVEL_FROM—The service area is created in the direction away from the facilities. TRAVEL_TO—The service area is created in the direction toward the facilities.	String
travelMode (Sólo lectura)	Accesses the travel mode set on a network analysis layer as an arcpy.na.TravelMode object.	Object
trimDistance (Lectura y escritura)	Provides the ability to get or set the distance within which the service area polygons are trimmed. The property value includes a numeric value and a unit for the distance separated by a space; for example, to specify a trim distance of 100 Meters, use "100 Meters".	String
trimPolygons (Lectura y escritura)	Controls whether the service area polygons are trimmed. The following is a list of possible values: TRIM_POLYS—Trim the polygons containing the edges at the periphery of the service area to be within the specified distance of these outer edges. This is useful if the network is very sparse and you don't want the service area to cover large areas where there are no features. A value of True can also be used to specify this option. NO_TRIM_POLYS—Do not trim polygons. A value of False can also be used to specify this option.	String
useHierarchy (Lectura y escritura)	Controls the use of the hierarchy attribute while performing the analysis. The following is a list of possible values: USE_HIERARCHY— Use the hierarchy attribute for the analysis. Using a hierarchy results in the solver preferring higher-order edges to lower-order edges. Hierarchical solves are faster, and they can be used to simulate the preference of a driver who chooses to travel on freeways over local roads when possible—even if that means a longer trip. This option is applicable only if the network dataset referenced by the Network Analyst layer has a hierarchy attribute. A value of True can also be used to specify this option. NO_HIERARCHY—Do not use the hierarchy attribute for the analysis. Not using a hierarchy yields an exact route for the network dataset. A value of False can also be used to specify this option.	String
uTurns (Lectura y escritura)	Provides the ability to get or set the policy that indicates how the U-turns at junctions that could occur during network traversal between stops are being managed by the solver. The following is a list of possible values: ALLOW_UTURNS—U-turns are permitted at junctions with any number of connected edges. NO_UTURNS—U-turns are prohibited at all junctions, regardless of junction valency. Note that U-turns are still permitted at network locations even when this setting is chosen; however, you can set the individual network locations' CurbApproach property to prohibit U-turns there as well. ALLOW_DEAD_ENDS_ONLY—U-turns are prohibited at all junctions, except those that have only one adjacent edge (a dead end). ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY—U-turns are prohibited at junctions where exactly two adjacent edges meet but are permitted at intersections (junctions with three or more adjacent edges) and dead ends (junctions with exactly one adjacent edge). Often, networks have extraneous junctions in the middle of road segments. This option prevents vehicles from making U-turns at these locations.	String

Descripción general del método

Método	Explicación
applyTravelMode (travel_mode)	Updates the analysis properties of a network analyst layer based on a travel mode object. The updated network analyst layer can then be solved to complete the analysis.

Métodos

applyTravelMode (travel_mode)

Parámetro	Explicación	Tipo de datos
travel_mode	A variable that references a travel mode object derived from a network dataset. A list of travel mode objects can be obtained by calling the arcpy.na.GetTravelModes function.	Object

When a network analyst layer is created, it is assigned default values for all of its analysis properties. The individual analysis properties can be updated using a solver properties object obtained from the network analyst layer. A travel mode stores a predefined set of analysis settings that help to perform a particular analysis, such as a walking time travel mode that stores the analysis settings required to perform a time-based walking analysis.

Using the applyTravelMode method, all the analysis settings that are defined in a travel mode can be applied at once. After the analysis properties are updated, the network analyst layer can be solved to complete the analysis.

If there is an error when updating the solver properties, such as when the provided travel mode references properties that don't exist on the current network dataset or references properties that are no longer applicable to the network dataset that was used to create the network analyst layer corresponding to the solver properties object, no exceptions are raised. The method will execute successfully, but you will get errors when you try to solve such a network analyst layer.

If the travel_mode parameter does not reference a travel mode object or a string, a TypeError exception is raised. If the travel_mode parameter references a string and the string cannot be internally converted to a valid string representation of a travel mode object, a ValueError exception is raised.

Muestra de código

ServiceAreaSolverProperties example 1 (stand-alone script)

This script shows how to update the Service Area solver properties through a full workflow. This is based on the tutorial network dataset of the San Francisco region.

# Name: ServiceAreaSolverProperties_Workflow.py
# Description: Finds the regions fire stations can reach within four minutes
#              as the initial assesment of the coverage of the region. We will
#              then change the break values to 1, 4, and 10 minutes to see a
#              better picture of coverage
# Requirements: Network Analyst Extension

# Import system modules
import arcpy
from arcpy import env
import os
import datetime

try:
    # Check out the Network Analyst license if available.
    # Fail if the Network Analyst
    # license is not available.
    if arcpy.CheckExtension("network") == "Available":
        arcpy.CheckOutExtension("network")
    else:
        raise arcpy.ExecuteError("Network Analyst Extension license is not available.")

    # Set environment settings
    output_dir = "C:\Data"

    # The NA layer's data will be saved to the workspace specified here
    env.workspace = os.path.join(output_dir, "Output.gdb")
    env.overwriteOutput = True

    # Set local variables
    input_gdb = "C:/Data/SanFrancisco.gdb"
    network = os.path.join(input_gdb, "Transportation", "Streets_ND")
    layer_name = "FireHouseRegions"
    travel_mode = "Driving Time"
    direction = "FROM_FACILITIES"
    cutoffs = 4
    in_facilities = os.path.join(input_gdb, "Analysis/FireStations")
    four_minute_polygons = os.path.join(output_dir, "Output.gdb", "four_minute_polygons")
    ten_minute_polygons = os.path.join(output_dir, "Output.gdb", "ten_minute_polygons")


    # Create a new Service Area layer. Fire stations are concerned with the
    # drive times away from the fire stations to the incidents.
    result_object = arcpy.na.MakeServiceAreaAnalysisLayer(network,
                                            layer_name, travel_mode,
                                            direction, cutoffs)

    # Get the layer object form the result object. The service area layer
    # can now be referenced using the layer object.
    layer_object = result_object.getOutput(0)

    # Get the names of all the sublayers within the service area layer.
    sub_layer_names = arcpy.na.GetNAClassNames(layer_object)
    # Store the layer names that we will use later
    facilities_layer_name = sub_layer_names["Facilities"]
    polygons_layer_name = sub_layer_names["SAPolygons"]

    # Load the fire station locations as facilities.
    arcpy.na.AddLocations(layer_object, facilities_layer_name, in_facilities,
                          "", "")

    # Solve the service area layer
    arcpy.na.Solve(layer_object)

    # Save the resulting polygon sublayer
    arcpy.management.CopyFeatures(polygons_layer_name, four_minute_polygons)

    # Get the solver properties object from the service area layer
    solverProps = arcpy.na.GetSolverProperties(layer_object)

    # Update the breaks to 1, 4, and 10 minutes
    solverProps.defaultBreaks = [1, 4, 10]

    # Solve the service area layer
    arcpy.na.Solve(layer_object)

    # Save the resulting polygon sublayer
    arcpy.management.CopyFeatures(polygons_layer_name, ten_minute_polygons)


except Exception as e:
    # If an error occurred, print line number and error message
    import traceback
    import sys
    tb = sys.exc_info()[2]
    print ("An error occurred on line %i" % tb.tb_lineno)
    print (str(e))

ApplyTravelMode example 2 (Python window)

This script shows how to apply the TruckingTime travel mode to an existing layer.

#Get the service area layer object from a layer named "Service Area" in the map
doc = arcpy.mp.ArcGISProject('current')
map_obj = doc.listMaps()[0]
sa_layer = map_obj.listLayers('Service Area')[0]

#Get the Trucking Time travel mode from the network dataset
desc = arcpy.Describe(sa_layer)
travel_modes = arcpy.na.GetTravelModes(desc.network.catalogPath)
trucking_mode = travel_modes["Trucking Time"]

#Apply the travel mode to the analysis layer
solver_properties = arcpy.na.GetSolverProperties(sa_layer)
solver_properties.applyTravelMode(trucking_mode)