LocationAllocationSolverProperties (arcpy.na)

Récapitulatif

Permet d'accéder aux propriétés d'analyse à partir d'une couche d'analyse de réseau d'emplacement-allocation. La fonction GetSolverProperties permet d'obtenir un objet LocationAllocationSolverProperties à partir d'une couche d'analyse de réseau d'emplacement-allocation.

Discussion

L'objet LocationAllocationSolverProperties permet un accès en lecture et en écriture à toutes les propriétés d'analyse d'une couche d'analyse de réseau d'emplacement-allocation. L'objet permet de modifier les propriétés d'analyse souhaitées de la couche d'emplacement-allocation, et la couche correspondante peut être analysée à nouveau en vue de déterminer les résultats appropriés. Il est possible de créer une nouvelle couche d'emplacement-allocation à l'aide de l'outil de géotraitement Créer une couche emplacement-attribution. Obtenir l'objet LocationAllocationSolverProperties à partir d'une nouvelle couche de ressource emplacement-allocation permet de réutiliser la couche existante pour les analyses suivantes plutôt que de créer une couche pour chaque analyse, ce qui peut être un processus lent.

Une fois les propriétés de l'objet LocationAllocationSolverProperties modifiées, la couche correspondante peut être utilisée immédiatement avec d'autres fonctions et outils de géotraitement. Aucune actualisation ni mise à jour de la couche n'est requise pour respecter les changements effectués par l'intermédiaire de l'objet.

Propriétés

Propriété	Explication	Type de données
accumulators (Lecture/écriture)	Permet d'obtenir ou de définir une liste des attributs de coût du réseau cumulés dans le cadre de l'analyse. Une liste vide, [], indique qu'aucun attribut de coût n'est cumulé.	String
attributeParameters (Lecture/écriture)	Permet d'obtenir ou de définir les attributs paramétrés à utiliser dans l'analyse. La propriété retourne un dictionnaire Python. La clé de dictionnaire est un tuple à deux valeurs comprenant le nom de l'attribut et le nom du paramètre. La valeur de chaque élément du dictionnaire correspond à la valeur du paramètre. Les attributs de réseau paramétrés permettent de modéliser un aspect dynamique de la valeur d'un attribut. Par exemple, un tunnel avec une restriction de hauteur de 12 pieds peut être modélisé à l'aide d'un paramètre. Dans ce cas, la hauteur du véhicule en pieds doit être spécifiée en tant que valeur de paramètre. Si la hauteur du véhicule est supérieure à 12 pieds, cette restriction prend la valeur True, ce qui restreint le passage par le tunnel. De la même façon, un pont peut comporter un paramètre pour spécifier une restriction de poids. Toute tentative de modification de la propriété attributeParameters en place ne permet pas de mettre à jour les valeurs. Vous devez à la place toujours utiliser un nouvel objet dictionnaire pour définir des valeurs pour la propriété. Les deux blocs de code suivants montrent la différence entre ces deux approches. #Don't attempt to modify the attributeParameters property in place. #This coding method won't work. solverProps.attributeParameters[('HeightRestriction', 'RestrictionUsage')] = "PROHIBITED" #Modify the attributeParameters property using a new dictionary object. #This coding method works. params = solverProps.attributeParameters params[('HeightRestriction', 'RestrictionUsage')] = "PROHIBITED" solverProps.attributeParameters = params Si la couche d'analyse de réseau ne comporte pas d'attributs paramétrés, cette propriété retourne la valeur Aucun.	Dictionary
defaultCapacity (Lecture/écriture)	Provides the ability to get or set the default capacity of facilities when the location-allocation problemType 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 defaultCapacity parameter for that facility.	Double
facilitiesToFind (Lecture/écriture)	Provides the ability to get or set the number of facilities that the solver should locate. The property value is ignored if the problemType property is set to MINIMIZE_FACILITIES, since the solver determines the minimum number of facilities to locate to maximize coverage. The property value is also ignored if the problemType property is set to TARGET_MARKET_SHARE, because the solver searches for the minimum number of facilities required to capture the specified market share.	Integer
impedance (Lecture/écriture)	Provides the ability to get or set the network cost attribute used as impedance.	String
impedanceCutoff (Lecture/écriture)	Provides the ability to get or set the maximum impedance at which a demand point can be allocated to a facility.	Double
impedanceParameter (Lecture/écriture)	Provides the ability to get or set a parameter value for the equations specified in the impedanceTransformation property. The property value is ignored when the impedanceTransformation property is set to LINEAR. The property value should not be zero.	Double
impedanceTransformation (Lecture/écriture)	Provides the ability to get or set the equation for transforming the network cost between facilities and demand points. This property value, coupled with the impedanceParameter property value, specifies how severely the network impedance between facilities and demand points influences the solver's choice of facilities. The following is a list of possible values: LINEAR —The transformed network impedance between the facility and the demand point is the same as the shortest-path network impedance between them. With this value set, the impedanceParameter property value is always set to one and any value set for impedanceParameter property is ignored. POWER —The 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 impedanceParameter property value. Use this property value with a positive impedanceParameter property value to give higher weight to nearby facilities. EXPONENTIAL —The 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 by the impedanceParameter property value. Use this property value with a positive impedanceParameter property value to give a very high weight to nearby facilities.	String
outputPathShape (Lecture/écriture)	Controls whether straight lines are used to represent the results from the location-allocation analysis. The following is a list of possible values: NO_LINES —No shape will be generated for the output of the analysis. This is useful when you have a large number of demand points or facilities and are interested only in the tabular output. STRAIGHT_LINES —Straight lines connecting the solution facilities to their allocated demand points are generated.	String
problemType (Lecture/écriture)	Provides the ability to get or set 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. The following is a list of possible values: MINIMIZE_IMPEDANCE —This option solves the warehouse location problem. It selects a set of facilities such 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. MAXIMIZE_COVERAGE —This option solves the fire station location problem. It chooses facilities such that all or the greatest amount of demand is within a specified impedance cutoff. MINIMIZE_FACILITIES —This option solves the fire station location problem. It chooses the minimum number of facilities needed to cover all or the greatest amount of demand within a specified impedance cutoff. MAXIMIZE_ATTENDANCE —This option solves the neighborhood store location problem where 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 chosen. Demand further than the specified impedance cutoff does not affect the chosen set of facilities. MAXIMIZE_MARKET_SHARE —This option solves the competitive facility location problem. It chooses 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 chosen. TARGET_MARKET_SHARE —This option solves the competitive facility location problem. It chooses 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 chosen.	String
restrictions (Lecture/écriture)	Permet d'obtenir ou de définir une liste des attributs de restriction appliqués pour l'analyse. Une liste vide, [], indique qu'aucun attribut de restriction n'est utilisé pour l'analyse.	String
solverName (Lecture seule)	Returns the name of the solver being referenced by the ArcGIS Network Analyst layer used to obtain the solver properties object. The property always returns the string value Location-Allocation Solver when accessed from a LocationAllocationSolverProperties object.	String
targetMarketShare (Lecture/écriture)	Provides the ability to get or set the target market share in percentage to solve when the problemType property is set to TARGET_MARKET_SHARE. It is the percentage of the total demand weight that you want your solution facilities to capture. The solver chooses the minimum number of facilities required to capture the target market share specified by this numeric value. Any value set for facilitiesToFind property is ignored.	Double
timeOfDay (Lecture/écriture)	Provides the ability to get or set the time and date of departure. The departure can be from facilities or demand points, depending on whether travel is from demand to facility or facility to demand. 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: Aujourd'hui - 12/30/1899 Dimanche - 12/31/1899 Lundi - 1/1/1900 Mardi - 1/2/1900 Mercredi - 1/3/1900 Jeudi - 1/4/1900 Vendredi - 1/5/1900 Samedi - 1/6/1900 For example, to specify that the departure 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 or demand points are located.	DateTime
timeZoneUsage (Lecture/écriture)	Specifies the time zone of the timeOfDay parameter. GEO_LOCAL —The timeOfDay parameter refers to the time zone in which the facilities or demand points are located. If a time and date is specified in timeOfDay and travelDirection is set to FACILITY_TO_DEMAND, this is the time zone of the facilities. If the same is true, but travelDirection is set to DEMAND_TO_FACILITY, this is the time zone of the facilities. UTC —The timeOfDay parameter refers to Coordinated Universal Time (UTC). Choose this option if you want to solve the analysis for a specific time, such as now, but aren't certain in which time zone the facilities or demand points will be located. When solving a location-allocation analysis that spans across multiple time zones, the following rules apply: All facilities must be in the same time zone when a start time is set and travel is from facility to demand. All demand points must be in the same time zone when a start time is set and travel is from demand point to facility.	String
travelDirection (Lecture/écriture)	Controls the direction of travel between facilities and demand points when calculating the network costs. The following is a list of possible values: FACILITY_TO_DEMAND —Direction of travel is from facilities to demand points. DEMAND_TO_FACILITY —Direction of travel is from demand points to facilities.	String
useHierarchy (Lecture/écriture)	Contrôle l'utilisation de l'attribut de hiérarchie lors de l'analyse. Voici une liste des valeurs possibles : USE_HIERARCHY — Utilise l'attribut de hiérarchie pour l'analyse. L'utilisation d'une hiérarchie implique une préférence du solveur pour les tronçons d'ordre supérieur par rapport aux tronçons d'ordre inférieur. Les recherches hiérarchiques sont plus rapides et permettent de simuler la préférence d'un chauffeur de circuler sur des autoroutes au lieu de routes locales si possible, même si cela implique un trajet plus long. Cette option s'applique uniquement si le jeu de données réseau référencé par la couche ArcGIS Network Analyst dispose d'un attribut de hiérarchie. Une valeur True peut également être utilisée pour spécifier cette option. NO_HIERARCHY —N'utilise pas l'attribut de hiérarchie pour l'analyse. Un itinéraire exact est alors obtenu pour le jeu de données réseau. Une valeur False peut également être utilisée pour spécifier cette option.	String
uTurns (Lecture/écriture)	Permet d'obtenir ou de définir la stratégie qui indique comment les demi-tours aux jonctions qui pourraient survenir pendant la traversée du réseau entre différents arrêts sont gérés par le solveur. Voici une liste des valeurs possibles : ALLOW_UTURNS —Les demi-tours sont autorisés aux jonctions comportant un nombre quelconque de tronçons connectés. NO_UTURNS —Les demi-tours sont interdits à toutes les jonctions, indépendamment de la valence de jonction. Notez toutefois que les demi-tours restent autorisés aux emplacements réseau même lorsque ce paramètre est sélectionné ; en revanche, vous pouvez configurer la propriété CurbApproach des emplacements réseau individuels pour y interdire les demi-tours également. ALLOW_DEAD_ENDS_ONLY —Les demi-tours sont interdits au niveau de toutes les jonctions, sauf celles ayant un seul tronçon adjacent (voie sans issue). ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY —Les demi-tours sont interdits aux jonctions où deux tronçons adjacents se rencontrent, mais sont autorisés aux intersections (jonctions avec au moins trois tronçons adjacents) et aux voies sans issue (jonctions avec exactement un tronçon adjacent). Souvent, les réseaux comportent des jonctions superflues au milieu de segments de route. Cette option empêche des véhicules de faire des demi-tours à ces emplacements.	String

Exemple de code

Exemple 1 d'utilisation de l'objet LocationAllocationSolverProperties (fenêtre Python)

Le script indique comment mettre à jour le type de problème d'une couche d'analyse de réseau d'emplacement-allocation pour Minimiser les ressources et définir une transformation d'impédance d'alimentation avec un paramètre d'impédance de 2. Il suppose qu'une couche d'emplacement-allocation appelée Couverture de magasins a été créée dans un nouveau document ArcMap d'après le jeu de données du didacticiel réseau pour la région de San Francisco.

#Get the location-allocation layer object from a layer named "Stores Coverage" in
#the table of contents
laLayer = arcpy.mapping.Layer("Stores Coverage")

#Get the solver properties object from the location-allocation layer
solverProps = arcpy.na.GetSolverProperties(laLayer)

#Update the properties for the location-allocation layer using the solver properties
#object
solverProps.problemType = "MINIMIZE_FACILITIES"
solverProps.impedanceTransformation = "POWER"
solverProps.impedanceParameter = 2

Exemple 2 d'utilisation de l'objet LocationAllocationSolverProperties (workflow)

Le script indique comment choisir des emplacements de magasin qui généreraient le plus gros chiffre d'affaires pour une chaîne à l'aide de l'analyse d'emplacement-allocation. Le script crée d'abord une nouvelle couche d'emplacement-allocation avec les paramètres d'analyse appropriés. À l'étape suivante, les emplacements de magasin candidats et les centroïdes de groupe d'îlots sont chargés en tant que ressources et points de demande, respectivement. L'analyse est résolue et enregistrée dans un fichier de couches. Deux analyses suivantes sont effectuées en modifiant les propriétés d'analyse à l'aide de l'objet LocationAllocationSolverProperties. Après chaque analyse, la couche est enregistrée en tant que fichier de couches. Le script utilise les données du didacticiel pour la région de San Francisco. La description détaillée du scénario est disponible dans le cadre de l'exercice 9 dans le didacticiel Network Analyst. Le didacticiel vous guide dans ce scénario à l'aide de l'interface utilisateur d'ArcMap, le script fournit un exemple de la façon dont le même scénario peut être automatisé à l'aide d'un script Python.

import arcpy

#Set up the environment
arcpy.env.overwriteOutput = True
arcpy.env.workspace = "C:/data/SanFrancisco.gdb"
arcpy.CheckOutExtension("network")

#Set up variables
networkDataset = "Transportation/Streets_ND"
outNALayerName = "NewStoreLocations"
inFacilities = "Analysis/CandidateStores"
requiredFacility = "Analysis/ExistingStore"
competitorFacility = "Analysis/CompetitorStores"
inDemandPoints = "Analysis/TractCentroids"
outputFolder = "C:/data/output/"

#Create a new location-allocation layer. In this case the demand travels to
#the facility. We wish to find 3 potential store locations out of all the
#candidate store locations using the maximize attendance model.
outNALayer = arcpy.na.MakeLocationAllocationLayer(networkDataset, outNALayerName,
                                                  "TravelTime","DEMAND_TO_FACILITY",
                                                  "MAXIMIZE_ATTENDANCE",3,5,
                                                  "LINEAR")
#Get the layer object from the result object. The location-allocation layer
#can now be referenced using the layer object.
outNALayer = outNALayer.getOutput(0)

#Get the names of all the sublayers within the location-allocation layer.
subLayerNames = arcpy.na.GetNAClassNames(outNALayer)
#Stores the layer names that we will use later
facilitiesLayerName = subLayerNames["Facilities"]
demandPointsLayerName = subLayerNames["DemandPoints"]

#Load the candidate store locations as facilities using default search
#tolerance and field mappings.
arcpy.na.AddLocations(outNALayer, facilitiesLayerName, inFacilities, "", "",
                      exclude_restricted_elements = "EXCLUDE")

#Load the tract centroids as demand points using default search tolerance. Use 
#the field mappings to map the Weight property from POP2000 field.
demandFieldMappings = arcpy.na.NAClassFieldMappings(outNALayer,
                                                    demandPointsLayerName)
demandFieldMappings["Weight"].mappedFieldName = "POP2000"
arcpy.na.AddLocations(outNALayer,demandPointsLayerName ,inDemandPoints,
                      demandFieldMappings, "",
                      exclude_restricted_elements = "EXCLUDE")

#Solve the location-allocation layer
arcpy.na.Solve(outNALayer)
    
#Save the solved location-allocation layer as a layer file on disk with 
#relative paths
outLayerFile = outputFolder + outNALayerName + ".lyr"
arcpy.management.SaveToLayerFile(outNALayer,outLayerFile,"RELATIVE")

#We need to re-solve the previous scenario as a store-expansion scenario, in
#which we will start with an existing store and optimally locate two additional
#stores.
#Load the existing store location as the required facility. Use the field
#mappings to set the facility type to requried. We need to append this
#required facility to existing facilities.
fieldMappings = arcpy.na.NAClassFieldMappings(outNALayer, facilitiesLayerName)
fieldMappings["FacilityType"].defaultValue = 1
fieldMappings["Name"].mappedFieldName = "Name"
arcpy.na.AddLocations(outNALayer, facilitiesLayerName, requiredFacility,
                      fieldMappings, "", append = "APPEND",
                      exclude_restricted_elements = "EXCLUDE")

#Solve the location-allocation layer
arcpy.na.Solve(outNALayer)
    
#Save the solved location-allocation layer as a layer file on disk with 
#relative paths
updatedNALayerName = "StoreExpansionScenario"
outNALayer.name = updatedNALayerName
outLayerFile = outputFolder + updatedNALayerName + ".lyr"
arcpy.management.SaveToLayerFile(outNALayer,outLayerFile,"RELATIVE")

#We need to resolve the previous scenario and locate new stores to 
#maximize market share in light of competing stores.

#Load the competitor store locations as the competitor facilities. Use the field
#mappings to set the facility type to Competitor. We need to append these
#competitor facilities to existing facilities.
fieldMappings["FacilityType"].defaultValue = 2
arcpy.na.AddLocations(outNALayer, facilitiesLayerName, competitorFacility,
                      fieldMappings, "", append = "APPEND",
                      exclude_restricted_elements = "EXCLUDE")

#Get the LocationAllocationSolverProperties object from the location-allocation 
#layer to modify the analysis settings for the layer.
solverProps = arcpy.na.GetSolverProperties(outNALayer)

#Set the problem type to Maximize Market Share, and impedance transformation to
#Power with an impedance parameter value of 2.
solverProps.problemType = "MAXIMIZE_MARKET_SHARE"
solverProps.impedanceTransformation = "POWER"
solverProps.impedanceParameter = 2

#Solve the location-allocation layer
arcpy.na.Solve(outNALayer)

#print the market share that was obtained
arcpy.AddMessage(arcpy.GetMessage(0))

#Change the name of the NA Layer
updatedNALayerName = "MaximizedMarketShareStoreLocations"
outNALayer.name = updatedNALayerName

#Save the solved location-allocation layer as a layer file on disk with 
#relative paths
outLayerFile = outputFolder + updatedNALayerName + ".lyr"
arcpy.management.SaveToLayerFile(outNALayer,outLayerFile,"RELATIVE")
    
arcpy.AddMessage("Completed")