トレース構成の追加 (Add Trace Configuration) (トレース ネットワーク)

概要

トレース ネットワーク内にトレース構成を作成します。

トレース構成では、共有と再利用のために複雑なトレースのプロパティを構成して格納することができます。トレース ネットワークに格納されているトレース構成を [トレース (Trace)] ツールから読み込んで実行したり、Web マップまたはフィールド アプリで使用されるマップ サービスを経由して共有したりできます。

トレース構成を追加する方法の詳細

使用法

  • 入力トレース ネットワークは、バージョン 2 以降である必要があります。

  • エンタープライズ ジオデータベースを操作する場合、入力トレース ネットワークは、トレース ネットワーク サービスから取得する必要があります。

  • 接続されたポータル アカウントは、トレース構成の作成者として表示されます。

    • ファイル ジオデータベースでトレース ネットワークを操作するときには、オペレーティング システムの認証を使用してトレース構成の作成者を保存します。

構文

arcpy.tn.AddTraceConfiguration(in_trace_network, trace_config_name, trace_type, {description}, {tags}, {path_direction}, {shortest_path_network_attribute_name}, {include_barriers}, {validate_consistency}, {ignore_barriers_at_starting_points}, {allow_indeterminate_flow}, {condition_barriers}, {function_barriers}, {traversability_scope}, {functions}, {output_conditions}, {result_types})
パラメーター説明データ タイプ
in_trace_network

新しいトレース構成が含まれるトレース ネットワーク。

Trace Network; Trace Network Layer
trace_config_name

トレース構成の名前。

String
trace_type

構成するトレースのタイプを指定します。

  • CONNECTED1 つ以上の始点で始まり、接続フィーチャに沿って外側に広がる接続トレースが使用されます。
  • UPSTREAMネットワーク内の場所から上流のフィーチャを検索する上流トレースが使用されます。このタイプのトレースでは、フロー方向が使用されます。
  • DOWNSTREAMネットワーク内の場所から下流のフィーチャを検索する下流トレースが使用されます。このタイプのトレースでは、フロー方向が使用されます。
  • SHORTEST_PATHフロー方向に関係なく、ネットワーク内の 2 つの始点間の最短パスを検索する最短パス トレースが使用されます。パスの通過にかかるコストは、フロー方向に関係なく、shortest_path_network_attribute_name パラメーターで設定されたネットワーク属性に基づいて決定されます。
String
description
(オプション)

トレース構成の説明。

String
tags
[tags,...]
(オプション)

トレース構成の識別に使用される一連のタグ。これらのタグは検索とインデックス構築に使用できます。

String
path_direction
(オプション)

トレース パスの方向を指定します。パスの通過にかかるコストは、shortest_path_network_attribute_name パラメーターの値によって決定されます。このパラメーターは、[SHORTEST_PATH] トレース タイプを実行する場合にのみ適用されます。

  • NO_DIRECTIONフロー方向に関係なく、2 つの始点間のパスが使用されます。これがデフォルトです。
  • PATH_UPSTREAM2 つの始点間の上流のパスが使用されます。
  • PATH_DOWNSTREAM2 つの始点間の下流のパスが使用されます。
String
shortest_path_network_attribute_name
(オプション)

パスの計算に使用されるネットワーク属性の名前。最短パス解析トレースを実行すると、形状の長さなど、数値のネットワーク属性を使用して、最短パスが計算されます。コストに基づくパスと距離に基づくパスの両方が得られます。最短パス解析トレースを実行する場合は、このパラメーターは必須です。

String
include_barriers
(オプション)

通過可能性バリア フィーチャをトレース結果に含めるかどうかを指定します。

  • INCLUDE_BARRIERS通過可能性バリア フィーチャをトレース結果に含めます。これがデフォルトです。
  • EXCLUDE_BARRIERS通過可能性バリア フィーチャをトレース結果に含めません。
Boolean
validate_consistency
(オプション)

通過したフィーチャのいずれかでダーティ エリアが発生した場合、エラーを返すかどうかを指定します。これは、トレースがネットワーク内を一貫したステータスでフィーチャを通過することを保証する唯一の方法です。ダーティ エリアを削除するには、ネットワークトポロジを整合チェックします。

  • VALIDATE_CONSISTENCY通過したフィーチャのいずれかでダーティ エリアが発生した場合、トレースがエラーを返します。これがデフォルトです。
  • DO_NOT_VALIDATE_CONSISTENCY通過したフィーチャのいずれかでダーティ エリアが発生したかどうかに関係なく、トレースが結果を返します。
Boolean
ignore_barriers_at_starting_points
(オプション)

始点ではトレース構成内のバリアを無視するかどうかを指定します。

  • IGNORE_BARRIERS_AT_STARTING_POINTS始点にあるバリアはトレース内で無視されます。
  • DO_NOT_IGNORE_BARRIERS_AT_STARTING_POINTS始点にあるバリアはトレース内で無視されません。これがデフォルトです。
Boolean
allow_indeterminate_flow
(オプション)

フロー方向が不定または未定のフィーチャをトレースするかどうかを指定します。このパラメーターは、上流トレースまたは下流トレースを実行する場合にのみ適用されます。

  • TRACE_INDETERMINATE_FLOWフロー方向が不定または未定のフィーチャをトレースします。
  • IGNORE_INDETERMINATE_FLOWフロー方向が不定または未定のフィーチャはトレースしません。これがデフォルトです。
Boolean
condition_barriers
[[Name, Operator, Type, Value, Combine Using],...]
(オプション)

ネットワーク属性との比較に基づいて、フィーチャに対して通過可能性バリア条件を設定します。条件バリアは、ネットワーク属性、演算子とタイプ、および属性値を使用します。たとえば、フィーチャが ArtificialPath の特定の値と等しい Code 属性を持っている場合に、トレースを停止します。フィーチャがこの条件を満たしている場合、トレースが停止します。複数の属性を使用している場合、Combine Using コンポーネントを使用して、[And] または [Or] 条件を定義できます。

条件バリアの構成は次のとおりです。

  • Name - システム内で定義された任意のネットワーク属性によってフィルタリングします。
  • Operator - 複数の異なる演算子から選択します。
  • Type - Name コンポーネントで指定された値から特定の値またはネットワーク属性を選択します。
  • Value- 演算子の値に基づいて処理を停止させる入力属性タイプの特定の値を指定します。
  • Combine Using - 複数の属性を追加する場合にこの値を設定します。[And] 条件または [Or] 条件を使用して、これらを結合することができます。

Operator コンポーネントは次のとおりです。

  • IS_EQUAL_TO属性と値が等しい。
  • DOES_NOT_EQUAL属性と値が等しくない。
  • IS_GREATER_THAN属性が値より大きい。
  • IS_GREATER_THAN_OR_EQUAL_TO属性が値以上である。
  • IS_LESS_THAN属性が値より小さい。
  • IS_LESS_THAN_OR_EQUAL_TO属性が値以下である。

Type コンポーネントは次のとおりです。

  • SPECIFIC_VALUE特定の値によるフィルター。
  • NETWORK_ATTRIBUTEネットワーク属性によるフィルター。

Combine Using コンポーネントは次のとおりです。

  • AND条件バリアを結合します。
  • ORいずれかの条件バリアが満たされている場合に使用します。
Value Table
function_barriers
[[Function, Attribute, Operator, Value, Use Local Values],...]
(オプション)

関数に基づいて、フィーチャに対する通過可能性バリアを設定します。関数バリアを使用すると、たとえば、始点からトレースが移動できる距離を制限したり、トレースを停止するための最大値を設定したりできます。たとえば、通過した各ラインの長さが、それまでに移動した合計距離に追加されます。移動した全長が指定された値に達した場合、トレースが停止します。

関数バリアの構成は次のとおりです。

  • Function - 複数の計算関数から選択します。
  • Attribute - システム内で定義されたネットワーク属性を基準にフィルタリングします。
  • Operator - 複数の演算子から選択します。
  • Value - 検出された時点で、処理を停止させる入力属性タイプの特定の値を指定します。
  • Use Local Values - 全体的なグローバル値とは対照的に、各方向で値を計算します。たとえば、関数バリアが、値が 4 以上の場合にトレースが停止する形状の長さの合計を計算するとします。グローバル値の場合は、値が 2 の 2 つのエッジを通過すると、形状の長さの合計値 4 にすでに到達するため、トレースが停止します。ローカル値を使用している場合は、各パスに沿ってローカル値が変化するため、トレースが続行します。

Function コンポーネントは次のとおりです。

  • AVERAGE入力値の平均値。
  • COUNTフィーチャの数。
  • MAX最大の入力値。
  • MIN最小の入力値。
  • ADD値を加算します。
  • SUBTRACT値を減算します。

Operator コンポーネントは次のとおりです。

  • IS_EQUAL_TO属性と値が等しい。
  • DOES_NOT_EQUAL属性と値が等しくない。
  • IS_GREATER_THAN属性が値より大きい。
  • IS_GREATER_THAN_OR_EQUAL_TO属性が値以上である。
  • IS_LESS_THAN属性が値より小さい。
  • IS_LESS_THAN属性が値より小さい。

Use Local Values コンポーネントは次のとおりです。

  • TRUEローカル値を使用します。
  • FALSEグローバル値を使用します。これがデフォルトです。
Value Table
traversability_scope
(オプション)

通過可能性をジャンクションに適用するか、エッジに適用するか、その両方に適用するかを指定します。たとえば、レクリエーション コースのネットワークにおいて、パス タイプが砂利で、通過可能性範囲がジャンクションのみに設定されている場合にトレースを停止するように条件バリアを定義すると、砂利のパスが検出された場合でも、このパス タイプはエッジにしか適用されないため、トレースは停止しません。つまり、このパラメーターは、トレースで、ジャンクションを無視するか、エッジを無視するか、またはトレース内のジャンクションとエッジを両方含めるかを示します。

  • BOTH_JUNCTIONS_AND_EDGES通過可能性は、ジャンクションとエッジの両方に適用されます。これがデフォルトです。
  • JUNCTIONS_ONLY通過可能性は、ジャンクションのみに適用されます。
  • EDGES_ONLY通過可能性は、エッジのみに適用されます。
String
functions
[[Function, Attribute, Filter Name, Filter Operator, Filter Type, Filter Value],...]
(オプション)

トレース結果に適用される計算関数。

関数の構成は次のとおりです。

  • Function - 複数の計算関数から選択します。
  • Attribute - システム内で定義されたネットワーク属性を基準にフィルタリングします。
  • Filter Name - 属性名によって関数の結果をフィルター処理します。
  • Filter Operator - 複数の演算子から選択します。
  • Filter Type - さまざまなフィルター タイプの中から選択します。
  • Filter Value - 入力フィルター属性の値を指定します。

Function コンポーネントには、次のオプションがあります。

  • AVERAGE入力値の平均値。
  • COUNTフィーチャの数。
  • MAX最大の入力値。
  • MIN最小の入力値。
  • ADD値の合計。
  • SUBTRACT値の差。

たとえば、始点フィーチャの値が 20 とします。次のフィーチャは 30 の値を持っています。MIN 関数を使用している場合、結果は 20 になります。MAX 結果は 30、ADD の結果は 50、AVERAGE の結果は 25、COUNT の結果は 2、SUBTRACT の結果は -10 になります。

Filter Operator コンポーネントには、次のオプションがあります。

  • IS_EQUAL_TO属性と値が等しい。
  • DOES_NOT_EQUAL属性と値が等しくない。
  • IS_GREATER_THAN属性が値より大きい。
  • IS_GREATER_THAN_OR_EQUAL_TO属性が値以上である。
  • IS_LESS_THAN属性が値より小さい。
  • IS_LESS_THAN属性が値より小さい。

Filter Type コンポーネントには、次のオプションがあります。

  • SPECIFIC_VALUE特定の値によるフィルター。
  • NETWORK_ATTRIBUTEネットワーク属性によるフィルター。
Value Table
output_conditions
[[Name, Operator, Type, Value, Combine Using],...]
(オプション)

ネットワーク属性に基づいて返されるフィーチャのタイプ。たとえば、Tap フィーチャ以外をすべて除外するよう構成されたトレースでは、Tap 属性が割り当てられていないトレース済みフィーチャは、結果に含まれません。そのカテゴリがあるトレース対象フィーチャは結果選択セットに返されます。複数の属性を使用すると、Combine Using オプションを使用して、[And] 条件または [Or] 条件を定義できます。

出力条件の構成は次のとおりです。

  • Name - システム内で定義された任意のネットワーク属性によってフィルタリングします。
  • Operator - 複数の演算子から選択します。
  • Type - Name コンポーネントで指定された値から特定の値またはネットワーク属性を選択します。
  • Value - 演算子の値に基づいて処理を停止させる入力属性タイプの特定の値を指定します。
  • Combine Using - 複数の属性を追加する場合にこの値を設定します。[And] 条件または [Or] 条件を使用して、これらを結合することができます。

Operator コンポーネントには、次のオプションがあります。

  • IS_EQUAL_TO属性と値が等しい。
  • DOES_NOT_EQUAL属性と値が等しくない。
  • IS_GREATER_THAN属性が値より大きい。
  • IS_GREATER_THAN_OR_EQUAL_TO属性が値以上である。
  • IS_LESS_THAN属性が値より小さい。
  • IS_LESS_THAN属性が値より小さい。

Type コンポーネントには、次のオプションがあります。

  • SPECIFIC_VALUE特定の値によるフィルター。
  • NETWORK_ATTRIBUTEネットワーク属性によるフィルター。

Combine Using コンポーネントには、次のオプションがあります。

  • AND条件を結合します。
  • ORいずれかの条件を満たした場合に使用します。
Value Table
result_types
[result_types,...]
(オプション)

トレースから返される結果のタイプを指定します。

  • SELECTION トレース結果は、該当するネットワーク フィーチャの選択セットとして返されます。これがデフォルトです。
  • AGGREGATED_GEOMETRY トレース結果は、ジオメトリ タイプによって集約され、アクティブなマップのレイヤー内に表示されるフィーチャクラスに格納されます。
String

派生した出力

名前説明データ タイプ
updated_trace_network

更新されるトレース ネットワーク。

トレース ネットワーク

コードのサンプル

AddTraceConfiguration (トレース構成の追加) の例 (Python ウィンドウ)

このサンプル スクリプトでは、「Upstream_HUC12」というトレース構成を「HydroNetwork」というトレース ネットワークに追加します。

import arcpy
arcpy.AddTraceConfiguration_un(
        r"HydroNetwork", "Upstream_HUC12", "UPSTREAM", 
        "Upstream trace for HUC12_allow indeterminate", "HUC12;Upstream", 
        "NO_DIRECTION", '', "INCLUDE_BARRIERS", "VALIDATE_CONSISTENCY", 
        "DO_NOT_IGNORE_BARRIERS_AT_STARTING_POINTS", "TRACE_INDETERMINATE_FLOW", 
        None, None, "BOTH_JUNCTIONS_AND_EDGES", None, None, None)

環境

このツールは、ジオプロセシング環境を使用しません。

ライセンス情報

  • Basic: いいえ
  • Standard: はい
  • Advanced: はい

関連トピック