Time Aware HCA-MCA Calculation (Method 2)

Summary

Time Aware HCA-MCA Calculation (Method 2) calculates ‘time aware’ HCA-MCA ranges by copying the results of a prior HCA-MCA analysis into the Gas HCA Tool project geodatabase, and then dynamically segmenting the current output of the HCA-MCA Calculation (Method 2) tool with HCA-MCA ranges from the prior analysis, with the output time aware HCA-MCA range features segmented by determination date. HCA and MCA ranges from the prior analysis are persisted in the time aware features output from this tool; HCA and MCA segments from the current analysis are only persisted in the time aware output features to the extent they are not covered by prior HCA and MCA ranges (i.e., they are newly identified HCA/MCA ranges). An HCA range in the current analysis takes precedence over an MCA range from the prior analysis.

Usage

  • Input Current HCA-MCA Range Features – This tool uses as input the HCA Range features created by a current HCA-MCA analysis using the HCA-MCA Calculation (Method 2) tool. Unless otherwise specified, the tool defaults this parameter to the HCA_RANGE_M2 feature class in your selected Gas HCA Tool project geodatabase.
  • Input Previous HCA-MCA Range Features or Records – This tool uses as input the HCA Range features created by a previous HCA-MCA analysis performed using the HCA-MCA Calculation (Method 2) tool, or an equivalent tool. There is no default value for this parameter. You may use the HCA_RANGE_M2 feature class from a Gas HCA Tool project geodatabase created for a prior HCA-MCA analysis, or you may use existing HCA-MCA range features or records from your pipeline database. Your input previous HCA-MCA range features/records must contain the following attribution for the tool to run:
      • Previous HCA-MCA Range Centerline Identifier Field – A field that uniquely identifies the centerline feature on which each previous HCA-MCA range feature/record occurs. This field will be mapped to and compared with ORIGINAL_ROUTE_ID field in the centerline features stored in the Gas HCA Tool project geodatabase (in the CENTERLINE feature class, by default). When using a data source that conforms to the HCA_RANGE_M2 schema, this parameter defaults to the RouteID field.
      • Previous HCA-MCA Range Begin Measure Field – A field that defines the begin measure values of your previous HCA-MCA range features/records. When using a data source that conforms to the HCA_RANGE_M2 schema, this parameter defaults to the BeginMeasure field.
      • Previous HCA-MCA Range End Measure Field – A field that defines the end measure values of your previous HCA-MCA range features/records. When using a data source that conforms to the HCA_RANGE_M2 schema, this parameter defaults to the EndMeasure field.
      • Previous HCA-MCA Range Unique Identifier Field – A field that uniquely identifies each of your previous HCA-MCA range features/records. When using a data source that conforms to the HCA_RANGE_M2 schema, this parameter defaults to the EventID field.
      • Previous HCA-MCA Range Type Field – A field that defines the range type of your previous HCA-MCA range features/records. Acceptable values are ‘HCA’ and ‘MCA.’ When using a data source that conforms to the HCA_RANGE_M2 schema, this parameter defaults to the RangeType field.
      • Previous HCA-MCA Range Determination Date Field – A field that stores the determination (discovery) date of your previous HCA-MCA range features/records. When using a data source that conforms to the HCA_RANGE_M2 schema, this parameter defaults to the DeterminationDate field.
  • Output Time Aware HCA-MCA Range Features – This parameter defines the destination of the output time aware HCA-MCA range features. Unless otherwise specified, the default destination for the output time aware HCA-MCA range features is the HCA_RANGE_M2_TA feature class in your selected Gas HCA Tool project geodatabase.
  • Output Previous HCA-MCA Range Features – This parameter defines the output destination for your copied previous HCA-MCA range features. Unless otherwise specified, the default destination for the previous HCA-MCA range featuresis the HCA_RANGE_M2_H feature class in your selected Gas HCA Tool project geodatabase.

Syntax

GenerateHCAMethod2TimeAware_hcapy (project_database, current_hca_mca_range_layer, previous_hca_mca_layer, previous_hca_mca_route_id, previous_hca_mca_begin_measure, previous_hca_mca_end_measure, previous_hca_mca_unique_id, previous_hca_mca_range_type, previous_determination_date, {hca_mca_ta_layer_out}, {output_hca_mca_history_layer})

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, by default.

There is no Python reference for this parameter.

Workspace
current_hca_mca_range_layer

Dialog Reference

Specify your input current HCA-MCA range features.

There is no Python reference for this parameter.

Table View
previous_hca_mca_layer

Dialog Reference

Specify your input previous HCA-MCA range features or records.

There is no Python reference for this parameter.

Table View
previous_hca_mca_route_id

Dialog Reference

Specify the field that uniquely identifies the centerline feature on which each previous HCA-MCA range feature/record occurs.

There is no Python reference for this parameter.

Field
previous_hca_mca_begin_measure

Dialog Reference

Specify the field that defines the begin measure values of your previous HCA-MCA range features/records.

There is no Python reference for this parameter.

Field
previous_hca_mca_end_measure

Dialog Reference

Specify the field that defines the end measure values of your previous HCA-MCA range features/records.

There is no Python reference for this parameter.

Field
previous_hca_mca_unique_id

Dialog Reference

Specify the field that uniquely identifies each of your previous HCA-MCA range features/records.

There is no Python reference for this parameter.

Field
previous_hca_mca_range_type

Dialog Reference

Specify the field that defines the range type of your previous HCA-MCA range features/records.

There is no Python reference for this parameter.

Field
previous_determination_date

Dialog Reference

Specify the field stores the determination (discovery) date of your previous HCA-MCA range features/records.

There is no Python reference for this parameter.

Field

hca_mca_ta_layer_out

(Optional)

Dialog Reference

Specify the destination for your output time aware HCA-MCA range features.

There is no Python reference for this parameter.

Table View
output_hca_mca_history_layer (Optional)

Dialog Reference

Specify the destination for your copied output previous HCA-MCA range features.

There is no Python reference for this parameter.

Table View

 

Code sample

Time Aware HCA-MCA Calculation (Method 2)

# Import GasHCA Library
import hcapy
# improt Gas HCA Tools
arcpy.ImportToolbox(“C:\Python27\ArcGIS10.6\Lib\site-packages\hcapy\esri\Toolboxes\Gas HCA Tools.pyt”)
project_database = r”C:\projects\GasHCA_Enhancements\A_DOTCLass_Test5.gdb”
current_clustered_dot_class_layer = r”C:\projects\GasHCA_Enhancements\A_DOTCLass_Test4_2.gdb\DOT_CLASS_RANGE_CLUSTERED”
current_unclustered_dot_class_layer = r”C:\projects\GasHCA_Enhancements\A_DOTCLass_Test4_2.gdb\DOT_CLASS_RANGE_UNCLUSTERED”
original_clustered_dotclass_layer = r”C:\projects\GasHCA_Enhancements\A_DOTCLass_Test4_2.gdb\DOT_CLASS_RANGE_CLUSTERED_ORIG”
original_clustered_dotclass_route_id = “ORIGINAL_ROUTE_ID”
original_clustered_dotclass_begin_measure = “BEGIN_MEASURE”
original_clustered_dotclass_end_measure = “END_MEASURE”
original_clustered_dotclass_class = “ORIGINAL_CLASS_TYPE”
original_clustered_dotclass_determination_date = “ORIGINAL_CLASS_DETERMINATION_DATE”
previous_clustered_dotclass_layer = r”C:\projects\GasHCA_Enhancements\A_DOTCLass_Test4_2.gdb\DOT_CLASS_RANGE_CLUSTERED_H”
previous_clustered_dotclass_route_id = “ORIGINAL_ROUTE_ID”
previous_clustered_dotclass_begin_measure = “BEGIN_MEASURE”
previous_clustered_dotclass_end_measure = “END_MEASURE”
previous_clustered_dotclass_class = “PREVIOUS_CLASS_TYPE”
previous_clustered_dotclass_determination_date = “PREVIOUS_CLASS_DETERMINATION_DATE”
original_unclustered_dotclass_layer = r”C:\projects\GasHCA_Enhancements\A_DOTCLass_Test4_2.gdb\DOT_CLASS_RANGE_UNCLUSTERED_ORIG”
original_unclustered_dotclass_route_id = “ORIGINAL_ROUTE_ID”
original_unclustered_dotclass_begin_measure = “BEGIN_MEASURE”
original_unclustered_dotclass_end_measure = “END_MEASURE”
original_unclustered_dotclass_class = “ORIGINAL_CLASS_TYPE”
original_unclustered_dotclass_determination_date = “ORIGINAL_CLASS_DETERMINATION_DATE”
previous_unclustered_dotclass_layer = “C:\projects\GasHCA_Enhancements\A_DOTCLass_Test4_2.gdb\DOT_CLASS_RANGE_UNCLUSTERED_H”
previous_unclustered_dotclass_route_id = “ORIGINAL_ROUTE_ID”
previous_unclustered_dotclass_begin_measure = “BEGIN_MEASURE”
previous_unclustered_dotclass_end_measure = “END_MEASURE”
previous_unclustered_dotclass_class = “PREVIOUS_CLASS_TYPE”
previous_unclustered_dotclass_determination_date = “PREVIOUS_CLASS_DETERMINATION_DATE”
# Execute tool
arcpy.GenerateDOTClassTimeAware_hcapy(project_database, current_clustered_dot_class_layer ,current_unclustered_dot_class_layer, original_clustered_dotclass_layer, original_clustered_dotclass_route_id, original_clustered_dotclass_begin_measure, original_clustered_dotclass_end_measure, original_clustered_dotclass_class, original_clustered_dotclass_determination_date,previous_clustered_dotclass_layer, previous_clustered_dotclass_route_id, previous_clustered_dotclass_begin_measure, previous_clustered_dotclass_end_measure, previous_clustered_dotclass_class, previous_clustered_dotclass_determination_date, original_unclustered_dotclass_layer, original_unclustered_dotclass_route_id, original_unclustered_dotclass_begin_measure, original_unclustered_dotclass_end_measure, original_unclustered_dotclass_class, original_unclustered_dotclass_determination_date, previous_unclustered_dotclass_layer, previous_unclustered_dotclass_route_id, previous_unclustered_dotclass_begin_measure, previous_unclustered_dotclass_end_measure, previous_unclustered_dotclass_class, previous_unclustered_dotclass_determination_date)
# Import GasHCA Library
import hcapy
# improt Gas HCA Tools
arcpy.ImportToolbox(“C:\Python27\ArcGIS10.6\Lib\site-packages\hcapy\esri\Toolboxes\Gas HCA Tools.pyt”)
project_database = r”C:\projects\GasHCA_Enhancements\A_DOTCLass_Test5.gdb”
current_hca_mca_range_layer = r”C:\projects\GasHCA_Enhancements\A_DOTCLass_Test4_2.gdb\HCA_RANGE”
previous_hca_mca_layer = r”C:\projects\GasHCA_Enhancements\A_DOTCLass_Test4_2.gdb\HCA_RANGE”
previous_hca_mca_route_id = “ORIGINAL_ROUTE_ID”
previous_hca_mca_begin_measure = “BEGIN_MEASURE”
previous_hca_mca_end_measure = “END_MEASURE”
previous_hca_mca_range_type = “RANGE_TYPE”
previous_determination_date = “PREVIOUS_DETERMINATION_DATE”
# Execute tool
arcpy.GenerateHCAMethod2TimeAware_hcapy(project_database, current_hca_mca_range_layer, previous_hca_mca_layer, previous_hca_mca_route_id, previous_hca_mca_begin_measure, previous_hca_mca_end_measure, previous_hca_mca_range_type, previous_determination_date)

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.

Related topics

Tags

High consequence area, HCA, moderate consequence area, MCA, method 2 .

Credits

Copyright © 2016-2020 by G2 Integrated Solutions, LLC. All Rights Reserved.

Use limitations

There are no access and use limitations for this item.