ServiceAreaSolverProperties (arcpy.na)

サマリ

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.

説明

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 re-solved to determine the appropriate results. A new service area layer can be created using the Make Service Area 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 new 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.

特性

プロパティ説明データ タイプ
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
defaultBreaks
(読み書き)

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
(読み書き)

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
impedance
(読み書き)

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
(読み書き)

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_FIELDSDo 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
(読み書き)

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
(読み書き)

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_LINESDo not generate lines.
  • TRUE_LINESLines are generated without measures.
  • TRUE_LINES_WITH_MEASURESLines 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
(読み書き)

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_MERGECreate individual polygons for each facility. The polygons can overlap each other.
  • NO_OVERLAPCreate 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
(読み書き)

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:

  • RINGSDo 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
(読み書き)

Provides the ability to get or set the type of polygons to be generated. The following is a list of possible values:

  • SIMPLE_POLYSCreate generalized polygons that are generated quickly and are fairly accurate, except on the fringes.
  • DETAILED_POLYSCreate 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_POLYSTurns off polygon generation for the case in which only service area lines are desired.
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 Service Area Solver when accessed from a ServiceAreaSolverProperties object.

String
splitLinesAtBreaks
(読み書き)

Controls whether service area lines are split when they cross a break value. The following is a list of possible values:

  • SPLITSplit 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_SPLITThe lines are not split at the boundaries of the breaks.
String
timeOfDay
(読み書き)

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:

  • 今日 - 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 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
(読み書き)

Specifies the time zone or zones of the timeOfDay parameter.

  • GEO_LOCALThe 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.
  • UTCThe 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.
    注意注意:

    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
(読み書き)

Controls the direction in which the impedance is accumulated during service area analysis. The following is a list of possible values:

  • TRAVEL_FROMThe service area is created in the direction away from the facilities.
  • TRAVEL_TOThe service area is created in the direction toward the facilities.
String
trimDistance
(読み書き)

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
(読み書き)

Controls whether the service area polygons are trimmed. The following is a list of possible values:

  • TRIM_POLYSTrim 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_POLYSDo not trim polygons. A value of False can also be used to specify this option.
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_ONLY2 つの隣接するエッジが接するジャンクションでの U ターンを禁止します。ただし、交差点(3 つ以上の隣接エッジを持つジャンクション)および行き止まり(1 つの隣接エッジを持つジャンクション)では U ターンを許可します。ネットワークには、道路セグメントの中間に無関係のジャンクションが存在する場合があります。このオプションは、これらの場所で車両が U ターンすることを防ぎます。
String

コードのサンプル

ServiceAreaSolverProperties example (Python window)

The script shows how to update a service area network analysis layer to use hierarchy and set 5, 10, and 15 minutes as the break values. It assumes that a service area layer called Store Trade Areas has been created in a new map document based on the tutorial network dataset for San Francisco region.

#Get the service area layer object from a layer named "Store Trade Areas" in
#the table of contents
saLayer = arcpy.mapping.Layer("Store Trade Areas")

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

#Update the properties for the service area layer using the solver properties
#object
solverProps.defaultBreaks = [5, 10, 15]
solverProps.useHierarchy = "USE_HIERARCHY"

関連トピック

4/26/2014