COPY CENTERLINES

Summary

Copy Centerlines copies your centerline features to the CENTERLINE feature class in an existing Gas HCA Tool project database (previously created using the Initialize Database tool).

The Copy Centerlines tool is typically the second tool you run in any of the Gas HCA Tool workflows. The next tool to run in all Gas HCA Tool workflows is typically the Prepare Centerline Buffers tool.

Usage

The CENTERLINE feature class defines the linear referencing backbone upon which all Gas HCA Tool calculations are performed. All Gas HCA Tool linear outputs incorporate BeginMeasure and EndMeasure attributes derived from their underlying centerline features. Because of this, all Gas HCA Tool workflows use the CENTERLINE feature class.

The centerline features that you supply as input to the Copy Centerlines tool should consist of the continuous, non-branching runs of pipe upon which you desire to perform calculations. Typically, your input centerline features correspond to named pipeline segments. Under the Pipeline Open Data Standard (PODS) nomenclature, your centerline features should consist of PODS Route Under Esri Utility and Pipeline Data Model (UPDM) nomenclature, your centerline features should consist of UPDM Continuous Network features. The CENTERLINE feature class stores centerline features as m-aware polylines, with the m-values at the vertices in a CENTERLINE feature, defining the linear referencing system of measurement along the CENTERLINE feature. Your input centerline features may be either simple polylines or m-aware polylines. If you input m-aware polylines, existing m-values are preserved. If you input simple polylines, m-values are created in the output CENTERLINE features by linearly interpolating m-values along your centerline features in the direction of digitization between the Begin- and End-Measure values defined by your input Centerline Begin Measure and Centerline End Measure fields.
Input Centerline Features – Your input centerline features must contain the following attributes (your field names need not match, but fields containing this information must be present):
- - Centerline Route ID Field– A field that uniquely identifies each input centerline feature. Your Route ID field is preserved in the ORIGINAL_ROUTE_ID field in the output CENTERLINE features. The Copy Centerlines tool generates new identifiers for the output CENTERLINE features that are stored in the ROUTE_ID field as Globally Unique Identifier (GUID) values.
  - Centerline Begin Measure Field – A field that defines the begin measure values of your centerline features.
  - Centerline End Measure Field – A field that defines the end measure values of your centerline features.

If you supply m-aware polylines as input centerline features, your centerline feature m-values should be consistent with the feature’s Begin- and End-Measure field values, and the feature m-values must monotonically increase (or decrease) along the length of the feature. If your feature m-values are inconsistent with the Begin- and End-Measure field values, the tool will attempt to update feature m-values (by scaling) to be consistent with the Begin- and End-Measure field values.

Output Centerline Features – The default destination for your copied centerline features is the CENTERLINE feature class in the designated input Gas HCA Tool project geodatabase, and this is the default value for this parameter. However, this parameter allows you to specify an alternate destination and name for the output CENTERLINE features, if desired.

Syntax

PrepareCopyCenterlineTool_hcapy (project_database, centerline_layer, centerline_route_id_field, centerline_begin_measure_field, centerline_end_measure_field, {output_centerline})

Parameter	Explanation	Data Type
project_database	Dialog Reference Select a Gas HCA Tool project geodatabase created using the Initialize Database tool. The output from this tool is stored in this workspace. There is no Python reference for this parameter.	Workspace
centerline_layer	Dialog Reference Specify the data source for you input centerline features. There is no Python reference for this parameter.	Table View
centerline_route_id_field	Dialog Reference Select the field that uniquely identifies your input centerline features. There is no Python reference for this parameter.	Field
centerline_begin_measure_field	Dialog Reference Specify the field that contains the begin measure values for your input centerline features. There is no Python reference for this parameter	Field
centerline_end_measure_field	Dialog Reference Specify the field that contains the end measure values for your input centerline features. There is no Python reference for this parameter.	Field
output_centerline (Optional)	Dialog Reference Specify the destination for your output copied centerline features. There is no Python reference for this parameter.	Feature Layer

Code sample

Copy Centerlines

import hcapy

arcpy.ImportToolbox(“C:/Workspace/hcapy/src/hcapy/esri/Toolboxes/Gas HCA Tools.pyt”)

project_database = r”C:\Temp\HCA.gdb”

centerline_layer = r”C:\Temp\HCA.gdb\StationSeries”

centerline_route_id_field = “EVENTID”

centerline_begin_measure_field = “BEGIN_MEASURE”

centerline_end_measure_field = “END_MEASURE”

arcpy.PrepareCopyCenterline_hcapy(project_database, centerline_layer, centerline_route_id_field, centerline_begin_measure_field, centerline_end_measure_field)

Environments

Current Workspace, Scratch Workspace, Default Output Z Value, M Resolution, M Tolerance, Output M Domain, Output XY Domain, Output Z Domain, Output Coordinate System, Extent, Geographic Transformations, Output has M values, Output has Z values, XY Resolution, XY Tolerance, Z Resolution, Z Tolerance

Licensing information

This tool requires a valid Gas HCA Tool user license or subscription. Please see the Request License and Register License tool help topics for details on obtaining and registering a Gas HCA Tool software license.

Credits

Use limitations

There are no access and use limitations for this item.