Calculate Hydro Trace HCA Intersections

Summary

Calculate Hydro Trace HCA Intersections performs High Consequence Area (HCA) intersection calculations on your Hydro Trace downstream plume transport features, outputting a table that tabulates HCA intersection data for each downstream transport plume.

To learn more about the Liquids HCA Tool in general, please see Liquids HCA Tool Frequently Asked Questions.

To learn more about the structure of the Liquids HCA Tool project geodatabase, please see Liquids HCA Tool Data Dictionary.

Usage

Calculate Hydro Trace HCA Intersections outputs data to a table in your Liquids HCA project file geodatabase, called HCA_INTERSECTIONS, that stores HCA intersection information for your Hydro Trace downstream transport plumes, Land Spill overland flow plumes, and release points. (In a typical Liquids HCA workflow, this table is created by the Calculate Land Spill HCA Intersections tool.) For each intersection of an HCA by a Hydro Trace downstream transport feature, Calculate Hydro Trace HCA Intersections writes a record to the HCA_INTERSECTIONS table in your Liquids HCA project file geodatabase. Each intersection record records the route and release point from which the intersecting downstream transport plume is sourced, the intersection type (hydro trace polyline or radial spread polygon), the time the plume enters (and, possibly, exits) the HCA, and the plume volume introduced into the HCA (and the plume volume remaining upon exit of the HCA, if appropriate), as well as the identifier of the affected HCA feature and the areal extent of the HCA affected (for radial spread polygons only). (Note that Calculate Land Spill HCA Intersections performs much the same function for overland flow release plumes and also writes its results to the same HCA_INTERSECTIONS table.) Because a single release plume may affect many HCAs, and because a given HCA can be affected by many release plumes, the HCA_INTERSECTIONS table can become very large.

Calculate Hydro Trace HCA Intersections uses the following parameters:

  • Input Project Database – This parameter allows you to specify the Liquids HCA project file geodatabase. You created your project geodatabase with the Initialize Database tool. By default, your input NHD intersection point, hydro trace path, radial spread polygon, and HCA polygon features are all sourced from your Liquids HCA Project file geodatabase, and the output HCA intersection records are written to your project file geodatabase.
  • Input Land Spill NHD Intersection Features – This parameter allows you to specify the Land Spill NHD intersection point features that are the starting points for your Hydro Trace downstream transport plumes. You created the NHD intersection points with the Calculate Land Spill NHD Intersections tool. The default value is the NHD_INTERSECTIONS feature class in your Liquids HCA project geodatabase. The tool looks for this feature class automatically; there is generally no need to alter the default parameter value.
  • Input Hydro Trace Path Features – This parameter allows you to specify the downstream trace features representing downstream transport along NHD flowline and artificial path features. You created the Hydro Trace path features with the Hydro Trace tool. The default value is the HydroTraceTransportPaths feature class in your Liquids HCA project geodatabase. The tool looks for this feature class automatically; there is generally no need to alter the default parameter value.
  • Input Hydro Trace Radial Spread Features – This parameter allows you to specify the downstream trace features representing radial slick spread into features. You created the Hydro Trace path features with the Hydro Trace tool. The default value is the WaterBodySpreadPolygons feature class in your Liquids HCA project geodatabase. The tool looks for this feature class automatically; there is generally no need to alter the default parameter value.
  • Input High Consequence Area Features – This parameter allows you to specify the HCA features to use in calculating HCA intersections. You import HCA features into you Liquids HCA project geodatabase using the Import High Consequence Areas tool. The default value is the HIGH_CONSEQUENCE_AREAS feature class in your specified Liquids HCA project geodatabase. The tool automatically searches for this feature class; there is generally no need to alter the default parameter value.

The tool makes use of the following input field parameters derived from your input HCA features layer.

    • Input HCA Type Field – This parameter is the field that stores the HCA feature type. (Valid HCA Types are HPA, OPA, NW, EC, and DW.) The default value is the HCA_TYPE field in your specified input HCA features layer; there is generally no need to alter the default parameter value.
    • Input HCA Identifier Field – This parameter is the field that uniquely identifies your HCA features. The default value is the G2_HCA_ID field in your specified input HCA features layer; there is generally no need to alter the default parameter value.
    • Input HCA Route Identifier Field – This parameter is the field that stores the route identifier associated with buffered HCA features. (The route ID value stored in this field for unbuffered HCA feature is -9999.) The default value is the ROUTE_ID field in your specified input HCA features layer; there is generally no need to alter the default parameter value.
    • Input Hydro Trace Buffer Field – This parameter is the field that stores the buffer tolerance distance value that is used for HCA intersection calculations (on a per route basis, by HCA type). The default value is the HT_BUFF field in your specified input HCA features layer; there is generally no need to alter the default parameter value.
  • Output HCA Intersections Table – This parameter allows you to specify the output HCA intersections table. The default destination is the HCA_INTERSECTIONS table in your specified Liquids HCA project geodatabase. If the table already exists, the tool appends output to the table. If not, the tool will create the table. There is generally no need to alter the default parameter value.

In a typical Liquids HCA Tool workflow, Calculate Hydro Trace HCA Intersections is run after Hydro Trace and before Generate Could Affect Segments.

For visual reference on Liquids HCA Tool execution order, see Liquids HCA Tool Process Flow Diagrams.

Syntax

CalculateHydrotraceHCAIntersections (in_workspace, in_nhd_intersections_features, in_htpath_features, in_htwb_features, in_hca_features, hca_type_field, hca_id_field, hca_routeid_field, hca_htbuff_field, in_hcaint_tbl_name)


Parameter
Explanation Data Type
in_workspace

Dialog Reference

Specify your input liquids HCA project file geodatabase.

There is no Python reference for this parameter.

Workspace
in_nhd_intersections_features

Dialog Reference

Specify your input Land Spill and NHD Intersection features.

There is no Python reference for this parameter.

Feature Layer
in_htpath_features

Dialog Reference

Specify your input Hydro Trace path features.

There is no Python reference for this parameter.

Feature Layer
in_htwb_features

Dialog Reference

Specify your input Hydro Trace radial spread features.

There is no Python reference for this parameter.

Feature Layer
in_hca_features

Dialog Reference

Specify your input High Consequence Area (HCA) features.

There is no Python reference for this parameter.

Feature Layer
hca_type_field

Dialog Reference

Select the field that stores HCA type in your input HCA features.

There is no Python reference for this parameter.

Field
g2_hcaid_field

Dialog Reference

Select the field that uniquely identifies your input HCA features.

There is no Python reference for this parameter.

Field
route_id_field

Dialog Reference

Select the field that stores the centerline route identifier for buffered HCAs in your input HCA features.

There is no Python reference for this parameter.

Field
hca_htbuffer_field

Dialog Reference

Select the field that stores the buffer distance for buffered HCAs in your input HCA features.

There is no Python reference for this parameter.

Field
in_hcaint_tbl_name

Dialog Reference

Specify the destination for your output HCA Intersections table.

There is no Python reference for this parameter.

String

Code sample

The following code sample illustrates the use of the Calculate Hydro Trace HCA Intersections tool in Python scripting:

import arcpy
# Import Liquids HCA Tools
arcpy.ImportToolbox(r”C:\Program Files\ArcGIS\Pro\bin\Python\envs\arcgispro-py3\Lib\site-packages\liquidshca\esri\toolboxes\LiquidsHCA.pyt”)
#Parameters values assignment
In_workspace = r”C:\LiquidsOutput.gdb”
in_nhd_intersections_features= r”C:\LiquidsOutput.gdb\NHD_Intersections”
in_htpath_features= r”C:\ LiquidsOutput.gdb \HydrographicTransportPaths”
in_hydrotrace_spread_features = r”C:\ LiquidsOutput.gdb \WaterbodySpreadPolygons”
in_hca_features=r”C:\LiquidsOutput.gdb\HIGH_CONSEQUENCE_AREAS”
in_hca_type_field = ”HCA_TYPE”
in_g2_hcaid_field = “G2_HCA_ID”
in_hca_routeid_field = “ROUTE_ID”
in_hca_htbuffer_field = “HT_BUFF”
in_hcaint_tbl_name = “HCA_Intersections”
arcpy.liquidshca.CalculateHydrotraceHCAIntersections(in_workspace, in_nhd_intersections_features , in_htpath_features , in_hydrotrace_spread_features, in_hca_features, in_hca_type_field, in_g2_hcaid_field, in_hca_routeid_field, in_hca_htbuffer_field _, in_hca_intersection_tablename)

Environments

Current Workspace, Scratch Workspace, Auto Commit, Qualified Field Names

Licensing information

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

Related topics

Tags

Liquids HCA, Hydro Trace, HCA intersection, highly populated area, other populated area, USA ecological resources, USA drinking water resources, commercially navigable waterways.

Credits

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

Use limitations

There are no access and use limitations for this item.