LocationAllocationSolverProperties (arcpy.na)
Zusammenfassung
Provides access to analysis properties from a location-allocation network analysis layer. The GetSolverProperties function is used to obtain a LocationAllocationSolverProperties object from a location-allocation network analysis layer.
Diskussion
The LocationAllocationSolverProperties object provides read and write access to all the analysis properties of a location-allocation network analysis layer. The object can be used to modify the desired analysis properties of the location-allocation layer, and the corresponding layer can be re-solved to determine the appropriate results. A new location-allocation layer can be created using the Make Location-Allocation Layer geoprocessing tool. Obtaining the LocationAllocationSolverProperties object from a new location-allocation layer allows you to reuse the existing layer for subsequent analyses rather than create a new layer for each analysis, which can be slow.
After modifying the properties on the LocationAllocationSolverProperties 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.
Eigenschaften
Eigenschaft | Erläuterung | Datentyp |
accumulators (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen einer Liste der Netzwerk-Kostenattribute, die als Teil der Analyse akkumuliert werden. Eine leere Liste, [], weist darauf hin, dass keine Kostenattribute akkumuliert werden. | String |
attributeParameters (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen der parametrierten Attribute, die für die Analyse verwendet werden sollen. Die Eigenschaft gibt ein Python-Wörterbuch zurück. Der Wörterbuchschlüssel ist ein Tupel mit zwei Werten, der aus dem Attributnamen und dem Parameternamen besteht. Der Wert der einzelnen Elemente im Wörterbuch ist der Parameterwert. Mithilfe der parametrierten Netzwerkattribute können dynamische Aspekte eines Attributwertes modelliert werden. So kann beispielsweise ein Tunnel mit einer Höhenbeschränkung von 12 Fuß mit einem Parameter modelliert werden. In diesem Fall sollte die Höhe des Fahrzeugs (in Fuß) als angegebener Parameterwert verwendet werden. Wenn das Fahrzeug höher als 12 Fuß ist, wird diese Einschränkung als "Wahr" bewertet und das Passieren des Tunnels somit untersagt. Entsprechend kann eine Brücke einen Parameter zur Angabe einer Gewichtsbeschränkung aufweisen. Das Ändern der festgelegten Eigenschaft " attributeParameters" würde keine aktualisierten Werte zurückgeben. Sie sollten daher immer ein neues Wörterbuchobjekt verwenden, um die Werte für die Eigenschaft festzulegen. Die zwei folgenden Codeblöcke veranschaulichen den Unterschied zwischen diesen beiden Ansätzen:
| Dictionary |
defaultCapacity (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen der Standardkapazität von Einrichtungen, wenn der Location-Allocation-Parameter "problemType" auf "MAXIMIZE_CAPACITATED_COVERAGE" gesetzt ist. Dieser Parameter wird bei allen anderen Problemtypen ignoriert. Einrichtungen verfügen über eine Kapazitätseigenschaft, die den Parameter "defaultCapacity" für diese Einrichtung überschreibt, wenn für die Eigenschaft ein Wert festgelegt wurde, der nicht Null ist. | Double |
facilitiesToFind (Lesen und schreiben) |
Ermöglicht das Abrufen oder Festlegen der Anzahl an Einrichtungen, die der Solver finden soll. Der Eigenschaftswert wird ignoriert, wenn die Eigenschaft problemType auf MINIMIZE_FACILITIES gesetzt ist, da der Solver die Mindestanzahl an zu suchenden Einrichtungen zur Maximierung der Abdeckung festlegt. Der Eigenschaftswert wird auch ignoriert, wenn die Eigenschaft problemType auf TARGET_MARKET_SHARE gesetzt ist, da der Solver nach der Mindestanzahl an Einrichtungen sucht, die erforderlich ist, um den angegebenen Marktanteil zu erreichen. | Integer |
impedance (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen des als Impedanz verwendete Netzwerk-Kostenattributs. | String |
impedanceCutoff (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen der maximalen Impedanz, bei der einer Einrichtung ein Bedarfspunkt zugeordnet werden kann. | Double |
impedanceParameter (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen des Parameterwertes für die in der Eigenschaft impedanceTransformation festgelegten Gleichungen. Der Eigenschaftswert wird ignoriert, wenn die Eigenschaft impedanceTransformation auf LINEAR gesetzt ist. Der Eigenschaftswert darf nicht Null sein. | Double |
impedanceTransformation (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen der Gleichung, die zum Umrechnen der Netzwerkkosten zwischen Einrichtungen und Bedarfspunkten verwendet wird. Dieser Eigenschaftswert gibt in Verbindung mit dem Eigenschaftswert "impedanceParameter" an, wie stark sich die Netzwerkimpedanz zwischen Einrichtungen und Bedarfspunkten auf die Auswahl von Einrichtungen durch den Solver auswirkt. Nachfolgend finden Sie eine Liste der möglichen Werte:
| String |
outputPathShape (Lesen und schreiben) | Steuert, ob gerade Linien verwendet werden, um die Ergebnisse aus der Location-Allocation-Analyse darzustellen. Nachfolgend finden Sie eine Liste der möglichen Werte:
| String |
problemType (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen des Problemtyps, der berechnet wird. Die Auswahl des Problemtyps hängt von der Art der gesuchten Einrichtung ab. Die Einrichtungen weisen je nach Art unterschiedliche Prioritäten und Einschränkungen auf. Nachfolgend finden Sie eine Liste der möglichen Werte:
| String |
restrictions (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen einer Liste der Restriktionsattribute, die für die Analyse angewendet werden. Eine leere Liste, [], weist darauf hin, dass keine Restriktionsattribute für die Analyse verwendet werden. | String |
solverName (Schreibgeschützt) | Gibt den Namen des Solvers zurück, der vom Network Analyst-Layer referenziert wird, um das Eigenschaftenobjekt des Solvers zu erhalten. Die Eigenschaft gibt immer den Zeichenfolgenwert Location-Allocation Solver zurück, wenn der Zugriff über ein LocationAllocationSolverProperties-Objekt erfolgt. | String |
targetMarketShare (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen des zu berechnenden Ziel-Marktanteils in Prozent, wenn die Eigenschaft problemType auf TARGET_MARKET_SHARE gesetzt ist. Es ist der Prozentsatz der gesamten Bedarfsgewichtung, die von Lösungseinrichtungen abgedeckt werden soll. Der Solver wählt die Mindestanzahl von Einrichtungen aus, die erforderlich ist, um den durch diesen numerischen Wert angegebenen Ziel-Marktanteil zu erreichen. Festgelegte Werte für die Eigenschaft facilitiesToFind werden ignoriert. | Double |
timeOfDay (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen der Uhrzeit und des Datums der Abfahrt. Die Abfahrt kann von Einrichtungen oder Bedarfspunkten erfolgen, je nachdem, ob die Fahrt vom Bedarfspunkt zur Einrichtung oder von der Einrichtung zum Bedarfspunkt erfolgt. Durch den Wert None kann festgelegt werden, dass keine Datums- und Uhrzeitangaben verwendet werden sollen. Statt ein bestimmtes Datum zu verwenden, kann ein Wochentag mithilfe der folgenden Datumsangaben angegeben werden:
Wenn Sie beispielsweise festlegen möchten, dass die Abfahrt um 8:00 Uhr am Freitag erfolgen soll, geben Sie den folgenden Wert an: datetime.datetime(1900, 1, 5, 8,0,0). | DateTime |
travelDirection (Lesen und schreiben) | Steuert die Fahrtrichtung zwischen Einrichtungen und Bedarfspunkten beim Berechnen der Netzwerkkosten. Nachfolgend finden Sie eine Liste der möglichen Werte:
| String |
useHierarchy (Lesen und schreiben) | Steuert die Verwendung des Hierarchieattributs während der Durchführung der Analyse. Nachfolgend finden Sie eine Liste der möglichen Werte:
| String |
uTurns (Lesen und schreiben) | Ermöglicht das Abrufen oder Festlegen der Richtlinie, die angibt, wie der Solver Wenden an Knoten, die beim Durchlaufen des Netzwerks zwischen Stopps auftreten können, verarbeitet. Nachfolgend finden Sie eine Liste der möglichen Werte:
| String |
Codebeispiel
The script shows how to update the problem type of a location-allocation network analysis layer to Minimize Facilities and set a power impedance transformation with an impedance parameter of 2. It assumes that a location-allocation layer called Stores Coverage has been created in a new map document based on the tutorial network dataset for San Francisco region.
#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
The script shows how to choose optimal store locations that would generate the most business for a retail chain using location-allocation analysis. The script first creates a new location-allocation layer with appropriate analysis settings. As a next step, the candidate store locations and the block group centroids are loaded as facilities and demand points, respectively. The analysis is solved and saved to a layer file. Two subsequent analyses are performed by modifying the analysis properties using the LocationAllocationSolverProperties object. After each solve, the layer is stored as a layer file. The script uses the tutorial data for the San Francisco region. The detailed description of the scenario is available as part of exercise 9 in the Network Analyst tutorial. While the tutorial walks you through this scenario using the ArcMap user interface, the script provides an example of how the same scenario can be automated using a Python script.
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")