概要
指定した始点から接続性または通過可能性に基づいて選択されたフィーチャを返します。
ユーティリティ ネットワーク トレース機能を使用すると、ネットワーク内のパスを解析できます。このツールは、指定した始点から接続性または通過可能性に基づいて選択されたフィーチャを返すトレースを実行します。通過可能性は、構成要件を満たす接続されたフィーチャまたは関連付けられたフィーチャによって確立されたパスを指します。
デフォルトでは、トレース結果は選択セットとして返され、ライン フィーチャ全体が含まれています。部分的なフィーチャ結果を返すようにするには、[結果タイプ] パラメーターオプションの [集約されたジオメトリ] を指定できます。
[集約されたジオメトリ] オプションにより、エッジに沿って配置された始点は、中間部分で接続している前のジャンクションまたは端点のエッジ エレメントを返します。[バリア フィーチャを含める] パラメーターがオンのエッジに沿ってバリアを配置した場合、トレースは、中間部分で接続している次のジャンクションまたはラインの終点が検出されると停止します。[バリア フィーチャを含める] パラメーターがオフの場合、トレースは、中間部分で接続している前のジャンクションまたは前のラインの終点が検出されると停止します。
トレースの結果、生成される選択セットまたは出力フィーチャクラスは、別のマップやネットワークのダイアグラム ビューに伝達されるか、別のツールまたはトレースの入力として使用されます。
使用法
ネットワーク トポロジを有効化する必要があります。トレース ツールはネットワーク トポロジに依存しているため、ダーティ エリアがトレースされた場合、トレースの結果が正確であるという保証はありません。トレース対象エリアのネットワーク トポロジは、ネットワークに加えられた最新の変更または更新を反映するよう、整合チェックを行う必要があります。
エンタープライズ ジオデータベースを操作する場合は、入力ユーティリティ ネットワークがユーティリティ ネットワーク サービスである必要があります。
Python を介して [トレース (Trace)] ツールを使用してサブネットワークベースのトレースを実行する場合、サブネットワーク定義の [サブネットワーク トレース構成] は入力した [層] には使用されないため、手動で指定する必要があります。
フィルター バリア、フィルター関数バリア、関数、および出力条件の日付フィールドに割り当てられたネットワーク属性を操作する場合は、日付値を yyyy-mm-dd hh:mm:ss として書式設定する必要があります (例: 2020-10-12 18:45:31)。
構文
arcpy.un.Trace(in_utility_network, trace_type, {starting_points}, {barriers}, {domain_network}, {tier}, {target_tier}, {subnetwork_name}, {shortest_path_network_attribute_name}, {include_containers}, {include_content}, {include_structures}, {include_barriers}, {validate_consistency}, {condition_barriers}, {function_barriers}, {traversability_scope}, {filter_barriers}, {filter_function_barriers}, {filter_scope}, {filter_bitset_network_attribute_name}, {filter_nearest}, {nearest_count}, {nearest_cost_network_attribute}, {nearest_categories}, {nearest_assets}, {functions}, {propagators}, {output_assettypes}, {output_conditions}, {include_isolated_features}, {ignore_barriers_at_starting_points}, {include_up_to_first_spatial_container}, {result_types}, selection_type, {clear_all_previous_trace_results}, {trace_name}, {aggregated_points}, {aggregated_lines}, {aggregated_polygons}, {allow_indeterminate_flow}, {validate_locatability}, {use_trace_config}, {trace_config_name})
パラメーター | 説明 | データ タイプ |
in_utility_network | トレースを実行するユーティリティ ネットワーク。エンタープライズ ジオデータベースを操作する場合、入力ユーティリティ ネットワークはフィーチャ サービスから取得したものである必要があります。データベース接続から取得したユーティリティ ネットワークはサポートされていません。 | Utility Network; Utility Network Layer |
trace_type | 実行するトレースのタイプを指定します。
| String |
starting_points (オプション) | トレースの始点を表す 1 つ以上のレコードを含むテーブルまたはフィーチャクラス。このフィーチャクラスまたはテーブルには、関連付けられているネットワーク フィーチャの情報を格納する FEATUREGLOBALID フィールドが含まれている必要があります。特定の形式を表示するには、[トレース位置] ウィンドウの [始点] ツールを使用して始点を作成し、デフォルトのジオデータベースに保存された UN_Temp_Starting_Points フィーチャクラスのスキーマを表示します。 | Feature Layer; Table View |
barriers (オプション) | トレースがそのポイントを通過しないようにするトレースのバリアを表す 1 つ以上のフィーチャを含むテーブルまたはフィーチャクラス。このフィーチャクラスまたはテーブルには、関連付けられているネットワーク フィーチャの情報を格納する FEATUREGLOBALID フィールドが含まれている必要があります。特定の形式を表示するには、[トレース位置] ウィンドウの [バリア] ツールを使用してバリアを作成し、デフォルトのジオデータベースに保存された UN_Temp_Barriers フィーチャクラスのスキーマを表示します。 | Feature Layer; Table View |
domain_network (オプション) | トレースを実行するドメイン ネットワークの名前。サブネットワーク、サブネットワーク コントローラー、上流解析、および下流解析トレース タイプを実行する場合、このパラメーターは必須です。 | String |
tier (オプション) | トレースを開始する層の名前。サブネットワーク、サブネットワーク コントローラー、上流解析、および下流解析トレース タイプを実行する場合、このパラメーターは必須です。 | String |
target_tier (オプション) | 入力層が流れるターゲット層の名前。上流または下流解析トレースでこのパラメーターを使用しない場合は、開始するサブネットワークの境界に到達するとトレースは停止します。このパラメーターを使用すると、このトレースを階層の上方または下方に継続できます。 | String |
subnetwork_name (オプション) | トレースを実行するサブネットワークの名前。このパラメーターは、サブネットワーク解析トレースの実行時に使用されます。サブネットワーク名を指定した場合、[始点] パラメーター (Python では starting_points パラメーター) は必要ありません。 | String |
shortest_path_network_attribute_name (オプション) | 最短パスを計算するために使用するネットワーク属性。最短パス解析トレースを実行すると、形状の長さなど、数値のネットワーク属性を使用して、最短パスが計算されます。コストに基づくパスと距離に基づくパスの両方が得られます。最短パス解析トレースを実行する場合は、このパラメーターは必須です。 | String |
include_containers (オプション) | 格納器フィーチャをトレース結果に含めるかどうかを指定します。
| Boolean |
include_content (オプション) | 格納器の格納物をトレース結果に含めるかどうかを指定します。
| Boolean |
include_structures (オプション) | 構造物フィーチャおよびオブジェクトをトレース結果に含めるかどうかを指定します。
| Boolean |
include_barriers (オプション) | 通過可能性バリア フィーチャをトレース結果に含めるかどうかを指定します。通過可能性バリアは、サブネットワーク定義で事前に設定されている場合でも任意指定です。このパラメーターは、ターミナルを含むデバイス フィーチャには適用されません。
| Boolean |
validate_consistency (オプション) | 通過したフィーチャのいずれかでダーティ エリアが発生した場合、エラーを返すかどうかを指定します。これは、トレースがネットワーク内を一貫したステータスでフィーチャを通過することを保証する唯一の方法です。ダーティ エリアを削除するには、ネットワークトポロジを整合チェックします。
| Boolean |
condition_barriers [[Name, Operator, Type, Value, Combine Using],...] (オプション) | ネットワーク属性との比較またはカテゴリ文字列のチェックに基づいて、フィーチャに対して通過可能性バリア条件を設定します。条件バリアは、ネットワーク属性、演算子とタイプ、および属性値を使用します。たとえば、フィーチャが Device Status の特定の値と等しい Open 属性を持っている場合に、トレースを停止します。フィーチャがこの条件を満たしている場合、トレースが停止します。複数の属性を使用している場合、[結合方法] パラメーターを使用して [And] 条件および [Or] 条件を定義することができます。 条件バリアの構成は次のとおりです。
条件バリアの operator の値オプションは次のとおりです。
条件バリアの Type の値オプションは次のとおりです。
条件バリアの Combine Using の値オプションは次のとおりです。
| Value Table |
function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (オプション) | 関数に基づいて、フィーチャに対する通過可能性バリアを設定します。関数バリアを使用して、始点からトレースが移動できる距離の制限としてそのような設定を行うか、トレースを停止するための最大値を設定することができます。たとえば、通過した各ラインの長さが、それまでに移動した合計距離に追加されます。移動した全長が指定された値に達した場合、トレースが停止します。 関数バリアの構成は次のとおりです。
関数バリアの [function] 値のオプションは次のとおりです。
関数バリアの [operator] 値のオプションは次のとおりです。
関数バリアの [Use Local Values] のオプションは次のとおりです。
| Value Table |
traversability_scope (オプション) | 適用する通過可能性のタイプです。通過可能性範囲は、通過可能性がジャンクション、エッジ、またはその両方のいずれに適用されるかを決定します。たとえば、Device Status が Open であり、通過可能性の範囲がエッジのみに設定されている場合にトレースを停止するように条件バリアを定義すると、トレースでオープン デバイスが検出された場合でも、Device Status はジャンクションにしか適用されないため、トレースは停止しません。つまり、このパラメーターは、トレースで、ジャンクション、エッジ、またはその両方を無視するかどうかを示します。
| String |
filter_barriers [[Name, Operator, Type, Value, Combine Using],...] (オプション) | いつ特定のカテゴリまたはネットワーク属性のトレースを停止するかを指定します。たとえば、特定の値と等しいライフ サイクル ステータス属性があるフィーチャでトレースを停止します。このパラメーターを使用して、システムに定義されているネットワーク属性の値に基づいてターミネーターを設定します。複数の属性を使用している場合、Combine Using オプションを使用して、[And] または [Or] 条件を定義できます。 フィルター バリアの構成は次のとおりです。
フィルター バリアの operator の値オプションは次のとおりです。
フィルター バリアの Type の値オプションは次のとおりです。
フィルター バリアの Combine Using の値オプションは次のとおりです。
| Value Table |
filter_function_barriers [[Function, Attribute, Operator, Value, Use Local Values],...] (オプション) | 特定のカテゴリのトレース結果をフィルタリングします。 フィルター関数バリアの構成は次のとおりです。
フィルター関数バリアの function の値オプションは次のとおりです。
フィルター関数バリアの operator の値オプションは次のとおりです。
フィルター関数バリアの Use Local Values オプションは次のとおりです。
| Value Table |
filter_scope (オプション) | 特定のカテゴリのフィルターをジャンクション、エッジ、その両方のいずれに適用するかを指定します。たとえば、Device Status が Open であり、通過可能性の範囲がエッジのみに設定されている場合にトレースを停止するようにフィルター バリアを定義すると、トレースでオープン デバイスが検出された場合でも、Device Status はジャンクションにしか適用されないため、トレースは停止しません。つまり、このパラメーターは、トレースで、ジャンクション、エッジ、またはその両方を無視するかどうかを示します。
| String |
filter_bitset_network_attribute_name (オプション) | bitset によるフィルター処理に使用するネットワーク属性の名前。このパラメーターは、上流、下流、およびループ トレース タイプのみに適用できます。このパラメーターを使用すると、トレースが実世界のシナリオをより細密に反映するように、トレース中に特別なロジックを追加できます。たとえば、ループ トレースの場合、Phases current ネットワーク属性は、ループが真の電気ループである (ループ全体で同じフェーズに電源が入る) かどうかを判断し、トレース結果の真の電源ループのみを返すことができます。上流トレースの場合、たとえば、配電網のトレース時に Phases current ネットワーク属性を指定することにより、トレース結果に、すべてのパスではなく、ネットワーク属性で指定された有効なパスのみを含めます。 | String |
filter_nearest (オプション) | K 最近隣内挿アルゴリズムを使用して、所定の距離内の特定のタイプのフィーチャの数を返すかどうかを指定します。このパラメーターを使用すると、個数、コスト、およびカテゴリやアセット タイプのコレクションを指定できます。
| Boolean |
nearest_count (オプション) | filter_nearest を FILTER_BY_NEAREST にしたときに返されるフィーチャの数。 | Long |
nearest_cost_network_attribute (オプション) | filter_nearest を FILTER_BY_NEAREST にしたときに、近接性、コスト、または距離の計算に使用される数値のネットワーク属性 (たとえば、形状の長さ)。 | String |
nearest_categories [nearest_categories,...] (オプション) | filter_nearest を FILTER_BY_NEAREST にしたときに返されるカテゴリ (たとえば、Protective)。 | String |
nearest_assets [nearest_assets,...] (オプション) | filter_nearest を FILTER_BY_NEAREST にしたときに返されるアセット グループおよびアセット タイプ (たとえば、ElectricDistributionDevice/Transformer/Step Down)。 | String |
functions [[Function, Attribute, Filter Name, Filter Operator, Filter Type, Filter Value],...] (オプション) | 演算関数をトレース結果に適用します。 関数の構成は次のとおりです。
関数の Function の値オプションは次のとおりです。
たとえば、始点フィーチャの値が 20 とします。次のフィーチャは 30 の値を持っています。MINIMUM 関数を使用している場合、結果は 20 になります。MAXIMUM 結果は 30、ADD の結果は 50、AVERAGE の結果は 25、COUNT の結果は 2、SUBTRACT の結果は -10 になります。 [Filter Operator] 値のオプションは次のとおりです。
関数の Filter Type の値オプションは次のとおりです。
| Value Table |
propagators [[Attribute, Substitution Attribute, Function, Operator, Value],...] (オプション) | 伝播させるネットワーク属性、およびトレース中に伝播がどのように発生するかを指定します。伝播されるクラス属性は、サブネットワーク内の他のフィーチャに広められる、サブネットワーク コントローラーの重要な値を示します。たとえば、配電モデルでは、位相値を伝播することができます。 プロパゲーターの構成は次のとおりです。
プロパゲーターの function の値オプションは次のとおりです。
プロパゲーターの operator の値オプションは次のとおりです。
メモ:このパラメーターは Python でのみ使用できます。 | Value Table |
output_assettypes [output_assettypes,...] (オプション) | 結果に含める出力アセット タイプをフィルタリングします (たとえば、頭上の変圧器のみを返す、など)。 | String |
output_conditions [[Name, Operator, Type, Value, Combine Using],...] (オプション) | ネットワーク属性またはカテゴリに基づいて返されるフィーチャのタイプを指定します。たとえば、Tap フィーチャ以外をすべて除外するよう構成されたトレースでは、Tap カテゴリが割り当てられていないトレース済みフィーチャは、結果に含まれません。そのカテゴリがあるトレース対象フィーチャは結果選択セットに返されます。複数の属性を使用している場合、Combine Using オプションを使用して、[And] または [Or] 条件を定義できます。 出力条件の構成は次のとおりです。
出力条件の operator の値オプションは次のとおりです。
出力条件の Type の値オプションは次のとおりです。
出力条件の Combine Using の値オプションは次のとおりです。
| Value Table |
include_isolated_features (オプション) | 分離フィーチャをトレース結果に含めるかどうかを指定します。このパラメーターは、分離性トレースの実行時にのみ使用されます。
メモ:エンタープライズ ジオデータベースを使用している場合、分離トレース タイプには ArcGIS Enterprise 10.7 以降が必要です。 | Boolean |
ignore_barriers_at_starting_points (オプション) | 始点ではトレース構成内のダイナミック バリアを無視するかどうかを指定します。これは、上流の保護デバイスのトレースを実行し、検出された保護デバイス (バリア) を始点として使用して、その後の上流の保護デバイスを検索する場合に、役立ちます。
| Boolean |
include_up_to_first_spatial_container (オプション) | トレース結果内のネットワーク エレメントごとに、最初の空間格納器まで (最初の空間格納器を含む) に遭遇した格納器のみを含めるように、返される格納器を制限するかどうかを指定します。所定のネットワーク エレメントで、空間格納器が検出されず、非空間格納器のみがある場合、結果にはすべての非空間格納器が含まれます。このパラメーターは、Include Containers が有効である場合にのみ使用できます。
| Boolean |
result_types [result_types,...] (オプション) | トレースによって返される結果のタイプを指定します。
| String |
selection_type | どのように選択を適用するか、選択がすでに存在する場合にはそれをどうするかを指定します。
| String |
clear_all_previous_trace_results (オプション) | 集約されたジオメトリを格納するために選択されたフィーチャクラスの内容を切り捨てるか追加するかを指定します。このパラメーターは、集約されたジオメトリの結果タイプのみに適用されます。
| Boolean |
trace_name (オプション) | トレース操作の名前。この値は出力フィーチャクラスの TRACENAME フィールドに格納され、トレース結果の識別に役立ちます。このパラメーターは、集約されたジオメトリの結果タイプのみに適用されます。 | String |
aggregated_points (オプション) | 集約された結果ジオメトリを含む出力マルチポイント フィーチャクラス。デフォルトでは、このパラメーターは Trace_Results_Aggregated_Points というシステムで生成されるフィーチャクラスを使用して設定され、プロジェクトのデフォルト ジオデータベースに格納されます。 このフィーチャクラスが存在しない場合は、自動的に作成されます。既存のフィーチャクラスも、集約されたジオメトリの格納に使用できます。デフォルト以外のフィーチャクラスを使用する場合は、TRACENAME という文字列フィールドを含むマルチポイント フィーチャクラスである必要があります。このパラメーターは、集約されたジオメトリの結果タイプのみに適用されます。 | Feature Class |
aggregated_lines (オプション) | 集約された結果ジオメトリを含む出力ポリライン フィーチャクラス。デフォルトでは、このパラメーターは Trace_Results_Aggregated_Lines というシステムで生成されるフィーチャクラスを使用して設定され、プロジェクトのデフォルト ジオデータベースに格納されます。 このフィーチャクラスが存在しない場合は、自動的に作成されます。既存のフィーチャクラスも、集約されたジオメトリの格納に使用できます。デフォルト以外のフィーチャクラスを使用する場合は、TRACENAME という文字列フィールドを含むポリライン フィーチャクラスである必要があります。このパラメーターは、集約されたジオメトリの結果タイプのみに適用されます。 | Feature Class |
aggregated_polygons (オプション) | 集約された結果ジオメトリを含む出力ポリゴン フィーチャクラス。デフォルトでは、このパラメーターは Trace_Results_Aggregated_Polygons というシステムで生成されるフィーチャクラスを使用して設定され、プロジェクトのデフォルト ジオデータベースに格納されます。 このフィーチャクラスが存在しない場合は、自動的に作成されます。既存のフィーチャクラスも、集約されたジオメトリの格納に使用できます。デフォルト以外のフィーチャクラスを使用する場合は、TRACENAME という文字列フィールドを含むポリゴン フィーチャクラスである必要があります。このパラメーターは、集約されたジオメトリの結果タイプのみに適用されます。 | Feature Class |
allow_indeterminate_flow (オプション) | フローが不定のフィーチャをトレースするかどうかを指定します。このパラメーターは、上流解析トレースまたは下流解析トレースを実行する場合にのみ適用されます。
メモ:このパラメーターには、ユーティリティ ネットワーク バージョン 5 以降が必要です。 | Boolean |
validate_locatability (オプション) | トレース中に、通過したオブジェクトの関連付け階層内の必要な格納、付属物、接続性がいずれも関連付けられていない非空間のジャンクション オブジェクトまたはエッジ オブジェクトが検出された場合にエラーを返すかどうかを指定します。このパラメーターにより、トレースまたはサブネットワーク更新操作によって返される非空間オブジェクトを、フィーチャまたは他の配置可能オブジェクトとの関連付けを通じて配置できるようになります。
メモ:このパラメーターには、ユーティリティ ネットワーク バージョン 4 以降が必要です。 | Boolean |
use_trace_config (オプション) | [トレース (Trace)] ツールのパラメーターの設定に既存のトレース構成を使用するかどうかを指定します。
メモ:このパラメーターには、ユーティリティ ネットワーク バージョン 5 以降が必要です。 | Boolean |
trace_config_name (オプション) | トレースのプロパティの定義に使用されるトレース構成の名前を指定します。このパラメーターは、[use_trace_config] パラメーターが [USE_TRACE_CONFIGURATION] に設定されている場合にのみ有効になります。 | String |
派生した出力
名前 | 説明 | データ タイプ |
out_utility_network | 更新されるユーティリティ ネットワーク。 | ユーティリティ ネットワーク |
コードのサンプル
フェーズ A、B、C に変圧器負荷を追加する中電圧層にある配電網で下流トレースを実行します。
'''****************************************************************************
Name: DownstreamTrace.py
Description: This script executes a downstream trace on the Medium Voltage tier
that adds up the transformer load on phases A, B, and C.
Created by: Esri
****************************************************************************'''
# Import required modules
import arcpy
# Set local variables
in_utility_network = "NapervilleElectric Utility Network"
trace_type = "DOWNSTREAM"
starting_points = "C:\\MyProject\\Bissell.gdb\UN_Temp_Starting_Points"
barriers = "C:\\MyProject\\Bissell.gdb\UN_Temp_Barriers"
domain_network = "ElectricDistribution"
tier = "Medium Voltage Radial"
include_containers = "INCLUDE_CONTAINERS"
include_structures = "INCLUDE_STRUCTURES"
condition_barriers = "'Device Status' IS_EQUAL_TO SPECIFIC_VALUE 1 #"
functions = "ADD 'Transformer Load' 'Phases Normal' INCLUDES_THE_VALUES SPECIFIC_VALUE 4;ADD 'Transformer Load' 'Phases Normal' INCLUDES_THE_VALUES SPECIFIC_VALUE 2;ADD 'Transformer Load' 'Phases Normal' INCLUDES_THE_VALUES SPECIFIC_VALUE 1"
# Run Trace with specified parameters and leave the rest default
arcpy.Trace_un(in_utility_network,
trace_type,
starting_points,
barriers,
domain_network,
tier,
include_containers=include_containers,
include_structures=include_structures,
condition_barriers=condition_barriers,
functions=functions)
環境
ライセンス情報
- Basic: いいえ
- Standard: はい
- Advanced: はい