ODCostMatrixSolverProperties (arcpy.na)

サマリ

Provides access to analysis properties from an origin-destination (OD) cost matrix network analysis layer. The GetSolverProperties function is used to obtain an ODCostMatrixSolverProperties object from an OD cost matrix network analysis layer.

説明

The ODCostMatrixSolverProperties object provides read and write access to all the analysis properties of an OD cost matrix network analysis layer. The object can be used to modify the desired analysis properties of the OD cost matrix layer, and the corresponding layer can be re-solved to determine the appropriate results. A new OD cost matrix layer can be created using the Make OD Cost Matrix Layer geoprocessing tool. Obtaining the ODCostMatrixSolverProperties object from a new OD cost matrix 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 ODCostMatrixSolverProperties 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.

特性

プロパティ説明データ タイプ
accumulators
(読み書き)

解析時に累積されるネットワーク コスト属性のリストを取得または設定できます。空のリスト（[]）は、累積されるコスト属性がないことを表します。

String
attributeParameters
(読み書き)

解析で使用されるパラメータ化属性を取得または設定できます。プロパティは Python ディクショナリを返します。ディクショナリのキーは、属性名とパラメータで構成される 2 つの値の組み合わせです。ディクショナリ内の各アイテムの値はパラメータ値です。

パラメータ化されたネットワーク属性は、リアルタイムに変化する属性値をモデリングするために使用されます。たとえば、12 フィートの車高規制があるトンネルをパラメータを使用してモデリングできます。この場合、車両の高さ（フィート）をパラメータ値として指定する必要があります。車両の高さが 12 フィートを超えている場合は、この規制が true に評価され、トンネルの通行が規制されます。同様に、橋は重量規制を指定するパラメータを保持することができます。

attributeParameters プロパティを直接変更しようとしても、値は更新されません。常に新しいディクショナリ オブジェクトを使用して、プロパティの値を設定する必要があります。以下の 2 つのコード ブロックは、これらの 2 つの方法の違いを示しています。

#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
ネットワーク解析レイヤにパラメータ化属性がない場合、このプロパティは None を返します。

Dictionary
defaultCutoff
(読み書き)

Provides the ability to get or set the default impedance value at which to cut off searching for destinations for a given origin. A value of None is used to specify that no cutoff should be used.

Double
defaultTargetDestinationCount
(読み書き)

Provides the ability to get or set the number of destinations to find for each origin. A value of None is used to specify that all destinations should be found.

Integer
impedance
(読み書き)

Provides the ability to get or set the network cost attribute used as impedance. This cost attribute is minimized while determining the routes between origins and destinations.

String
outputPathShape
(読み書き)

Controls whether a straight line is generated between each origin-destination pair in the output OD cost matrix. The following is a list of possible values:

  • NO_LINES —No shape is generated between origin-destination pairs. This is useful when you have a large number of origins and destinations and are interested only in the OD cost matrix table (and not the output line shapes).
  • STRAIGHT_LINES —A single straight line between each of the origin-destination pairs is generated.
String
restrictions
(読み書き)

解析時に適用される規制属性のリストを取得または設定できます。空のリスト（[]）は、解析で使用される規制属性がないことを表します。

String
solverName
(読み取り専用)

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 OD Cost Matrix Solver when accessed from a ODCostMatrixSolverProperties object.

String
timeOfDay
(読み書き)

Provides the ability to get or set the departure date and time from the origins. 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:

  • 今日 - 1899/12/30
  • 日 - 1899/12/31
  • 月 - 1900/1/1
  • 火 - 1900/1/2
  • 水 - 1900/1/3
  • 木 - 19001/4
  • 金 - 1900/1/5
  • 土 - 1900/1/6

For example, to specify that the route from each origin should start at 8:00 a.m. on Wednesday, specify the value as datetime.datetime(1900, 1, 3, 8,0,0).

The timeZoneUsage parameter specifies whether the date and time refer to UTC or the time zone in which the orders are located.

DateTime
timeZoneUsage
(読み書き)

Specifies the time zone of the timeOfDay parameter.

  • GEO_LOCAL —The timeOfDay parameter refers to the time zone in which the origins are located.
  • 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 origins will be located.

When solving an OD cost matrix analysis that spans across multiple time zones and a start time is set, all origins must be in the same time zone.

String
useHierarchy
(読み書き)

解析を実行しているときの階層属性の使用を制御します。設定可能な値の一覧を次に示します。

  • USE_HIERARCHY（階層を使用） — 階層属性を解析に使用します。階層を使用すると、解析は下位ランクのエッジよりも上位ランクのエッジを優先します。階層解析は、より高速で、運転者が遠回りであっても一般道路の代わりに高速道路を利用する状況をシミュレートするのに使用できます。このオプションは、Network Analyst レイヤが参照しているネットワーク データセットに階層属性がある場合のみ適用されます。値を True に設定することでも、このオプションを指定できます。
  • NO_HIERARCHY（階層を使用しない） —階層属性を解析に使用しません。階層を使用しないことで、ネットワーク データセットの正確なルートが検索されます。値を False に設定することでも、このオプションを指定できます。
String
uTurns
(読み書き)

ストップ間のネットワーク移動中に発生する可能性のあるジャンクションでの U ターンを、解析でどのように処理するかを指定するポリシーを取得または設定できます。設定可能な値の一覧を次に示します。

  • ALLOW_UTURNS（U ターンを許可） —任意の数の接続されたエッジを持つジャンクションで U ターンを許可します。
  • NO_UTURNS（U ターンを規制） —ジャンクションの結合にかかわらず、すべてのジャンクションで U ターンを禁止します。ただし、この設定が選択されている場合でも、ネットワーク ロケーションでは U ターンが許可されます。同様に、個々のネットワーク ロケーションの CurbApproach プロパティで U ターンを禁止するように設定できます。
  • ALLOW_DEAD_ENDS_ONLY（行き止まりのみ許可） —1 つの隣接エッジを持つジャンクション（行き止まり）を除くすべてのジャンクションでの U ターンを禁止します。
  • ALLOW_DEAD_ENDS_AND_INTERSECTIONS_ONLY —2 つの隣接するエッジが接するジャンクションでの U ターンを禁止します。ただし、交差点（3 つ以上の隣接エッジを持つジャンクション）および行き止まり（1 つの隣接エッジを持つジャンクション）では U ターンを許可します。ネットワークには、道路セグメントの中間に無関係のジャンクションが存在する場合があります。このオプションは、これらの場所で車両が U ターンすることを防ぎます。
String

コードのサンプル

ODCostMatrixSolverProperties example (Python window)

The script shows how to update an OD cost matrix network analysis layer to find all destinations within a five-minute cutoff value. It assumes that an OD cost matrix layer called Store Accessibility has been created in a new map document based on the tutorial network dataset for San Francisco region. 

#Get the OD cost matrix layer object from a layer named "Store Accessibility" in
#the table of contents
odLayer = arcpy.mapping.Layer("Store Accessibility")

#Get the solver properties object from the OD cost matrix layer
solverProps = arcpy.na.GetSolverProperties(odLayer)

#Update the properties for the OD cost matrix layer using the solver properties
#object
solverProps.defaultCutoff = 5
solverProps.defaultTargetDestinationCount = None

関連トピック

OD コスト マトリックス解析
Copyright © 1995-2014 Esri. All rights reserved.
4/26/2014