生成 LRS 数据产品 (位置参考)

适用于 Location Referencing 许可。

摘要

用于变换 LRS 数据,为 LRS 网络中的选定路径创建长度、路径日志或要素计数数据产品。

使用情况

  • 模板文件必须为 .json

  • 针对输入路径要素参数,使用网络要素类。

  • 此工具不会修改输入,并将创建 .csv 文件或地理数据库表作为输出。

  • 此工具支持选择和定义查询功能。

  • 生效日期参数用于确定网络的时态视图。 仅使用在该日期处于活动状态的路径进行输出计算。

  • 当创建长度数据产品时,请考虑以下事项:

    • 使用指定汇总字段和长度字段的 LRS 数据模板。 您可以使用管线公路和高速公路的定位参考模板。
    • 汇总字段和长度字段必须与 LRS 网络图层位于同一地理数据库中。
    • 当从网络测量单位转换为其他单位时,支持单位转换。
    • 如果 .json 文件中未包含汇总字段,边界要素汇总字段参数才有效。

  • 当创建路径日志数据产品时,请考虑以下事项:

    • 使用指定日志、位置和引用字段的 LRS 数据模板。 您可以使用管线公路和高速公路的定位参考模板。
    • 日志图层和字段必须与 LRS 网络图层位于同一地理数据库中。
    • 位置图层和字段必须为面图层,并且与 LRS 网络图层位于同一地理数据库中。
    • 引用图层和字段必须为 LRS 点事件要素类,并且与 LRS 网络图层位于同一地理数据库中。

  • 当创建要素计数数据产品时,请考虑以下事项:

    • 使用指定计数、汇总和路径标识符字段的 LRS 数据模板。 您可以使用管线公路和高速公路的定位参考模板。
    • 计数、汇总和路径标识符字段必须与 LRS 网络图层位于同一地理数据库中。
    • 如果 .json 文件中未包含汇总字段,边界要素汇总字段参数才有效。

参数

标注说明数据类型
模板

输入 LRS 数据模板,用于指定摘要和长度字段(长度数据产品);路径标识符、日志、位置和引用字段(路径日志数据产品);或计数、摘要和路径标识符字段(要素计数数据产品)。

File
输入路径要素

将用于计算长度、路径日志或要素计数的 LRS 网络。

Feature Layer
生效日期

定义网络时态视图的日期。

Date
长度单位
(可选)

指定输出中长度字段的测量单位。

仅当创建长度数据产品时,此参数才可用。

  • 英寸(美制测量)将以英寸为单位。
  • 英尺(美制测量)单位将为英尺。
  • 码(美制测量)单位将为码。
  • 英里(美制测量)单位将为英里。
  • 海里(美制测量)单位将为海里。
  • 法定英里单位将为法定英里。
  • 英尺(国际)单位将为国际英尺。
  • 毫米单位将为毫米。
  • 厘米单位将为厘米。
  • 单位将为米。
  • 千米单位将为千米。
  • 分米单位将为分米。
String
边界要素
(可选)

用于汇总数据的边界图层。

仅当创建长度或要素计数数据产品时,此参数才可用。

Feature Layer
汇总字段
(可选)

提供汇总行名称的边界图层字段。

仅当创建长度或要素计数数据产品时,此参数才可用。

Field
排除空汇总行
(可选)

指定是否排除空的汇总行。

  • 选中 - 将从输出中排除长度或要素计数为零的行。 这是默认设置。
  • 未选中 - 将不会从输出中排除长度或要素计数为零的行。

仅当创建长度或要素计数数据产品时,此参数才可用。

Boolean
输出格式
(可选)

指定输出文件格式。

  • CSV输出文件将为 .csv。 这是默认设置。
  • 输出文件将为地理数据库表。
String
输出文件
(可选)

将写入计算的长度、路径日志或要素计数的输出 .csv 文件。

File
输出表
(可选)

将使用计算的长度、路径日志或要素计数创建的地理数据库表。

Table

arcpy.locref.GenerateLrsDataProduct(in_template, in_route_features, effective_date, {units}, {boundary_features}, {summary_field}, {exclude_null_summary_rows}, {output_format}, {out_file}, {out_table})
名称说明数据类型
in_template

输入 LRS 数据模板,用于指定摘要和长度字段(长度数据产品);路径标识符、日志、位置和引用字段(路径日志数据产品);或计数、摘要和路径标识符字段(要素计数数据产品)。

File
in_route_features

将用于计算长度、路径日志或要素计数的 LRS 网络。

Feature Layer
effective_date

定义网络时态视图的日期。

Date
units
(可选)

指定输出中长度字段的测量单位。

仅当创建长度数据产品时,此参数才可用。

  • INCHES将以英寸为单位。
  • FEET单位将为英尺。
  • YARDS单位将为码。
  • MILES单位将为英里。
  • NAUTICAL_MILES单位将为海里。
  • INTMILES单位将为法定英里。
  • INTFEET单位将为国际英尺。
  • MILLIMETERS单位将为毫米。
  • CENTIMETERS单位将为厘米。
  • METERS单位将为米。
  • KILOMETERS单位将为千米。
  • DECIMETERS单位将为分米。
String
boundary_features
(可选)

用于汇总数据的边界图层。

仅当创建长度或要素计数数据产品时,此参数才可用。

Feature Layer
summary_field
(可选)

提供汇总行名称的边界图层字段。

仅当创建长度或要素计数数据产品时,此参数才可用。

Field
exclude_null_summary_rows
(可选)

指定是否排除空的汇总行。

  • EXCLUDE将从输出中排除长度或要素计数为零的行。 这是默认设置。
  • DO_NOT_EXCLUDE将不会从输出中排除长度或要素计数为零的行。

仅当创建长度或要素计数数据产品时,此参数才可用。

Boolean
output_format
(可选)

指定输出文件格式。

  • CSV输出文件将为 .csv。 这是默认设置。
  • TABLE输出文件将为地理数据库表。
String
out_file
(可选)

将写入计算的长度、路径日志或要素计数的输出 .csv 文件。

File
out_table
(可选)

将使用计算的长度、路径日志或要素计数创建的地理数据库表。

Table

代码示例

GenerateLrsDataProduct 示例 1(独立脚本)

以下独立脚本演示了如何在独立脚本中使用 GenerateLrsDataProduct 函数。

# Name: GenerateLrsDataProduct_ex1.py
# Description: Transforms LRS data to create a data product for the selected routes in an LRS Network in a stand-alone script.
# Requirements: ArcGIS Location Referencing

# Import arcpy module
import arcpy

# Check out any necessary licenses
arcpy.CheckOutExtension("LocationReferencing")

# Local tool variables
in_template = r"C:\Data\Template.json"
in_route_features = r"C:\Data\SampleData.gdb\LRS\Network"
effective_date = "12/31/2024"
units = "METERS"
boundary_features = None
summary_field = None
exclude_null_summary_rows = "EXCLUDE"
output_format = "CSV"
out_file = r"C:\Data\LP1.csv"
out_table = None

# Run the tool
arcpy.locref.GenerateLrsDataProduct(in_template, in_route_features, effective_date, units, boundary_features, summary_field, exclude_null_summary_rows, output_format, out_file, out_table)

# Check in licenses
arcpy.CheckInExtension("LocationReferencing")
GenerateLrsDataProduct 示例 2(Python 窗口)

以下脚本演示了如何在 Python 窗口中使用 GenerateLrsDataProduct 函数。

# Name: GenerateLrsDataProduct_ex2.py
# Description: Transforms LRS data to create a data product for the selected routes in an LRS Network in the inline Python window in ArcGIS Pro.
# Requirements: ArcGIS Location Referencing

# Local tool variables
in_template = r"C:\Data\Template.json"
in_route_features = r"C:\Data\SampleData.gdb\LRS\Network"
effective_date = "12/31/2024"
units = "METERS"
boundary_features = None
summary_field = None
exclude_null_summary_rows = "DO_NOT_EXCLUDE"
output_format = "CSV"
out_file = r"C:\Data\LP2.csv"
out_table = None

# Run the tool
arcpy.locref.GenerateLrsDataProduct(in_template, in_route_features, effective_date, units, boundary_features, summary_field, exclude_null_summary_rows, output_format, out_file, out_table)
GenerateLrsDataProduct 示例 3(独立脚本)

以下独立脚本演示了如何将 GenerateLrsDataProduct 函数与要素服务中的数据配合使用。

# Name: GenerateLrsDataProduct_Ex3.py
# Description: Transforms LRS data to create a data product for the selected routes using a feature service.
# Requires: ArcGIS Location Referencing

# Import arcpy module.
import arcpy

# Check out the license
arcpy.CheckOutExtension("LocationReferencing")

# Input event and target LRS network are in feature service.  Signing in portal is required to access the feature service.
arcpy.SignInToPortal('https://yourdomain.com/portal', 'username', 'password')

# Map the LRS network from the feature service. Here, 1 corresponds to the target LRS Network's layer ID.
in_route_features = r"https://yourdomain.com/server/rest/services/FeatureServiceName/FeatureServer/1"

# Set tool variables
in_template = r"C:\Data\Template.json"
effective_date = "12/31/2024"
units = "FEET"
boundary_features = None
summary_field = None
exclude_null_summary_rows = "EXCLUDE"
output_format = "CSV"
out_file = r"C:\Data\LP3.csv"
out_table = None

# Run the tool
arcpy.locref.GenerateLrsDataProduct(in_template, in_route_features, effective_date, units, boundary_features, summary_field, exclude_null_summary_rows, output_format, out_file, out_table)

# Check in license
arcpy.CheckInExtension("LocationReferencing")

许可信息

  • Basic: 需要 ArcGIS Location Referencing(ArcGIS Pipeline Referencing 或 ArcGIS Roads and Highways)
  • Standard: 需要 ArcGIS Location Referencing(ArcGIS Pipeline Referencing 或 ArcGIS Roads and Highways)
  • Advanced: 需要 ArcGIS Location Referencing(ArcGIS Pipeline Referencing 或 ArcGIS Roads and Highways)

相关主题