添加追踪配置 (追踪网络)

描述

在追踪网络中创建追踪配置。

追踪配置用于配置和存储复杂追踪的属性,以供重用和共享。追踪网络中存储的追踪配置可以从追踪工具加载和执行,或通过 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

指定要配置的追踪类型。

  • CONNECTED将使用从一个或多个起点开始并沿着已连接要素向外跨越的已连接追踪。
  • UPSTREAM将使用能够发现网络中某位置上游的要素的上溯追踪。此类追踪使用流向。
  • DOWNSTREAM将使用能够发现网络中某位置下游的要素的下溯追踪。此类追踪使用流向。
  • SHORTEST_PATH将使用可查找网络中两个起点之间的最短路径(无论流向为何)的最短路径追踪。遍历路径的成本取决于为 shortest_path_network_attribute_name 参数设置的网络属性。
String
description
(可选)

追踪配置的描述。

String
tags
[tags,...]
(可选)

用于标识追踪配置的标签集。可在搜索和索引中使用此类标签。

String
path_direction
(可选)

指定追踪路径的方向。遍历路径的成本取决于 shortest_path_network_attribute_name 参数值。此参数仅在运行 SHORTEST_PATH 追踪类型时使用。

  • NO_DIRECTION将使用两个起点之间的路径(无论流向为何)。这是默认设置。
  • PATH_UPSTREAM将使用两个起点之间的上游路径。
  • PATH_DOWNSTREAM将使用两个起点之间的下游路径。
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],...]
(可选)

基于与网络属性的比较,对要素设置可遍历性障碍条件。条件障碍使用网络属性、运算符和类型以及属性值。例如,当要素的 Code 属性等于 ArtificialPath 的特定值时,停止追踪。当要素满足此条件时,追踪将停止。如果要使用多个属性,可使用 Combine Using 组件来定义“和”或“或”条件。

条件障碍组件如下:

  • 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 的边之后,形状长度总和即已达到 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],...]
(可选)

根据网络属性返回的要素类型。例如,如果将追踪配置为“过滤掉除水龙头要素外的所有要素”,那么未分配“水龙头”属性的追踪要素均不会包含在结果中。任何追踪的要素都会返回到结果选择集中。如果要使用多个属性,可使用 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: 是

相关主题