PREPARE QUALIFYING AREAS

Summary

Prepare Qualifying Areas copies your point or polygon features for Qualifying Areas/Buildings (for Class Location analysis) and/or Identified Sites (for HCA-MCA analysis) from your pipeline database into your Gas HCA Tool project geodatabase.

Usage

The tool populates (by default) the following features classes in your Gas HCA Tool project geodatabase:
- - QUALIFYING_AREA_POINT – When your input features are points.
  - QUALIFYING_AREA_POLYGON – When your input features are polygons.
Absent a feature selection or a feature layer definition query, Prepare Qualifying Areas copies all input features. When using a feature layer as input, you may want to apply an appropriate definition query or feature selection to ensure that only the features needed for Class Location or HCA-MCA analysis are copied into your Gas HCA Tool project geodatabase.
Input Qualifying Areas – This parameter allows you to select multiple input layers or feature classes, and to mix point and polygon shape types in the input feature layers or feature classes. However, all input layers/feature classes must have a common schema.
Qualifying Area/Building or Identified Site Type Field– A field that defines the type of qualifying outside area or building (for Class Location analysis), and/or the identified site type (for HCA-MCA analysis). This field is intended primarily for use in map display; all features in the QUALIFYING_AREA_POINT and QUALIFYING_AREA_POLYGON feature classes are used in analysis.
Note that the regulatory definition for identified sites for HCA-MCA analysis (49 CFR §192.903(a)-(c)) is more conservative than that for qualifying areas and buildings for Class Location analysis (49 CFR §192.5(b)(3)(ii)) (i.e., more outside areas and building will require designation as identified sites than will require designation as qualifying areas and buildings, respectively). For this reason, ENTRUST recommends that identified sites be used as qualifying areas and buildings for Class Location analysis, as this will generate more conservative Class Location ranges.
Output Qualifying Area Point Features and Output Qualifying Area Polygon Features – These parameters are optional; unless otherwise specified, the default to the aforementioned standard output feature classes in your Gas HCA Tool project geodatabase.
Prepare Qualifying Areas (together with Prepare Structures) is generally run after Prepare Centerline Buffers and before Prepare Structure and Site Buffers and Segments in a typical Class Location analysis workflow. In a typical HCA-MCA analysis workflow, Prepare Qualifying Areas (together with Prepare Structures) is generally run after Copy Centerlines and before Prepare Pipe Segment and MAOP Features.

Syntax

PrepareQATool_hcapy (project_database, input_qa, qa_id_field, qa_type, {qa_buffer_distance_value}, {discover_date}, {structure_date}, {output_qa_point}, {output_qa_polygon})

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
input_qa	Dialog Reference Specify your input qualifying area/building and/or identified site features. You may select multiple point and polygon feature layers or feature classes. There is no Python reference for this parameter.	Multiple Value
qa_id_field	Dialog Reference Specify the field that uniquely identifies qualifying area/building and/or identified site. There is no Python reference for this parameter.	String
qa_type	Dialog Reference Specify the field that defines qualifying area/building and/or identified site type. There is no Python reference for this parameter.	String
qa_buffer_distance_value (Optional)	Dialog Reference Specify a desired numeric buffer distance and linear units type. The default is set to 300 feet. There is no Python reference for this parameter.	Linear Unit
discover_date (Optional)	Dialog Reference Specify the field that records the ‘discovery date’ of your qualifying area/building and/or identified site features. There is no Python reference for this parameter.	String
structure_date (Optional)	Dialog Reference Specify the field that records the date at which your qualifying area/building and/or identified site features were added to your pipeline database. There is no Python reference for this parameter.	String
output_qa_point (Optional)	Dialog Reference Specify the destination of the output point qualifying area/building and/or identified site features. There is no Python reference for this parameter.	Feature Layer
output_qa_polygon (Optional)	Dialog Reference Specify the destination of the output polygon qualifying area/building and/or identified site features. There is no Python reference for this parameter.	Feature Layer

Code sample

# Import GasHCA Library

import hcapy

# import 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”

input_qa = r”C:\projects\GasHCA_Enhancements\Test.gdb\identifiedsite”

qa_id_field = “StructorSiteID”

qa_type = “Identified_Site_Type”

number_of_stories = “Num_Stories”

qa_buffer_distance_value = “300 Feet”

# Execute tool

arcpy.PrepareQA_hcapy(project_database, input_qa, qa_id_field, qa_type, qa_buffer_distance_value)

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.