Prepare Cluster Buffers

Summary

Prepare Cluster Buffers generates dissolved ‘cluster’ buffer polygons for Buildings Intended for Human Occupancy (BIHOs) and qualifying areas/buildings based on groups of BIHOs and qualifying areas/buildings, respectively, whose individual buffer polygons overlap. When the Boundary Adjustment Method selected is Arc Method, the cluster buffers are intersected with the centerline to produce structure and site (qualifying area/building) cluster segments. When the Boundary Adjustment Method selected is Perpendicular/Parallel Method, the tool uses BIHO and qualifying area/building influence ranges to produce structure and site (qualifying area/building) cluster segments, extending the influence range segments along the centerline by the appropriate length. Prepare Cluster Buffers performs these operations in preparation for calculating Class 4 and ‘clustered’ Class 2 and Class 3 location ranges (per 49 CFR §192.5(c)), and Class 3 ranges due to the presence of qualifying areas/buildings (per 49 CFR §192.5(b)(3)(ii)).

Usage

Prepare Cluster Buffers input parameters are divided into three sections:

1. Inputs

  • Number of Structures to be Considered a Cluster – The Pipeline and Hazardous Materials Safety Administration (PHMSA) has never rigorously defined the term, ‘cluster,’ or the number of BIHOs that constitute a cluster. Based on the language of 49 CFR §192.5(c), Prepare Cluster Buffers interprets ‘cluster’ to mean a set of BIHOs whose 660-foot buffers overlap. (Similar logic is applied to sets of qualifying areas/buildings for the purposes of defining Class 3 ranges per 49 CFR §192.5(b)(3)(ii).) This parameter allows you to define the number of BIHO dwelling units that constitute a cluster. If the number of BIHO dwelling units in a cluster is less than your threshold value, the IGNORE_FLAG field value is set to ‘Y’ on the cluster buffer and the cluster is ignored for the purposes of calculating clustered class location ranges. If the number of dwelling units in the cluster equals or exceeds your threshold value, the IGNORE_FLAG field value for the cluster is set to ‘N’ and the cluster is used in calculating clustered class location ranges. The default value for this parameter is 1; G2-IS’ interpretation of 49 CFR §192.5(c) is that a single dwelling unit constitutes a cluster. We recommend you use the default value.
  • Percentage (%) for a Cluster to be Considered Class 4 – Per 49 CFR §192.5(b)(4), “A Class 4 location is any class location unit where buildings with four or more stories above ground are prevalent.” PHMSA has never rigorously defined the operative term, ‘prevalent.’ Prepare Cluster Buffers defines prevalence in terms of the relative proportion (percentage) of 4-story or higher buildings in a cluster of 4-story or higher buildings relative to the total number of BIHO features in such a cluster. This parameter allows you to define the threshold percentage of 4-story or higher BIHO features (i.e., building footprints, not dwelling units) in a cluster that requires a Class 4 location unit. For example, if your threshold value is 50% and the number of 4-story or higher BIHOs exceeds 50% of the total number of BIHOs in the cluster, the IGNORE_FLAG field value for the output Class 4 Cluster Segment record is set to ‘N’ and a Class 4 location unit results. If the percentage of 4-story or higher buildings in the cluster does not exceed the threshold percentage, the IGNORE_FLAG field value for the output Class 4 Cluster Segment record is set to ‘Y’ and a Class 4 location unit does not result.

2. Boundary Extension

  • Boundary Adjustment MethodArc Method (also called radial arc method) calculates clustered Class Location unit ranges using cluster buffers; the clustered Class Location unit ends where the BIHO cluster buffer intersects the pipeline centerline. When this method is selected, the tool consumes as input your specified Structure Buffer Features input data.

Perpendicular/Parallel calculates clustered Class Location units by locating the bounding BIHO/qualifying area/building influence range features for the cluster, and then extending along the pipeline centerline from the endpoints of the bounding influence range features using the values of Extension Length From Last Structure in Cluster (Feet) or Extension Length From Last Qualifying Area in Cluster (Feet), as appropriate. When this method is selected, the tool consumes as input your specified Influence Range Features input data.

  • Structure Buffer Features – This tool requires as input the STRUCTURE_BUFFER features output by the Prepare Structure and Site Buffers and Segments tool. Unless otherwise specified, the tool defaults this parameter to the STRUCTURE_BUFFER feature class in your selected Gas HCA Tool project geodatabase.
  • Qualifying Area Features – For use in defining Class 3 Location units due to the presence of qualifying areas/buildings, this tool requires as input the QUALIFYING_AREA_BUFFER features output by the Prepare Structure and Site Buffers and Segments tool. Unless otherwise specified, the tool defaults this parameter to the QUALIFYING_AREA_BUFFER feature class in your selected Gas HCA Tool project geodatabase.
  • Influence Range Features – This tool requires as input the DOT_BIHO_INFLUENCE_RANGE features output by the Calculate Influence Ranges tool. Unless otherwise specified, the tool defaults this parameter to the DOT_BIHO_INFLUENCE_RANGE feature class in your selected Gas HCA Tool project geodatabase.

3. Outputs

  • Structure Cluster Buffer Features – Unless otherwise specified, the default destination for the output BIHO structure cluster features is the DOT_STRUCTURE_CLUSTERBUFFER feature class in your selected Gas HCA Tool project geodatabase.
  • Structure Cluster Segment Records – Unless otherwise specified, the default destination for the output BIHO structure cluster segment records is the DOT_STRUCTURE_CLUSTERSEGMENT table in your selected Gas HCA Tool project geodatabase.
  • Site Cluster Segment Records – Unless otherwise specified, the default destination for the output the output qualifying area/building cluster segment records is the DOT_SITE_CLUSTERSEGMENT table in your selected Gas HCA Tool project geodatabase.
  • Class 4 Cluster Segment Records – Unless otherwise specified, the default destination for the output Class 4 cluster buffer segment records is the DOT_CLASS4_CLUSTERSEGMENT table in your selected Gas HCA Tool project geodatabase.
  • Class 4 Cluster Buffer Features – Unless otherwise specified, the default destination for the output Class 4 cluster buffer features is the DOT_CLASS4_CLUSTERBUFFER feature class in your selected Gas HCA Tool project geodatabase.

In a typical Class Location analysis workflow, Prepare Cluster Buffers is run immediately after the Calculate Influence Ranges tool, and before the Generate Sliding Ranges tool.

Syntax

PrepareClusterTool_hcapy (project_database, cluster_tolerance, prevalent_ratio, boundary_method, {structure_buffer_layer}, {qualifying_area_buffer_layer}, {influencerange_layer}, {ir_stuctureorsiteid_field}, {ir_route_id_field}, {ir_begin_measure_field}, {ir_end_measure_field}, {structure_ext_length}, {qa_ext_length}, {structure_cluster_buffer}, {structure_cluster_table}, {site_cluster_table}, {class4_cluster_table}, {class4_cluster_buffer})

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
cluster_tolerance

Dialog Reference

Specify the number of dwelling units that constitute a cluster. The default value is 1.

There is no Python reference for this parameter.

Long
prevalent_ratio

Dialog Reference

Specify the threshold percentage of 4-story or higher buildings relative to the total number of buildings in a cluster of 4-story or higher buildings that results in a Class 4 Location unit. The default value is 50%.

There is no Python reference for this parameter.

Double
boundary_method

Dialog Reference

Specify the method used to determine the spatial extent of clustered Class Location ranges. The default Arc Methodcalculates clustered Class Location unit ranges by intersecting cluster buffers with the centerline. The Perpendicular/Parallel Method calculates clustered Class Location units by extending the bounding influence range features for the cluster along the pipeline by the appropriate length (by default, 660 feet for BIHO clusters, and 300 feet for qualifying area/building clusters).

There is no Python reference for this parameter.

String

structure_buffer_layer

(Optional)

Dialog Reference

Specify your input BIHO (structure) buffer features.

There is no Python reference for this parameter.

Feature Layer

qualifying_area_buffer_layer

(Optional)

Dialog Reference

Specify your input qualifying area/building buffer features.

There is no Python reference for this parameter.

Feature Layer

influencerange_layer

(Optional)

Dialog Reference

Specify your input influence range features.

There is no Python reference for this parameter.

Feature Layer

ir_stuctureorsiteid_field

(Optional)

Dialog Reference

Specify the field that uniquely identifies each influence range feature. (The same identifier is used for the BIHO or qualifying area feature related to the influence range feature.)

There is no Python reference for this parameter.

Field

ir_route_id_field

(Optional)

Dialog Reference

Specify the field that uniquely identifies the centerline feature which underlies the influence range feature.

There is no Python reference for this parameter.

Field

ir_begin_measure_field

(Optional)

Dialog Reference

Specify the field that contains the BeginMeasure values for your influence range features.

There is no Python reference for this parameter.

Field

ir_end_measure_field

(Optional)

Dialog Reference

Specify the field that contains the EndMeasure values for your influence range features.

There is no Python reference for this parameter.

Field

structure_ext_length

(Optional)

Dialog Reference

Specify the distance to extend along the centerline from the last BIHO in a cluster of BIHOs to define the extent of a clustered Class 2 or Class 3 Location range, or a Class 4 Location range, when using the Perpendicular/Parallel clustered Class Location range Boundary Adjustment method. The default value is 660 feet.

There is no Python reference for this parameter.

Double

qa_ext_length

(Optional)

Dialog Reference

Specify the distance to extend along the centerline from the last qualifying area or building in a cluster of qualifying areas/buildings to define the extent of a Class 3 Location unit due the presence of one or more qualifying areas/buildings, when using the Perpendicular/Parallel clustered Class Location range Boundary Adjustment method. The default value is 300 feet.

There is no Python reference for this parameter.

Double

structure_cluster_buffer

(Optional)

Dialog Reference

Specify the destination for your output BIHO (structure) cluster buffer features.

There is no Python reference for this parameter.

Table View

structure_cluster_table

(Optional)

Dialog Reference

Specify the destination for your output BIHO (structure) cluster buffer segment records.

There is no Python reference for this parameter.

Table View

site_cluster_table

(Optional)

Dialog Reference

Specify the destination for your output qualifying area/building cluster buffer segment records.

There is no Python reference for this parameter.

Table View

class4_cluster_table

(Optional)

Dialog Reference

Specify the destination for your output 4-story and higher BIHO (structure) cluster buffer segment records.

There is no Python reference for this parameter.

Table View

class4_cluster_buffer

(Optional)

Dialog Reference

Specify the destination for your output 4-story and higher BIHO (structure) cluster buffer features.

There is no Python reference for this parameter.

Feature Layer

Code sample

Prepare Cluster Buffers

# 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”
no_of_structures_to_cluster = 1
prevalent_ratio = 50
boundary_method = “Arc Method”
# Execute tool
arcpy.PrepareClusterTool_hcapy(project_database, no_of_structures_to_cluster, prevalent_ratio, boundary_method)

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

Class Location, BIHO, qualifying area, qualifying building, cluster, arc, parallel, perpendicular, Class 4.

Credits

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

Use limitations

There are no access and use limitations for this item.