Arc Hydro Toolbox

An overview of the Arc Hydro toolbox
Page 1 of 1
An overview of the Arc Hydro toolbox

ArcGIS 10
The Arc Hydro Tools toolbox contains a set of public domain utilities developed on top of the Arc
Hydro data model. They operate in the ArcGIS environment. Some of the tools require the
Spatial Analyst extension. The GWIS to FEMA tools within the GIS Data Exchange toolset require
the Data Interoperability extension.
The toolbox contains ten toolsets.
Toolset
Description
Arc Hydro Setup
Define default target locations for the tools.
Attribute Tools
Populate attributes in the Arc Hydro geodatabase.
GIS Data Exchange
Export/Import data between geodatabases and XML files.
H&H Modeling
Contain toolsets supporting hydrologic and hydraulic modeling

(GeoICPR, Green and Ampt, Map to Map and Time of
Concentration).
Network Tools
Perform operation on the geometric network.
Point Characterization
Characterize point features.
Terrain Morphology
Perform analyses on a non-dendritic (i.e. flat) terrain.
Terrain Preprocessing
Preprocess terrain data for delineation.
Terrain Preprocessing
Workflows
Typical terrain preprocessing workflow (e.g. Dendritic terrain)

and batch process to run geoprocessing model in batch mode.
Utility
Various utilities tools.
Watershed Processing
Delineate and characterize watersheds.
Arc Hydro Tools toolbox's toolsets
Copyright 1995-2013 Esri. All rights reserved.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2E9A.htm
12/8/2014
'
Arc Hydro Tools
B ~ 10 Management
'\, Assign HydroiD
'
Assign UniqueiD
-5i Assign WatershediD

-5i Compact HydroiD
-5i Copy ApUniqueiD Table for Replica
-5i Select By WatershediD
-5i Sync HydroiD
-5i Update ApUniqueiD Table
-5i Update HydroiD
lt; Models
)a Features Count
)a Features Density
)a Features length
)a Intersect Features
)a Percent by Zone
:}a Stats by Zone
'
'
'
'
'
'
)a
Accumulate Attributes
Accumulate local Parameters
Accumulate Multiple Attributes
Assign River Order
Calculate length Downstream for Edges
Calculate length Downstream for Junctio
Classify Water Bodies
""'\ Compute Global Parameters

' Compute line Parameters
" ' compute Line segment Parameters
.---i
'
Compute Subwatershed Parameters
'
'
Find Next Downstream Junction

Find Next Downstream line
'
Generate From/To Node for lines
Generate From/To Node for lines
)a Iden:ify Riparian Water Bodies
B ~ Arc Hydro Setup

' Set Batch Target locations
' Set Target locations
B ~ Attribute Tools
'
Store Area Outlets by Drainage Point Pro;
'
Store Area Outlets by Junction Intersect
'
Store Area Outlets by Next Downstream 1
B ~ GIS Date Exchange
B ~ Excel Exchange
'\, Excel to Map
'
Export Tool Parameters
' \ Map to Excel
Standard Export to Excel
8 ~ GWIS to FEMA
~ GWIS to FEMA DCS Hydraulic
~ GWIS to FEMA DCS Hydrologic
B ~ XML ~xchange
~ Append Loord1nate ::,ystem to XML
" \ Export GIS Data to XML
'\, Import from XML
'
Transform XML
8 ~ H & H Modeling
8 ~ GeoiCPR
'\, Floodplain Delineation (Link)
'\, Floodplain Delineation (Node)
-5i
'
Generate ICPR Basin
'\, Generate !CPR Link
'\, Generate !CPR Node
'\, Import from !CPR
'
Mosaic Floodplains
B ~ Green and Ampt
'
Accumulate Incremental TimeSeries
'
Compute Green and Ampt Excess Rair
"" CUIIIIJUlt: Grt:t:ll diii.J AIII!Jl Pdldlllt:lt:l~
'
Create Green and Ampt Parameter Rc
'
Export to ICPR Green and Ampt Parar
' \ Export to !CPR Green and Ampt Rainf
8 ~ t:!ap to Map
B ~ Map to Map
"'\ Export to DSS
)a Flood From Stream W5E

:}a GeoRAS to Flood
:}a HMS to GeoRAS
'\, Import from DSS
'\, Run HMS
'\, Run RAS
"'\ SDF to XML
~~ Stream WSE From Poi1t WSE Measut
'\, Update RAS Flow
B ~ Streamstats
"
"
Compute Flows
Edit Computed Parameters
" Recompute Flows

" ' Streamstats Compute Streamgage F
'
Streamstats Edit Paraneters andRe
'
Streamstats Global Pcrameters
'
Streamstats Global Pcrameters Serv
' \ Streamstats Global Wtershed Delim
B ~ Time of Concentration
.$ Adjust Slope
~ Compute Time of Con:entration
'
Compute Time of Con:entration for G
'
Compute Time of Con:entration for lc
'
Compute Travel Time for Preferential
'\, Define TR55 Zones fa Longest Flow I
'
Generate TRSS Zone ~rid
B ~ Utility
Create Fishnet by Cel Height and Wic
.!} Create Fishnet by Nuhlber of Rows ar
~ Denslfy Fishnet
" ' Thin Cross-Section
B ~ Network Tools
'
Hydro Network Generatio1
~ Node link Schema Generction
-5i
P''i.t-~.~.'--------------------.,------.,....-...,..,...--...,.-,----------------------'
B Network Tools
" Modify Terminal Sink in Group Basin
'
Hydro Network Generation
'
Node link Schema Generation
'
Set Flow Direction
'
Store Flow Direction
B ~ Point Characterization
'
'
Remove Duplicate Terminal Sinks from Group Basin
'
Select Upstream Catchments using Preferential link
'
Ungroup Selected Catchments
B ~ Terrain Preprocessing
B ~ OEM Manipulation
Generate Flow Path
'
Assign Stream Slope
Generate Point Connectivity
'
Build Walls
"
Snap Point
'
Burn Stream Slope
'
Create Drainage line Structures
B ~ Terrain Morphology
B ~ AH Connectivity Refinement
'
Add linear Structure HydroEdges to Preferential link
' \ Add Point Structure HydroEdges to Preferential Link
'
connect control ::,tructure Junctions
'
Connect HydroJunctions
'
Define Overland Preferential Node link Schema
' \ Flip Preferential Path
'
Set Flow Direction Using Preferential link
'
Sink Identification by HEP
Update Preferential Node link Schema
'
Drainage Boundary Processing
Cross Section Direction
'
'
Drainage Area Characterization
'
Drainage Boundary Definition
'
Drainage Boundary Direction
'
Drainage Boundary Smoothing
'
Drainage Connectivity Characterization
'
Elevation-Width-Area Characterization
'
Station-Elevation Characterization
Gruui.JiY
'
Generate Group Basin
'
Generate Group Junction
'
'
'
~~
Generate Group link

Group Selected Catchments
Modify Terminal Sink in Group Basin
..!j Create Sink Structures

.!} Create Sinks for line Structure
..!j Create Synthetic Sinks
"'\ OEM Reconditioning
'
OEM Reconditioning from Stream Grid
'
Depression Evaluation
' \ Fill Sinks
'
level OEM
'
Sink Evaluation
'
Sink Prescreening
'
Sink Selection
B Vector QC
~ Create Initial QC GOB
)0 Identify Water Body and Stream Intersections
..s) Non Draining Watersheds
Stream Connectivity Parameters
"" Stream QC
..s) Streams Near Processing Area Boundary
..s) Streams Near Watershed Boundary
" ' Accumulate Shapes
" Adjoint Catchment Processing
" Adjust Flow Direction in lakes
" Adjust Flow Direction in Sinks
'
Adjust Flow Direction in Streams
$ Append Coastal Catchments
Append Coastal Catchments

Assign CatType Attribute
Catchment Grid Delineation
Catchment Polygon Processing
Combine Stream link and Sink link
Drainage line Processing
Drainage Point Processing
Extend lines
Flow Accumulation
Flow Direction
Flow Direction with Sinks
Global Adjoint Catchment Processing
Longest Flow Path for Adjoint Catchments
Longest Flow Path for Catchments
Sink Watershed Delineation
Slope
Stream Definition
Stream Segmentation
El Terrain Preprocessing Worl<flows
)a Basic Combined Terrain Processing
)a Basic Dendritic Terrain Processing
)a Basic Deranged Terrain Processing
: \ Batch Processing
)a Dendritic Terrain Processing with Imposed Drainage line and V
B ~ Utility
B ~ Support
Create Directory
.s) Create TIN
Dissolve with Path
Get Coordinate System from Vector
Get Feature Layer Path
Get Feature Layer Workspace
Get Field
Get Field Alias
Get Field Alias by Alias
.si
.si
.si
.si
.si
.si
.si
.si
Get Field Alias by Alias

Get Raster Layer Path
Get Schema Workspace
Get Spatial Reference From Raster
Get Spatial Reference From Vector
TIN to Raster
" Convert 30 line to Raster
~ Convert 3D line to Raster Py
" Create Thiessen Polygons
" \ Create Unit Patch By Near Neighbor Method
~ Create Zone By Distance
$ Create Zone By Distance From Raster
"'\. Download Time Series Data
" \ Export Data Cart to XML
~ Feature Class To Batch FC
"'\. Generate Processing Units
" Intersect Areas
" \ Point TSValue to 3D Line
" Terrain Profile
" \ Update TSValue on Points
" \ Weighted Average
B ~ Watershed Processing
B ~ Line Processing
'
Create Analysis line
~ Identify Threshold Points
'
Remove Stream Pseudo Nodes
" \ Batch Global Watershed Delineation
" Batch Subwatershed Delineation
'
Batch Watershed Delineation
" Batch Watershed Delineation for Polygons
~ Catchment Delineation for Polygons
" Construct 3D line
" \ Delineate from Multiple Inlets and Outlets
' \ Drainage Area Centroid
~ Flow Path Para~eters from 2D line
Batch Watershed Delineation for Polygons

Catchment Delineation for Polygons
Construct 30 line
Delineate from Multiple Inlets and Outlets
)a
"\
"\
"\
"\
"\
.si'
B
Drainage Area Centroid

Flow Path Parameters from 20 line
Flow Path Parameters from 30 line
Interactive Delineation
Longest Flow Path
Longest Flow Path for Subwatersheds
Longest Flow Path for Watersheds
Main Flow Path
Smooth 3D Line
Subwatershed from Watershed
ArcHydroPartiaiTerrainUpdate
~ Add Field Long
)0 Basic Deranged Terrain Processing
)a Basic Deranged Terrain Processing for Update
~ Compact HydroiD
)0 Create OEM for Reprocessing
;}a Identify Updated Catchments
.si' Update ApUniqueiD Table
11
11
~ Update Raster Data

"'\ Update Vector Data
~ Cartography Tools
crJ Conversion Tools
11
Coverage Tools
11 crJ Data Interoperability Tools

11 crJ Data Management Tools
11 Editing Tools
11 crJ Geocoding Tools
11 crJ Geostatistical Analyst Tools
11
linear Referencing Tools
c;,
An overview of the Arc Hydro Setup toolset
Page 1 of 4

ArcGIS 10
The Arc Hydro Setup toolset contains tools that are used to create the target raster and vector
locations that will be used by the Arc Hydro tools. There are two Arc Hydro Setup tools: Set
Batch Target Locations and Set Target Locations.
Tools
Description
Set Batch
Target
Locations
Create the vector target database/dataset and raster vector location if

they do not already exist based on the location of an input raster. Update
the active configuration in ArcMap. All licenses supported.
Set Target
Locations
Create the specified target raster and vector locations and update the
active configuration in ArcMap. All licenses supported.
Overview of Arc Hydro Setup Toolset
Set Batch Target Locations (Arc Hydro Tools)
Summary
Creates the target vector and raster locations based on the location and spatial reference of
the input raster dataset and set these locations as default locations in ArcMap.
Learn more about how Set Batch Target Locations (Arc Hydro) works
Usage
Syntax
SetBatchTargetLocations_archydro (in_dem_raster)
Parameter
in_dem_raster
Explanation
Input DEM.
Data Type
String
Environments
This tool does not use any geoprocessing environments
Related Topics
Set Target Locations
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhD360.htm
12/8/2014
Page 2 of 4
Set Target Locations (Arc Hydro Tools)
Summary
Creates the specified raster and target vector locations and set them as default locations for
the Arc Hydro tools in ArcMap by editing the active configuration loaded in memory.
Learn_more_about_how_Set_Target_Locations_Arc_Hydro_works
Usage
Syntax
SetTargetLocations_archydro (in_appconfig, in_mapname, in_rasterlocation, in_vectorlocation)
Parameter
Explanation
Data Type
in_appconfig
Application for which the default locations are being

set.
String
in_mapname
Define the dataframe in the map for which the

target locations are being defined. Locations are
updated in ArcMap in the configuration XML loaded
in memory for the MapView node associated to this
dataframe.
String
in_rasterlocation
Workspace where the output rasters generated by

the Arc Hydro tools will be created by default. Can
be set to a directory or to a file geodatabase. The
tool will try to create the geodatabase/directory if it
does not already exist.
Workspace
in_vectorlocation
Vector workspace where the vector data generated

by the Arc Hydro tools will be created by default.
Can be a personal geodatabase (.mdg/.gdb) or a
remote geodatabase. The tool will a create the
personal geodatabase if it does not already exist.
Environments
Related Topics
Set Batch Target Locations
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 3 of 4
Learn more about how Set Batch Target Locations (Arc Hydro) works
The Set Batch Target Locations tool allows creating the target vector and raster locations for
each process based on an input raster and can be used when running a geoprocessing model in
batch mode, e.g. when performing terrain preprocessing steps on multiple Digitial Elevation
Models. The tool used the input raster to define the target vector and raster locations as well as
the projection to use.
Raster Location
The raster location is set to the directory containing the input raster.
Vector Location
The vector location is set to a geodatabase in the directory containing the input raster that has
the same name as the directory. The tool creates the database if it does not already exist as well
as the feature dataset "Layers" with the same projection as in the input raster.
Note: You can reset the locations to the default locations associated to
the current map document in ArcMap by using the function
ApUtilities > Additional Utilities > Reset Target Locations on the
Arc Hydro Tools toolbar.
Learn more about how Set Target Locations (Arc Hydro) works
The Set Target Locations tool allows creating the target vector and target locations and sets up
the corresponding Arc Hydro environment.
Raster Location
The tool sets the raster location to the specified location.
Vector Location
The tools creates as vector location a geodatabase in the specified vector location.
Arc Hydro Default Configuration

In ArcMap, the tool updates the configuration XML loaded in memory in the map for the
Application node and dataframe specified by the user, so that the specified locations are used
by default for that tool in that dataframe.
12/8/2014
An overview of the Attribute Tools toolset
Page 1 of 29

ArcGIS 10
The Attribute Tools toolset contains tools that populate attributes in the Arc Hydro geodatabase.
Tools
Description
ID Management
toolset
Models toolset
Toolset allowing managing unique identifiers in the Arc Hydro geodatabase.
Assign River Order
Populate the field RiverOrder in the input feature class.
Calculate Length
Downstream for
Edges
Calculate the length from a network edge to the associated sink and
populates the field LengthDown.
Calculate Length
Downstream for
Junctions
Calculate the length from a network junction to the associated sink and
populate the field LengthDown.
Compute Global
Parameters
Compute specified attributes for global watersheds.
Compute
Subwatershed
Parameters
Compute specified attributes for subwatersheds.
Find Next
Downstream Junction
Populate JunctionID field with Hydro of next downstream Junction using the
geometric network.
Find Next
Downstream Line
Create and populate the NextDownID field with the HydroID of the next
downstream line.
Generate From/To
Node for Lines
Generate from-node/to-node topology based on physical line connectivity for

a line feature class. Nodes are defined as ends of lines. They are not created
as a separate feature class, but rather just identified and accounted for
internally. This tool does not require a hydro network.
Percent by Zone
Model calculating the percent of a given type in each zone. Used by the
Compute Global Parameters tool.
Store Area Outlets by

Drainage Point
Proximity
Populate JunctionID with HydroID of the area outlet using Drainage Point
Proximity method.

Junction Intersect
Populate JunctionID with HydroID of the area outlet using the Junction
Intersect method.

Next Downstream
Area
Populate JunctionID with HydroID of the arae outlet using the Next
Downstream Area method.
Toolset containing models used by the tools computing parameters.
Summary of the tools in the Attribute Tools toolset
An overview of the ID Management toolset

The ID Management toolset contains tools that manages ID attributes in the Arc Hydro geodatabase.
Tools
Description
Assign HydroID
Create the HydroID field if it does not exist and populate it with the next
available HydroID.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 2 of 29
Assign UniqueID
Create the specified UniqueID field if it does not exist and populate it
with the next available unique identifier.
Assign WatershedID
Populate WatershedID field in valid layers/tables in the specified

geodatabase.
Copy ApUniqueID Table

for Replica
Copy ApUniqueID table.
Compact HydroID
Compact HydroIDs and related IDs to remove gaps in HydroID

sequences.
Select by Attribute
Select by attribute.
Select by WatershedID
Select by WatershedID.
Sync HydroID
Synchronize HydroIDs and related IDs between a parent and child

geodatabase.
Update ApUniqueID Table
Copies LASTID value from replica database to update ApUniqueID table.
Update HydroID
Update HydroIDs field in child geodatabase based on HydroIDs from

parent geodatabase.
Assign HydroID (Arc Hydro Tools)
Summary
Creates HydroID field if needed and populates it with the next available HydroIDs. HydroIDs are unique
within the geodatabase.
Learn more about how Assign HydroID (Arc Hydro) works
Usage
Syntax
AssignHydroID_archydro (in_objectclass, {overwrite})
Parameter
in_objectclass
overwrite
(Optional)
Explanation
Name of the input feature class or table
Indicate whether to overwrite the existing HydroIDs
Data Type
Table
Boolean
Environments
Related Topics
Find Next Downstream Line
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 3 of 29
Assign UniqueID (Arc Hydro Tools)
Summary
Populates specified field with unique identifiers.
Usage
z
Tool works on selected set and will process all records if there is no selected set.
Syntax
AssignUniqueID_archydro (in_objectclass, uniqueID_field, overwrite)
Parameter
in_objectclass
uniqueID_field
overwrite
Explanation
Data Type
Input Feature Class/Table to process.

Name of UniqueID field to populate. Must be numeric. Will
be created if it does not exist.
Indicates whether to overwrite existing unique identifiers.
Table
String
Boolean
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Assign WatershedID (Arc Hydro Tools)
Summary
Creates the field WatershedID if it does not already exist and populates it with the WatershedID
associated to the selected input Watershed Name. The tool will update all the layers/tables from the
input workspace that are defined in the AHPyConfig.xml configuration file located in the
ArcGIS\Desktop10.x\ArcToolbox\Scripts\ArcHydro directory.
The configuration for the tool is defined under the node <ApFunction Name="AssignWatershedID"> in
the configuration file. The list of layers/tables to update is defined under the child node <ApLayers
Name="LayerNames"> while the list of layers/tables that should not be updated is defined under the
child node <ApLayers Name="ExcludeLayerNames">.
Usage
z
The tool works on all features/records and does not honor the selected sets.
The WatershedName field in the user interface is populated from the attribute WATERSHED in the
12/8/2014
Page 4 of 29
Watersheds feature class located in the SWFWMDSchema.gdb template geodatabase installed

under the ArcGIS\Desktop10.x\ArcToolbox\scripts\ArcHydro directory. The WATERSHEDID value
associated to the selected WATERSHED is used to populate the field WatershedID in the selected
geodatabase.
Syntax
AssignWatershedID_archydro (Geodatabase, WatershedName, {Overwrite_WatershedID})
Parameter
Geodatabase
WatershedName
Overwrite_WatershedID
(Optional)
Explanation
Input geodatabase containing the feature classes and
tables for which the WatershedID field will be updated.
The list of feature classes/tables to update is read from
the ApLayers node tagged "LayerNames" in the
AHPyConfig.xml configuration file. The list of feature
classes/tables that should not be updated is read from
the ApLayers node tagged "ExcludeLayerNames".
Name of the watershed whose associated WatershedID
will be used to populate the WatershedID field for all
input valid layers/tables in the input geodatabase.
Optional. Set to false by default. Indicates whether to
overwrite existing values.
Data Type
String
String
Boolean
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Compact HydroID (Arc Hydro Tools)
Summary
Compacts HydroIDs and related IDs (e.g. NextDownID, etc.) in input workspace to reset the IDs so that
they start at the value of the HydroIDBase + 1 and they no do not contain any sequential gap.
The HydroIDBase is optional and set to 0 by default, so that the HydroIDs are starting from 1 by default.
The configuration for the tool is defined in the AHPyConfig.xml configuration file located in the
The tool will compact the unique identifiers defined in the configuration file under the node <ApFunction
Name="Shared"><ApFields Name ="RelatedIDFields"> for all layers/tables in the specified workspace
containing these attributes, except for the layers/tables specified as ExcludeLayerNames under the node
<ApFunction Name="CompactHydroID">.
Usage
Syntax
CompactHydroID_archydro (Input_Workspace, {HydroIDBase})
12/8/2014
Parameter
Input_Workspace
HydroIDBase
(Optional)
Explanation
Page 5 of 29
Data Type
All layers/tables in the specified input workspace will have

their HydroIDs compacted to eliminate sequential gaps.
Integer defining the base HydroID of the updated
geodatabase. Defaults to 0. The minimum HydroID in the
compacted geodatabase will be HydroIDBase + 1.
Workspace
Long
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Copy ApUniqueID Table for Replica (Arc Hydro Tools)
Summary
Copies the ApUniqueID table from the geodatabase from which the replica was created into the
geodatabase storing the replica as both APUNIQUEID and APUNIQUEIDWHENCHKOUT. The APUNIQUEID
table is used to provide new unique identifiers when editing features in the replica geodatabase. The
APUNIQUEIDWHENCHKOUT stores the state of the table in the source geodatabase at check out. It
should not be modified. It will be used when checking in the replica to ensure unicity of the Unique IDs in
the geodatabase from which the replica was created.
Usage
Syntax
CopyApUniqueIDTableforReplica_archydro (WorkspaceSDE, WorkspaceGDB)
Parameter
WorkspaceSDE
WorkspaceGDB
Explanation
Data Type
Input ArcSDE geodatabase from which the replica was

created.
Input geodatabase containing the checked out replica.
Workspace
Workspace
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 6 of 29
Select by WatershedID (Arc Hydro Tools)

Summary
Select records and features from all feature classes and tables in the active dataframe in the Table of
Contents of ArcMap that have the specified WatershedID.
This tool may be used to select the records in the tables that should be extracted when using the Create
Replica tool.
Usage
Syntax
SelectbyWatershedID_archydro (WatershedID)
Parameter
WatershedID
Explanation
Data Type
Input WatershedID.
String
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Sync HydroID (Arc Hydro Tools)
Summary
Synchronizes HydroIDs and related IDs in the checked out workspace (inWorkspaceGDB) based on the
current last HydroID used in the parent replica workspace (inWorkspaceSDE) and on the value stored
when the checked out database was generated.
The checked out workspace is a workspace whose HydroID and RelatedID values will be updated based
on:
1.
the current last HydroID value in the parent workspace (inWorkspaceSDE).
2.
the last HydroID value in the parent workspace (inWorkspaceSDE) when the checked out
workspace was generated. Before any editing is done in the checked out workspace, the
LASTID in its APUNIQUEID is the same as the LASTID in its APUNIQUEIDWHENCHKOUT table.
All the HYDROID and RelatedIDs that are greater than the LASTID when checked out in the checked out
geodatabase will be shifted by DID = LASTID(inWorkspaceSDE) - LASTID(In
APUNIQUEIDWHENCHKOUT ).
The list of feature classes/tables that should not be synchronized is read under the <ApFunction Name =
"SyncHydroID"> node in the configuration file.
12/8/2014
Page 7 of 29
The list of attributes to synchronize is read from the <ApFields Name="RelatedIDFields"> node under
the "Shared" ApFunction.
Usage
Syntax
SyncHydroID_archydro (InWorkspaceSDE, InWorkspaceGDB)
Parameter
InWorkspaceSDE
InWorkspaceGDB
Explanation
Data Type
Input parent workspace, whose last HydroID will be used

to synchronize the HydroID and RelatedIDs in the checked
out geodatabase (inWorkspaceGDB) so that it can be later
checked back into the parent workspace without
generating duplicate identifiers.
Input checked out workspace that will be synchronized so
that it can be later checked back into the parent
geodatabase without generating duplicate identifiers.
Workspace
Workspace
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Update ApUniqueID Table (Arc Hydro Tools)
Summary
Copies LASTID value from a checked out replica geodatabase into the APUNIQUEID table in the parent
geodatabase from where the replica was created.
The objective of this tool is to update the APUNIQUEID's LASTID in the parent geodatabase so that it is
synchronized with the LASTID in the checkout geodatabase. The tool will also update the table
APCHECKOUTHISTORY if it exists in the parent geodatabase and if it contains a string matching the
name of the checkout database in the field GDBFILE.
The APCHECKOUTHISTORY table is created by the tool Copy ApUniqueID for Replica when generating the
checked out database. The current tool will update the fields LASTIDCHECKEDIN and DATECHECKEDIN.
If the name of the checked out database has changed, the tool will provide a warning indicating that no
record was updated in the table.
Usage
Syntax
UpdateApUniqueIDTable_archydro (WorkspaceGDB, WorkspaceSDE)
Parameter
WorkspaceGDB
Explanation
Input replica workspace that will be checked into the
parent replica geodatabase (WorkspaceGDB).
Data Type
Workspace
12/8/2014
WorkspaceSDE
Input workspace from where the replica originates. The

tool updates the APUNIQUEID table's LASTID field for
HydroID with the value read from the input replica
workspace and the record in the APCHECKOUTHISTORY
table associated to the replica geodatabase.
Page 8 of 29
Workspace
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Update HydroID (Arc Hydro Tools)
Summary
Updates HydroIDs and related IDs in a child workspace based on the LASTID associated to HydroID in
the parent workspace. This maximum parent HydroID is added to the original IDs in the child
workspaces to generate the new IDs.
The objective of this tool is to update the IDs in a geodatabase before initial upload into a centralized
geodatabase so that there are no duplicate ids between the 2 geodatabases.
The tool will update the unique identifiers defined in the configuration file under the node <ApFunction
Name="Shared"><ApFields Name ="RelatedIDFields"> for all layers/tables in the specified workspace
containing these attributes, except for the layers/tables specified as ExcludeLayerNames under the node
<ApFunction Name="UpdateHydroID">.
Usage
Syntax
UpdateHydroID_archydro (WorkspaceSDE, WorkspaceGDB)
Parameter
WorkspaceSDE
WorkspaceGDB
Explanation
Input parent workspace. The maximum HydroID in this
workspace will be added to the HydroIDs and related IDs
in the child workspace to ensure that the HydroIDs are
unique in each workspace.
Input child workspace. The HydroIDs and related IDs in
this workspace will be updated based on the maximum
HydroIDs retrieved from the input parent workspace.
Data Type
Workspace
Workspace
Environments
12/8/2014
Page 9 of 29
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Assign HydroID (Arc Hydro) works

The Assign HydroID tool allows assigning or reassigning a unique identifier, the HydroID, to the features in
the Arc Hydro database.
HydroIDs are assigned based on sequences defined in two tables, ApUniqueID and LayerKeyTable. These
tables are created by default in the target workspace, with the following structure:
APUNIQUEID
Field
Type
Description
IDNAME
String
Name of the unique identifier.
LASTID
Integer
Last id used.
ApUniqueID table
LAYERKEYTABLE
Field
Type
Description
LAYERNAME String Name of the feature classes/table the layer key applies to.
IDFLDNAME
String Name of the field in the feature class/table.
LAYERKEY
String IDNAME in the APUNIQUEID used as source for the unique identifier for this
layer/table-field combination.
ApUniqueID table
HydroIDs are generated in the following way:

z
The LayerKey associated with the layer and the HydroID field is retrieved from the LayerKeyTable
(optional).
The LASTID associated to that key is retrieved from the APUNIQUEID table.
The HydroID is incremented (by 1 by default) to the next HydroID value.
The HydroID field is created (if needed) in the layer and populated with the incremented HydroID.
The LayerKeyTable is created empty, whereas the ApUniqueID table is created with the following records:
LAYERKEYTABLE
IDNAME
LASTID
HYDROID
MARINEID
ApUniqueID table
The UniqueIDs tables may be edited with the UniqueIDs Tables Manager function available in the ApUtilities
menu in the Arc Hydro Tools toolbar.
An overview of the Models toolset
12/8/2014
Page 10 of 29
The Models toolset contains two models used bt the tools computing parameters.
Models
Description
Percent by
Zone
Model calculating the percent of a given type in each zone. Used by the tools
computing parameters.
Stats by Zone
Model calculating the statistiq of a given type in each zone. Used by the tools
computing parameters.
Percent by Zone (Arc Hydro Tools)
Summary
Computes percentages per zone.
Usage
z
Tool works on selected set of drainage areas or on all areas if there is no selected set.
Syntax
PercentbyZone_archydro (Input_Drainage_Area, ID_Field, Category_Raster, Category_Field, Result_Table,
{Snap_Raster}, {Calculate_Percentages})
Parameter
Explanation
Input_Drainage_Area
Input drainage area features defining the zones.
ID_Field
Name of ID field in input drainage areas defining the

zones.
Category_Raster
Input raster storing the value to compute.
Category_Field
Result_Table
Snap_Raster
(Optional)
Calculate_Percentages
(Optional)
Name field in Raster storing the value to use for

computation.
Result table storing the computed values for each zone.
Snap Raster used to set the snapping raster
environment when performing raster computation.
Boolean. Optional. Indicates whether to compute
percentages or ratios.
Data Type
Composite
Geodataset
Field
Raster Layer
Field
Table
Raster Layer
Raster Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 11 of 29
Stats by Zone (Arc Hydro Tools)

Summary
Computes specified statistics per zone.
Usage
z
Tool works on selected set of drainage areas or on all areas if there is no selected set.
Syntax
StatsbyZone_archydro (Input_Drainage_Area, ID_Field, Category_Raster, Result_Table,
{Ignore_NoData_in_calculations}, Statistics_type, {Snap_Raster})
Parameter
Input_Drainage_Area
Explanation
Data Type
ID_Field
Composite
Geodataset
Field
Name of ID field in input drainage areas defining the
zones.
Category_Raster
Input raster storing the value to compute.
Raster Layer
Result_Table
Result table storing the computed values for each

zone.
Table
Boolean. Indicates whether to ignore NoData in

calculations.
Boolean
Ignore_NoData_in_calculations
(Optional)
Statistics_type
Snap_Raster
(Optional)
Input drainage area features defining the zones.
Type(s) of statistics to compute.

Snap Raster used to set the snapping raster
environment when performing raster computation.
String
Raster Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Accumulate Attributes (Arc Hydro Tools)
Summary
Accumulate attributes.
Usage
z
Syntax
12/8/2014
Page 12 of 29
AccumulateAttributes_archydro (trace_type, in_tracinglayer_features, {nextDownID_field},

in_sourcelayer_features, source_field, accumulation_type, {weightedaverage_field}, in_target_features,
target_field)
Parameter
trace_type
in_tracinglayer_features
nextDownID_field
(Optional)
in_sourcelayer_features
source_field
accumulation_type
weightedaverage_field
(Optional)
Explanation
Type of trace used to accumulate the attributes.
"Network Based" or "Attribute Based".
Input feature layer used to perform the trace. Must be
the same as the Source Layer or related to the Source
Layer with a relationship.
NextDownID Field. Optional. Required if Trace Type is
set to "Attribute Based".
Input Source Layer feature storing the attribute to
accumulate.
Attribute to accumulate.
Type of accumulation:
z
Sum
Mean
Min
Max
Count
Median
Mode
Standard Deviation
Weighted Average by Field
Weighted Average Field in source layer. Required if

Accumulation Type is set to "Weighted Average by
Field".
Data Type
String
Feature Layer
Field
Feature Layer
Field
String
Field
in_target_features
Feature Layer
Input Target Layer where the accumulated values will
be stored. Must be either the same as the input Source
Layer or related to the Source Layer with a relationship.
target_field
Target attribute where the accumulated value will be

stored. The attribute will be created if it does not
already exist.
Field
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Assign River Order (Arc Hydro Tools)
Summary
12/8/2014
Page 13 of 29
Classifies the input features (e.g. Catchment or Drainage Line) using the selected ordering methods and
populates the specified RiverOrder field with the calculated order.
Learn more about how Assign River Order (Arc Hydro) works.
Usage
Syntax
AssignRiverOrder_archydro (inTableName, RiverOrder_Field, {RiverOrderType}, {inFSTableName})
Parameter
inTableName
RiverOrder_Field
RiverOrderType
(Optional)
inFSTableName
(Optional)
Explanation
Data Type
Input River or Catchment layer. Must have HydroID and

NextDownID fields (splits to be tested). Used to establish
the river order that will be stored in the RiverOrderField in
that same layer.
Field in input layer where the river order will be stored.
Method used to populate river order (PU_Order, Strahler,
Shreve). Most upstream features are assigned a river
order of 1.
z
PU_Order: downstream feature river order =

maximum of upstream features river order + 1.
Strahler: if different upstream orders, then maximum

of the upstream orders, if more than 1 with maximum
order, then max order +1.
Shreve: add upstream orders.
Input Flow Split table. To be tested.
TableView
Field
String
TableView
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Calculate Length Downstream for Edges (Arc Hydro Tools)
Summary
The tool Calculate Length Downstream for Edges calculates the length from a network edge to its sink in
the network and populates the field LengthDown in that feature class with the calculated value.
The user can specify edge feature classes from the current geometric network. The tool will use the field
Shape_Length in the selected feature classes to retrieve the length of the features.
Learn more about how Calculate Length Downstream for Edges (Arc Hydro) works.
Usage
z
The tool works on selected set and will process all features if there is no selected set.
12/8/2014
Page 14 of 29
Syntax
CalculateLengthDownstreamforEdges_archydro (input_edge_features)
Parameter
Explanation
input_edge_features
Input edge feature classes from geometric network.
[input_edge_features,...]
Data Type
Feature
Layer;Feature
Layer
Environments
Calculate Length Downstream for Junctions (Arc Hydro Tools)
Summary
Calculates the length from a network junction to its sink and populates the field LengthDown in that
feature class with the calculated value.
Usage
z
The tool works on the selection set or on all features if there is no selection.
The tool uses the field Shape_Length in the linear network features to calculate the length
downstream.
Syntax
CalculateLengthDownstreamForJunctions_archydro (input_junction_features)
Parameter
Explanation
input_junction_features
Input junction feature classes to process.
[input_junction_features,...]
Data Type
Feature
Layer;Feature
Layer
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Compute Global Parameters (Arc Hydro Tools)
Summary
Computes selected parameters for global watersheds.
Learn more about how Compute Global Parameters (Arc Hydro) works.
12/8/2014
Page 15 of 29
Usage
Syntax
ComputeGlobalParameters_archydro (in_globalwatershed_features, in_cupolygon_features,
global_datapath, input_parameters)
Parameter
Explanation
in_globalwatershed_features
in_cupolygon_features
Input Global Watershed feature class for which

parameters will be computed.
Cataloging unit polygon feature class.
global_datapath
Parent directory under which the subdirectories

storing the data for each cataloging unit are located.
input_parameters
List of parameters that can be computed.
Data Type
Feature Layer
Feature Layer
Directory
String
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Compute Subwatershed Parameters (Arc Hydro Tools)
Summary
Compute subwatershed parameters.
Usage
z
The tool only processes parameters defined using the GPToolOp custom operator.
The tool processes all selected features (or all features if there is no selection set) at the same
time. It is faster than using the Compute Local Parameters tool that loops through each input
feature but can only be used when processing non overlapping polygons (subwatersheds).
Syntax
ComputeSubwatershedParameters_archydro (in_subwatershed_features, input_parameters, {datapath})
Parameter
in_subwatershed_features
input_parameters
Explanation
Input Subwatershed Feature Layer for which parameters will be
computed.
Parameters to compute.
Data
Type
Feature
Layer
String
The list of parameters is defined in the configuration XML.

Parameters are defined as ApField nodes using the GPToolOp
operator in the XML under the node
FrameworkConfig/HydroConfig/ProgParams/ApFunctions/ApFunction
(WshParams)/ApFields
datapath
Folder
12/8/2014
(Optional)
Page 16 of 29
Optional. Location where the input data required to compute the

parameters are located (if not in the map).
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Find Next Downstream Junction (Arc Hydro Tools)
Summary
Identifies the next downstream junction and populates the field NextDownID with the HydroID of that
feature.
Usage
Syntax
FindNextDownstreamJunction_archydro (in_junction_features)
Parameter
in_junction_features
Explanation
Input Junction features to process.
Data Type
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Find Next Downstream Line (Arc Hydro Tools)
Summary
Finds next downstream line, retrieves its HydroID and stores it in the NextDownID field.
Learn more about how Find Next Downstream Line (Arc Hydro) works
Usage
12/8/2014
Page 17 of 29
Syntax
FindNextDownstreamLine_archydro (in_line_features)
Parameter
in_line_features
Explanation
Data Type
Input Line Layer for which the NextDownID field will be

populated.
Feature Layer
Environments
Related Topics
Assign HydroID
Assign Stream Slope
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Generate From/To Node for Lines (Arc Hydro Tools)
Summary
Updates the FROM_NODE and TO_NODE fields for each line feature in the "Line" feature class.
Learn more about how Generate From/To Node for Lines (Arc Hydro) works
Usage
Syntax
GenerateFNodeTNode_archydro (in_line_features)
Parameter
in_line_features
Explanation
Data Type
Feature Layer
Input Line
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Store Area Outlets by Drainage Point Proximity (Arc Hydro Tools)
12/8/2014
Page 18 of 29
Summary
Locates the outlet junctions for a selected set of areas based on the Drainage Point Proximity method.
Learn more about how Store Area Outlets by Drainage Point Proximity Arc Hydro works
Usage
Syntax
StoreAreaOutletsbyDrainagePoint_archydro (in_area_features, in_hydrojunction_features,
in_drainagepoint_features, search_tolerance)
Parameter
Explanation
in_area_features
Input area features to evaluate
in_hydrojunction_features
Input HydroJunction assessed as outlets
in_drainagepoint_features
Input Drainage Point features used to identify the

outlet,
search_tolerance
Search tolerance.
Data Type
Feature Layer
Feature Layer
Feature Layer
Linear Unit
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Store Area Outlets by Junction Intersect (Arc Hydro Tools)
Summary
Stores identifier of outlet associated to area using the Junction Intersect method.
Learn more about how Store Area Outlets by Junction Intersect Arc Hydro works
Usage
Syntax
StoreAreaOutletsbyJunctionIntersect_archydro (in_area_features, in_hydrojunction_features,
{outletinarea}, outletnearboundary, {search_tolerance}, {compareupdownedges}, {checkedgesinarea})
Parameter
in_area_features
outletinarea
(Optional)
outletnearboundary
Explanation
Input area features to process.
Input Hydro Junction to evaluate as outlets for the
input area features.
Indicates whether the outlet must be located within
the associated area feature.
Indicates whether the outlet must be located near the
boundary of the area features (within the specified
Data Type
Feature Class
Feature Layer
Boolean
Boolean
12/8/2014
Page 19 of 29
tolerance).
search_tolerance
Search tolerance used to check whether the junction is

located near the boundary (if checked).
(Optional)
compareupdownedges
Indicates whether to compare the length of upstream

and downstream edges.
(Optional)
checkedgesinarea
Boolean
Boolean
Indicates whether the edges must be located within

the area.
(Optional)
Boolean
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Store Area Outlets by Next Downstream Area (Arc Hydro Tools)
Summary
Identifies outlet of next downstream area based on Next Downstream Area method.
Learn more about how Store Area Outlets by Next Downstream Area Arc Hydro works
Usage
Syntax
StoreAreaOutletsbyNextDownArea_archydro (in_area_features)
Parameter
in_area_features
Explanation
Data Type
Input areas to process.
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Assign River Order (Arc Hydro) works
The tool Assign River Order populates the RiverOrder field in the input feature class with a river order
12/8/2014
Page 20 of 29
generated using one of the following methods:

z
PU_Order
Strahler
Shreve
PU_Order
Strahler
Shreve
Learn more about how Calculate Length Downstream for Edges (Arc Hydro)
works
This topic applies to ArcEditor and ArcInfo only.
Input/Output Management
The user is prompted for edge feature classes from the current geometric network.
The user is also prompted for the field, common to the selected feature classes, that contains the length
of each feature.
Field created: LengthDown
How the tool works

The length downstream value starts at zero at a sink and increases in the upstream direction. The length
downstream value for a given edge includes the length of all downstream edges (taking the shortest path
through any loops), but not the length of the current edge. For instance, the length downstream for an
edge at the most upstream segment of a river (with no loops) will be the entire length of the river minus
the length of that upstream segment. Likewise, the length downstream for any edge that is connected to
a sink will be zero.
The tool works by tracing downstream from a given feature and summing up the lengths of all
downstream edges that comprise the shortest path between the feature and the nearest sink. The length
of each edge is defined in a field specified by the user. Null values in the field are treated as zeros. The
length downstream is recorded in a field called LengthDown of type double. If a LengthDown field does
not already exist in the feature class, it will be created automatically.
The tool can run on a selected set of records or on all records. If no features are selected, the tool runs
on all records. If any features are selected, the tool runs only on the selected records.
Network preparation
Before using the tool, several steps should be taken to ensure that the network and network solver are
prepared to perform the length downstream calculations:
z
Flow direction must be set in the network. If no flow direction is set, then the length downstream for
every feature will be zero (because the feature does not know where to flow). To set flow direction,
use the Set_Flow_Direction in the Network Tools toolset, or Set Flow Direction on the Arc Hydro Tools
toolbar.
If the network contains loops or is otherwise not a dendritic network (i.e. does not branch in the
downstream direction), then weights and the Trace Indeterminate Flow option must be specified using
the Utility Network Analyst. If flow direction has not been set for edges in a loop and the network
solver has not been instructed to trace through indeterminate flow, then a downstream trace will end
at the beginning of the loop.
12/8/2014
Page 21 of 29
The Trace Indeterminate Flow option is set using the Utility Network Analyst toolbar by clicking
Analysis->Options and selecting the General tab. With this option checked, a downstream trace will
proceed through loops with indeterminate flow. Note that if flow direction is defined on edges in a
loop, then a trace will proceed according to each edge's flow direction.
The tool uses the lengths of edges along the shortest path between the feature of interest and the
nearest sink. This path is determined by the network weights. If no weights are specified, then the
path that traces through the least number of edges is considered the shortest path. This can lead to
inaccurate results since the path with the least number of edges may not necessarily be the shortest
path as far as distance goes. Note that this is not a problem with dendritic networks since there is
only one path to the sink in such networks. Weights are set using the Utility Network Analyst toolbar
by clicking Analysis->Options and selecting the Weights tab. Note that all weights for the network
must be defined when the network is created. Refer to the ArcGIS Desktop Help for more information
on weights and networks.
Learn more about how Calculate Length Downstream for Junctions (Arc
Hydro) works
The function Calculate Length Downstream for Junctions (Attribute Tool toolbox) calculates the length from a
network junction to its associated sink and populates the field LengthDown in that feature class with the
calculated value.
The user is prompted for junction feature classes from the current geometric network. The tool uses the field
Shape_Length in the edge features in the network.
Input
Output
Junction Feature Class(es)
"LengthDown" Field in Junction Feature Class(es)
The user is prompted for junction feature classes from the current geometric network.
The user is also prompted for the field, common to the selected feature classes, that contains the length of
each feature.
Field created: "LengthDown"
How the tool works

The length downstream value starts at zero at a sink and increases in the upstream direction. The length
downstream value for a given edge includes the length of all downstream edges (taking the shortest path
through any loops), but not the length of the current edge. For instance, the length downstream for an
edge at the most upstream segment of a river (with no loops) will be the entire length of the river minus
the length of that upstream segment. Likewise, the length downstream for any edge that is connected to
a sink will be zero.
The tool works by tracing downstream from a given feature and summing up the lengths of all
downstream edges that comprise the shortest path between the feature and the nearest sink. The length
of each edge is defined in the Shape_Length field. Null values in the field are treated as zeros. The length
downstream is recorded in a field called LengthDown of type double. If a LengthDown field does not
already exist in the feature class, it will be created automatically.
The tool can run on a selected set of records or on all records. If no features are selected, the tool runs
on all records. If any features are selected, the tool runs only on the selected records.
Network preparation
12/8/2014
Page 22 of 29
Before using the tool, several steps should be taken to ensure that the network and network solver are
prepared to perform the length downstream calculations:
z
Flow direction must be set in the network. If no flow direction is set, then the length downstream for
every feature will be zero (because the feature does not know where to flow). To set flow direction,
use the Set Flow Direction tool in the Network Tools toolset or in the Network Tools menu on the Arc
Hydro Tools toolbar.
If the network contains loops or is otherwise not a dendritic network (i.e. does branch in the
downstream direction), then weights and the Trace Indeterminate Flow option must be specified using
the Utility Network Analyst. If flow direction has not been set for edges in a loop and the network
solver has not been instructed to trace through indeterminate flow, then a downstream trace will end
at the beginning of the loop.
The Trace Indeterminate Flow option is set using the Utility Network Analyst toolbar by clicking
Analysis->Options and selecting the General tab. With this option checked, a downstream trace will
proceed through loops with indeterminate flow. Note that if flow direction is defined on edges in a
loop, then a trace will proceed according to each edge's flow direction.
The tool uses the lengths of edges along the shortest path between the feature of interest and the
nearest sink. This path is determined by the network weights. If no weights are specified, then the
path that traces through the least number of edges is considered the shortest path. This can lead to
inaccurate results since the path with the least number of edges may not necessarily be the shortest
path as far as distance goes. Note that this is not a problem with dendritic networks since there is
only one path to the sink in such networks. Weights are set using the Utility Network Analyst toolbar
by clicking Analysis->Options and selecting the Weights tab. Note that all weights for the network
must be defined when the network is created. Refer to the ArcGIS Desktop Help for more information
on weights and networks.
Learn more about how Find Next Downstream Line (Arc Hydro) works
The Find Next Downstream Line tool finds the next downstream line(s) based on the From_Node and
To_Node fields in the input Line feature class. It creates the NextDowID field if it does not already exists and
populates this field with the HydroID of the next downstream line. The tool also creates a flow split table
named by appending _FS to the name of the input name. This table stores the additional connectivity
information for cases when flow splits occur and there is more than one downstream line.
Having the next downstream feature listed as an attribute in the table allows features to "communicate" with
each other without the presence of a network, passing values or other information as desired. Knowing the
next downstream point of interest is also important for applications such as Water Rights Analysis and Total
Maximum Daily Load studies.
Input/Output
Input
Output
Line" Feature Class
"NextDownID" field in "Line" feature class

Line Flow Split" table (not prompted)
If there is a line feature class that has a tag "Line", it will be used as a default for the input theme. If not,
the user needs to specify a theme name that will be tagged with the "Line" tag at the end of the
operation.
Line
12/8/2014
Page 23 of 29
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the feature.
Required
FROM_NODE
Integer
Identifier of the from node of the feature. Populated by the

function Generate From/To Nodes for Lines in the toolbar.
Required
TO_NODE
Integer
Identifier of the to node of the feature. Populated by the

function Generate From/To Nodes for Lines in the toolbar.
Created
NextDownID
Integer
HydroID of one of the next downstream Line features.
Attributes table of Line
Note Flow Split table

The user is not prompted for the name of the output Flow Split table. Its name is built by appending the
suffix "_FS" to the name of the input "Line" feature class.
Line_FS
Role
Field
Type
Description
Created
FeatureID
Integer
HydroID of the associated Line feature.
Created
NextDownID
Integer
HydroID of one of the additional downstream Line features.
Attributes table of Line_FS
How the function works

For each line feature in the input "Line" feature class, the function retrieves the TO_NODE of the feature
and look for the feature(s) having the same value for the FROM_NODE, which is/are the next downstream
feature(s) for the feature being processed. The function retrieves the HydroID(s) of the downstream
feature(s), and populates the NextDownID of the processed feature with the first value. Additional values
are stored in the flow split table.
If the function cannot find a downstream feature, then the NextDownID field in the line feature class is
populated with 1.
Learn more about how Generate From/To Node for Lines (Arc Hydro) works
The tool Generate From/To Node for Lines updates the FROM_NODE and TO_NODE fields for each line
feature in the "Line" feature class. The function creates the fields if they do not already exist.
A node is the beginning or the ending location of a line feature. It is topologically linked to all lines that meet
at the node. From nodes and to nodes are assigned based on the direction in which the line features were
digitized. The FROM_NODE and TO_NODE fields define both the direction in which the line features have
been digitized, but also the links between the different line features.
Input/Output
Input
Output
Line" Feature Class
FROM_NODE and TO_NODE updated in "Line" Feature Class
If there is a line feature class that has a tag "Line", it will be used as a default for the input theme. If not,
the user needs to select an existing line theme name that will be tagged with the "Line" tag at the end of
the operation.
12/8/2014
Fields created:
FROM_NODE
TO_NODE
Page 24 of 29
Learn more about how Compute Global Parameters (Arc Hydro) works
The tool Compute Global Parameters computes the selected parameters for the input Global Watershed
features.
Learn more about how Store Area Outlets by Drainage Point Proximity (Arc
Hydro) works
The function Store Area Outlets by Drainage Point Proximity (Attribute Tools menu) locates the outlet
junctions for a selected set of areas and assigns the HydroID of the junction to the JunctionID field in the
corresponding area feature class. If no features are selected, the tool runs on all records. The JunctionID
field is created if it does not already exist in the area feature class.
This tool is designed to facilitate a scheme where areas are connected to the network through outlet
junctions. To perform hydrologic analyses involving rainfall/runoff and channel routing, areas must somehow
be connected to the river network in order to pass runoff to the river channel. This connection is established
by storing in the JunctionID of the area feature class field the HydroID of the junction that serves as the
outlet for the area. Hypothetically, a junction may serve as the outlet of multiple areas, but each area will
have only one outlet.
The tool locates the outlet junction based on the Next Downstream Area Method, i.e. by retrieving the
JunctionID of the downstream area feature.
If the tool cannot locate an outlet junction for a given area, the JunctionID field for that area is set to -1. A
message informs the user that the ObjectIDs of those areas have been written to an error log. These areas
may also be retrieved by selecting the areas with a -1 JunctionID value.
The Drainage Point Proximity method requires the user to select as input a Hydro Junction feature class, an
Area feature class and a Drainage Point feature class.
Input
Output
"Area" Polygon Feature Class
JunctionID field in "Area" Feature Class
"Hydro Junction" Feature Class

"Drainage Point" Feature Class
If there is a network junction feature class that has a tag "Hydro Junction", it will be used as a default for
the first input theme. If not, the user needs to select an existing network junction feature class that will be
tagged with the "Hydro Junction" tag at the end of the operation.
Required field: HydroID
If there is a network junction feature class that has a tag "Area", it will be used as a default for the second
input theme. If not, the user needs to select an existing polygon feature class that will be tagged with the
"Area" tag at the end of the operation.
12/8/2014
Page 25 of 29
Required field: DrainID

Field created: JunctionID
If there is a point feature class that has a tag "Drainage Point", it will be used as a default for the third input
theme. If not, the user needs to select an existing point feature class that will be tagged with the "Drainage
Point" tag at the end of the operation.
Required field: DrainID
How the Drainage Point Proximity method works

Drainage Areas are often delineated from a digital elevation model (DEM). A Drainage Point typically
represents the centroid of the outlet cell of the DEM to which all other cells within the Drainage Area flow.
A Drainage Point does not necessarily fall on the stream network, especially if that network was derived
from means other than grid processing. The Drainage Point Proximity method locates the junction nearest
to the Drainage Point for a given area, within the specified search tolerance, and designates this junction
as the outlet junction.
The DrainID attribute in the area feature class points to the DrainID attribute in the Drainage Point
feature class. These attributes must already exist and must be populated in both the drainage area
feature class and drainage point feature class in order to use this method. If no junctions are found within
the specified search tolerance, a value of -1 is assigned to the JunctionID field in the drainage area
feature class.
The figure below shows a potential scenario for use of the Drainage Point Proximity Method.
When using the DrainID method, note that if the nearest junction to the Drainage Point for a given area is
not in the same drainage area as the desired outlet junction feature class, then a value of -1 is assigned
as the JunctionID for that area.
Learn more about how Store Area Outlets by Junction Intersect (Arc Hydro)
works
The Store Area Outlets by Junction Intersect tool(Attribute Tools toolset) locates the outlet junctions for a
selected set of areas and assigns the HydroID of the junctions to the JunctionID field in the corresponding
12/8/2014
Page 26 of 29
area feature class. If no features are selected, the tool runs on all records having a JunctionID null or equal
to -1. The JunctionID field is created if it does not already exist in the area feature class.
The tool locates the the outlet junction based on the Junction Intersect, i.e. by retrieving the JunctionID of
the downstream area feature.
The Junction Intersect method requires the user to select as input a Hydro Junction feature class and an
Area feature class.
Input
Output
"Hydro Junction " Feature Class

Outlet within Area Feature
Outlet near Area Boundary
Search Tolerance
Compare upstream and downstream length

Check edge within area
If there is a network junction feature class that has a tag "Area", it will be used as a default for the second
"Area" tag at the end of the operation.
If there is a network junction feature class that has a tag "Hydro Junction", it will be used as a default for
the first input theme. If not, the user needs to select an existing network junction feature class that will be
tagged with the "Hydro Junction" tag at the end of the operation.
Required Field: HydroID
How the Junction Intersect method works
z
Select the input Area features to process. Note that the function will only process the features having a
JunctionID null or equal to -1.
Select the input HydroJunction feature class that will be used to define the associated outlets.
Specify whether the oulet should be within the Area feature and/or near the Area boundaries. At least
one of the check boxes must be selected.
If Outlet Near Boundary was checked, specify the search tolerance for identifying the Hydro Junction
located near the area features boundaries.
Specify whether potential outlet must have a total length of traced upstream edges within the area
greater than the total length of downstream edges within the area.
Specify whether a potential outlet must have traced edges within the area.
For each input area feature having Junction null or equal to -1:
12/8/2014
Page 27 of 29
The function selects the junctions that lie within the specified distance (search tolerance) of the
boundary of the drainage area and/or the junctions within the areas depending on the options
specified. If no junctions are found based on the criteria specified, the search tolerance can be
increased to select junctions that are further away from the area's boundary.
For each identified junction (potential outlet):
The function performs an upstream trace and intersects the resulting edges with the area.
It performs a downstream trace and intersects the resulting edges with the area.
It identifies as potential outlets the junctions maximizing the total upstream lengths - total downstream
lengths within the Area feature.
If the option "Upstream > Downstream edges edges within Area feature" is checked, the function will
consider only the junctions having a total length of upstream length within the Area greater than the
total length of downstream edges within the area.
If the option "Must have edges within Area feature" is checked, the function will only consider the
junctions that have connected edges within the Area feature.
Notes
The Junction Intersect method does not create junctions at the intersection of the areas and the network.
The tool assumes that this step has already been done. One way to produce junctions on the boundaries of
areas is to intersect the line set with the areas, using the Geoprocessing Wizard's Intersect Utility. Rebuilding
the network from the intersected line set will produce junctions where the lines and areas intersected.
Only junctions located on an edge will be considered - if a standalone junction is found, the function will
write its OID to the log with a warning and set JunctionID to -1 if no other junction can be associated to the
area considered.
The following figures illustrate the process of selecting the outlet junction. The tool is operating on the pink
area in this example.
Limitations
The Junction Intersect Method possesses some limitations. To insure that all junctions along the boundary of
an area are selected, the tool builds two buffer polygons, one bigger and one smaller than the drainage area.
The user specifies the size of the buffer as the search tolerance for this method. Careful consideration should
be taken in choosing the search tolerance. A tolerance too large may result in selecting junctions far
downstream of the area. A tolerance too small may result in not selecting the appropriate junction. The
nature of the map units should also be taken into consideration
The Junction Intersect Method works best with a relatively homogeneous set of drainage areas. If the areas
differ greatly in size, then a search tolerance that is appropriate for one area may be too large or too small
for another area.
Note: Before using the tool, the the flow direction must be set in the geometric network.
12/8/2014
Page 28 of 29
Learn more about how Store Area Outlets by Next Downstream Area (Arc
Hydro) works
The tool Store Area Outlets by Next Downstream Area (Attribute Tools toolset) locates the outlet junctions
for a selected set of areas and assigns the HydroID of the junction to the JunctionID field in the
corresponding area feature class. If no features are selected, the tool runs on all records. The JunctionID
field is created if it does not already exist in the area feature class.
The tool uses the Next Downstream Area method for locating the outlet junction:
The Next Downstream Area Method requires one input class, the Area Feature class, which has to contain
the fields NextDownID and HydroID already populated.
Input
Output
If there is a network junction feature class that has a tag "Area", it will be used as a default for the input
theme. If not, the user needs to select an existing polygon feature class that will be tagged with the "Area"
tag at the end of the operation.
Required fields: HydroID, NextDownID
How the NextDownstream Area method works

Connectivity between Drainage Areas may be defined through the NextDownID attribute. On a Drainage
Area, the NextDownID points to the HydroID of the next downstream Drainage Area. Thus, connectivity
between Drainage Areas may be established without the use of a geometric network. The Next
Downstream Area method uses this connectivity to locate the outlet junction for a Drainage Area. For a
given area, this method reads JunctionID values from next downstream areas until a numeric non-zero
value (that is not equal to -1) is found. This value is then assigned as the JunctionID for the area of
interest. This technique is useful when no stream network extends into the area of interest.
The following figure illustrates the Next Downstream Area method. The area in pink is the area of interest
in this case. The tool looks for an area with a HydroID equal to the NextDownID of the pink area (101).
The next downstream area is the area at the bottom of the figure (HydroID = 101). The JunctionID is
read from this downstream area and recorded in the pink area, so that both areas share the same outlet.
12/8/2014
Page 29 of 29
12/8/2014
An overview of the GIS Data Exchange toolset
Page 1 of 10

ArcGIS 10
The GIS Data Exchange toolset contains tools that import/export data between an XML file and a
geodatabase.
Tools
Description
Excel
Exchange
Import/Export data between Excel and geodatabase.
GWIS to
FEMA
Export GWIS data into FEMA database format. This toolset require the
Data Interoperability extension.
XML
Exchange
Import/Export data between an XML file and a geodatabase.
Summary of the tools in the GIS Data Exchange toolset
An overview of the Excel Exchange toolset

The Excel Exchange toolset contains tools that import/export data between an Excel file and a
geodatabase.
Tools
Description
Excel_to_Map
Execute geoprocessing model in ArcMap using parameters

values from Excel and update map data with data from an Excel
spreadsheet.
Export_Tool_Parameters Store tool name and parameters into a table.

Map_to_Excel
Export data (including geoprocessing model name and

parameters) from map into Excel spreadsheet.
Summary of the tools in the Excel Exchange toolset
Excel to Map (Arc Hydro Tools)
Summary
Executes a geoprocessing model in ArcMap using parameters values from Excel and updates
map data with data from an Excel spreadsheet.
Learn more about how Excel to Map (Arc Hydro) works
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2FF1.htm
12/8/2014
Page 2 of 10
Usage
Syntax
ExcelToMap_archydro (input_excel_file)
Parameter
input_excel_file
Explanation
Path to Excel file.
Data Type
File Location
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Export Tool Parameters (Arc Hydro Tools)
Summary
Stores geoprocessing tool or mode name and parameters in a table.
Usage
Syntax
ExportToolParameters_archydro (input_tool_name, out_toolparams_table)
Parameter
Explanation
Data Type
input_tool_name
Name of geoprocessing tool or model, whose

parameters need to be exported.
String
out_toolparams_table
Output table storing the exported geoprocessing

tool or model parameters.
Table
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 3 of 10
MapToExcel (Arc Hydro Tools)
Summary
Exports layer from map into Excel. Learn more about how Map to Excel (Arc Hydro) works
Usage
Syntax
MapToExcel_archydro (input_excel_file)
Parameter
input_excel_file
Explanation
Location of Excel file.
Data Type
File Location
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Excel to Map (Arc Hydro) works

Executes a geoprocessing model in ArcMap using parameters values from Excel and updates map
data with data from an Excel spreadsheet.
Learn more about how Export Tool Parameters (Arc Hydro) works
Exports geoprocessing tool or model parameters into a table.
12/8/2014
Page 4 of 10
Learn more about how Map to Excel (Arc Hydro) works

Exports data (including geoprocessing model name and parameters) from a map into an Excel
spreadsheet.
An overview of the GWIS to FEMA toolset

The GWIS to FEMA toolset contains a set of tools that allow exporting GWIS data into FEMA
database format.
Toolset
Description
GWIS to FEMA DCS

Hydraulic
Export data from GWIS geodatabase into FEMA DCS Hydraulic

geodatabase.
GWIS to FEMA DCS

Hydrologic
Export data from GWIS geodatabase into FEMA DCS

Hydrologic geodatabase.
Summary of the toolsets in the GWIS to FEMA toolset
GWIS to FEMA DCS Hydraulic (Arc Hydro Tools)
Summary
Exports data from GWIS geodatabase into FEMA DCS Hydraulic geodatabase.
Usage
Syntax
GWIStoFEMADCSHydraulic_archydro (SourceDataset_GEODATABASE_FILE,
DestDataset_GEODATABASE_FILE, {SOURCE_CIT_S_SUBBASINS (Optional)},
{SOURCE_CIT_S_XS}, {SOURCE_CIT_S_FLD_HAZ_AR}, {SOURCE_CIT_S_PROFIL_BASLN})
Parameter
Explanation
SourceDataset_GEODATABASE_FILE
Source GWIS geodatabase.
DestDataset_GEODATABASE_FILE
Target FEMA DCS Hydraulic
Data Type
Multiple
Value
Workspace
12/8/2014
Page 5 of 10
geodatabase.
SOURCE_CIT_S_SUBBASINS
(Optional)
(Optional)
SOURCE_CIT_S_XS
(Optional)
SOURCE_CIT_S_FLD_HAZ_AR
(Optional)
SOURCE_CIT_S_PROFIL_BASLN
(Optional)
Value for SOURCE_CIT attributes in

S_Subbasins feature class in target
FEMA DCS Hydraulic geodatabase.
String
Value for SOURCE_CIT attribute in

S_XS feature class in target FEMA
DCS Hydraulic geodatabase.
String

S_FLD_HAZ_AR feature class in
target FEMA DCS Hydraulic
geodatabase.
String

S_PROFIL_BASLN feature class in
target FEMA DCS Hydraulic
geodatabase.
String
Environments
ArcView: Requires Data Interoperability
ArcEditor: Requires Data Interoperability
ArcInfo: Yes
GWIS to FEMA DCS Hydrologic (Arc Hydro Tools)
Summary
Imports GWIS data into FEMA DCS Hydrologic geodatabase.
Usage
Syntax
GWIStoFEMADCSHydrologic_archydro (SourceDataset_GEODATABASE_FILE,
DestDataset_GEODATABASE_FILE, {SOURCE_CIT_S_SUBBASINS},
{SOURCE_CIT_S_HYDRO_REACH}, {SOURCE_CIT_S_NODES})
Parameter
Explanation
SourceDataset_GEODATABASE_FILE
Source geodatabase.
DestDataset_GEODATABASE_FILE
Destination geodatabase.
SOURCE_CIT_S_SUBBASINS

S_Subbasins feature class in target
FEMA DCS Hydrologic geodatabase.
(Optional)
Data Type
Multiple
Value
Workspace
String
12/8/2014
SOURCE_CIT_S_HYDRO_REACH
(Optional)
SOURCE_CIT_S_NODES
(Optional)
Page 6 of 10

S_HydroReach feature class in target
FEMA DCS Hydrologic geodatabase.
String

S_Nodes feature class in target FEMA
DCS Hydrologic geodatabase.
String
Environments
ArcView: Requires Data Interoperability
ArcEditor: Requires Data Interoperability
ArcInfo: Yes
An overview of the XML Exchange toolset

The XML Exchange toolset contains tools that import/export data between an XML file and a
geodatabase.
Tools
Description
Append Coordinate System to

XML
Insert coordinate system information in an existing XML

file.
Export GIS Data to XML
Export preconfigured data from a geodatabase into an

XML file.
Import from XML
Import data from an XML file into a geodatabase.
Transform XML
Transform an input XML into an output XML using an XSL

file.
Summary of the tools in the XML Exchange toolset
Append Coordinate System to XML (Arc Hydro Tools)
Summary
Inserts information on coordinate system in existing XML file by editing the first node
'.//WKT' in the input XML.
12/8/2014
Page 7 of 10
Usage
Syntax
AppendCoordinateSystemtoXML_archydro (Input_XML_File, Input_Coordinate_System,
Overwrite_Coordinate_System_in_XML)
Parameter
Explanation
Data Type
Input_XML_File
Input XML file to edit.
File
Input_Coordinate_System
Input Coordinate System to insert

in the input XML file.
Coordinate
System
Overwrite_Coordinate_System_in_XML
Indicates whether to overwrite the

existing spatial reference in the
XML. Default to False.
Boolean
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Export GIS Data to XML (Arc Hydro Tools)
Summary
Exports data from a geodatabase into an XML file based on a predefined configuration file.
Learn more about how Export GIS Data to XML (Arc Hydro) works
Usage
Syntax
ExportToXML_archydro (in_appconfig, input_export_controlfile, output_export_xmlfile)
Parameter
Explanation
Data Type
in_appconfig
Name of the application for the export. Tool will

use the XML configuration node associated to
the selected application.
String
input_export_controlfile
Location and name of the control file used for

the export. Refer to the document XML-Based
GIS Data Exchange Tools v2.0 - User
Manual.pdf for more information on the
structure of the control file.
File Location
12/8/2014
output_export_xmlfile
Location and name of the output XML file.
Page 8 of 10
File Location
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Import from XML (Arc Hydro Tools)
Summary
Import from XML allows importing data from an XML file into a geodatabase.
Learn more about how Import from XML (Arc Hydro) works
Usage
Syntax
ImportFromXML_archydro (input_xmlfile, output_filegeodatabase)
Parameter
Explanation
Data Type
input_xmlfile
XML file to import.
File Location
output_filegeodatabase
Output geodatabase storing the imported data.
File
Geodatabase
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Transform XML (Arc Hydro Tools)
12/8/2014
Page 9 of 10
Summary
Transforms XML based on input XSL file.
Learn more about how Transform XML (Arc Hydro) works
Usage
Syntax
TransformXML_archydro (input_xmlfile, input_xslfile, output_file)
Parameter
Explanation
Data Type
input_xmlfile
Input XML File for Transform
File Location
input_xslfile
Input XSL File for Transform
File Location
output_file
Output XML File
File Location
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Export GIS Data to XML (Arc Hydro) works
The Export GIS Data to XML tool allows exporting data from a geodatabase into an output XML
file based on a predefined XML control file. The structure of the control file is described in details
in the document intitled XML-Based GIS Data Exchange Tools v2.0 - User Manual.pdf.
There are 2 main options to define the data to export and its source in the control file:
z
Data to export is loaded into the map document. The tool exports only the data from the
control file that is in the map document.
Data location is defined in the configuration XML associated to the map document. Only the
data configured for export that is tagged in the XML with a valid target location will be
exported.
Learn more about how Import from XML (Arc Hydro) works
12/8/2014
Page 10 of 10
Imports preconfigured data from an XML file into a geodatabase.
Learn more about how Transform XML (Arc Hydro) works

Transforms an XML using an XSL file.
12/8/2014
An overview of the H&H Modeling toolset
Page 1 of 63
An Overview of the H&H Modeling toolset

ArcGIS 10
The H&H Modeling toolset contains a set of toolsets that support hydrologic and hydraulic modeling.
Toolset
Description
GeoICPR
Tools supporting ICPR modeling.
Green and Ampt
Tools supporting Green and Ampt modeling.
Map to Map
Tools supporting hydrologic and hydraulic modeling, starting

with a map from rainfall to generate a map of flooding.
Streamstats
Tools supporting USGS Streamstats application
Time of Concentration
Tools supporting computation of time of concentration.
Utility
Tools supporting modeling.
Summary of the toolsets in the H&H Modeling toolset
An overview of the GeoICPR toolset

The GeoICPR toolset contains tools that generate the GIS data required for importing/exporting data between GIS and ICPR and
generating Floodplains based on the modeling results.
ICPR stands for Interconnected Channel and Pond Routing Model. It solves the problem of flood routing through complex networks of
interconnected and hydraulically interdependent stormwater ponds.
Tools
Description
Floodplain Delineation (Link)
Generate the Floodplain rasters and polygon features associated to

CHANNEL type ICPR links.
Floodplain Delineation (Node)
Generate the Floodplain rasters and polygon features associated to the

ICPR Node features of type STAGE/AREA (i.e. sink nodes).
Generate ICPR Basin
Generate ICPR Basin features based on ICPR Links and Nodes to

prepare for export to ICPR model.
Generate ICPR Link
Generate ICPR Link features to prepare for export to ICPR model.
Generate ICPR Node
Generate ICPR Node features to prepared for export to ICPR model.
Import from ICPR
Import result of ICPR modeling run into GWIS geodatabase.
Mosaic Floodplains
Create mosaic datasets using the depth/elevation rasters generated by

the ICPR Floodplain Delineation (Node/Link) tools for a given return
period with varying duration or for a given duration with varying return
periods.
The tools generating ICPR data should be used in the following sequence:
1.
Generate ICPR Node
2.
Generate ICPR Link
3.
Generate ICPR Basin
Floodplain Delineation (Link) (Arc Hydro Tools)
Summary
Generates the water surface elevation and depth rasters for each of the surface water elevations selected by the user as well as the
ICPRFloodPlain polygon feature class representing the floodplain.
The input ICPR Basin is optional. If set, the floodplain will be computed within each ICPR Basin and assembled at the end, i.e. ICPR
Links segments only influence the ICPR Basin within which they are located. If the ICPR Basin is not set, there is no constraint
applied and the floodplain is computed using the ICPR Links elevations and DEM elevation only.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 2 of 63
For each selected Input Link feature of type CHANNEL, the tool checks whether there are two ICPR Nodes located at the from and
to nodes of the line with populated surface elevations. If there are, then the tool performs a linear interpolation of the elevations
along the line.
The tool generates a new ICPR Link raster representing the surface elevations along the ICPR Links. All other cells have no data.
The tool burns in these elevations onto the input DEM to create a raster where the cells keep their original elevation at the
exception of the cells located along the ICPR Links of type CHANNEL which are assigned the interpolated surface elevations.
The tool interpolates the surface elevations (nibbles) based on the Water surface levels along the link.
z
If an input ICPR Basin has been specified, the tool processes each ICPR Basin separately by performing the nibble operation
using as mask a raster where only the ICPR Links within the basin have an elevation value. All other cells are set to nodata and
will be populated by the nibble operation. Each nibbled grid associated to an ICPR Basin is used to populate the values in that
basin in a global nibble grid.
If the ICPR Basin has not been specified, the tool performs only one nibble operation using the grid with elevations only in the
ICPR Links as mask.
The resulting nibble grid created in both cases represents a water surface elevation grid. The tool then generates an associated
depth grid by subtracting the input elevation grid form the surface elevation grid.
The tool converts the floodplain raster into a polygon feature class and generates the output Floodplain polygon features by storing
the underlying polygon feature associated to each input ICPR Node. It populates the following attributes:
z
VARID: Type of water elevation surface.
TSTIME: Date and time the record was created.
VARDESC: Description of surface elevation.
RASTERPATH: Path to associated surface elevation raster.
DEPTHRASTERPATH: Path to associated depth raster.
Usage
z
The tool works on a selected set of ICPR Links of type CHANNEL and processes all features if there is no selection set. The
ICPR Basin input is optional - if specified, the floodplain in each ICPR Basin will be generated based on the ICPR Links within
the basin only.
Syntax
FloodPlainDelineationLink_archydro (ICPRLink, ICPRNode, ICPRNodeResult, {ICPRBasin}, RawDEM, VariableDefinition,
input_select_water_levels, ICPRFloodPlain)
Parameter
Explanation
ICPRLink
ICPRNode
Data Type
Input ICPR Link features of type CHANNEL to process.

Input ICPR Node features associated to the ICPR Link features.
Feature Layer
Feature Layer
ICPRNodeResult
Input ICPR Node Max Stage (Ft) Table storing the results of the ICPR
modeling run.
Table View
ICPRBasin
Input ICPR Basin Polygon feature class.
Feature Layer
RawDEM
Input Digitial Elevation Model used to extract data to compute the depth
rasters.
Raster Layer
VariableDefinition
Input VariableDefinition table storing the water level frequencies that

may be selected in the field VARDESC.
Table View
input_select_water_levels
Water level frequencies (e.g. 100 Yr 1 Day, 100 Yr 5 Day etc.) for which
you want to delineate the floodplains. These frequencies are read from
the 'VARDESC' field in the input VariableDefinition table.
String,String
(Optional)
ICPRFloodPlain
Output ICPR Floodplain Polygon feature class.
Feature Class
Environments
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
Floodplain Delineation (Node) (Arc Hydro Tools)
12/8/2014
Page 3 of 63
Summary
Generate the floodplain rasters and polygon features associated to the ICPR Node features of type STAGE/AREA (i.e. sink nodes).
The output of the tool is an elevation raster for each of the variables selected and an ICPRFloodPlain feature class representing the
floodplains.
For each selected water elevation type, the tool retrieves the water surface elevations associated to the selected ICPR Nodes of
type STAGE/AREA. The elevations are stored in the input ICPR Node Result table and relates to the ICPR Node feature class through
the Name/ICPR_NODE_NAME fields. The elevation fields must have the same names as the elevation variables.
The function generates a temporary polygon feature class by reselecting the ICPR Basin features underlying the input ICPR Node
features being processed and stores the associated water surface elevation in the attributes table.
The function converts the temporary polygon feature class storing the water levels into a temporary water surface elevation raster.
The function generates the final floodplain raster by keeping only the areas of the surface elevation raster higher than the input
elevation raster and setting the others to no data.
The function generates the associated depth grid by subtracting the input elevation grid from the surface elevation grid.
The function converts the floodplain raster into a polygon feature class and generates the output Flood Plain polygon features by
storing the underlying polygon feature associated to each input ICPR Node. It populates the following attributes:
z
FEATUREID: HydroID of associated ICPR Node feature.
VARID: Type of water elevation surface.
TSTIME: Date and time the record was created.
TSVALUE: Value of surface elevation at associated ICPR Node.
VARDESC: Description of surface elevation.
ICPR_NODE_NAME: Name of associated ICPR Node.
RASTERPATH: Path to associated surface elevation raster.
DEPTHRASTERPATH: Path to associated depth raster.
Usage
z
The tool works on a selected set of ICPR Nodes and processes all features if there is no selected set.
Syntax
FloodPlainDelineationNode_archydro (ICPRNode, ICPRNodeResult, ICPRBasin, RawDEM, VariableDefinition, input_select_water_levels,
ICPRFloodPlain)
Parameter
Explanation
Data Type
ICPRNode
Input ICPR Node features of type STAGE/AREA to process.
Feature Layer
ICPRNodeResult
Input ICPR Node Max Stage (Ft) Table storing the results of the ICPR
modeling run.
Table View
ICPRBasin
Input ICPR Basin Polygon feature class.
Feature Layer
RawDEM
VariableDefinition
input_select_water_levels
ICPRFloodPlain
Input Digitial Elevation Model used to extract data to compute the depth
rasters.
Input VariableDefinition table storing the water level frequencies that
may be selected in the field VARDESC.
Water level frequencies (e.g. 100 Yr 1 Day, 100 Yr 5 Day etc.) for which
you want to delineate the floodplains. These frequencies are read from
the 'VARDESC' field in the input VariableDefinition table.
Output ICPR Floodplain Polygon feature class.
Raster Layer
Table View
String,String
Feature Class
Environments
ArcInfo: Yes
Generate ICPR Basin (Arc Hydro Tools)
12/8/2014
Page 4 of 63
Summary
Generates ICPR Basins based on ICPR Nodes of type Stage/Area and mid points of ICPR Links of type Channel.
Learn_more_about_how_Generate_ICPR_Basin_Arc_Hydro_works
Usage
Syntax
GenerateICPRBasin_archydro (in_icprnode_features, in_icprlink_features, in_groupbasin_features, in_catchment_features,
in_preferentiallink_features, in_flow_direction_raster, in_icprbasin_features)
Parameter
Explanation
in_icprnode_features
Input ICPR Node
in_icprlink_features
Input ICPR Link
in_groupbasin_features
in_catchment_features
in_preferentiallink_features
Data Type
Feature Layer
Feature Layer
Input ICPR Group Basin
Feature Layer
Feature Layer
Input Catchment
Input Preferential Link
Feature Layer
in_flow_direction_raster
Input Flow Direction Grid
Raster Layer
in_icprbasin_features
Input ICPR Basin
Feature Class
Environments
ArcInfo: Yes
Generate ICPR Link (Arc Hydro Tools)
Summary
Generates ICPR Links.
Learn_more_about_how_Generate_ICPR_Link_Arc_Hydro_works
Usage
z
The tool ignores any selection set and processes all input features.
The tool clears all existing records in the input ICPR Link feature class.
Syntax
GenerateICPRLink_archydro (in_groupbasin_features, in_icpr_seedpoint_features, in_grouplink_features, in_hydroedge_features,
in_hydrojunction_features, in_groupjunction_features, in_icprnode_features, in_hep_features, in_icprlink_features)
Parameter
in_icpr_seedpoint_features
in_grouplink_features
in_hydroedge_features
Explanation
Data Type
Input GroupBasin feature class.
Feature Layer
Input Seedpoint feature class. Required fields: NAME, TYPE.
Feature Layer
Input Seedpoint feature class.

Input Hydro Edge feature class. Required fields: HYDROID, FLOWDIR.
Input Hydro Junction feature class. Required fields: HYDROID,
JUNCTION_TYPE_DESC.
Feature Layer
Feature Layer
Feature Layer
in_groupjunction_features
Input Group Junction feature class
Feature Layer
Input ICPR Node feature class. Required field: TYPE.
Feature Layer
in_hep_features
Input Hydraulic Element Point feature class. Required fields:

SUBELEMENTID, JUNCTIONID, SUBELEMENT_TYPE.
Feature Layer
in_icprlink_features
Input ICPR Link. Required fields: NAME, TYPE. Generated ICPR links will
be saved in this feature class.
Feature Layer
12/8/2014
Page 5 of 63
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Generate ICPR Node (Arc Hydro Tools)
Summary
Generates ICPR Nodes based on Seed Point features and Group Node features (optional).
Learn more about how Generate ICPR Node (Arc Hydro) works
Usage
z
The tool ignores the selection sets in all input feature classes and processes all features.
The tool will delete all existing features in the input ICPR Node feature class.
Syntax
GenerateICPRNode_archydro (in_icpr_seedpoint_features, {in_groupnode_features}, in_icprnode_features)
Parameter
in_icpr_seedpoint_features
in_groupnode_features
(Optional)
Explanation
Data Type
Input ICPR Seed Point
Feature Layer
Input Group Node
Feature Layer
Input ICPR Node feature class. Required fields: NAME, TYPE.
Feature Layer
The tool will delete all existing records in this feature class.
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Import from ICPR (Arc Hydro Tools)
Summary
Imports the results from ICPR modeling runs into the GWIS geodatabase.
Learn more about how Import from ICPR (Arc Hydro) works
Usage
Syntax
ImportFromICPR_archydro (in_modelresult_location, in_variabledefinition_table, out_node_result_table, out_link_result_table,
out_node_hydrograph_table, out_link_hydrograph_table)
Parameter
in_modelresult_location
in_variabledefinition_table
Explanation
Location of the results of the ICPR model model runs.
Input TSTypeInfo table.
out_node_result_table
Data Type
Directory
Table
Table
12/8/2014
Page 6 of 63
Ouput ICPR Node Max Stage (Ft) table.

out_link_result_table
Ouput ICPR Link Max Flow (cfs) table.
out_node_hydrograph_table
out_link_hydrograph_table
Ouput ICPR Node Hydrograph table.

Ouput ICPR Link Hydrograph table.
Table
Table
Table
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Mosaic Floodplains (Arc Hydro Tools)
Summary
Create mosaic datasets for depths and elevation grids corresponding to a fixed return period (frequency) with varying durations or
a fixed duration with varying return periods.
Usage
Tool processes all combinations of frequency/duration present in the input ICPRFloodPlain feature class. This feature class may
generated by the Post Processing tools available in the GeoICPR Tools toolbr.
The input ICPRFloodPlain feature class must contain the following fields:
TSTYPEDESC: frequency/duration type, as ELEVATION_nnnYR_dDAY_VAL, where nnn is the return period and d the
duration of the event.
DEPTHRASTERPATH: full path the Depth raster associated to the frequency/duration type.
RASTERPATH: full path to the Elevation raster associated to the frequency/duration type.
The resulting Mosaic Datasets may be time-enabled as follows:

1. Right-click the raster dataset to open its Properties window and switch to the Time tab.
2.
Select as "Layer Time": "Each feature has a single time field.
3.
Select as "Time Field": OBJECTID (the rasters in the rmosaic dataset have been sorted correcly by the tool).
4.
Keep the default (1 and Years) as Time Step Interval.
You can then use the Time Slider tool available on the Tools toolbar to display the rasters as a function of the return periods for
a fixed duration or as function of the durations for a fixed return period.
Syntax
MosaicFloodplains_archydro (ICPRFloodPlain)
Parameter
ICPRFloodPlain
Explanation
Data Type
Input ICPR Floodplain polygon layer. May be created with the Floodplain
Delineation tools Tool for Node or Link. The RASTERPATH and
DEPTHRASTERPATH must point to the correct raster locations.
Feature Layer
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Generate ICPR Basin (Arc Hydro) works
12/8/2014
Page 7 of 63
This tool allows generating ICPR Basin features delineated from the ICPR Node features of type STAGE/AREA and from the points
located halfway along the ICPR Link features of type CHANNEL.
This tool ignores the selection set(s) in the input feature classes.
Input/Output
Input
Output
"ICPR Node" Feature Class
"ICPR Basin" Feature Class
"ICPR Link" Feature Class

"Group Basin" Feature Class
"Catchment" Feature Class
"Preferential Link" Feature Class
"Flow Direction Grid"
How the tool works

The tool checks whether there are any ICPR Links of type Channel within the input Group Basins.
z
No Channel ICPR Link: ICPR Basins are identical to the input Group Basins and are draining into Stage/Area ICPR Nodes.
With Channel ICPR Link(s)

1.
The tool loops through the input ICPR Links of type CHANNEL and identifies the point located in the middle of each link. It
splits the ICPR Links of type Channel in the middle.
2.
The tool generates the watersheds associated to the input split Channel ICPR Links using the input Flow Direction grid.
3.
The tool reselects the watersheds draining into the first part of each ICPR Link (from the ICPR Channen node to the mid
point).
4.
The tool uses the input Preferential Links to identify the upstream catchments features associated to each selected
delineated "channel" watershed and merges their geometries with the associated watershed.
The tool looks for the ICPR Node of type STAGE/AREA or CHANNEL located in each ICPR Basin. It retrieves the name of this node
and appends it to the prefix "B" to generate the name of the Basin, which is stored in the Name field.
ICPR Node
Role
Field
Type
Description
Required
Name
String
Name of the ICPR Node.
12/8/2014
Required
Type
String
Page 8 of 63
Type of ICPR node. Populated with coded values from domain dICPR_NODETYPE:
STAGE/AREA, TIME/STAGE, STAGE/VOLUME, MANHOLE or CHANNEL.
Attributes table of ICPR Node
ICPR Link
Role
Field
Type
Description
Required
Type
String
Type of ICPR link. Populated with coded values from domain dICPR_LINKTYPE: WEIR,
CHANNEL.
Attributes table of ICPR Link
Group Basin
Role
Field
Type
Description
Required
HydroID
String
Unique identifier of the Group Basin feature in the Hydro database.
Attributes table of Group Basin
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the Catchment feature in the Hydro geodatabase.
Required
GroupID
Integer
HydroID of associated Group Basin.
Required
IsTerminal
Integer
Indicates whether the catchment is the most downstream in its Group.
Attributes table of Catchment
Preferential Link
Role
Field
Type
Description
Required
FeatureID1
Integer
HydroID of the source Catchment associated to the preferential link.
Required
FeatureID2
Integer
HydroID of the target Catchment associated to the preferential link.
Attributes table of Preferential Link
ICPR Basin
Role
Field
Type
Description
Created/Populated
HydroID
Integer
Unique identifier of the feature in the Hydro geodatabase.
Created/Populated
Name
String
Name of the basin. Populated by appending the name of the node into which the
basin drains to the prefix "B".
Attributes table of ICPR Basin
Learn more about how Generate ICPR Link (Arc Hydro) works
This tool allows generating ICPR Links based on the Seed Point, Group Link, ICPR Node, Hydro Edge, Hydro Junction, Group Junction
and Hydraulic Element Point input feature classes. The tool ignores any selection set and processes all input features. It clears all
existing records in the ICPR Link feature class.
The NAME field is populated with the abbreviation associated to the link type, concatenated with the HydroID of the new ICPR Link.
Group Link and Group Node features define the preferred connectivity between Group Basins and are used to generate ICPR Links and
Node.
The tool creates the following type of ICPR links:
1.
2.
Based on input ICPR Seed Points and ICPR Nodes of type CHANNEL:
z
ICPR links of type WEIR and CHANNEL for input Seed Point features of type WEIR.
z
ICPR links of type PIPE and CHANNEL for input Seed Point features of type BARREL.
ICPR links of type BRIDGE and CHANNEL for input Seed Points of type BRIDGE.
Based on HydroEdges of type CONDUIT or CHANNEL and ICPR Nodes of type CHANNEL:
z
ICPR links of type PIPE and CHANNEL associated to input Hydro Edge features of hydraulic type CONDUIT or
CHANNEL.
z
3.
ICPR links of type DROP STRUCTURE and CHANNEL associated to input Hydro Edge features of hydraulic type
CONDUIT
ICPR links of type PIPE associated to Hydraulic Element Point subelements defining a pipe barrel for a WEIR.
Input/Output
12/8/2014
Page 9 of 63
Input
Output
"ICPR Seed Point" Feature Class
"ICPR Link" Feature Class
"Group Link" Feature Class

"Hydro Edge" Feature Class
"Group Junction" Feature Class
"Hydraulic Element Point" Feature Class
How the tool works

Setting up geometric network for tracing
The tool traces the geometric network with the HydroEdges and HydroJunctions to define the ICPR Links. The flow direction in the
network must be set to reflect the preferential flow path before using the tool. This may be done by using first the tool Set Flow
Direction Using Preferential Link that will populate the FLOWDIR attribute in the HydroEdge feature class with the direction of the
preferential path. Then the tool Set Flow Direction from the Network Tools toolset may be used to set the flow in the network itself.
The tool uses the input Group Junction feature class to identify the HydroJunction features of type Sinks (i.e. having
JUNCTION_TYPE_DESC='LPOBASIN' that intersect GroupJunction features. These HydroJunction features define the Group Sink
points for the network. The tool will programmatically set these HydroJunctions as barriers that stop the downstream traces. The
tool also creates new ICPR Node features of type STAGE/AREA for these junctions if they do not already exist.
The following sections describe how the ICPR links are generated.
1.
Based on input ICPR Seed Points and ICPR Nodes of type CHANNEL
The tool loops through each WEIR/BRIDGE/BARREL type Seed Point feature and creates WEIR/BRIDGE/PIPE or CHANNEL
type ICPR links by merging the geometries of Hydro Edge features on both sides of the point structures and tracing each
end to its Group Junction of type SINK. If there are CHANNEL type ICPR Nodes along the merged Hydro Edge features,
the tool splits the merged geometry into CHANNEL type ICPR Links for segments that do not contain the seed point. The
ICPR Link containing the Seed Point will be assigned the type WEIR/BRIDGE/PIPE. If they are no CHANNEL nodes, the
tool creates one ICPR link of type WEIR/BRIDGE/PIPE. The picture below illustrates the case where one ICPR Link of type
PIPE and one of type CHANNEL are created based on the input Seed Point of type BARREL located on the Group Basin
boundary and on the ICPR Node of type CHANNEL located on the path connecting the 2 group sink junctions
(corresponding to ICPR Node of type STAGE/AREA) through the BARREL feature.
2.
Based on HydroEdges of type CONDUIT and ICPR Nodes of type CHANNEL

The tool loops through CONDUIT HydroEdges (i.e. Hydro Edges having their field
12/8/2014
Page 10 of 63
"HYDROEDGE_HYDRAULIC_TYPE_DESC" set to 'CON') to create PIPE or DROP STRUCTURE and CHANNEL ICPR Links. The
tool creates either one PIPE or one DROP STRUCTURE link, depending on the type of the hydraulic type of the
HydroJunctions located at the from and at the to point of the CONDUIT. In addition, it creates CHANNEL Links if the
connected HydroEdges on the path from Group Sink to Group Sink through the CONDUIT have ICPR Nodes of type
CHANNEL.
For each Hydro Edge of type CONDUIT:
z
The tool checks the hydraulic type of the Hydrojunctions located at the from and at the To Point of the CONDUIT
(PIPE or DROP STRUCTURE). The rule is that if at least one of the end junctions for conduit is a Control Structure
(CS), then the new ICPR Link will be a DROP STRUCTURE, otherwise it will be a PIPE.
z
The new ICPR Links created for the conduit must link 2 STAGE/AREA ICPR Nodes. The tool checks whether there are
Linear Structure HydroEdges (HYDROEDGE_HYDRAULIC_TYPE_DESC='SC') connected to the CONDUIT:
a. The tool checks if there are any SC Hydro Edges connecting at the From Point of the CONDUIT:
i. If the tool finds connected SC Hydro Edges, it adds the line(s) to the geometries included in
the new links. It checks whether there is an ICPR Node of type STAGE/AREA located at the
end of the SC HydroEdges. If there is none, the tool traces downstream from the end of the
SC HydroEdge to the Group Sink and adds the traced geometries to the collection of
geometries that will be used to create the links. It then checks whether there are ICPR Nodes
of type CHANNEL located on these Hydro Edges:
If the tool finds CHANNEL ICPR Nodes, it adds the nodes to the collection of points that
will split the line geometries to create ICPR Link of type CHANNEL for each resulting part
at the exception of the last part which will be part of the PIPE or DROP STRUCTURE
created (based on the type of the ICPR Node at the To Point of the CONDUIT).
ii.
b.
If the tool does not find any ICPR Node of type CHANNEL, the line geometries will be
part of the ICPR Link of type PIPE or DROP STRUCTURE.
If the tool does not find a connected SC Hydro Edge connecting at the From Point of the
CONDUIT, it looks for an existing ICPR Node of type STAGE/AREA at the From Point and
creates it if it does not already exist. The conduit will be part of the new ICPR Link.
The tool checks next whether there are any SC Hydro Edges connected at the To Point of the CONDUIT:
i. If the tool finds connected SC Hydro Edges, it adds the line(s) to the collection of lines that
will be used to create the link(s). It checks whether there is an ICPR Node of type
STAGE/AREA located at the end of the SC HydroEdges. If there is none, the tool traces
downstream from the end of the SC HydroEdge to the Group Sink. It then checks whether
there are ICPR Nodes of type CHANNEL located on these Hydro Edges:
If the tool finds CHANNEL ICPR Nodes, it adds the nodes to the collection of points to
use to split the line geometries to create ICPR Link of type CHANNEL for each resulting
part at the exception of the first part which will be part of the PIPE or DROP STRUCTURE
created (based on the type of the ICPR Node at the To Point of the CONDUIT).
ii.
If the tool does not find any ICPR Node of type CHANNEL, the line geometries will be
part of the ICPR Link of type PIPE or DROP STRUCTURE.
If the tool does not find a connected SC Hydro Edge connecting at the To Point of the
CONDUIT, it looks for an existing ICPR Node of type STAGE/AREA at the To Point and creates
it if it does not already exist. The conduit will be part of the new ICPR Link.
If it finds any, it merges their geometries with the CONDUIT and looks for the ICPR Nodes of type
CHANNEL located along these features. The tool looks for ICPR Nodes of type PIPE or DROP STRUCTURE
located on these features and sets their field IsIncluded to 0 so that these nodes are not exported to
ICPR (e.g. To Point of CONDUIT).
c.
The tool merges all the line geometries found through the 2 previous steps (conduit, shallow
concentrated and trace lines) and splits these lines at the location of the CHANNEL ICPR Node features (if
any). The line split by the nodes will be used to generate ICPR Links of type CHANNEL at the exception of
the geometries overlaying the conduit that will be used to create the ICPR Link of type PIPE or DROP
STRUCTURE.
The first picture below shows the source CONDUIT HydroEdge that is being processed. The second
picture shows the resulting ICPR Link, created by merging the CONDUIT with the 2 connected SHALLOW
CONCENTRATED HydroEdges. The ICPR Link is created with the type DROP STRUCTURE since its From
HydroJunction is a control structure.
12/8/2014
3.
Page 11 of 63
ICPR links of type PIPE associated to Hydraulic Element Point subelements defining a pipe barrel for a WEIR.
The tool creates additional ICPR Links for each subelement of type BARREL associated to a Hydro Junction of type WEIR
for which an ICPR Link has been generated. The new links are generated by copying the existing PIPE ICPR Link
associated to the Hydro Junction. The total number of links match the number of subelement associated to the
HydroJunction. In this example below, since there are 2 barrel subelements associated to the Hydro Junction. one
additional link is created in addition to the ICPR Link already existing.
12/8/2014
Page 12 of 63
The tool proceeds as follows:

z
it builds the list of SUBELEMENTIDs associated to Hydro Junction features of type WEIR by retrieving the records (i.e.
BARREL) from the input Hydraulic Element Point feature class having the field JUNCTIONID populated. This field
stores the HydroID of the Hydro Junction associated to the Hydraulic Element Point. The field SUBELEMENTID stores
the HydroID of the subelement (e.g. BARREL) associated to the Hydraulic Element Point and to the HydroJunction.
For example, the Hydro Junction in the picture above has 2 associated barrel subelements. The tool will create one
additional PIPE ICPR Link to represent the second Barrel that will overlap the ICPR Link of type PIPE already created
for that junction.
z
it identifies the ICPR Links associated to the HydroJunction(s) and duplicates this link as needed so that each
subelement is represented in the ICPR Link feature class.
ICPR Seed Point

Role
Field
Type
Description
Required
Name
String
Name of Seed Point
Required
Type
String
Type of Seed Point. Tool processes features of type WEIR, BARREL and BRIDGE.
Hydro Edge
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of
the feature in the
Arc Hydro
geodatabase.
Required/Created
HYDROEDGE_HYDRAULIC_TYPE_DESC
String
Hydraulic type of
the edge (e.g.
Hydraulic Element,
Flowline, Shoreline).
Required
FLOWDIR
Integer
Flow direction for

the edge.
Hydro Junction
Role
Field
Type
Description
12/8/2014
Page 13 of 63
Required
HydroID
Integer
Unique identifier of the

feature in the Arc Hydro
geodatabase.
Required
HYDRAULIC_TYPE_DESC
String
Hydraulic type of the

junction (e.g. Culvert,
Bridge, Control Structure,
etc.).
Required
JUNCTION_TYPE_DESC
String
Description of the junction

(e.g. LOW POINT OF
BOUNDARY, HYDRAULIC
ELEMENT, LOW POINT OF
BASIN).
Group Junction
Role
Field
Type
Description
ICPR Node
Role
Field
Type
Description
Created
Type
String
STAGE/AREA, TIME/STAGE, STAGE/VOLUME, MANHOLE, CHANNEL, PIPE, DROP
STRUCTURE. Tool uses features of type CHANNEL.
Created
IsIncluded
Short
Integer
Indicates whether the feature should be exported to ICPR.
Hydraulic Element Point

Role
Field
Type
Description
Required
JUNCTIONID
Integer
HydroID of the associated

HydroJunction (e.g. Culvert).
Required
SUBELEMENTID
Integer
Identifier of the subelement.
Required
SUBELEMENT_TYPE
String
Type of subelement. Tool

processes the subelements of
type BARREL.
ICPR Link
Role
Field
Type
Description
Created
HydroID
Integer
Unique identifier of the feature in the Arc Hydro geodatabase.
Created
Type
String
Populated with coded values from domain dICPR_LINKTYPE: WEIR, CHANNEL, PIPE, DROP
STRUCTURE, BRIDGE.
Learn more about how Generate ICPR Node (Arc Hydro) works
This tool allows auto generating ICPR Nodes based on Seed Point and Group Node input features. The tool ignores the selection sets in
all input feature classes and processes all features. It clears all existing records in the ICPR Node feature class.
The tool generates ICPR Nodes in 2 types of location:
z
at the location of input Seed Point features of all types except WEIR, BARREL and BRIDGE.
at the location of the Group Node (STAGE/AREA).

Input/Output
Input
Output
"ICPR Seed Point" Feature Class
"Group Node" Feature Class

How the tool works

The tool copies the input Seed Point features of all types except 'WEIR", "BARREL" and "BRIDGE" into the output ICPR Node feature
class. The tool populates the field Type in the Seed Point feature class with the value read from the Type field in the corresponding
input Seed Point feature.
The tool copies the input Group Node features (optional) as STAGE/AREA ICPR Nodes.
12/8/2014
Page 14 of 63
The input Seed Point feature of type "WEIR", "BRIDGE" and "BARREL" are used instead to indicate to the program to create
WEIR/BRIDGE/PIPE and CHANNEL type ICPR links connecting the STAGE/AREA or CHANNEL type seed points at upstream and
downstream of the WEIR/BRIDGE/BARREL.
Notes
z
Only STAGE/AREA ICPR Nodes and CHANNEL type ICPR Links will be used to generate ICPR Basins. Other types of ICPR Nodes
do not have a drainage area associated with them.
By default, IsIncluded is set to 1 for all ICPR node types created by this tool.
ICPR Seed Point

Role
Field
Type
Description
Required
TYPE
String
Type of Seed Point (e.g. CHANNEL, STAGE/AREA)
Attributes table of ICPR Seed Point
Group Node
Role
Field
Type
Description
Required
TYPE
String
Type of Seed Point (e.g. CHANNEL, STAGE/AREA)
Attributes table of Group Node
ICPR Node
Role
Field
Type
Description
Created
HydroID
Integer
Created
Name
String
Name of the ICPR Node.
Created
Type
String
STAGE/AREA, TIME/STAGE, STAGE/VOLUME, MANHOLE or CHANNEL.
Created
IsIncluded
Short
Integer
Populated by default with 1. Used when exporting to ICPR.
Attributes table of ICPR Node
Learn more about how Import from ICPR (Arc Hydro) works
The purpose of the tool is to import the stage (node)/flow (link) maximum values and time series computed by ICPR into the GWIS
database. The model results are be stored in dbf files and packaged in a folder as shown below.
Input/Output
12/8/2014
Input
Page 15 of 63
Output
"Model Result Location"
"ICPR Node Max Stage (Ft)" Table
"TSTypeInfo" Table
"ICPR Link Max Flow (Cfs)" Table

"ICPR Node Hydrograph" Table
"ICPR Link Hydrograph" Table
ICPR Model Results

The Model Result Location is the path to the directory storing the dbf tables generated by ICPR that will be imported.
Result Table Naming Convention

z
ICPR model outputs - Maximum Values: Maximum elevation result for ICPR nodes and maximum flow for ICPR Links are stored
in dbf files with file name starting with model name (e.g. WillowSink), followed by description of the values in the table (e.g.
_nodemax_stage, _linkmax_flow). In the Model results folder above, WillowSink_nodemax_stage.dbf and
WillowSink_linkmax_flow.dbf stores maximum stage and flow values for node and link respectively.
ICPR model outputs - Time series Values: Time series for various events (YR100_1DAY, YR100_5DAY etc) are stored in separate
dbf files (WillowSink_nodets_YR100_1DAY.dbf, WillowSink_linkts_YR100_1DAY.dbf etc). The last part of the name (e.g.
YR100_1DAY) represents the simulation name.
Mapping between Maximum Node/Link Stage/Flow results and GWIS

The field names in the maximum stage/flow result tables are maintained in the GWIS tables. If there are additional fields created
from Model run, these fields will be automatically imported from the result table without having to configure additional fields in the
import process.
Mapping between Maximum Node Elevation result and GWIS
ICPR_NODE_RESULT (e.g. WillowSink_nodemax_stage.dbf)
- ICPR
ICPR_NODE_RESULT ICPR_NODEMAX_STAGE_FT
(GWIS)
NAME
NAME (Text)
YR100_1DAY
YR100_1DAY (Float)
YR100_5DAY
YR100_5DAY (Float)
YR500_1DAY
YR500_1DAY (Float)
YR500_5DAY
YR500_5DAY (Float)
Mapping between Maximum Link Flow result and GWIS

WillowSink_linkmax_flow.dbf (ICPR)
ICPR_LINK_RESULT ICPR_LINKMAX_FLOW_CFS (GWIS)
NAME
NAME (Text)
YR100_1DAY
YR100_1DAY (Float)
YR100_5DAY
YR100_5DAY (Float)
YR500_1DAY
YR500_1DAY (Float)
YR500_5DAY
YR500_5DAY (Float)
Mapping between Time Series Node/Link Stage/Flow results and GWIS

The mapping between the Time Series result table and GWIS loosely follows Arc Hydro Time Series storage format.
Mapping between Node Elevation Time Series result and GWIS
WillowSink_linkts_YR100_1DAY.dbf (ICPR)
ICPR_NODE_HYDROGRAPH (GWIS)
NAME
NAME (Text)
SIM
Variable (Text)
TIME
TSTime (Float)
STAGE
TSValue (Float)
Mapping between Link Elevation Time Series result and GWIS

WillowSink_nodets_YR100_1DAY.dbf (ICPR)
ICPR_LINK_HYDROGRAPH (GWIS)
12/8/2014
Page 16 of 63
NAME
NAME (Text)
FLOW
Variable (Text)
TIME
TSTime (Float)
STAGE
TSValue (Float)
Note
Shown below is the XML configuration used by the Import from ICPR tool to define the mapping between GWIS tables and dbf files
in the model result folder.
<ApFunction Name="ICPR" TagName="ICPR">
<ModelTableNames>
<TableName Name="ICPRNodeResult" EndsWith="_nodemax_stage"/>
<TableName Name="ICPRLinkResult" EndsWith="_linkmax_flow"/>
<TableName Name="ICPRNodeHydrograph" Contains="_nodets_"/>
<TableName Name="ICPRLinkHydrograph" Contains="_linkts_"/>
</ModelTableNames>
</ApFunction>
Creation of TSTypeInfo table for Flood Plain Delineation Tools

Flood plain delineation tools require that TSTypeInfo table be populated with Variables used for simulation. The tool will create a new
TSType record in TSTypeInfo table for each 'Float' type fields in NodeMax_Stage table. The tool assumes that selected simulations
apply to all output types (stage/flow/time series) and need not loop through all model result tables to find unique simulations. The
user is required to enter additional information (FeatureID, TSTypeID, Units etc.) in the TSTypeInfo table to make it an Arc Hydro
compliant Time Series and use it as input to other Arc Hydro Time Series tools. Fig 10: TSTypeInfo table populated with Simulation
names as 'Variables'.
An overview of the Green and Ampt toolset

The Green and Ampt toolset contains tools supporting Green and Ampt modeling.
Tools
Description
Accumulate Incremental
Time Series
Accumulate incremental time series steps associated to the input subwatershed features.
Compute Green and Ampt

Excess Rainfall
Compute the Green and Ampt Excess Rainfall time series for an input subwatershed feature class
using an associated Soil Landuse Precipitation polygon feature class (i.e. SLURP) and Soil and
Landuse lookup tables.
Compute Green and Ampt

Parameters
Compute the Green and Ampt parameters for an input polygon feature class using the grids
generated with the tool Create Green and Ampt Parameter Rasters for example.
Create Green and Ampt

Parameter Rasters
Create parameter rasters based on an input Soil Landuse polygon created by intersecting a soil
feature class with a landuse feature, and the associated Soil and Landuse lookup tables.
Export to ICPR Green and

Ampt Parameters
Create input files allowing running ICPR for Green and Ampt Basins. This tool works in ArcMap
only, not in ArcCatalog.
Export to ICPR Green and

Ampt Rainfall Excess
Create input files allowing running ICPR for Impervious SCS Basins. This tool works in ArcMap
only, not in ArcCatalog.
Green and Ampt toolset's tools
Accumulate Incremental TimeSeries (Arc Hydro Tools)
Summary
Accumulates incremental time series associated to input subwatershed features.
Learn more about how Accumulate Incremental TimeSeries (Arc Hydro) works
12/8/2014
Page 17 of 63
Usage
Syntax
AccumulateIncrementalTimeSeries_archydro (in_subwatershed_features, in_timeseries_table, in_variabledefinition_table,
tsvarid_source, tsvarid_target, start_time, end_time, out_timeseries_table)
Parameter
Explanation
in_timeseries_table
tsvarid_source
tsvarid_target
Data Type
Input Subwatershed feature layer with an associated incremental time

series to accumulate.
Input Time Series table containing the incremental time series to
accumulate.
Table storing the definition of Time Series variables.
Unique identifier of source incremental time series variable to
accumulate. Incremental time series have the integer field DataType set
to Incremental in the VariableDefinition table.
Unique identifier of target time series variable associated to the
accumulated time series.
Feature Layer
Table
Table
Integer
Integer
start_time
Starting date and time for the time series steps to accumulate. Required
(cannot be left blank).
Date
end_time
Starting date and time for the time series steps to accumulate. Required
(cannot be left blank).
Date
out_timeseries_table
Output Time Series table storing the accumulated time series.
Table
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Compute Green and Ampt Excess Rainfall (Arc Hydro Tools)
Summary
Computes excess rainfall using Green and Ampt method for the selected subwatersheds.
Learn more about how Compute Green and Ampt Excess Rainfall (Arc Hydro) works
Usage
Syntax
ComputeGreenAmptExcessRain_archydro (in_subwatershed_features, in_soil_landuse_precip_features, in_soil_lookup_table,
in_landuse_lookup_table, in_timeseries_table, in_variabledefinition_table, tsvarid_rainfall, tsvarid_excess_rainfall, start_time,
end_time, design_rain_constant, effective_porosity, hydraulic_conductivity, effective_saturation, out_timeseries_table, report_slurp,
output_timestep_increment, export_rai, {rai_path})
Parameter
Explanation
Data Type
Input Subwatershed polygon layer for which the excess rainfall will be Feature Layer
computed. Must contain the HydroID and Name fields.
in_soil_landuse_precip_features
Input SLURP layer defined by intersecting the subwatershed feature

class with a soil and land use feature class. Must contain key fields
relating to the Soil and Landuse lookup tables. Default fields are
MUKEY for soil code field and FLUCCSCODE for landuse code field.
Must contain KeyFrom and PctFrom fields storing respectively the
HydroID and percent of the area of the associated subwatershed
feature. The tool will compute the Green and Ampt parameters for
the SLURP features and store their values in this feature class.
Feature Layer
in_soil_lookup_table
Soil Lookup table for the input SLURP layer. Must contain a soil code
key field (default: MUKEY) that relates to the soil code field in the
SLURP layer.
Table
in_landuse_lookup_table
Table
12/8/2014
Page 18 of 63
Landuse Lookup table for the input SLURP layer. Must contain a
landuse code key field (default: FLUCCSCODE) that relates to the
landuse code field in the SLURP layer.
in_timeseries_table
Time Series Table storing the rainfall data for the input Subwatershed
layer.
Table
Table storing the definition of temporal variables.
Table
tsvarid_rainfall
Unique identifier of the input rainfall time series variable used to

compute the excess rainfall. Must be a cumulative or incremental
type, i.e. must have the integer field DataType set to 2 (Cumulative)
or 3 (Incremental) in the TSTypeInfo table.
Integer
The Starting Time and Ending Time must be specified only for
incremental time series with the Design Rainfall Constant set to 1. In
all other cases these parameters are ignored and may be left blank.
tsvarid_excess_rainfall
Time Series variable defining the Excess Rainfall Time Series.
Integer
start_time
Starting date and time for the input time series. Required and used
only for incremental time series with the Design Rain Constant set to
1. Will not be used and may be left blank in all other cases.
Date
end_time
design_rain_constant
effective_porosity
Ending date and time for the input time series. Required and used
only for incremental time series with the Design Rain Constant set to
1. Will not be used and may be left blank in all other cases.
Design rain value used to scale the excess rainfall. Multiplier that can
be applied to an existing time series to get the design conditions
based on a unit hydrograph. If you specify a value different from 1,
then your must have an input time series defined for FeatureID=0. If
you set this parameter to 1, then you must have a time series
defined for each input subwatershed (with FeatureID = HydroID of
the subwatershed in the time series table).
Effective porosity coefficient used to compute the excess rainfall. The
porosity of the soils will be multiplied by this coefficient to calculate
the porosity of the SLURP polygons.
Date
Double
Double
hydraulic_conductivity
Hydraulic conductivity coefficient used to compute the excess rainfall.

The saturated hydraulic conductivity of the soils (KSat) will be
multiplied by this coefficient to calculate the saturated hydraulic
conductivity of the SLURP polygons.
Double
effective_saturation
Effective saturation parameter used to compute the excess rainfall.

Ranges from 0 (dry) to 1 (saturated).
Double
Output Time Series table where the excess rainfall time series will be
stored.
Table
report_slurp
Indicate whether to generate the excess rainfall associated to the

SLURP in addition to the excess rainfall associated to the
Subwatershed.
Boolean
output_timestep_increment
export_rai
rai_path
(Optional)
Indicate the increment between the time series that should be

reported in the excess rainfall time series. A value of 1 means that
the same time steps will be used. A value of 2 that every other time
steps will be used, etc.
Indicate whether to export the excess rainfall time series as RAI files.
Location on the disk where the RAI files storing the excess rainfall
should be exported.
Integer
Boolean
Directory
Environments
Related Topics
Compute Green and Ampt Parameters
Create Green and Ampt Parameter Rasters
Export to ICPR Green and Ampt Rainfall Excess
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 19 of 63
Compute Green and Ampt Parameters (Arc Hydro Tools)

Summary
Computes the following Green and Ampt Parameters for each input subwatershed feature by retrieving their values from the
corresponding input grids:
z
Percent of Directly Connected Impervious Area (DCIA)
Percent impervious (PctImp)
Hydraulic conductivity (KSat)
Soil storage (Sst)
Soil suction (Ssu)
Porosity (Porosity)
Learn more about how Compute Green and Ampt Parameters (Arc Hydro) works
Usage
Syntax
ComputeGreenAmptParameters_archydro (in_subwatershed_features, {in_dcia_raster}, {in_pctimp_raster}, {in_ksat_raster},
{in_sst_raster}, {in_ssu_raster}, {in_porosity_raster})
Parameter
Explanation
in_dcia_raster
(Optional)
in_pctimp_raster
(Optional)
in_ksat_raster
(Optional)
in_sst_raster
(Optional)
in_ssu_raster
(Optional)
in_porosity_raster
(Optional)
Data Type
Input Subwatershed layer for which the Green and Ampt parameters will
be computed.
DCIA grid. Percent of the area considered as directly connected
impervious area (i.e. no infiltration).
Grid storing the percentage of impervious coverage.
Feature Layer
Raster Layer
Raster Layer
Grid storing the hydraulic conductivity.
Raster Layer
Grid storing the soil storage.
Raster Layer
Grid storing the soil suction.
Raster Layer
Grid storing the porosity (i.e. moisture content at saturation).
Raster Layer
Environments
Related Topics
Compute Green and Ampt Excess Rainfall
GUID-D3A6D8B9-857B-49F0-AB5B-B0143820B30C
ArcInfo: Yes
Create Green and Ampt Parameter Rasters (Arc Hydro Tools)
Summary
Creates Green and Ampt parameter rasters based on an input Soil Landuse Polygon feature class and the corresponding Soil and
Landuse Lookup tables.
Learn more about how Create Green and Ampt Parameter Rasters (Arc Hydro) works
Usage
12/8/2014
Page 20 of 63
Syntax
CreateGreenAmptParamRasters_archydro (in_soil_landuse_features, in_soil_lookup_table, in_landuse_lookup_table,
{out_dcia_raster}, {out_pctimp_raster}, {out_ksat_raster}, {out_sst_raster}, {out_ssu_raster}, {out_porosity_raster},
{in_dem_raster})
Parameter
Explanation
Data Type
in_soil_landuse_features
Input Soil Landuse polygon layer defined by intersecting a soil and a land
use feature classes. Must contain key fields relating to the Soil and
Landuse lookup tables. Default fields are MUKEY for soil code field and
FLUCCSCODE for landuse code field.
Soil Lookup table for the input Soil Landuse Polygon layer. Must contain a Table
soil code key field (default: MUKEY) that relates to the soil code field in
the Soil Landuse Polygon layer.
Landuse Lookup table for the input Soil Landuse Polygon layer. Must
contain a landuse code key field (default: FLUCCSCODE) that relates to
the landuse code field in the Soil Landuse Polygon layer.
out_dcia_raster
(Optional)
out_pctimp_raster
(Optional)
out_ksat_raster
(Optional)
out_sst_raster
(Optional)
out_ssu_raster
(Optional)
out_porosity_raster
(Optional)
in_dem_raster
(Optional)
DCIA grid storing the percentage of Directly Connected Impervious Area.
Feature Layer
Table
Raster Layer
Percent Impervious Grid.
Raster Layer
Hydraulic Conductivity Grid
Raster Layer
Raster Layer
Soil Storage Grid

Soil Suction Grid
Raster Layer
Porosity Grid
Raster Layer
Grid used to setup the cell size for the output grids.
Raster Layer
Environments
Related Topics
GUID-D3A6D8B9-857B-49F0-AB5B-B0143820B30C
ArcInfo: Yes
Export to ICPR Green and Ampt Parameters (Arc Hydro Tools)
Summary
Creates input XML file to run ICPR for Green and Ampt basins.
Learn more about how Export to ICPR Green and Ampt Parameters (Arc Hydro) works
Usage
Syntax
ExportToICPRGAParams_archydro (in_subwatershed_features, in_soil_landuse_precip_features, in_soil_lookup_table,
in_landuse_lookup_table, rai_path, icprexport_xmlpath)
Parameter
Explanation
Data Type
Subwatershed features to export. Must contain the fields HydroID

and Name.
Feature Layer
in_soil_landuse_precip_features
Soil Landuse Precipitation Polygon (SLURP) features to export. Must

contain the fields HydroID, KeyFrom (HydroID of the associated
Subwatershed feature), MUKEY (default SoilCode field), FLUCCSCODE
(default LandUseCode field).
Feature Layer
Table
12/8/2014
Page 21 of 63
Soil Lookup table. Must contain the fields MUKEY (set as default
SoilCode field in the ahd configuration file), KSat, Sst (SoilStorage),
Ssu (SoilSuction), Porosity.
Landuse Lookup Table. Must contain the fields FLUCCSCODE (set as

default LandUseCode field in the ahd configuration file), PctImp,
DCIA.
Table
rai_path
Path to input RAI files storing rainfall previously generated. These

files may be created with the Arc Hydro function Export SCurve to
RAI located in the menu Attribute Tools > Time Series Processing.
File Location
icprexport_xmlpath
Path and name for the exported ICPR XML file. RAI files will be copy
into the RAI subdirectory in the same location as the XML.
File Location
Environments
Related Topics
Export to ICPR Green and Ampt Rainfall Excess
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Export to ICPR Green and Ampt Rainfall Excess (Arc Hydro Tools)
Summary
Creates input XML file to run ICPR with the Impervious SCS option.
Learn more about how Export to ICPR Green and Ampt Rainfall Excess (Arc Hydro) works
Usage
Syntax
ExportToICPRGARainfallExcess_archydro (in_subwatershed_features, rai_path, icprexport_xmlpath)
Parameter
Explanation
Data Type
Subwatershed features to export. Must contain the fields HydroID and

Name.
Feature Layer
rai_path
Path to input RAI files storing excess rainfall previously generated.

These files may be created with the tool Compute Green and Ampt
Excess Rainfall.
File Location
icprexport_xmlpath
Path and name for the exported ICPR XML file.
File Location
Environments
Related Topics
Export to ICPR Green and Ampt Parameters
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Compute Green and Ampt Excess Rainfall (Arc Hydro) works
12/8/2014
Page 22 of 63
This tool allows computing the Green and Ampt Excess Rainfall time series for the selected input subwatershed features using an
associated Soil Landuse Precipitation polygon feature class (i.e. SLURP) and Soil and Landuse lookup tables. The Green and Ampt
infiltration model is a physical model that relates the rate of infiltration to measurable soil and landuse properties such as the porosity,
hydraulic conductivity and the moisture content of a particular soil.
The tool creates and populates the output Target TSTable table with the excess rainfall time series associated to the input
subwatershed features.
If Aggregate Slurp is checked, it also creates an excess rainfall time series for the input SLURP features.
If Export to RAI is checked, the tool exports the excess rainfall time series into RAI files that may be used as input by the tool Export to
ICPR Green and Ampt Rainfall Excess.
Note
No unit conversion is done in the calculation. All the inputs must be in the same unit system (English or Metric) as the GIS data.
Input/Output
Input
Output
"Subwatershed" Feature Class
"Target Time Series" Table
"Soil Landuse Polygon (SLURP)" Feature Class
RAI files (optional)
"Soil Lookup" Table

"Landuse Lookup" Table
"Time Series" Table
"Variable Definition" Table
Spatial Parameters
Select the input Subwatershed and SLURP feature classes, as well as the associated Soil and Landuse Lookup tables. The tool will
compute the Green and Ampt parameters for each SLURP polygon and store them in the SLURP feature class.
Subwatershed
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the subwatershed in the Arc Hydro database.
Required
Name
String
Name of the watershed. Used to retrieve associated RAI file.
Attributes table of Subwatershed
Soil Landuse Precipitation Polygon (SLURP)

Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the SLURP feature in the Arc Hydro database.
Required
KeyFrom
Integer
HydroID of the associated Subwatershed feature. Used to link to the subwatershed

and precipitation data.
Required
PctFrom
Double
Percentage of the area of the corresponding subwatershed.
Required
MUKEY
String
Soil code key field used to relate to the Soil Lookup table. The name of this field may
be modified by editing the ahd configuration file. If you do change the name of this
field, you will need to update the control XML file as well.
Required
FLUCCSCODE
String
Land use code key field. Used to relate to the SLURP feature class. The name of this
field may be modified by editing the ahd configuration file. If you do change the
name of this field, you will need to update the control XML file as well.
Created
DCIA
Double
Percent of directly connected impervious area.
Created
PctImp
Double
Percent Impervious
Created
KSat
Double
Saturated hydraulic conductivity in inches/hour or centimeters/hour.
Created
Sst
Double
Soil storage in inches or centimeters.
Created
Ssu
Double
Soil suction in inches or centimeters.
Created
Porosity
Double
Porosity. Unitless.
Attributes table of Soil Landuse Precipitation Polygon
Soil Lookup Table

Role
Field
Type
Description
Required
MUKEY
String
Soil code key field used to relate to the SLURP feature class. The name of this field may be
modified by editing the ahd configuration file. If you do change the name of this field, you
will need to update the control XML file as well.
Required
KSat
Double
12/8/2014
Page 23 of 63
Required
Sst
Double
Required
Ssu
Double
Required
Porosity
Double
Porosity. Unitless.
Attributes table of Soil Lookup Table
Landuse Lookup Table

Role
Field
Type
Description
Required
FLUCCSCODE
String
field may be modified by editing the ahd configuration file. If you do change the name
of this field, you will need to update the control XML file as well.
Required
PctImp
Double
Percent impervious.
Required
DCIA
Double
Attributes table of Landuse Lookup Table
Time Series Parameters

z
Select the input Time Series table and Variable Definition table associated to the subwatershed.
Enter the time series variable identifier for the input rainfall. It must be a cumulative (Datatype=Cumulative in
VariableDefinition) or incremental (DataType=Incremental in VariableDefinition) time series.
Specify the output excess rainfall variable identifier. It should also be defined in the VariableDefinition table.
Specify the start date/time and end date/time for the time series. These parameters are required and used only for an
incremental time series with the Design Rain Constant set to 1. They will be ignored and may be left blank in all other cases.
The Design Rain Constant is a multiplier that can be applied to an existing time series to get the design conditions based on a
unit hydrograph. If it is set to 1, then you must have input time series defined for each input subwatershed feature (with
FeatureID = HydroID of the subwatershed in the Time Series table). If it is set to value different from 1, then you must have
one time series defined for FeatureID=0 that will be used for all the subwatersheds.
Time Series Table

Role
Field
Type
Description
Required
FeatureID
Integer
HydroID of the associated feature.
Required
VarID
Integer
Type of time series stored.
Required
TSTime
DateTime
Date and time of the corresponding time step.
Required
TSValue
Double
Value at the corresponding time step.
Created
TSDateTime_DBL
Double
Date and time of the corresponding time step stored as double to improve
performance while processing.
Attributes table of Time Series Table
Variable Definition Table

Role
Field
Type
Description
Required
VarID
Integer
Required
TSTime
Integer
Time Interval.
Required
TSUnits
String
Unit associated to time interval.
Required
DataType
String
Type of time series data (e.g. incremental, cumulative, etc.)
Attributes table of TSTypeInfo Table
Green and Ampt Coefficients

Specify the 3 Green and Ampt coefficients. Defaults are read from the active configuration file and will be updated based on the
newly specified values:
z
Effective Porosity: the porosity of the soils will be multiplied by this coefficient to calculate the porosity of the SLURP polygons.
Hydraulic Conductivity: the saturated hydraulic conductivity of the soils (KSat) will be multiplied by this coefficient to calculate
the saturated hydraulic conductivity of the SLURP polygons.
Effective Saturation: ratio of the available moisture to the maximum possible available moisture content. Used in the Green and
Ampt computation.
Output Parameters
Specify the name of the output Target Time Series table. It is recommended to store the results in a separate time series table to
improve performance and ease maintenance.
Target Time Series Table
Role
Field
Type
Description
12/8/2014
Page 24 of 63
Created
FeatureID
Integer
Created
VarID
Integer
Created
TSTime
DateTime
Created
TSValue
Double
Attributes table of Target Time Series Table
When "Create Time Series for SLURP" is checked, the tool creates an excess rainfall time series for the SLURP features in addition to
the time series created for the subwatershed features.
The Output Timestep increment parameter allows specifying the increments for the output time series. A value of 1 means that the
same time steps will be used. A value of 2 that every other time steps will be used, etc.
z
Check "Export to RAI" and specify the directory where the resulting RAI files should be exported if needed. These files store the
excess rainfall and may be used as input by the Export to ICPR Green and Ampt Rainfall Excess tool. Each file is named after its
associated subwatershed. The path will be stored in the parameter ApFunction(GreenAmptCalculation)/RAIDirectory in the active
ahd configuration and in the XML configuration associated with the map document in ArcMap.
Click OK.
Notes
z
The primary function of this tool is to calculate excess rainfall for each subwatershed defined in the subwatershed feature class
using Green & Ampt loss method (Chow, V.T., Maidment, D.R., Mays L.W. (1988). Applied Hydrology, McGraw-Hill, New York,
NY., 140-14incrExcessRainIndex).
The program implements the flowchart in Figure 5.4.1 with the exception of additional accounting for Soil Storage, DCIA and
Impervious.
Rainfall falling over DCIA (Directly Connected to outlet) is runoff. No G&A computation needed. So the excess rainfall for the
DCIA portion = DCIA * Unadjusted Original Cumulative Rainfall.
Excess rainfall for the pervious area is computed for a portion 1-DCIA (everything except DCIA). So the excess rainfall for the 1DCIA portion = (1-DCIA) * excess rainfall using G&A computation.
Excess rainfall for the impervious area (PctImp-DCIA) is accounted by incrementing the rainfall for pervious area by a factor (1 DCIA) / (1-PCTIMP), which translates to 1 when DCIA = PctImp.
If the cumulative infiltration at any time 't' is greater than the soil storage, then everything from that point onwards is excess.
No need to compute G&A infiltration. So excess rainfall for non DCIA portion at time t+dt = Cumulative Excess Rainfall at time t
+ intensity of rain between t and t+dt * delta T.
For polygons with storage = 0, no need to compute excess rainfall. Same as # 6.
No unit conversion is done in the calculation. All the inputs must be in the same unit system.
Learn more about how Compute Green and Ampt Parameters (Arc Hydro) works
The Compute Green and Ampt Parameters tool allows computing the Green and Ampt parameters for an input Subwatershed polygon
feature class using the grids generated with the tool Create Green and Ampt Parameter Raster.
You need to select as Input Subwatershed the polygon feature class for which you want to populate the Green and Ampt parameters.
This feature class must contain the HydroID field and it must be populated with unique values.
The tool computes the average value of each requested parameter by performing a zonal statistics operation on each grid using
HydroID to define the zones in the input Drainage Area feature class. The Green Ampt fields are created if they do not already exist and
populated for each polygon feature. At least one input grid must be specified.
Input/Output
Input
Output
Green and Ampt fields populated in "Subwatershed"
"DCIA Grid"
"Percent Impervious Grid"
"Hydraulic Conductivity"Grid"
"Soil Storage Grid"
"Soil Suction Grid"
"Porosity Grid"
Subwatershed
12/8/2014
Page 25 of 63
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the SLURP feature in the ArcHydro database.
Created
DCIA
Double
Created
PctImp
Double
Percent Impervious
Created
KSat
Double
Created
Sst
Double
Created
Ssu
Double
Created
Porosity
Double
Porosity. Unitless.
Learn more about how Create Green and Ampt Parameter Rasters (Arc Hydro) works
This tool allows creating parameter rasters based on an input Soil Landuse polygon feature class. This feature class may be created by
intersecting a soil feature class with a landuse feature class using the Intersect Areas geoprocessing tool for example. The tools will
look up the Green and Ampt parameters for the soils and landuses in the specified Soil and Landuse lookup tables. The optional input
DEM is used to set the cell size for the output rasters. If it not set, the cell size from the default raster environment will be used.
Input/Output
Input
Output
"Soil Landuse Polygon" Feature Class
"DCIA Grid"
"Soil Lookup" Table
"Percent Impervious Grid"
"Hydraulic Conductivity Grid"
"DEM" Grid
"Soil Storage Grid"

"Soil Suction Grid"
"Porosity Grid"
The Input Soil Landuse Polygon must contain 2 fields that will be used to join with respectively a Landuse and a Soil lookup tables. The
names of these fields are read from the configuration xml/ahd. The default names are currently MUKEY for the SoilCode field and
FLUCCSCODE for the LanduseCode field and can be modified in the configuration xml/ahd.
Soil Landuse Polygon
Role
Field
Type
Required MUKEY
Description
String Soil code key field used to relate to the Soil Lookup table. The name of this field may be
modified by editing the ahd configuration file.
Required FLUCCSCODE String Land use code key field. Used to relate to the SLURP feature class. The name of this field
may be modified by editing the ahd configuration file.
Attributes table of Soil Landuse Polygon
The Input Soil Lookup table must contain the SoilCode field (e.g. MUKEY) as well as the Ksat, Porosity, SSt and SSu fields.
Soil Lookup Table
Role
Field
Required MUKEY
Type
Description
String
modified by editing the ahd configuration file. If you do change the name of this field, you will
need to update the control XML file as well.
Required KSat
Double Saturated hydraulic conductivity in inches/hour or centimeters/hour.
Required Sst
Double Soil storage in inches or centimeters.
Required Ssu
Double Soil suction in inches or centimeters.
Required Porosity Double Porosity. Unitless.

The Landuse Lookup table must contain the LanduseCode field (e.g. FLUCCSCODE) as well as the DCIA and PctImp (Percent
Impervious) fields.
Role
Field
Type
Description
12/8/2014
Required FLUCCSCODE String
Page 26 of 63
Land use code key field. Used to relate to the SLURP feature class. The name of this field
may be modified by editing the ahd configuration file. If you do change the name of this
field, you will need to update the control XML file as well.
Required PctImp
Double Percent impervious.
Required DCIA
Double Percent of directly connected impervious area.
The tool will join the attributes table of the input Soil Landuse Polygon feature class with the LandUse and Soil lookup tables and
generate one parameter raster for each requested output grid parameter. The outputs are optional and will not be generated if left
blank. At least one output grid should be specified.
Learn more about how Export to ICPR Green and Ampt Parameters (Arc Hydro) works
Note: This tool works in ArcMap only. It does not work in ArcCatalog.
This tool allows creating the ICPR XML file to run ICPR with the Green and Ampt option. The Subwatershed features must have the
Green and Ampt parameters fields populated. The RAI files. The RAI files used in the export stores information on rainfall, not on
excess rainfall. The losses computation will be performed in ICPR.
The RAI files may be generated by using the Arc Hydro function Export SCurve to RAI located in the standard Arc Hydro Tools toolbar in
the Attribute Tools > Time Series Processing > Export SCurve to RAI. This function writes the location of the exported RAI file to the
parameter ApFunction(GreenAmptCalculation)>RAIDirectorySCurve.
Warning
z
The linear unit for the Subwatershed and SLURP feature classes must feet, so that their areas are expressed in square feet. If
you are using another linear unit, you need either to convert to feet or modify the unit conversion factor in the transformation
file used by the export so that it matches your unit. This file defaults to GWIS2ICPRXMLGAParams.xsl and is located in the
ArcHydro/bin directory.
The scaling coefficients specified in the input XML file are retrieved
How to use the tool

Input/Output
Input
Output
ICPR XML - Green and Ampt Parameters
"Soil Landuse Precipitation Polygon" Feature

Class
RAI subdirectory with RAI storing rainfall files in the same location as the
output XML
"Soil Lookup" Table

RAI Path - Green and Ampt Parameters
Select the input Subwatershed and SLURP feature classes, as well as the associated Soil and Landuse Lookup tables.
Subwatershed
Role
Field
Type
Description
Required
HydroID
Integer
Required
Name
String
Name of the watershed. Used to retrieve associated RAI file.
Soil Landuse Precipitation Polygon (SLURP)

Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the SLURP feature in the Arc Hydro database.
Required
KeyFrom
Integer
HydroID of the associated Subwatershed feature. Used to link to the subwatershed

and precipitation data.
Required
MUKEY
String
Soil code key field used to relate to the Soil Lookup table. The name of this field may
be modified by editing the configuration file. If you do change the name of this field,
you will need to update the control XML file as well.
12/8/2014
Required
FLUCCSCODE
String
Page 27 of 63
field may be modified by editing the configuration file. If you do change the name of
this field, you will need to update the control XML file as well.
Attributes table of Soil Landuse Precipitation Polygon
Soil Lookup Table

Role
Field
Type
Description
Required
MUKEY
String
modified by editing the configuration file. If you do change the name of this field, you will
need to update the control XML file as well.
Required
KSat
Double
Saturated hydraulic conductivity in inches/hour.
Required
Sst
Double
Soil storage in inches.
Required
Ssu
Double
Soil suction in inches.
Required
Porosity
Double
Porosity. Unitless.

Role
Field
Type
Description
Required
FLUCCSCODE
String
and use code key field. Used to relate to the SLURP feature class. The name of this
field may be modified by editing the configuration file. If you do change the name of
this field, you will need to update the control XML file as well.
Required
PctImp
Double
Percent impervious.
Required
DCIA
Double
Specify the location of the RAI files storing the rainfall information. This location defaults to the path set in the XML in the node
ApFunction(GreenAmptCalculation)>RAIDirectorySCurve.
Learn more about how Accumulate Incremental TimeSeries (Arc Hydro) works
This tool allows accumulating the time series steps from the input incremental time series associated to each input subwatershed
feature.
Input/Output
Input
Output
"Target Time Series" Table
"Time Series" Table

"Variable Definition" Table
"Source Time Series Variable ID" for the incremental time series
"Target Time Series Variable ID" for the accumulated time series
"Starting date/time for accumulating"
"Ending date/time for accumulating"
For each feature in the input Subwatershed feature class, the function retrieves the specified associated incremental time series steps
for the requested interval. It accumulates the time steps and stores them as a new time series of the specified output type in the target
time series table.
Note
The function is adding a new field in the input TimeSeries table that stores the date as double to improve the speed of the
computation.
Subwatershed
Role
Field
Type
Description
Required
HydroID
Integer
Time Series Table

Role
Field
Type
Description
12/8/2014
Page 28 of 63
Required
FeatureID
Integer
Required
VarID
Integer
Required
TSTime
DateTime
Required
TSValue
Double
Created
TSDateTime_DBL
Double
Variable DefinitionTable
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the time series variable in the geodatabase.
Required
TimeStep
Integer
Time Interval.
Required
TimeUnits
String
Units for time intervals.
Required
DataType
String
Attributes table of Variable Definition Table
Target Time Series Table

Role
Field
Type
Description
Created
FeatureID
Integer
Created
VarID
Integer
Created
TSTime
DateTime
Created
TSValue
Double
Attributes table of Target Time Series Table
Learn more about how Export to ICPR Green and Ampt Rainfall Excess (Arc Hydro) works
Note: This tool works in ArcMap only. It does not work in ArcCatalog.
ICPR, standing for Interconnected Channel and Pond Routing Model, is a commercial stormwater modeling product developed by
Streamline Technologies, Inc. The Export to ICPR Green and Ampt Rainfall Excess tool allows creating the ICPR XML file required to run
ICPR with the Impervious SCS option. In addition to the XML file, this option will also take as input RAI files storing excess rainfall
accounting for losses. These RAI files may be generated by the tool Create Green and Ampt Excess Rainfall.
The export process exports the GIS data for the subwatersheds of interest into an ICPR XML structure and copies associated RAI files
storing excess rainfall previously generated into the RAI subdirectory in the same location as the XML.
Since the excess rainfall is going to be used as input to perform ICPR modeling, ICPR does NOT need to perform loss calculations. This
will be accomplished by "tricking" ICPR by defining that each subwatershed has 100% DCIA. This also means that it is not necessary to
export records for each SLURP, but just for subwatershed.
How to use the tool

Input/Output
Input
Output
ICPR XML - Green and Ampt Excess Rain
RAI Path - Green and Ampt Excess

Rain
RAI subdirectory with RAI files storing excess rainfall in the same location as the
output XML
"TSType Info" Table

1.
Select the input Subwatershed feature class. This layer must contain the field HydroID and Name.
2.
Specify the path to the previously generated RAI files storing excess rainfall. This path defaults to the value of the
parameter ApFunction(GreenAmptCalculation)>RAIDirectory in the active configuration that is updated when running the
tool Create Green and Ampt Excess Rainfall.
3.
Enter the location and name of the output ICPR XML and click OK.
12/8/2014
Page 29 of 63
The tool exports the GIS data into the XML structure and copy the RAI files into the same location as the XML through the following
steps:
z
It sets the parameter RAIDirectory for the ApFunction(GreenAmptCalculation) in the XML document in memory in ArcMap to the
RAI path.
It sets the parameter XMLTargetDirectory to the directory where the XML will be stored.
If the specified RAI path exists, it creates the subdirectory \RAI under the location where the XML will be stored and exports the
rai files into that folder.
It retrieves from the active configuration the name of the XML control file that will be used to generate the XML. The control file
is defined with the parameter ApFunction(GreenAmptCalculation)>ICPRExportControlGAExcess. This file must exist in the
ArcHydro/bin directory. It defaults to ICPRExportControlGAExcess.xml.
It retrieves the name of the transformation style sheet from ApFunction(GreenAmptCalculation)>GWIS2ICPRXMLGAExcess. This
file must exist in the ArcHydro/bin directory. It defaults to GWIS2ICPRXMLGAExcess.xml.
It generates an intermediate xml, whose name is hardcoded to GIS2ICPRTmpFileGAExcess.xml.
It creates the ICPR XML file and stores it in the target location.
An overview of the Map to Map toolset

The Map to Map toolset contains various tools used to generate a flood map from a rainfall map.
Tools
Description
Export to DSS
Export time series data in Arc Hydro format to DSS.
Flood from Stream WSE
Geoprocessing model creating flood plain based on water elevation raster.
GeoRAS to Flood
Geoprocessing model generating FloodDepth grid, FloodExtent grid and FloodExtent polygon
feature class based on HEC-GeoRAS results geodatabase. This geodatabase may be created using
the model HMS to GeoRAS.
HMS to GeoRAS
Run HEC-HMS project, update HEC-RAS flows, run HEC-RAS project and import the resulting data
into a GeoRAS results geodatabase.
Import from DSS
Import time series from DSS file into an Arc Hydro time series table.
Run HMS
Run HEC-HMS.
Run RAS
Run HEC-RAS.
SDF to XML
Convert a SDF file into XML.
Stream WSE from Point

WSE Measurements
Geoprocessing model creating water elevation raster (WSE) along a stream.
Update RAS Flow
Update RAS Flow.
Map to Map toolset's tools
Export to DSS (Arc Hydro Tools)
Summary
The Export to DSS tool allows exporting time series data stored in an Arc Hydro geodatabase into DSS.
Learn more about how Export to DSS (Arc Hydro) works
Usage
Syntax
ExportToDSS_archydro (in_timeseries_features, in_timeseries_table, in_variabledefinition_table, tstype_id, start_time, end_time,
dssfile_for_export, {gagefile_yes})
Parameter
in_timeseries_features
Explanation
Input Feature Class with associated time series data to export to DSS.
Must contain the Name field.
Data Type
Feature Layer
12/8/2014
Page 30 of 63
in_timeseries_table
Input Time Series Table storing the time series associated to the
specified input TS Layer.
Table
Input Variable Definition Table storing the description of the time series
variables. The variable name and unit must correspond to one of the
variables defined in the configuration file.
Table
tstype_id
ID defining the type of the time series to export.
Integer
start_time
end_time
dssfile_for_export
gagefile_yes
(Optional)
Starting date and time for the time series data to export.
Ending date and time for the time series data to export.
Path and name of the output DSS resulting from the export.
Indicates whether to generate a Gage File.
Date Time
Date Time
File Location
Boolean
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Flood from Stream WSE (Arc Hydro Tools)
Summary
Generates the floodplain depth and floodplain extent based on the water surface elevations along the stream.
Usage
Syntax
FloodfromStreamWSE_archydro (Target_Raster_Location_Workspace, Target_Vector_Location_Workspace, Target_Feature_Dataset,
WSEAlongStream, {Stream}, DEM, Watershed, FloodPoly, FloodDepth)
Parameter
Explanation
Data Type
Target_Raster_Location_Workspace
Target raster location (Directory).
Workspace
Target_Vector_Location_Workspace
Target vector location (Geodatabase).
Workspace
Target_Feature_Dataset
Target feature dataset name.
String
WSEAlongStream
Water Surface Elevation raster defining water elevations along the

stream.
Composite
Geodataset
Stream
Input stream feature layer.
Feature Layer
DEM
Input DEM raster.
DEM
Watershed
Composite
Input Watershed feature layer. Optional input. If specified, the
Geodataset
resulting FloodPoly features and FloodDepth rasters will be
constrained within watersheds (i.e. a floodplain polygon cannot croo
watershed boundaries).
(Optional)
FloodPoly
FloodDepth
Output Flood Polygon feature class defining the areas where the
water surface elevations are greater than the ground elevations,
i.e. areas that would be flooded.
Output FloodDepth raster defining the depths within the floodplain
polygons, i.e. the difference between the water surface elevations
and the ground elevations.
Feature Class
Raster Dataset
Environments
12/8/2014
Page 31 of 63
ArcInfo: Yes
GeoRAS to Flood (Arc Hydro Tools)
Summary
Model generating FloodExtent polygon feature class as well as floodgrid and depthgrid rasters based on input HEC-GeoRAS results
geodatabase and the user selected surface water elevation type.
Usage
Syntax
GeoRAStoFlood_archydro (Input_M2MRASResults_Geodatabase, Input_DEM, Input_Flood_Elevation_Field)
Parameter
Explanation
Input_M2MRASResults_Geodatabase
Input_DEM
Input_Flood_Elevation_Field
Input HEC-GeoRAS results geodatabase.

Input DEM raster.
Alias name of field storing flood elevation results in the XSCutlines
feature class stored in the input HEC-GeoRAS result geodatabase.
Data Type
Workspace
Composite
Geodataset
String
Environments
ArcView: Requires 3D Analyst
ArcEditor: Requires 3D Analyst
ArcInfo: Yes
HMS to GeoRAS (Arc Hydro Tools)
Summary
Model generating HEC-GeoRAS results geodatabase based on input HMS files
Usage
Syntax
HMStoGeoRAS_archydro (Input_HMS_Project_File___hms_, Start_Time__mm_dd_yyyy_00_00_00_,
End_Time__mm_dd_yyyy_00_00_00_, Time_Interval, Input_RAS_Project_File___prj_, Input_Cross_Section_Features,
Input_GeoRAS2GXDE_XSLT_File, Output_Directory)
Parameter
Explanation
Input_HMS_Project_File___hms_
Input HEC-HMS project file (.hms file).
Start_Time__mm_dd_yyyy_00_00_00_
Data Type
File
Start time for HMS run.
Date
End_Time__mm_dd_yyyy_00_00_00_
End time for HMS run.
Date
Time_Interval
Input time interval for HMS run.
Input_RAS_Project_File___prj_
Input_Cross_Section_Features
Input_GeoRAS2GXDE_XSLT_File
Output_Directory
Input HEC-RAS project file (.prj file).

Input Cross Section feature layer.
Input XSLT file used to parse the XML file.
Output directory where the HEC-GeoRAS result geodatabase will
be created.
Long
File
Feature Layer
File
Folder
Environments
12/8/2014
Page 32 of 63
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Import from DSS (Arc Hydro Tools)
Summary
This tool imports time series data from DSS into a Time Series table in the output geodatabase.
Learn more about how Import from DSS (Arc Hydro) works.
Usage
Syntax
ImportFromDSS_archydro (in_timeseries_features, in_variabledefinition_table, tstype_id, dssfile_for_import, out_timeseries_table)
Parameter
Explanation
in_timeseries_features
Data Type
Input Feature Class with associated time series data to export to DSS.
Input Variable Definition Table
Feature Layer
Table
tstype_id
ID defining the type of the time series to export.
Integer
dssfile_for_import
DSS File for Import
File Location
Output Time Series Table
Table
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Run HMS (Arc Hydro Tools)
Summary
The Run HMS tool allows running an existing HEC-HMS project using the run parameters specified by the user. HEC-HMS must be
installed on the computer. Refer to the US Army Corps of Engineers web page for more information on how to install HEC-HMS ( ).
Learn more about how Run HMS (Arc Hydro) works
Usage
Syntax
RunHMS_archydro (input_hmsfile, start_time, end_time, time_interval, hms_run_name)
Parameter
input_hmsfile
Explanation
Input HMS File. Browse to the HMS project file (.hms) (Location set with
HMS Project Setup function). All other required files (.met, .gage and
basin) must be available at the same location and have the same file
name as the HMS project but with different extensions. The name of the
dss file can be different as long as it is correctly specified in the .gage file
for the project.
start_time
Data Type
File Location
Date
12/8/2014
Page 33 of 63
Start Time. This is a required argument for creating the control file for
the HMS run. This value is used to populate the Start Data and Start
Time in the control file by extracting Date and Time separately from this
input. The earliest Start Time among all gages within the .gage file
located at the same location as the .hms file is used as default value.
end_time
End Time. Used to populate End Data and End Time in the control file by
extracting Date and Time separately from this input. The latest End Time
among all gages within the .gage file located at the same location as
the .hms file is used as default value.
Date
time_interval
Time Interval. Used to populate Time Interval in the control file. Default
value is read from the .gage file found at the same location as the .hms
file.
Integer
hms_run_name
HMS Run Name
Text
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Run RAS (Arc Hydro Tools)
Summary
Runs an existing HEC-GeoRAS project. HEC-RAS must be installed on the computer. Refer to the US Army Corps of Engineers web
page for more information on how to install HEC-RAS (http://www.hec.usace.army.mil/software/hec-ras/).
Learn more about how Run RAS (Arc Hydro) works
Usage
Syntax
RunRAS_archydro (input_rasfile)
Parameter
input_rasfile
Input
Explanation
Data Type
Input RAS File. User must have edited the RAS file created by HECGeoRAS to establish the relationship between HMS elements and Cross
Sections used by RAS. Boundary condition and default flow file (.f0 file)
and other required RAS inputs are expected to be populated for the RAS
project.
File Location
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
SDF to XML (Arc Hydro Tools)
Summary
The SDF to XML tool allows exporting a SDF file generated by HEC-RAS into an XML file.
This tool requires that HEC-GeoRAS be installed on the computer.
12/8/2014
Page 34 of 63
Learn more about how SDF to XML (Arc Hydro) works
Usage
Syntax
SDFToXML_archydro (input_sdffile, out_xml_file)
Parameter
Explanation
Data Type
input_sdffile
Input SDF File
File Location
out_xml_file
Ouput XML File
File Location
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Stream WSE from Point WSE Measurements (Arc Hydro Tools)
Summary
Creates a linear raster of water surface elevations along the input 3D vector line. The raster values are defined based on the 3D
values in the line feature class.
Usage
Syntax
StreamWSEfromPointWSEMeasurements_archydro (Point, TimeSeries, Variable, TSTime, Line, Raster, Line_Raster, Line3D)
Parameter
Explanation
Data Type
Point
Input Point feature layer defining locations on the streams where water
surface elevations have been recorded.
Feature Layer
TimeSeries
Input Time Series table storing surface water elevations.
Table View
Variable
Input Time Series variable name associated to the water surface

elevation type considered.
String
TSTime
Time when the surface elevations have been recorded.
String
Line
Raster
Line_Raster
Line3D
Input Line feature layer defining the stream.
Feature Layer
Raster Layer
Input Raster.
Ouput Line Raster raster storing the surface water elevations along the
input line (stream).
Output Line3D feature class storing the water surface elevations.
Raster Layer
Feature Layer
Environments
ArcInfo: Yes
Update RAS Flow (Arc Hydro Tools)
12/8/2014
Page 35 of 63
Summary
Updates HEC-RAS flow files based on the HEC-GeoHMS run file and run name.
Learn more about how Update RAS Flow (Arc Hydro) works
Usage
Syntax
UpdateRASFlow_archydro (input_rasfile, in_xscutline_features, input_hmsfile, hms_run_name, {flow_type})
Parameter
Explanation
Data Type
input_rasfile
Input RAS File. Browse to the location where the RAS Project was
created. User is required to open the RAS project created from GeoRAS
and establish the relationship between HMS elements and Cross Sections
used for RAS. Boundary condition and default flow file (.f0 file) and other
required RAS inputs are expected to be populated for the RAS.
File Location
in_xscutline_features
Input Cross Section Cut Lines. A relationship must exist between Cross
Section and HMS Nodes for which Peak flow are computed using HECHMS: the NodeName field in the Cross Section Cut Lines feature classes
must be populated with the name of the associated HMS Node.
Feature Layer
input_hmsfile
Input HMS File. HMS run file containing the dss file information and
control file name for retrieving the peak flows resulting from the HMS
run.
File Location
hms_run_name
HMS Run Name. Name of the run (a run file can have multiple runs).
Used in DSS path to retrieve peak flows (/RUN:/RUN1/).
Text
flow_type
Flow Type
flow_type
Steady
(Optional)
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Export to DSS (Arc Hydro) works

This tool allows exporting Time Series data associated to input features of interest into the DSS format.
Note
The U.S. Army Corps of Engineers' Hydrologic Engineering Center Data Storage System, or HEC-DSS, is a database system designed
to efficiently store and retrieve scientific data that is typically sequential. Such data types include, but are not limited to, time series
data, curve data, spatial-oriented gridded data, and others. The system was designed to make it easy for users and application
programs to retrieve and store data. HEC-DSS is incorporated into most of HEC's major application programs.
Data in HEC-DSS database files can be graphed, tabulated, edited and manipulated with HEC-DSSVue, a Java-based visual utilities
program. HEC-DSSVue is supported for Microsoft Windows 98 / ME / NT / 2000 / XP, Sun Solaris SPARC, and Linux.
Input/Output
Input
Output
"TS Layer" Feature Class
DSS File
"Time Series Table"
Gage File
"Variable Definition Table"

"Time Series Type ID"
"Starting Time"
"Ending Time"
TS Layer
12/8/2014
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the feature in the Arc Hydro database. Link to FeatureID in the
TimeSeries table.
Required
Name
String
Name of the feature used during the export to DSS.
Page 36 of 63
Attributes table of TS Layer
Time Series Table

Role
Field
Type
Description
Required
FeatureID
Integer
Required
VarID
Integer
Unique identifier of type of time series stored.
Required
TSTime
DateTime
Required
TSValue
Double
Created
TSTime_DBL
Double

Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of time series variable.
Required
VarName
String
Name of variable measured. Must match the name of one of the AHVariables defined in
the configuration file under ApFunction(DSSExportImport).
Required
TimeStep
Double
Time Interval.
Required
TimeUnits
String
Unit for time interval.
Required
DataType
String
Required
IsRegular
Integer
Indicates whether the value is regular (1) or irregular (0).
Required
VarUnits
String
Units of measurement. Must match the name of one of the AHUnits defined in the
configuration file under ApFunction(DSSEXportImport)
Learn more about how Flood from Stream WSE (Arc Hydro) works
Model creating flood plain based on water elevation raster.
Learn more about how GeoRAS to Flood (Arc Hydro) works

Model generating floodplain polygons based on input GeoRAS data.
Learn more about how HMS to GeoRAS (Arc Hydro) works

Model generating GeoRAS geodatabase based on input HMS files.
Learn more about how Import from DSS (Arc Hydro) works
12/8/2014
Page 37 of 63
This tool imports time series data from DSS into a Time Series table in the output geodatabase.
Note
The U.S. Army Corps of Engineers' Hydrologic Engineering Center Data Storage System, or HEC-DSS, is a database system designed
to efficiently store and retrieve scientific data that is typically sequential. Such data types include, but are not limited to, time series
data, curve data, spatial-oriented gridded data, and others. The system was designed to make it easy for users and application
programs to retrieve and store data. HEC-DSS is incorporated into most of HEC's major application programs.
Data in HEC-DSS database files can be graphed, tabulated, edited and manipulated with HEC-DSSVue, a Java-based visual utilities
program. HEC-DSSVue is supported for Microsoft Windows 98 / ME / NT / 2000 / XP, Sun Solaris SPARC, and Linux.
Input/Output
Input
Output
"TS Layer" Feature Class
"Time Series Table"
"Variable Definition Table"

"Time Series Type ID"
"DSS File for Export"
TS Layer
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the feature in the Arc Hydro database. Link to FeatureID in the
TimeSeries table.
Required
Name
String
Name of the feature used during the export to DSS.
Attributes table of TS Layer

Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of type of time series variable stored.
Required
VarName
String
Name of variable measured. Must match the name of one of the AHVariables defined in
the configuration file under ApFunction(DSSExportImport).
Required
TimeStep
Integer
Time Interval.
Required
TimeUnits
String
Time Interval units.
Required
DataType
String
Required
IsRegular
Integer
Indicates whether the value is regular (1) or irregular (0).
Required
VarUnits
String
Units of measurement. Must match the name of one of the AHUnits defined in the
configuration file under ApFunction(DSSExportImport)
Time Series Table

Role
Field
Type
Description
Required
FeatureID
Integer
Required
VarID
Integer
Required
TSTime
DateTime
Required
TSValue
Double
Created
TSTime_DBL
Double
Learn more about how Run HMS (Arc Hydro) works

The tool Run HMS creates a control file with a .control extension in the same location and with the same name as the HMS project. If
the control file already exists, an incremented number will be appended at the end of the name (e.g. will_geoHMS1.control if
will_geoHMS.run control).
The contents of the Gage file may be examined using the application HEC-DSSVue that can be downloaded from the Army Corps of
Engineers web site. Refer to http://www.hec.usace.army.mil/software/hec-dss/hecdssvue-dssvue.htm for more information on HEC-
12/8/2014
Page 38 of 63
DSSVUE.
Sample Control File

Control: Control 1
Description: Control file
Last Modified Date: 3 August 2009
Last Modified Time: 18:03:02
Start Date: 12 January 2007
Start Time: 18:15
End Date: 13 January 2007
End Time: 17:00
Time Interval: 15
End:
The tool creates a run file with a .run extension in the same location and with the same name as the HMS project. If the run file
already exists, an incremented number will be appended at the end of the name (e.g. will_geoHMS1.run if will_geoHMS.run exists).
Sample Run File

Run: Run 1
Default Description: Yes
DSS File: will_geoHMS.dss
Basin: will_geoHMS
Precip: will_geoHMS
Control: Control1
End:
The tool creates a scripting file with a .script extension in the same location and with the same name as the HMS project. If the
extension file already exists, an incremented number will be appended at the end of the name (e.g. will_geoHMS1.script if
will_geoHMS.script exists).
Sample Script File

from hms.model.JythonHms import *
OpenProject("will_geoHMS", "C:\\austin\\williamson\\geoHMS_06\\will_geoHMS")
Compute("Run1")
Exit(1)
The tool executes the script file as a Windows console application. The path to HEC-HMS is read from the registry. Note that HECHMS does not have an entry under HKEY_LOCAL_MACHINE\Software\HEC so the reference is obtained by looping through each
registry entry under Windows\CurrentVersion\Uninstall and loking for 'DisplayName = HEC-HMS 3.2'.
C:\Program Files\HEC\HEC-HMS\3.4>\hec-hms.cmd -s C:\austin\williamson\geoHMS_06\will_geoHMS.scr

Learn more about how Run RAS (Arc Hydro) works

The tool uses HECRASController to run the RAS project and exports to an SDF file.
12/8/2014
Page 39 of 63
'Load a project
HecRas.Project_Open("C:\celso\austin\williamson\geoRAS_02\ras01.prj")
'run it
Dim nmsg As Long, msg() As System.String
HecRas.Compute_CurrentPlan(nmsg, msg)
HecRas.Compute_HideComputationWindow()
HecRas.ExportGIS()
Learn more about how SDF to XML (Arc Hydro) works

The SDF to XML tool allows exporting a SDF file generated by HEC-RAS into an XML file.
Learn more about how Stream WSE from Point Measurements WSE
Model creating water elevation raster along a stream.
Learn more about how Update RAS Flow (Arc Hydro) works
The tool loops through the Cross Section features with associated HMS element (i.e. field NodeName not null) and updates the flow file
using HECRASController methods. The run file, run name and control file are used to construct the dss path to retrieve the peak flow
from DSS (e.g. TSRecord DssPathname=//J311/FLOW/01JAN2007/15MIN/RUN:RUN1/)
'Load a project
HecRas.Project_Open("C:\austin\williamson\geoRAS_02\ras01.prj")
'Loop through each XS feature
Dim flow(1) As Single
flow(1) = 600 'get the peak flow from DSS
HecRas.SteadyFlow_SetFlow("Williamson Ck", "Lower", "46879.11", flow)
'End of loop
HecRas.Project_Save()
An overview of the Streamstats toolset

The Streamstats toolset contains various tools used to delineate watersheds and compute streamflow statistics.
Tools
Description
Compute Flows
Compute streamflows and stream statistics using NSS.
Edit Computed Parameters
Edit parameters in input Flows XML file.
Recompute Flows
Recompute flows based on input Flows XML file.
Streamstats Global Parameters
Compute global parameters for Streamstats (Parameters list is updated based on

configuration but tool cannot be published).
Streamstats Global Parameters

Server
Compute global parameters for Streamstats (Parameters list is not updated based on
configuration but tool can be published).
Streamstats Global Watershed
Delineate global watershed for Streamstats application.
12/8/2014
Page 40 of 63
Delineation
Streamstats toolset's tools
Compute Flows (Arc Hydro Tools)
Summary
Compute streamflows and stream statistics using NSS.
Learn more about how Compute Flows (Arc Hydro) works
Usage
Syntax
ComputeFlows_archydro (in_globalwatershed_features, in_globalwatershedpoint_features, out_flowxml, out_flowhtm,
{in_xmlconfig}, {input_flowstypes}, {out_vectorlocation})
Parameter
Explanation
Data Type
Input Global Watershed feature class for which flows will be

computed.
Feature Layer
in_globalwatershedpoint_features
Input Global Watershed Point feature class associated to global

watersheds.
Feature Layer
out_flowxml
Output Flows XML file.
File
out_flowhtm
in_xmlconfig
(Optional)
input_flowstypes
(Optional)
out_vectorlocation
(Optional)
Output Flows htm file.
File
Input XML configuration file (optional). If specified, in ArcMap, this

node will be uploaded in the XML configuration in memory (e.g.
StreamstatsConfig). If the node was already loaded, it will not be
updated. If this parameter is not specified, the tool will used the
configuration under the HydroConfig node.
File
Optional. Semi-colon separated list of tagnames of regions flows to

compute. If not specified, all configured regions flows will be
computed.
String
Output vector target location where derived features generated

during the computation of the characteristics supporting the flows
will be saved.If not specified, the features will be created in the
same workspace as the input watershed.
Workspace
Environments
ArcInfo: Yes
Edit Computed Parameters (Arc Hydro Tools)
Summary
Edits parameters in NSS Flows XML file.
Learn more about how Edit Computed Parameters (Arc Hydro) works
Usage
Syntax
12/8/2014
Page 41 of 63
EditComputedParameters_archydro (in_flowxml, in_parameters, out_editedflowxml, {in_xmlconfig})

Parameter
Explanation
Data Type
in_flowxml
Flows XML File generated by the tool Compute Flows, Recompute Flows
or Edit Computed Parameters.
XML file
in_parameters
List of parameters extracted from the input Flows XML File.
ValueTable
out_editedflowxml
Ouput XML file generated by the tool.
in_xmlconfig
(Optional)
Input XML configuration file.
XML file
XML file.
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Recompute Flows (Arc Hydro Tools)
Summary
Recompute flows.
Learn more about how Recompute Flows (Arc Hydro) works
Usage
Syntax
RecomputeFlows_archydro (in_flowxml, out_flowxml, {in_xmlconfig})
Parameter
in_flowxml
out_flowxml
in_xmlconfig
(Optional)
Explanation
Data Type
Input Flows XML file.

Output Flows XML file.
Input XML Configuration file.
XML File
XML File
XML File
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Streamstats Global Parameters (Arc Hydro Tools)
Summary
Computes global parameters for Streamstats application. This tool contrains a complex parameter and cannot be published as a
geoprocessing service.
Usage
z
The tool works on a selected set of features or on all features if there is no selected set.
12/8/2014
Page 42 of 63
Syntax
StreamstatsGlobalParameters_archydro (in_globalwatershed_features, in_globalwatershedpoint_features, input_parameters,
out_paramsxml, out_paramshtm, {in_xmlconfig}, {out_vectorlocation})
Parameter
Explanation
Data Type
Input GlobalWatershed features for which the selected parameters

will be computed.
Feature Layer
Input GlobalWatershedPoint associated to the GlobalWatershed

features through HydroID/DrainID relationship.
Feature Layer
input_parameters
List of parameters that may be computed. Read from the default

configuration if input XML configuration is not specified or from the
specified input XML configuration.
Multivalue
out_paramsxml
out_paramshtm
in_xmlconfig
(Optional)
out_vectorlocation
(Optional)
Output XML file containing the computed parameters and their

values.
Output htm file containing the computed parameters and their
values.
Input XML Configuration file containing the list of parameters to
compute and how they will be computed.
Output vector workspace where the features generated during the
parameters computation will be saved. If not specified, the features
will be saved in the workspace of the input GlobalWatershed feature
class.
File
File
File
Worspace
Environments
ArcInfo: Yes
Streamstats Global Parameters Server (Arc Hydro Tools)
Summary
Computes global parameter to support Streamstats application. This tool can be published as a geoprocessing service.
Usage
z
The tool works on a selected set of features or on all features if there is no selected set.
Syntax
StreamstatsGlobalParametersServer_archydro (in_globalwatershed_features, in_globalwatershedpoint_features, input_parameters,
out_paramsxml, out_paramshtm, {in_xmlconfig}, {out_vectorlocation})
Parameter
Explanation
Input GlobalWatershed features for which the selected parameters
will be computed.
Input GlobalWatershedPoint associated to the GlobalWatershed
features through HydroID/DrainID relationship.
Data Type
Feature Layer
Feature Layer
input_parameters
Semi-colon (;) separated list of tag names of parameters that may

be computed. Must match parameters in the default configuration if
input XML configuration is not specified or from the specified input
XML configuration.
String
out_paramsxml
Output XML file containing the computed parameters and their

values.
File
out_paramshtm
Output htm file containing the computed parameters and their

values.
File
in_xmlconfig
Input XML Configuration file containing the list of parameters to

compute and how they will be computed.
File
Output vector workspace where the features generated during the
Worspace
(Optional)
out_vectorlocation
12/8/2014
(Optional)
Page 43 of 63
parameters computation will be saved. If not specified, the features

will be saved in the workspace of the input GlobalWatershed feature
class.
Environments
ArcInfo: Yes
Streamstats Global Watershed Delineation (Arc Hydro Tools)
Summary
Performs global watershed delineation to support Streamstats application.
Usage
z
The tool processes selected batch point having the field IsDone = 0 or Null.
Syntax
StreamstatsGlobalWatershedDelineation_archydro (in_batchpoint_features, {in_xmlconfig}, clear_features,
out_globalwatershed_features, out_globalwatershedpoint_features)
Parameter
Explanation
Data Type
in_batchpoint_features
Input Batch Point features to process. Tool will work on features

having IsDone=0 or Null.
Feature Layer
in_xmlconfig
Input XML Configuration file defining the input parameters for the
delineation. If not specified in memory configuration will be used.
File
clear_features
Indicates whether to delete existing watershed point and watershed

features. Default to False (do not clear existing features).
Boolean
out_globalwatershed_features
Output global watershed feature class. Contains both the local and
global watershed features associated to each point.
Feature Class
out_globalwatershedpoint_features
Output Global Watershed point.
Feature Class
(Optional)
Environments
ArcInfo: Yes
Learn more about how Compute Flows (Arc Hydro) works

The Compute Flows tool computes streamflow statistics for the selected input Global Watershed features. The tool will process all
features if there is no selected set.
For each selected feature in the input GlobalWatershed feature class (or all features if there is no selected set), the tool performs the
following steps.
1.
Retrieve HydroID of GlobalWatershed feature being processed.
2.
Compute latitude and longitude for associated Global Watershed Point under the ApFunction(WshParams) node.
3.
Compute mandatory parameters (URBLCD01 and IMPNLCD01 if set in XML, respectively % urban and % impervious).
4.
Check whether the watershed point is located on a coordinated reach:
12/8/2014
5.
Page 44 of 63
a.
Check whether a CoordinatedReaches ApLayer has been defined in the XML.
b.
Look for the layer with matching name or alias in the map --> should not be in map. Look under global location
as well?
c.
Look for the field tagged "REACHCODE" in that layer.
d.
If a valid layer has been found in the map, check whether the watershed point is located on a coordinated reach
feature. The search tolerance used is set as ApFunction(GlobalPointDelineation)>SearchToleranceNumCells. It
defaults to 0.5 if not set.
If the CoordinatedReaches layer has not been defined or does not exist, or is the watershed point is not located on a
coordinated reach feature, the function will proceed with the regular NSS Flow Statistics computation. If the point is located
on a coordinated reach, the tool will compute the flows using the coordinated reach method.
NSS Computation
For each Flow Region grid defined in the XML under the ApFunction(WshParams)>ApLayers(RegionLayers) node:
1.
Retrieve the region grid and its associated HUCRegionsTable.
2.
Define the regions intersecting the global watershed.
3.
Check whether there are regions with multiple flow equations and map to the appropriate region (using
ArcHydroSchema.mdb>NSSRegions table).
4.
Build list of NSS parameters required by the regions.
5.
Find associated GIS parameters (using ArcHydroSchema>GISParameters table).
6.
Compute GIS parameters and generate associated features (e.g. Longest Flow Path, Centroid, etc.).
7.
Create XML to send to NSS to compute flows.
8.
Compute flows using NSS.
9.
Build result XML.
10.
Display result XML in html report.
11.
Returns new features?
Coordinated Reach Computation

1.
Check whether a CoordinatedReaches ApLayer has been defined in the XML.
2.
Look for the layer with matching name or alias in the map.
3.
Look for the field tagged "REACHCODE" in that layer.
4.
If a valid layer has been found in the map, check whether the watershed point is located on a coordinated reach feature.
The search tolerance used is set as ApFunction(GlobalPointDelineation)>SearchToleranceNumCells. It defaults to 0.5 if not
set.
5.
Compute the area for the watershed using the parameter defined in ApFunction(WshParams)>ApFields with the
AdditionalParams ISWATERSHEDAREA=1.
6.
Find a and b coefficients associated to the REACHCODE retrieved in the table tagged CoordReachEqTable. This table must
be stored in the same location as the CoordinatedReaches layer.
7.
Retrieve the following characteristics of the associated coordinated reach from the table:
a. BASINNAME
8.
9.
10.
b.
STREAMNAME
c.
BEGINDA
d.
ENDDA
Compute flows using the coefficients and the computed drainage area.
Build result XML.
Display result XML in html report.
NSS Data Requirements

Region grids
Grid defining the hydrologic regions for a given type of flow characteristics (e.g. peak flow, low flow, base flow, mean flow, etc.). One
grid needs to be defined for each type of flow. The values in the grids correspond to the NSS regions, except for multi equations
regions. The IDs for these regions match the IDs defined in the ArcHydroSchema.mdb's NSSRegions table (see below). The flow region
grids are defined under the ApFunction(WshParams)>ApLayers(RegionLayers) node as ApLayer. The tags defining each region must be
unique since they are used internally to differentiate the regions. The description of each region layer (Desc) is used to populate the
characteristics and flow header in the Flows Statistics Report:
Basin Characteristics is appended to the description for the parameters
Streamflows Statistics is appended to the description for standard flows
Statistics is appended to the description for probability. Regions used to compute probability must be defined with the additional
parameter: PROBABILITY=1
12/8/2014
Page 45 of 63
The AdditionalParams ISWATERSHEDAREA associated to each region ApLayer allows identifying the field to use as NSS area parameter.
Note that ISWATERSHEDAREA is set to the same value in the AdditionalParams of the region and in the AdditionalParams of the ApField
used to compute the area sent to NSS for this region. If ISWATERSHEDAREA is not defined for a region, the function will assume that it
is set to 1. At this time, only Tennessee requires using different values for peak flows and low flows.
The optional AdditionalParams FLOWSDISPLAYORDER defines as a comma delimited list the order of the NSS flows in the report. This
parameter is optional - if not set, the order from NSS will be used. If set, only the fields listed will be displayed in the report even if
more flows are computed by NSS.
The function may also use the ExcludePoly to decide whether to compute a type of flow statistics for a given watershed:
z
The delineation will store the ExclusionCode in the field tagged ExcludeCode (you need to add it to the GlobalWatershed ApLayer
definition in the xml) - for the name, you may want to use something shorter (<=10).
The flows statistics and flow statistics recomputation functions will retrieve the value from the ExcludeCode field in the
GlobalWatershed feature class and compare it to the value associated to each region - the value is defined using the
AdditionalParams EXCLUDECODE for each region layer in the xml (optional). The code in the ExcludePoly is the sum of the code of
the regions to exclude.
12/8/2014
Page 46 of 63
Exclude Code value

ExcludeCode = 1 - no delineation (already used)
Region1: EXCLUDECODE=2
Region2: EXCLUDECODE=4
Region3: EXCLUDECODE=8 etc.
So to exclude region 1 and 2, the code in excludepoly should be 6, to exclude region 1 only use code 2, and region 2 only use code 4.
The Region grids are stored in the RASTERDATAPATH directory defined under ApFunction(WshParams), which is the global directory for
raster data.
HUC Region tables
One HUCRegionsTable is defined for each region grid. Each table is generated by intersecting the HUCPoly feature class with the flow
region grid. The table stores the area of each region in each HUC. The tables are used to speed up the determination of the regions and
region areas associated with the delineated watershed. These tables are located in the Global.mdb geodatabase defined under
ApFunction(GlobalPointDelineation)/GlobalDataPath.
The name of the table associated to a flow grid is defined by setting the name attribute of the ApLayers>ApLayer(HUCRegionsTable)
defined as a child node of the region grid. The tag must be set to HUCRegionsTable
The HUCRegion tables are generated using the function Region Prepro available in the Streamstats Setup toolbar in Arc Hydro.
z
StreamstatsDB.mdb: contains the NSS equations.
ArcHydroSchema.mdb: Template database installed with Arc Hydro. The following tables are used by the functions:
GISParameters: This table links the tag names of the GIS characteristics with the ID of the NSS parameters.
NSSRegions (optional): This table indicates check that need to be performed on the watershed to determine which flow
regions should be used.
The ArcHydroSchema.mdb is installed in the ArcHydro/bin directory and this location will be used unless an alternate location
is explicitly defined in the Streamstats.XML file under ApFunction(WshParams)>NSSRegionsConnectionString.
12/8/2014
Page 47 of 63
XML Configuration
The configuration is stored in the nodes ApFunction(WshParams) and ApFunction(GlobalPointDelineation).
Parameter
Description
ApFields
Define parameters and local computation methods (same as Arc Hydro configuration).
Note: Percent Urban must be defined with the tag URBNLCD01 and Percent Impervious with the
tag IMPNLCD01. These parameters will always be computed if defined in the XML and they will
be displayed at the top of the report. If they exceed predefined thresholds, warning messages
will be displayed in the report. The thresholds and messages are set as attributes of ApState in
the ApStates.xml configuration file.
RASTERDATAPATH
Location of the global directory for raster data.
VECTORDATAPATH
Location of the global directory for vector data.
RegionThresholdPct
Minimum value of the total area in percent above which a region is taken into account. Regions
below this threshold are considered to be part of the biggest region.
UndefinedRegionID
Id of the region in the Region grid having no associated equation. Used for regions where some
of the required characteristics cannot be computed.
UndefinedRegionThresholdPct Threshold under which the area in undefined region is added to the biggest region.
ApFields(Flows)
Define the names of the fields storing the computed flows in the GlobalWatershed feature class.
This node must be located below the ApFields node defining the parameters.
ApLayers(RegionLayers)
List of region grids defining the flow regions for NSS.
ApFields(Edited)
Define alternate computation methods to compute the characteristics that will be used only
when the watershed has been edited. Only the parameters with an alternate method need to be
defined under this node.
HUCRegionsTableConnString
Connection string to the location of the HUCRegionTables. If not set, the location is assumed to
be the location set as GlobalDataPath under ApFunction(GlobalPointDelineation), i.e. the
location of Global.mdb. If the GlobalDataPath does not point to an Access geodatabase (e.g. a
gdb file), then the HUCRegionsTableConnString has to be specified and it must point to either
to a mdb file or to an ArcSDE database. This is required because gdb is a binary format that
does not support the complex statements used in the code.
NSSRegionsConnectionString
Optional. Connection string to the database containing the tables GISParameters and
NSSRegions. Default to a connection string to the ArcHydroSchema.mdb database installed
with Arc Hydro if not set.
Example: Provider=sqloledb;Data Source=seademon\sdesqlexp;Initial
Catalog=Streamstats;Integrated Security=SSPI
Coordinated Reach Data Requirements and Configuration

Parameter
Description
ApLayers
(CoordReachLayers)
Parent node for the configuration of the coordinated reaches computation method.
ApLayer
(CoordinatedReaches)
ApLayer defining the Coordinated Reaches line feature class. It must contain a field tagged
REACHCODE (e.g. StreamID in the example above). A layer with this name/alias must be present
in the map document.
ApLayer
(CoordReachEqTable)
ApLayer defining the Coordinated Reaches Equation table storing the characteristics of the
coordinates reaches as well as the a and b coefficients used to compute the flows. The following
fields must be defined:
12/8/2014
Page 48 of 63
REACHCODE - relate to the REACHCODE in the Coordinated Reached layer

BASINNAME
STREAMNAME
BEGINDA - minimum drainage area for which the equation is valid
ENDDA - maximum drainage area for which the equation is valid
ApFields/ApField
(AREA2MI)
ApField defining the drainage area parameter. Must be defined with AdditionalParams
ISWATERSHED=1
Coordinated Reaches layer must be present in the map document

Attributes table of Coordinated Reaches layer
Attributes table of Coordinated Reaches Equation Table (ID relates to StreamID in the Coordinated Reaches feature class)
Coordinated Reached layer (e.g. CQ_reaches) and the Coordinated Reached Equation Table (e.g. eqWithID) must be stored in the same
geodatabase.
Learn more about how Edit Computed Parameters (Arc Hydro) works
Learn more about how Edit Computed Parameters (Arc Hydro) works.

An overview of the Time of Concentration toolset

The Time of Concentration toolset contains tools allowing to compute time of travel and time of concentrations for drainage areas and
group basins, as wll as generating associated longest flow paths. These tools should be used based on the following workflow:
1.
Run Generate TR55 Zone Grid to compute a Grid that has values 1,2 and 3 representing Overland Sheet, Shallow
Concentrated and Channel flow zones respectively or Define TR55 Zones for Longest Flow Path.
2.
Run Adjust Slope so that all slopes are greater than the specified threshold. The adjusted slope grid will used as input by
the Compute Time of Concentration tool.
3.
Run Compute Time of Concentration to compute a travel time grid with values defining the travel time in hours to traverse
each cell, the Longest Flowpath using Tt grid as weight grid and the Time of Concentration Tc for each input Drainage area
polygon or Compute Time of Concentration for Longest Flow Path.
4.
Adjust Tc for each catchment for structures and residential lots (need to do manually now by editing Tc attribute).
5.
Run Compute Time of Concentration for Preferential Link to compute Travel time through pipes (EDGE_HYDRAULIC_TYPE =
CONDUIT - CON), channel (CHANNEL-CHAN) and linear structure (SHALLOW CONCENTRATED - SC)
6.
Compute Time of Concentration for Group Basin by aggregating travel times for each catchment belonging to the group and
finding the longest time, and also creating the associated Group Longest flow path.
Tools
Description
Adjust Slope
Adjust Slope grid so that all slopes are greater or equal to the specified threshold.
Compute Time of Concentration
Compute Time of Concentration and associated Longest Flow Path for each input
Drainage Area feature.
Compute Time of Concentration for Group

Basin
Compute Time of Concentration and associated Group Longest Flow Path for each
input Group Basin feature.
Compute Time of Concentration for

Longest Flow Path
Compute Time of Concentration for each input Longest Flow Path feature.
12/8/2014
Page 49 of 63
Compute Travel Time for Preferential Link
Compute Travel Time for each selected input Preferential Link.
Define TR55 Zones for Longest Flow Path
Define the TR55 Zones for each input Longest Flow Path feature.
Generate TR55 Zone Grid
Create a new TR55 Zone grid that identifies 3 TR55 zones within the extent of the
Drainage Area feature class.
Adjust Slope (Arc Hydro Tools)
Summary
Adjusts slope grid so that each cell having a value that is less than the specified threshold is assigned the threshold value.
Usage
z
This tool may be used before the Calculate Time of Concentration tool to modify the Slope grid used as input to compute the
time of concentration.
Syntax
AdjustSlope_archydro (Input_Slope_Grid, Minimum_Slope_Threshold, Adjusted_Slope_Grid)
Parameter
Explanation
Data Type
Input_Slope_Grid
Input Slope grid to update.
Minimum_Slope_Threshold
Raster Layer
Double
Minimum slope value for the output adjusted grid. Any cell having a
slope that is less than the specified threshold will be set to the threshold
value.
Adjusted_Slope_Grid
Output adjusted slope grid where all slope values are greater than or
equal to the specified Minimum Slope Threshold.
Raster Dataset
Environments
ArcInfo: Yes
Compute Time of Concentration (Arc Hydro Tools)
Summary
Computes a Time of Travel (Tt) grid defining the travel time in hours to traverse each cell and generates the Longest Flow Path
using the Time of Travel grid as weight grid. Computes the Time of Concentration for each input Drainage Area polygon feature.
The time of concentration (Tc) is defined as the time for runoff to travel from the hydraulically most distant point of the drainage
area to the outlet of the drainage area. The time of concentration is computed by summing all the travel times for consecutive
components of the drainage conveyance system.
The time of concentration is an important variable since it influences the shape and peak of the runoff hydrograph. Urbanization
usually decreases the time of concentration, thereby increasing the peak discharge. However, the time of concentration can be
increased as a result of ponding behind small or inadequate drainage systems, including storm drain inlets and road culverts, or as
a result of land slope reduction from grading.
Learn more about how Compute Time of Concentration (Arc Hydro) works
Usage
Syntax
12/8/2014
Page 50 of 63
ComputeTimeofConcentration_archydro (in_drainagearea_features, in_TR55Zone_raster, in_flowdir_raster, in_slopefpf_raster,

in_rain2YrInch_raster, in_manningsn_raster, in_surface_raster, {in_hydroedge_features}, out_traveltime_raster,
out_longestflowpath_features)
Parameter
Explanation
Data Type
in_drainagearea_features
Input Drainage Area. Tool will create and populate the field Tc with the
time of concentration in hours. All input features will be processed.
Feature Layer
in_TR55Zone_raster
Input TR55 Zone Grid defining the way the water moves through the
drainage area : overland sheet flow (1), shallow concentrated flow (2)
or channel flow (3). The time of concentration is calculated in a
different way in each zone.
Raster Layer
in_flowdir_raster
Input Flow Direction Grid. Used to generate the longest flow path
using the time of concentration as weight.
Raster Layer
in_slopefpf_raster
Input Slope Grid (ft/ft). Slope of the hydraulic grade line.

Dimensionless.
Raster Layer
in_rain2YrInch_raster
in_manningsn_raster
in_surface_raster
(Optional)
Input 2-Year 24-Hour Rainfall Grid in inches.

Input Mannings' N Grid. Manning roughness values.
Input Surface Pavement Grid. Used to calculate velocity in shallow
concentrated flow zone. 1 - Paved, Any other value(s) - Unpaved.
Input Hydro Edge. Optional. All hydro edge features will be processed.
Required only if the input TR55 Zone Grid has a channel flow zone (3).
Raster Layer
Raster Layer
Raster Layer
Feature Layer
Required fields: MANNINGSN, WETPERIFT, CSAREAFT2 (cross section

area in square feet)
These parameters are required to compute the time of concentration
for channel flows.
out_traveltime_raster
out_longestflowpath_features
Output Travel Time Grid. Travel time (Tt ) is the time it takes water to
travel from one location to another in a drainage area. Each cell value
in the Tt Grid represents the time it takes water to cross that cell.
Output Longest Flow Path generated by using the output Time of
Travel grid as weight grid. DrainID is populated with HydroID of
associated input Drainage Area feature. Tc is populated with time of
concentration for the longest flow path (and hence the associated
Drainage Area) in hours.
Raster Layer
Feature Class
Environments
ArcInfo: Yes
Compute Time of Concentration for Group Basin (Arc Hydro Tools)
Summary
Computes time of concentration for each input Group Basin feature and generates associated Group Longest Flow Path. Time of
concentration for a Group Basin is computed as the longest travel time from each catchment in the Group Basin to the outlet of the
Group Basin.
The time of travel from each catchment within the group is computed by adding up the times of concentration of each catchment in
that group that are on the preferential path to the outlet with the travel times computed for the preferential links between those
catchments.
Learn more about how Compute Time of Concentration for Group Basin (Arc Hydro) works
Usage
Syntax
ComputeTcGroupBasin_archydro (in_groupbasin_features, in_catchment_features, in_preferentiallink_features,
in_longestflowpath_features, out_grouplongestflowpath_features)
Parameter
Explanation
Data Type
12/8/2014
Input Group Basin feature class. The tool works on a selected set of
Group Basins or on all Group Basins if there is no selected set. The
tool computes the time of concentration for the Group Basin and
stores it in the Tc field.
Page 51 of 63
Feature Layer
Required fields: HydroID, GroupID.

Input Catchment feature class. Required fields: HydroID, Tc,

IsTerminal.
Feature Layer
Associated to Group Basin through GroupID field.

Input Preferential Link feature class. Required fields: FeatureID1,

FeatureID2, and time of travel fields (Tt_Chan, Tt_Con, Tt_Pipe)
populated by the tool Compute Travel Time for Preferential Link.
in_longestflowpath_features
Input Longest Flow Path feature class associated to input

Catchment feature class. Required field: DrainID.
out_grouplongestflowpath_features
Output Group Longest Flow Path feature class associate to Group

Basin feature class. Fields created: HydroID, DrainID, Tc.
Feature Layer
Feature Layer
Feature Class
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Compute Time of Concentration for Longest Flow Path (Arc Hydro Tools)
Summary
Compute Time of Concentration for Longest Flow Path.
The tool calculates Tc for each TR55 segment stored in the input Longest Flow Path TR55 feature class associated to an input
Longest Flow Path feature (through its DrainID) being processed. It then adds up the value for each segment and stores the sum in
the Tc field in the Longest Flow Path and Catchment features.
Usage
z
Tools works on a selected set of input Longest Flow Path features or on all features is there is no selected set.
Syntax
ComputeTimeofConcentrationforLongestFlowPath_archydro (in_longestflowpath_features, in_longestflowpathTR55_features,
in_drainagearea_features, in_dem_raster, in_flowdir_raster, in_slopefpf_raster, in_rain2YrInch_raster, in_manningsn_raster,
in_surface_raster)
Parameter
Explanation
Input Longest Flow Path features for which the Time of
Concentration will be computed. Must contain the attribute DrainID
and have associated features in the input Longest Flow Path TR55
feature class.
Data Type
Feature Layer
The tool creates and calculates the attribute Tc (Time of

Concentration) for each feature being processed.
in_longestflowpathTR55_features
Input Longest Flow Path feature class storing the TR55 segments
associated to the input Longest Flow Path features through
DrainID/DrainID. These features are created by the tool Define TR55
Zones for Longest Flow Path.
Feature Layer

Concentration) for each feature associated to an input Longest Flow
Path feature being processed.
Input Drainage Area features associated to the input Longest Flow

Path feature class through DrainID/DrainID.
Feature Layer

Concentration) for each feature associated to an input Longest Flow
Path feature being processed.
12/8/2014
Page 52 of 63
in_dem_raster
Input DEM. Used to retrieve elevations and calculate slope for

segments in Zone 1 and 3. Slope in Zone 2 is computed using the
input Slope grid.
Raster Layer
in_flowdir_raster
Input Flow Direction Grid. Used to generate the length of the line in
each cell for segments in Zone 2.
Raster Layer
in_slopefpf_raster
Input Slope Grid (ft/ft). Slope of the hydraulic grade line.

Dimensionless.
Raster Layer
in_rain2YrInch_raster
Input 2-Year 24-Hour Rainfall Grid in inches.
Raster Layer
in_manningsn_raster
Input Mannings' N Grid. Manning roughness values.
in_surface_raster
Input Surface Pavement Grid. Used to calculate velocity in shallow

concentrated flow zone. 1 - Paved, Any other value(s) - Unpaved.
Raster Layer
Raster Layer
Environments
ArcInfo: Yes
Compute Travel Time for Preferential Link (Arc Hydro Tools)
Summary
Computes travel time through pipes (HYDROEDGE_HYDRAULIC_TYPE_DESC=CONDUIT-CON), channels (CHANNEL-CHAN) and
linear structures (SHALLOW CONCENTRATED - SC).
Learn more about how Compute Travel Time for Preferential Link (Arc Hydro) works
Usage
Syntax
ComputeTtPreferentialLink_archydro (in_preferentiallink_features, in_hydroedge_features, in_sinkpoly_features, in_terrain_raster)
Parameter
Explanation
Input Preferential Link. Tool works on selected set or on all features if
there is no selected set. Fields created: TT_PIPE, TT_CHANNEL,
TT_CONCENTRATED.
Input Hydro Edge. Required fields:
HYDROEDGE_HYDRAULIC_TYPE_DESC, VEL_FPS, PAVED, MANNINGSN,
WETPERIFT, CSAREAFT2 (cross section area in square feet)
Data Type
Feature Layer
Feature Layer
- VEL_FPS (velocity) must be populated for the HydroEdges of type

CONDUIT
- MANNINGSN, WETPERIFT, CSAREAFT2 must be populated for the
HydroEdges of typee CHANNEL
- PAVED must be populated for HydroEdges of type SHALLOW
CONCENTRATED
in_sinkpoly_features
Input Sink Polygon. Used to identify the segments of the preferential

link that are within sink polygons.
Feature Layer
in_terrain_raster
Input DEM. Used to compute slopes.
Raster Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 53 of 63
Define TR55 Zones for Longest Flow Path (Arc Hydro Tools)
Summary
Define TR55 Zones for Longest Flow Path features.
If an input HydroEdge feature class is provided, the tool first defines the sections of the input Longest Flow Path features overlaying
the HydroEdge features as belonging to Zone 3 - Channel.
The tool then assigns the beginning of each unassigned segment up to the specified overland distance to Zone 1 - Sheet Flow.
The remaining section, if any, is assigned to Zone 2 - Shallow Concentrated.
Usage
z
Tools works on a selected set if input Longest Flow Path features or on all features if there is no selection.
Tool ignores the selection set in the input Hydro Edge feature class and will use all features.
Syntax
DefineTR55ZonesforLongestFlowPath_archydro (in_longestflowpath_features, overland_flowdistance,
out_LongestFlowPathTR55_features, overland_flowdistance, {in_hydroedge_features})
Parameter
Explanation
Input Longest Flow Path features for which the TR55 zones will be
defined.
overland_flowdistance
Overland Flow Distance in Linear Units. May be specified as a value

(double)or by specifying a field in the input Longest Flow Path
feature layer that stores the distances in linear units.
Data Type
Feature Layer
Must contain the attribute DrainID populated.

Double;Field
The lines' segments located within the overland distance starting

from the upstream end of the lines and outside of the channel
zones will be assigned to Zone 1 - Sheet Flow.
out_LongestFlowPathTR55_features
Feature classes storing the segments of the input Longest Flow Path Feature Class
features assigned to each zone.
The DrainID attribute is populated with the DrainID of the
associated Longest Flow Path feature and the attribute TR55Zone is
populated with the zone identifier for the segment:
z
1: Sheet Flow
2: Shallow Concentrated
3: Channel Flow
If the HydroEdge feature class is provided as optional input, the

following fields are craeted and their values are copies form the
corresponding HydroEdge features:
overland_flowdistance
WETPERIFT: Wet perimeter in feet.
CSAREAFT2: Cross-section area in square feet.
MANNINGSN: Manning's roughness coefficient.
Overland Flow Distance in Linear Units. May be specified as a value

(double)or by specifying a field in the input Longest Flow Path
feature layer that stores the distances in linear units.
Double;Field
The lines' segments located within the overland distance starting

from the upstream end of the lines and outside of the channel
zones will be assigned to Zone 1 - Sheet Flow.
(Optional)
Optional. Input HydroEdge features of type channel (i.e. having

HYDROEDGE_HYDRAULIC_TYPE_DESC = 'CHAN' are to define the
portions of the input Longest Flow Path features that reside in TR55
Zone 3 - Channel.
Feature Layer
In addition to HYDROEDGE_HYDRAULIC_TYPE_DESC, the following

are required and must populated as they are copied into the output
segment in Zone 3 and will be use by the tool Generate Time of
Concentration for Longest Flow Path:
z
WETPERIFT: Wet perimeter in feet.
CSAREAFT2: Cross-section area in square feet.
MANNINGSN: Manning's roughness coefficient.
Environments
12/8/2014
Page 54 of 63
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Generate TR55 Zone Grid (Arc Hydro Tools)
Summary
Creates a new TR55 Zone grid that identifies 3 TR55 zones within the extent of the input DEM Grid. Each zone defines a way for the
water to move within each drainage area.
z
Zone 1: Sheet flow. Flow over plane surfaces. It usually occurs in the headwater of streams and is assigned to to all cells
outside of the drainage area features as well as:
Boundary Drainage Area Method: all cells within the specified Overland Flow Distance from the boundaries within the
drainage areas.
Longest Flow Path Method: all cells in the Longest Flow Path features from the from node of the lines to the specified
Overland Flow Distance along the lines as well as all cells within the Sheet Flow Buffer Distance for these segments within
each drainage area.
Zone 2: Shallow Concentrated. All cells that are not in Zone 1 or 3.
Zone 3: Channel Flow. All cells within the Channel Buffer Distance (if no channel buffer distance was specified, it includes only
the channel grid cells). This will overwrite some cells within Zone 1 that overlay channel buffer cells.
Learn more about how Generate TR55 Zone Grid (Arc Hydro) works
Usage
Syntax
GenerateTR55ZoneGrid_archydro (in_drainagearea_features, in_dem_raster, out_TR55Zone_raster, in_sheetflow_method,
overland_flowdistance_meters, {in_longestflowpath_features}, {sheetflow_buffer_meters}, {in_hydroedge_features},
{channel_buffer_meters})
Parameter
Explanation
Data Type
Input Drainage Area. All features will be processed.
Feature Layer
in_dem_raster
Input DEM. Used to setup the Grid environment.
Raster Layer
out_TR55Zone_raster
in_sheetflow_method
overland_flowdistance_meters
Output TR55 Zone Grid defining 3 zones: Overland Sheet Flow (1),
Shallow Concentrated Flow (2), Channel Flow (3).
Method to use to define the Overland Sheet Flow zones (Drainage
Area Boundary (default)/Longest Flow Path).
Overland Flow Distance in Meters. May be specified as a value
(double) in meters or by specifying a field in the input Drainage Area
feature layer that stored the distances in meters.
Raster Layer
String
Double
With the Drainage Boundary sheet flow method, all cells located within
the overland flow distance of the drainage area boundary will be
assigned to Zone 1 - Sheet Flow.
With the Longest Flow Path sheet flow method, all cells along the lines
located within the overland distance starting from the upstream end of
the lines and within the sheet flow buffer distance will be assigned to
Zone 1 - Sheet Flow.
(Optional)
sheetflow_buffer_meters
(Optional)
(Optional)
channel_buffer_meters
(Optional)
Input Longest Flow Path. Optional. Used when Longest Flow Path
method is selected as Sheet Flow Method.
Feature Layer
Optional. Sheet Flow buffer distance in meters. All cells within the
sheet flow buffer zone will be assigned to Zone 1 - Sheet Flow. If the
buffer distance is set to 0, only the cells located under the upstream
segment (up to the overland distance) of the longest flow path
features will be in Zone 1.
Double
Optional. Input hydro edge features having the field

HYDROEDGE_HYDRAULIC_TYPE_DESC = CHAN (Channel) are used
with the Channel Buffer distance to define Zone 3 - Channel Flow.
Feature Layer
Optional. Channel buffer distance in meters. All cells within the
Double
12/8/2014
Page 55 of 63
channel buffer zone will be assigned to Zone 3 - Channel Flow. If the

buffer distance is set to 0, only the cells located under the channel
features will be in Zone 3.
Environments
ArcInfo: Yes
Time of concentration has several definitions including:
z
The minimum time required after runoff begins for the entire basin to contribute flow to the outlet.
The time required for a particle of water to travel from the most hydraulically distant point in the basin to the outlet.
The time required for a flood wave to travel from the most hydraulically distant point to the outlet.
The time of concentration is computed by summing all the travel times for consecutive components of the drainage conveyance system.
Travel time is computed differently for the 3 following zones in the drainage area:
1.
Sheet Flow
2.
Shallow Concentrated Flow
3.
Channel Flow
Time of Travel for Sheet Flow

Sheet flow is flow over plane surfaces. It usually occurs in the headwater of streams. With sheet flow, the friction value (Manning's
n) is an effective roughness coefficient that includes the effect of raindrop impact; drag over the plane surface; obstacles such as
litter, crop ridges, and rocks; and erosion and transportation of sediment. These n values are for very shallow flow depths of about
0.1 foot or so.
For sheet flow of less than 300 feet, use Manning's kinematic solution to compute Tt :
where:
Tt = Travel time (hr)
n = Manning's roughness coefficient
L = Flow length (ft)
P2 = 2-year, 24 hour rainfall (in)
s = Slope of hydraulic grade line (land slope, ft/ft)
This simplified form of the Manning's kinematic solution is based on the following: shallow steady uniform flow, constant intensity of
rainfall excess (that part of a rain available for runoff), rainfall duration of 24 hours and minor effect of infiltration on travel time.
Rainfall depth (P2) can be obtained from appendix B in TR-55.
Shallow Concentrated Flow

After a maximum of 300 feet, sheet flow usually becomes shallow concentrated flow. The average velocity for this flow is a function
of watercourse slope and type of channel. Tillage can affect the direction of shallow concentrated flow. Flow may not always be
directly down the watershed slope if tillage runs across the slope.
First, use one of the following equations to calculate the velocity:
V = 16.1345(s)0.5
(unpaved)
V = 20.3282(s)0.5
12/8/2014
Page 56 of 63
(paved)
where:
V = average velocity (ft/s)
s = slope of the hydraulic grade line (watercourse slope, ft/ft)
These two equations shown above are based on the solution of Manning's equation with different assumptions for n (Manning's
roughness coefficient) and r (hydraulic radius, ft). For unpaved areas, n is 0.05 and r is 0.4; for paved areas, n is 0.025 and r is 0.2.
Finally, the travel time for shallow concentrated flow is determined using:
where:
V = Average velocity (ft/s)
3600 = conversion factor from seconds to hours
Channel Flow Computation

Open channels are assumed to begin where surveyed cross section information has been obtained, where channels are visible on
aerial photographs or where blue lines (indicating streams) appear on United States Geological Survey (USGS) quadrangle sheets.
Manning's equation or water surface profile information can be used to estimate average flow velocity. Average flow velocity is
usually determined for bankfull elevation.
Manning's equation is:
where:
r = Hydraulic radius (ft) and is equal to A/Pw
A = Cross sectional flow area (ft2)
Pw = Wetted perimeter (ft)
s = Slope of the hydraulic grade line (channel slope, ft/ft)
n = Manning's roughness coefficient for open channel flow.
After computing the average velocity using the above equation, the travel time (Tt ) for the channel segment can be estimated
using:
where:
The following physical characteristics can be modified through urbanization and consequently impact the time of concentration:
z
Surface roughness
Channel shape and flow patterns
Slope
Learn more about how Compute Time of Concentration for Group Basin (Arc Hydro) works
The Compute Time of Concentration for Group Basin tool generates the Group Longest Flow Path for each Group Basin and computes
the associated Time of Concentration. The time of concentration will be stored in the Tc field in both the Group Basin and its Group
Longest Flow Path.
12/8/2014
Page 57 of 63
For each selected Group Basin feature (or each Group Basin feature if there is no selected set), the tool performs the following steps:
1.
Looks for the Catchment features belonging to the Group Basin, i.e. having GroupID=GroupID of the Group Basin.
2.
For each catchment within the Group Basin, the tool retrieves its HydroID, Tc (time of concentration) and IsTerminal (i.e.
checks whether one the catchment is a terminal catchment) values.
3.
If there is at least one terminal Catchment (i.e. IsTerminal=1), then for each catchment:
z
Retrieves the time of concentration for that Catchment from its Tc field.
z
Finds the Preferential Link feature coming out of that catchment (i.e. having FeatureID = HydroID of catchment). The
tool expects only one Preferential Link coming out of the catchment.
Adds its travel times (pipe, channel, concentrated) to the travel time of the catchment
Retrieves its FeatureID2 (HydroID of Catchment it is going into) and checks whether this Catchment belongs to the
Group Basin.
If it does, repeat the 4 previous steps for that catchment and adds to the time of concentration.
If it does not, this is a terminal basin - processing for that Catchment is complete
4.
Finds the catchment with the bigger calculated time of concentration.
5.
Unions the Preferential Link features associated to the maximum time of concentration with the Longest Flow Path feature
associated to the Catchment used to obtain the maximum time of concentration.
6.
Stores this geometry as the Group Basin Longest Flow Path (DrainID=HydroID of Group Basin) and populates the Tc field as
well.
7.
Populates the Tc field for the Basin Group with the maximum time of concentration.
Learn more about how Compute Travel Time for Preferential Link (Arc Hydro) works
This tool computes the time of travel for preferential link features.
For each selected input Preferential Link feature:
-the tool identifies the segments of the link that are within sink polygons and outside sink polygons.
-the tool processes the segments outside of sink polygons and for each segment:
1.
the tool identifies the overlapping Hydro Edge features and processes the part of the Hydro Edges that intersect the
segment. However, it ignores:
z
the first Hydro Edge between Sink Point and Catchment boundary. This edge is considered to be non-contributing to
travel time because the catchment needs to be filled up to the lowest point along the boundary before water is taken
downstream through the preferential link.
z
2.
the first Hydro Edge feature between Sink Point and Inlet. This edge is considered to be non-contributing to travel
time because the travel time between the sink and inlet is assumed to be zero due to submersion.
the tool checks the field HYDROEDGE_HYDRAULIC_TYPE_DESC and computes the velocity using the method defined for that
hydraulic type:
z
CONDUIT (CON): computes time of concentration through pipe by retrieving the velocity from the attribute table in the
Hydro Edge feature class.
z
CHANNEL (CHAN): retrieves Manning's N, wetted perimeter and cross section area from the fields in the Hydro Edge
attributes table, from and to elevation of the segment using the DEM to compute the dimensionless slope. The velocity
is calculated using the following equation:
where:
r = Hydraulic radius (ft) and is equal to A/Pw
A = Cross sectional flow area (ft2)
Pw = Wetted perimeter (ft)
s = Slope of the hydraulic grade line (channel slope, ft/ft)
n = Manning's roughness coefficient for open channel flow.
z
SHALLOW CONCENTRATED (SC): computes the time of travel using the TR-55 shallow concentrated equations
V = 16.1345(s)0.5
(unpaved)
V = 20.3282(s)0.5
12/8/2014
Page 58 of 63
(paved)where:V = average velocity (ft/s)s = slope of the hydraulic grade line (watercourse slope, ft/ft)
- The tool then computes the time of travel for the segment as:
where:
L = Segment length (ft)
- The tool aggregates the travel time of the same type and stores them in the fields Tt_Pipe (conduit), Tt_Chan and Tt_Con (Shallow
concentrated) in the attributes table of Preferential Link.
Learn more about how Generate TR55 Zone Grid (Arc Hydro) works
This tool creates a new TR55Zone grid that identifies three TR55 zones within the extent of the input DEM grid.
The three zones are:
1.
Zone 1: Sheet flow (Flow over plane surfaces. It usually occurs in the headwater of streams.)
2.
Zone 2: Shallow Concentrated
3.
Zone 3: Channel Flow
The zones are identified as follows:

z
Zone 1 - all cells outside of the drainage area features and
Drainage Boundary Method: all cells within the specified Overland Flow Distance from the Drainage Area boundary within the
drainage area features.
Longest Flow Path Method: all cells in the Longest Flow Path features from the from node of the lines to the specified
Overland Flow Distance along the lines as well as all cells within the Sheet Flow Buffer Distance for these segments within
each drainage area.
Zone 3 - all cells within the Channel Buffer Distance (if no channel buffer distance was specified, it includes only the channel grid
cells). This will overwrite some cells within Zone 1 that overlay channel buffer cells.
Zone 2 - all other cells that are not 1 or 3
This tool ignores the selection set and processes all Drainage Area features.
Technical Release 55 (TR-55) is one of the most commonly used design methods in the United States for the management of storm
water runoff in urban settings. Originally published in 1975 by the Soil Conservation Service (SCS), TR-55 presents procedures for the
calculation of storm runoff volume, peak rate of discharge, hydrographs and detention pond storage volumes for small watersheds. The
Natural Resources Conservation Service (NRCS), formally known as the SCS, published a revised version of TR-55 in 1986. The
methods in TR-55 are also described in the hydrology section of the National Engineering Handbook which was also compiled by the
SCS (NRCS).
An Overview of the Utility Toolset

The Utility toolset contains a set of tools that support hydrologic and hydraulic modeling.
Toolset
Description
Create Fishnet by Cell Height and Width
Tool creating a fishnet based on specified cell height and width.
Create Fishnet by Number of Rows and Columns
Tool creating a fishnet based on specified number of rows and columns.
Densify Fishnet
Tool densifying a fishnet based on values specified in attributes nDenRow

and nDenColumn.
Thin Cross-Section
Tool thinning 3D Cross Section lines.
Summary of the tools in the Utility toolset
12/8/2014
Page 59 of 63
Create Fishnet by Cell Height and Width (Arc Hydro Tools)
Summary
Generates a Fishnet based on the user specifed cell heigth and width.Cell height is defined along the heigth (shorter side) of the
outline rectangle, while cell width is defined along the width (longer side) of the outline rectangle. The number of cells is calculated
internally in a way to completely fill in the outline rectangle. That number is rounded up to the nearest integer. The consequence of
this approach is that the resulting fishnet will be slightly larger than the extent of the outline rectangle. Following figures
demonstrate this process and the final fitted fishnet. iRow and iColumn fields are created and populated in the resulting fishnet
feature class.
The tools is implemented as a Python script tool performing a two-step process:

1.
The tool first fits an outline rectangle to the input feature class. This is accomplished using "Minimum Bounding
Geometry" gp tool. The result is an outline rectangle that fits the input polygon in such a way to minimize the height
(shorter side) of the rectangle. This mimics the identification of minor and major "axes" of the input polygon. The outline
rectangle contains MBG_Width, MBG_Length, and MBG_Orientation attributes that define the rectangle properties. This is
a temporary feature class and is not saved by the tool.
2.
The properties of the outline rectangle (its origin geometry and attributes) are then used to calculate parameters for the
"Create Fishnet" gp tool.
The tool will generate two fields, iRow and iColumn, with row and column index for each fishnet polygon.
Usage
z
The resulting fishnet is stored in the same geodatabase/feature dataset as the input feature class if only the name of the
resulting layer is provided, or in the user specified location if a full path is provided.
Syntax
CreateFishnetByCekkHeightWidth_archydro (Input_feature_class, Input_cell_height, Input_cell_width, Output_feature_class_name)
Parameter
Explanation
Data Type
Input_feature_class
Input feature class. Can be of any type (point, line, polygon).
Feature Layer
Input_cell_height
Input cell height in map units. This is the length of a row.
Double
Input_cell_width
Output_feature_class_name
Input cell width in map units. This is the length of a column.
Double
Feature Layer
Name of the output feature class. The fishnet feature class will be
placed in the same location as the input feature class if only the name
of the resulting layer is provided or in the user specified location if a full
path is provided.
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 60 of 63
Create Fishnet by Number of Rows and Columns (Arc Hydro Tools)
Summary
Generates a fishnet based on the user specified number of rows and columns. Rows are defined along the height (shorter side) of
the outline rectangle, while columns are defined along the width (longer side) of the outline rectangle. The cell size of the fishnet is
calculated internally in a way to completely fill in the outline rectangle with the specified numbers of rows and columns. The
following figures demonstrate this process and the final fitted fishnet. iRow and iColumn fields are created and populated in the
resulting fishnet feature class.
The tools is implemented as a Python script tool performing a two-step process:

1.
The tool first fits an outline rectangle to the input feature class. This is accomplished using "Minimum Bounding
Geometry" gp tool. The result is an outline rectangle that fits the input polygon in such a way to minimize the height
(shorter side) of the rectangle. This mimics the identification of minor and major "axes" of the input polygon. The outline
rectangle contains MBG_Width, MBG_Length, and MBG_Orientation attributes that define the rectangle properties. This is
a temporary feature class and is not saved by the tool.
2.
The properties of the outline rectangle (its origin geometry and attributes) are then used to calculate parameters for the
"Create Fishnet" gp tool.
The tool will generate two fields, iRow and iColumn, with row and column index for each fishnet polygon.
Usage
z
The resulting fishnet is stored in the same geodatabase/feature dataset as the input feature class if only the name of the
resulting layer is provided, or in the user specified location if a full path is provided.
Syntax
CreateFishnetByNRowCol_archydro (Input_feature_class, Input_number_of_rows, Input_number_of_columns,
Output_feature_class_name)
Parameter
Explanation
Data Type
Input_feature_class
Can be of any type (point, line, polygon).
Feature Layer
Input_number_of_rows
Number of rows (along shorter outline rectangle axis).
Long
Input_number_of_columns
Number of columns (along longer outline rectangle axis).

Name of the output feature class. The fishnet feature class will be
placed in the same location as the input feature class if only the name
of the resulting layer is provided, or in the user specified location if a
full path is provided.
Long
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 61 of 63
Densify Fishnet (Arc Hydro Tools)
Summary
Densify fishnet based on the values stored in the nDenRow and nDenColumn required attributes of the input fishnet.
z
If either of nDenRown and nDenColumn = 0 the polygon is deleted.
If both nDenRown and nDenColumn are = 1 or at least one is <null> the polygon is not densified but copied as is
Any other combination is densified.
Two attributes will be added to the densified fishnet: iiRow and iiColumn. They are densified cell indices (within input cell identified
with iRow and iColumn).
Input Fishnet to Densify (labelled with cells OID)
Input Fishnet Table
Output Densified Fishnet (labelled with cells OID)
Output Densified Fishnet Table (partial)
Usage
z
The resulting fishnet feature class is stored in the same geodatabase/feature dataset as the input feature class if only the
name of the resulting layer is provided, or in user specified location if full path is provided.
Syntax
DensifyFishnet_archydro (Input_feature_class, Output_feature_class_name)
12/8/2014
Parameter
Explanation
Input_feature_class
Data Type
Input polygon feature class. Must have the attributes iRow and iColumn
(cell indices) and nDenRow and nDenColumn (cell densification).
Page 62 of 63
Name of the output feature class. The densified fishnet feature class
will be placed in the same location as input feature class if only the
name of the resulting layer is provided, or in user specified location if
full path is provided.
Feature Layer
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Thin Cross-Section (Arc Hydro Tools)
Summary
Thin 3D Cross Sections to remove vertices while minimizing the impact on the area defined by the lines.
The areas being compared are the ones defined by the polygon formed by connecting the from and to point of the line and the line
before and after removing the point.
Horizontal Plane
1.
For each line, the from and to points cannot be deleted and are marked with CanDelete=False.
2.
Construct each cross-section line (XLine)'s bounding polygon.
3.
Intersect the bounding polygon with the XLine vertices to identify the intersecting points (XPoints).
4.
Evaluate each XPoint to assess whether the point-area impact on the horizontal plane area is lower than the specified
threshold. The area polygon is generated by connecting the from point and to point from each line and using the line to
close the polygon. The area with the point being removed from the line is compared with the area with the point. If the
change in areas is greater than the specified threshold (set to 10), then the points cannot be removed and the vertices
are set to CanDelete=False.
Z Checks
1.
Construct each XLine's profile (ZProfile) showing elevation vs. distance along the line using the XYZ values from the
vertices.
2.
For each vertex:

z
Compute the impact of removing this vertex on the ZProfile's area (DELTAAREA) generated by connecting the from
point and to point of the ZProfile and using the line as boundary.
z
3.
Compute the moving average Z associated to the vertex (MZ). First and last point keep their elevation. All other
average elevations are computed using 3 vertices. The objective is to cleanup the little noise in the elevations.
Use MZ to compute local MAX/MIN points. The associated vertices are marked with CanDelete=False.
z
For each vertex, get the MZ for the 3 vertices located before and after.
If all 6 have a higher MZ, vertex is a local Minimum and set to CanDelete=False.
4.
If all 6 have a lower MZ, vertex is a local Maximum and set to CanDelete=False..
For each candidate, check the 3 vertices before and after.
Compute number of points that need to be removed (NDELETE) from the line.
5.
Sort the vertices based on DELTAAREA and delete 1/15 * NDELETE vertices having the smallest DELTAAREA.
6.
Recompute DELTAAREA based on update ZProfile, sort and remove 1/5 * NDELETE vertices having the smallest
DELTAAREA.
7.
Recompute DELTAAREA based on update ZProfile, sort and remove 3/5 * NDELETE vertices having the smallest
DELTAAREA.
8.
Recompute DELTAAREA. and remove the remaining points that need to be deleted.
9.
Save the line as the output simplified line.
Usage
z
The tool works on a selected set on input 3D Cross Section features and processes all features if there is no selection.
12/8/2014
Page 63 of 63
The output features and records relate back to the input features though the FeatureID/HydroID attributes.
Syntax
ThinCrossSection_archydro (in_xline_fc, out_XLineSimplified, out_XLineTBL, thinningType, Threshold)
Parameter
in_xline_fc
out_XLineSimplified
out_XLineTBL
thinningType
Threshold
Explanation
Data Type
Input 3D Cross Section line features to simplify. Must be a 3D line feature

class and contain the HydroID field.
Output simplified 3D Cross Section line features with the following
attributes:
z
FeatureID: HydroID of the associated input line feature.
PNTCOUNT0: Number of vertices in input line feature.
PNTCOUNT1: Number of vertices in simplified line feature after

thinning.
AREAPCT: Area defined using the simplified line/Area defined using

original line in percent.
LENGTHPCT: Length of simplified line divided by lenght of input line

in percent.
Output Thinning Report Table providing details on the thinning process

for each processed feature. The table contains the following attributes:
z
FEATUREID: HydroID of the associated line feature.
POINTINDEX: Index of the associated vertex in the input line.
INCLUDED: Indicate whether the initial vertex is included (1) or not

(0) in the simplified line.
AREAPCT: Impact on area in percent up to that vertex.
ACCAREA0: Accumulated area up to that vertex using the initial line.
ACCAREA1: Accumulated area up to that vertex using the simplified

line.
Thinning Method to use.

z
"MaxNumberOfVertices": thinning is based on the maximum number

of points allowed in each simplified line feature.
"FractionOfVertices": thinning is based on the fraction of initial

vertices that may remain in each simplified line feature.
Threshold associated to selected Thinning Method.

z
Maximum number of vertices allowed in simplified line if

"MaxNumberOfVertices" is selected.
Fraction of initial number of vertices to keep in simplified line if

"FractionOfVertices" is selected.
Feature Layer
Feature Class
Table
String
Double
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
An overview of the Network Tools toolset
Page 1 of 9

ArcGIS 10
The Network Tools toolset contains a set of tools supporting the creation and editing of the Hydro
geometric network as well as the creation of a simplified network schema.
Tools
Description
Hydro Network Generation
Generate a Hydro Network (hydro edges and hydro

junctions) from drainage lines, catchments and drainage
points. The tool updates the connectivity field in the
input feature classes.
Node Link Schema Generation
Generate schematic (node-link) network by connecting

centers of catchments/drainage areas to junctions, and
connecting junctions to junctions. Connectivity is
established through connectivity fields, not attributes.
Set Flow Direction
Store information about hydro (geometric) network

element's directionality into an attribute of the feature
associated to the element.
Store Flow Direction
Define flow direction for a geometric network based on

digitized direction or an attribute for the feature. A
network created in ArcCatalog does not have its flow
direction set and this tool must be run first before the
network can be traced upstream and downstream.
Summary of the tools in the Network Tools toolset
Hydro Network Generation (Arc Hydro Tools)
Summary
Generates Hydro geometric network.
Learn more about how Hydro Network Generation (Arc Hydro) works
Usage
Syntax
HydroNetworkGeneration_archydro (in_drainageline_features, in_catchment_features,
in_drainagepoint_features, network_name, out_hydroedge_features,
out_hydrojunction_features)
Parameter
Explanation
in_drainageline_features
Input drainage line features.
Input catchment features.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhCE81.htm
Data Type
Feature
Layer
Feature
Layer
12/8/2014
Page 2 of 9
Input drainage point features.
network_name
Name of output geometric network.
Feature
Layer
String
out_hydroedge_features
Output HydroEdge features belonging to the

new nwtwork.
Feature
Class
out_hydrojunction_features
Ouput HydroJunction features belonging to

the new network.
Feature
Class
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Node Link Schema Generation (Arc Hydro Tools)
Summary
Generates node link schema.
Learn more about how Node Link Schema (Arc Hydro) works
Usage
Syntax
NodeLinkSchemaGeneration_archydro (in_schemapoly_features, in_schemajunction_features,
out_schemalink_features, out_schemanode_features)
Parameter
Explanation
in_schemapoly_features
Input polygon features.
in_schemajunction_features
Input junctions used to generate the schema.
out_schemalink_features
Output schema link features.
out_schemanode_features
Output schema node features.
Data Type
Feature
Layer
Feature
Layer
Feature
Class
Feature
Class
Environments
12/8/2014
Page 3 of 9
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Set Flow Direction (Arc Hydro Tools)
Summary
Sets flow direction in selected edges in geometric network based on user specified direction
or field.
Learn more about how Set Flow Direction (Arc Hydro) works.
Usage
z
Tools works on selected set of edge features and processes all features if there is no
selection set.
Syntax
SetFlowDirection_archydro (input_edge_features, flowdirection_type)
Parameter
input_edge_features
Explanation
Input Edges feature classes to process
flowdirection_type
Data Type
Feature
Layer
String
Select the way the flow direction is to be set
(with digitized direction, against it, using a field)
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Store Flow Direction (Arc Hydro Tools)
Summary
Stores flow direction for input edges in FlowDir attribute. Learn more about how Store Flow
12/8/2014
Page 4 of 9
Direction (Arc Hydro) works
Usage
z
Tools works on selected set of edge features and processes all features if there is no
selection set.
Syntax
StoreFlowDirection_archydro (input_edge_features)
Parameter
input_edge_features
Explanation
Input Edges feature classes to process
Data Type
Feature
Layer;Feature
Layer
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Hydro Network Generation (Arc Hydro) works
The Hydro Network Generation function (Network Tools toolset) allows converting drainage
features into network features. The function performs the following operations:
z
Convert the Drainage Line feature class into the Hydro Edge feature class.
Create the Hydro Junction feature class as the From Nodes/To Nodes without duplication (a
junction is defined by one and one point only)
Create an Arc Hydro Geometric Network based on the Hydro Edge and Hydro Junction
feature classes, and set the flow direction in Hydro Edge in the digitized direction.
Establish attribute connectivity between the drainage and network feature classes.
Attribute each junction with HydroID and NextDownID field.
Create a relationship between the Catchments and Hydro Junctions:

HydroJunctionHasCatchment
Input
Output
"Drainage Line" Feature Class
"Hydro Junction" Network Junction Feature Class
"Catchment" Polygon Feature Class
"Hydro Edge" Complex Edge Feature Class
" Drainage Point" Feature Class
"Arc Hydro" Geometric Network

"HydroJunctionHasCatchment" Relationship
12/8/2014
Page 5 of 9
If there is a theme that has a tag "Drainage Line", it will be used as a default for the first input
feature class. If not, the user needs to select a line feature class that will be tagged with the
"Drainage Line" tag at the end of the operation.
Required fields: GridID, HydroID, NextDownID
Fields created/updated: DrainID
If there is a theme that has a tag "Catchment", it will be used as a default for the second input
feature class. If not, the user needs to select a polygon feature class that will be tagged with the
"Catchment" tag at the end of the operation.
Required fields: GridID, HydroID
Fields created/updated: NextDownID, JunctionID
If there is a theme that has a tag "Drainage Point", it will be used as a default for the third input
feature class. If not, the user needs to select a point feature class that will be tagged with the
"Drainage Point" tag at the end of the operation.
Required fields: GridID
Fields created: HydroID (if not previously existing). Created empty. May be populated by the tool
Assign HydroID.
Fields created/updated: DrainID, JunctionID
If there is a theme that has a tag "Hydro Edge", it will be used as a default for the output
complex edge feature class. If not, the user needs to specify a feature class name that will be
tagged with the "Hydro Edge" tag at the end of the operation. The output feature class, if it
already exists, is automatically overwritten without prompting the user.
Fields created:
z
HydroID: Unique identifier of the Hydro Edge in the Hydro database.
DrainID: Unique identifier of the associated catchment. Correspond to the GridID in the
Drainage Line feature class.
FType: Feature Type. Default to Synthetic Channel.
FlowDir: Flow direction for the edge (Associated domain: HydroFlowDirections). Default to
WithDigitized flow direction.
EdgeType: Type of Edge (Associated domain: HydroEdgeType). Available values are

Flowline and Shoreline. Default to Flowline.
Enabled: Indicate whether the feature is enabled (True) or disabled (False) in the geometric
network (Associate domain: EnabledDomain). A feature that is disabled in the network acts
as a barrier when the network is traced.
If there is a theme that has a tag "Hydro Junction", it will be used as a default for the output
network junction feature class. If not, the user needs to specify a feature class name that will be
tagged with the "Hydro Junction" tag at the end of the operation. The output feature class, if it
already exists, is automatically overwritten without prompting the user.
Fields created:
z
HydroID: Unique identifier of the Hydro Junction in the Hydro database.
NextDownID: HydroID of the next downstream Hydro Junction.
FType: Feature type of the Hydro Junction: Stream Confluence, Drainage Outlet, Drainage
12/8/2014
Page 6 of 9
Inlet for beginning of streams (for the entire drainage area considered).
z
SchemaRole: Indicate whether the junction will be used by the tool Node/Link Schema
Generation to create the schema. (0: not used for Drainage Inlet, 1: used for Drainage
Outlet and Stream Confluence).
AncillaryRole: Specify whether the feature represents a source, sink or neither. Used to
calculate the flow direction in the geometric network (Associated domain:
AncillaryRoleDomain with values 1: Source, 2: Sink (Drainage Outlet), 0: None)).
Enabled: Indicate whether the feature is enabled (True) or disabled (False) in the geometric
network (Associated domain: EnabledDomain). A feature that is disabled in the network
acts as a barrier when the network is traced.
Junction_Placement_Desc: Populated with 'AH' (Arc Hydro) to indicate that the tool was
created by the Arc Hydro tools.
Hydraulic_Type_Desc: Hydraulic role of the junction. Populated with 'None'.
Attribute Connectivity
Hydro Network Generation establishes connectivities between the input and output feature
classes through the JunctionID and NextDownID attributes.
z
JunctionID is the HydroID of the Hydro Junction related to the feature (Catchment or
Drainage Point). There is one and only one JunctionID for a given catchment or drainage
point, but there may be several catchments or drainage points associated to a Hydro
Junction.
NextDownID is the HydroID of the next down feature in the Catchment and Drainage Point
feature classes.
The relationship HydroJunctionHasCatchment relates the Hydro Junction feature class to the
Catchment feature class based on the Junction HydroID/Catchment JunctionID.
Learn more about how Node Link Schema Generation (Arc Hydro)
works
The Node/Link Schema Generation tool (Network Tools toolset) allows generating a node-link
schema. The nodes are defined by the centers of the polygons representing basins and by points
that represent locations of interest in the model. The points include basin outlets, river junctions,
water intakes and other facilities.
The function requires that the relationship between the Watershed Polygons and their outlet be
established through the JunctionID field, and the relationship between the Junctions and their
next downstream junction be established through the NextDownID field.
Input
Output
"Watershed Polygons" Feature Class (optional)
"Schema Link" Line Feature Class
"Junctions" Point Feature Class
"Schema Node" Point Feature Class
12/8/2014
Page 7 of 9
If there is a polygon feature class that has a tag "Watershed Polygons", it will be used as a
default for the first input theme. If not, the user needs to select an existing polygon feature class
that will be tagged with the "Watershed Polygons " tag at the end of the operation. This input is
optional.
Required fields:
z
HydroID: Unique identifier of the Watershed Polygon in the Hydro database.
JunctionID: HydroID of the junction that serves as the outlet for the drainage area. May be
populated by one of the Store Area Outlet tools.
If there is a point feature class that has a tag "Junctions", it will be used as a default for the
second input theme. If not, the user needs to select an existing point feature class that will be
tagged with the "Junctions " tag at the end of the operation.
Required fields:
z
HydroID: Unique identifier of the Junction in the Hydro database.
NextDownID: HydroID of the next downstream junction. May be populated by the tool
Hydro Network Generation for a network junction feature class.
Optional field:
SchemaRole: Indicate whether the Junction should be exported as a Node. All junctions are
exported if the field does not exist. If it exists, only the junctions with SchemaRole<>0 or
not null are exported.
If there is a linear feature class that has a tag "Schema Link", it will be used as a default for the
output feature class. If not, the user needs to specify a feature class name that will be tagged
with the "Schema Link" tag at the end of the operation.
Fields created:
z
HydroID - Unique identifier of the Schema Link in the Hydro database.
FromNodeID - HydroID of the Schema Node at the upstream end of the Schema Link.
ToNodeID - HydroID of the Schema Node at the downstream end of the Schema Link.
LinkType - Type of link. 1 for Watershed link (between Watershed and junction Schema
Node), 2 for Junction link (between two junction Schema Nodes).
If there is a point feature class that has a tag "Schema Node", it will be used as a default for the
output feature class. If not, the user needs to specify a feature class name that will be tagged
with the "Schema Node " tag at the end of the operation
Fields created:
z
HydroID: Unique identifier of the Schema Node in the Hydro database.
FeatureID: HydroID of the Hydro Feature from which the node was created. This enables
the schematic node to connect to the attribute information of the feature it describes. If
necessary, a relationship can be built using these attributes
SrcType: Source Type, i.e. input layer used to create the node (1 for Watershed "Watershed
Polygons", 2 for Junction "Junctions").
How the tool works

The tool creates one Schema Node for each feature in the two input feature classes:
z
For Watershed Polygons: the Schema Node corresponds to the center of gravity of the
12/8/2014
Page 8 of 9
watershed.
z
For Junctions: the Schema Node corresponds to the junctions.
The function creates Schema Links as:

z
Watershed link, between a watershed Schema Node and its corresponding junction
Schema Node outlet. The outlet is determined by the field JunctionID in the Watershed
Polygons feature class, which indicates the HydroID of the outlet in the Junctions feature
class.
Junction link, between a junction Schema Node and the next downstream junction
Schema Node. The next downstream junction is retrieved from the NextDownID field in
the Junctions feature class.
Learn more about how Set Flow Direction (Arc Hydro) works
The tool Set Flow Direction (Network Tools toolset) sets the flow direction for selected edges in
edge feature classes from the same geometric network. If no features are selected, the tool sets
the flow direction for all the edges in each selected feature class.
Input
Output
Selected edge feature classes form the current network

Value of flow direction or field storing flow direction
Flow direction in a network is stored as esriFlowDirection constants, which have the following
values:
z
esriFDIndeterminate 3 Indeterminate flow direction
esriFDWithFlow 1 With digitized direction
esriFDAgainstFlow 2 Against digitized direction
esriFDUninitialized 0 Uninitialized flow direction
The flow direction may be set in two ways:

z
by selecting an esriFlowDirection flow direction to assign to all the selected edges (or all the
edges if none selected)
by reading values from an integer field in the edge feature class: the value must
corresponds to one of the to esriFlowDirection constants, i.e. 0, 1, 2, or 3. If no valid value
is found, the flow direction defaults to the selected esriFlowDirection.
Assigning flow direction based on an attribute allows the user to delete the network (for
maintenance or distribution reasons) and to still retain the proper flow direction values. Once the
network is reestablished, flow direction can be assigned by attribute without having to create
sinks in the network. Flow directions for indeterminate cases (such as edges in loops) can be
assigned manually with this tool. Situations in which flow directions may change (such as in
canals in flat areas) can also be modeled.
Note: Complex edges may contain more than one flow direction if they are made up of more than
one edge segment. The Set Flow Direction tool assigns the selected flow direction to all segments
12/8/2014
Page 9 of 9
of the complex edge. The tool does not allow the user to set flow direction on only one individual
segment of a complex edge, if that edge contains more than one segment.
Learn more about how Store Flow Direction (Arc Hydro) works
The function Store Flow Direction (Network Tools toolset) reads the flow direction for selected
edges form the current geometric network and writes the value of the flow direction in the
FlowDir field. The field is created if it does not exist with its associated domain
HydroFlowDirections.
The function can run on a selected set of records or on all records in an edge feature class. If no
features are selected, the tool runs on all records. If features are selected, the tool runs only on
the selected records.
Input
Output
Selected edges from the current geometric

network
FlowDir field in selected edge feature

classes
Flow direction in a network is stored as esriFlowDirection constants. The constants have the
following values:
z
esriFDIndeterminate 3 Indeterminate flow direction
esriFDWithFlow 1 With digitized direction
esriFDAgainstFlow 2 Against digitized direction
esriFDUninitialized 0 Uninitialized flow direction
Note: Make sure the flow direction has already been set for the network.
Limitation
A complex edge may have different flow directions assigned on its individual segments. Because
rows in a table represent an entire feature, and not each individual network element, the Store
Flow Direction tool only stores one of the flow direction values for complex edges. The choice of
which segment to use is arbitrary.
12/8/2014
An overview of the Point Characterization toolset
Page 1 of 2

ArcGIS 10
The Point Characterization toolset contains a set of tools supporting the characterization of poitn
features.
Tools
Description
Generate Flow Path
Generate the flow path line feature associated to

each input point.
Summary of the tools in the Network Tools toolset
Generate Flow Path (Arc Hydro Tools)
Summary
Generates flow paths associated to input points using preprocessed data by performing a
local cost path within the catchment associated to the point and merging the resulting path
with the downstream segment of the connected drainage line and with the additional
downstream drainage lines. The connectivity is established by using the
HydroID/NextDownID attributes in the drainage line features. The tool does not currently
handle flow splits.
Usage
z
Tool works on selected set of input points and will overwrite the flow paths already
associated to the points being processed using the FeatureID/HydroID relationship.
Syntax
GenerateFlowPath_archydro (in_batchpoint_features, in_flow_direction_raster,
in_catchment_features, in_drainageline_features, out_flowpath_features)
Parameter
Explanation
Data Type
Input Batch Point features to process. The tool

works on selected sets. Must have the field
HydroID populated.
Feature
Layer
Input Flow Direction Grid used to determine the

flow path within the catchment associated to
each input point.
Raster Layer
Input Catchment Feature Class. Used to restrict

the extent of the flow direction grid when
performing cost path to improve performance.
Must contain the field HydroID.
Feature
Layer
Input Drainage Line Feature Class. Used to

identify the end of the cost path as well and the
remanining downstream path. Must contain the
Feature
Layer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhC04E.htm
12/8/2014
Page 2 of 2
fields HydroID, DrainID (HydroID of associated

catchment) and NextDownID (HydroID of next
downstream line).
out_flowpath_features
Output Flow Path feature class. The FeatureID

field contains the HydroID of the associated
input Batch Point.
Feature
Class
Environments
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhC04E.htm
12/8/2014
An overview of the Terrain Morphology toolset
Page 1 of 69

ArcGIS 10
The Terrain Morphology toolset contains 3 toolsets that allow processing non dendritic (deranged) terrain.
Toolset
Description
AH Connectivity
Refinement
Add structure connectivity between catchments and identify preferential paths

for deranged catchments.
Drainage
Boundary
Processing
Generate and characterize drainage areas' boundaries and generate overland

connectivity for deranged areas. This connectivity is added to the dendritic
connectivity generated by the tool Hydro Network Generation.
Grouping
Group drainage areas based on preferential path and create groups to simplify
the connectivity for modeling.
Summary of the tools in the Terrain Morphology toolset
The toolsets should be used in the following sequence, and after generating the dendritic network if
processing a combined terrain (i.e. both dendritic and deranged):
1.
Drainage Boundary Processing
2.
AH Connectivity Refinement
3.
Grouping
The resulting network and groups will be used to perform modeling (e.g. with the GeoICPR or Time of
Concentration toolsets).
An overview of the AH Connectivity Refinement toolset

The Arc Hydro Connectivity Refinement toolset contains tools that allow adding the structures connectivity
to the hydro geometric network and defining a preferential flow path in the network.
The Arc Hydro Connectivity Refinement toolset contains the following tools:
Tools
Description
Add Linear Structure

HydroEdges to Preferential
Link
Create a Preferential Link feature representing a Linear Structure by

merging the geometries of Linear Structures HydroEdges with their
connected HydroEdges (i.e. Conduit).
Add Point Structure

HydroEdges to Preferential
Link
Create a Preferential Link feature representing a Point Structure by

merging the HydroEdges connected to he HydroJunction of Hydraulic
Type Culvert, Control Structures or Bridge having IsPreferred set to 1.
Connect Control Structure

Junctions
Connect HydroJunctions of Hydraulic Type Inlet/Outlet and Control

Structure corresponding to the Control Structure Sequence to the
spider web geometric network.
Connect HydroJunctions manually created

(JUNCTION_PLACEMENT_DESC='MAN') and having
HYDRAULIC_TYPE_DESC in ('BRID','CULV','DAM','LEV','CS').
Define Overland
Preferential Node Link
Schema
Create a Preferential Node/Link schema that defines the "main"

overland flowpaths associated to Catchment features.
Flip_Preferential_Path
Flip selected Preferential Link features, switch the attributes pairs

FeatureID1/FeatureID2 and FNID/FNID and updates FlowDir field in
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 2 of 69
associated HydroEdge features.

Set Flow Direction Using
Preferential Link
Populate Flow Direction attribute for HydroEdges based on direction of

associated Preferential Links.
Sink Identification by HEP
Set the field IsSink to 1 in the input Sink Polygon features containing
Hydraulic Element Points features.
Update Preferential Node

Link Schema
Generate Overland Preferential Link and Preferential Node feature

classes based on the 'IsPreferred' attribute in the input HydroEdge
feature class.
The tool should be used in the following sequence after running the Drainage Connectivity Characterization
tool from the Drainage Boundary Processing toolset that established the initial overland connectivity:
1.
Update Hydro Network connectivity with point and linear structures:

z
z
2.
Connect Control Structure Junctions
Define Preferential Path

z
Define Overland Preferential Node Link Schema
z
Add Point Structure HydroEdges to Preferential Link
Add Linear Structure HydroEdges to Preferential Link
3.
Update Preferential Node Link Schema
4.
Flip Preferential Path
5.
Set Flow Direction Using Preferential Link (optional)
Add Linear Structure HydroEdges to Preferential Link (Arc Hydro Tools)
Summary
Creates a Preferential Link feature representing a Linear Structure by merging the geometries of
preferred Linear Structures HydroEdges with their connected HydroEdges (i.e. Conduit or Channel
edges).
Learn more about how Add Linear Structure HydroEdges to Preferential Link (Arc Hydro) works
Usage
z
Tool works on selected set of HydroEdges or on all HydroEdges if there is no selected set and
processes only the HydroEdge features that have the following characteristics:
IsPreferred=1
FType="Linear Structure"
From Point intersects the FromPoint of another HydroEdge feature (i.e. only the Linear
Structure edge connected to the From Point of a Conduit/Channel Hydro Edge will generate
the associated Preferential Path, not the Linear Structure edge connected to a to point).
The flow direction must be set in the digitized direction for the input Linear Structure and
Conduit/Channel Hydro Edges as the tool performs downstream traces from the From Point of the
Linear Structures.
Syntax
12/8/2014
Page 3 of 69
AddLinearStructureHydroEdgesToPreferentialLink_archydro (in_hydroedge_features,
in_sinkpoint_features, in_catchment_features, out_preferentialnode_features,
out_preferentiallink_features)
Parameter
Explanation
Data Type
Hydro Edge feature class processed. Tool works on

selected set of HydroEdge features or on all
features if there is no selected set and processes
HydroEdges having IsPreferred=1, FType = 'Linear
Structure' and having their FromPoint connected to
the FromPoint of another edge (e.g. Conduit or
Channel).
Feature
Layer
in_sinkpoint_features
Input Sink Point. Required fields: HydroID. Used to

populate field SinkID in output preferential nodes.
Feature
Layer
Input Catchment. Required field: HydroID. Used to

populated FeatureID1 and FeatureID2 in the output
Preferential Links (HydroID or origin and
destination catchments) and DrainID in output
preferential nodes.
out_preferentialnode_features
out_preferentiallink_features
Output Preferential Node. DrainID is populated with

the HydroID of the associated catchment and
SinkID with the HydroID of the associated sink
point.
Output Preferential Link(s) associated to the Linear
Structure HydroEdges. FNID and TNID are
populated with the HydroIDs of the From and To
preferential Nodes based on the digitized direction
of the link and FeatureID1 and FeatureID2 with the
HydroIDs of the source and destination catchments.
IsFlipped indicates whether the feature has been
flipped by the user and is initialized with 0 (No). It
will be populated automatically by the tool Flip
Preferential Path.
Feature
Layer
Feature
Class
Feature
Class
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Add Point Structure HydroEdges to Preferential Link (Arc Hydro Tools)
Summary
Creates a Preferential Link feature associated to a Point Structure by merging the geometries of the
HydroEdges connected to the Point Structure. The point structures that can be processed are
represented in the nework model by the HydroJunction features of hydraulic type Culvert, Control
Structure, Bridge, Levee or Dam (default configuration read from the XML). The point structures may
be further defined by Hydraulic Element Point features associated to HydroJunctions (e.g. upstream and
downstream invert location for culvert).
12/8/2014
Page 4 of 69
Learn more about how Add Point Structure HydroEdges to Preferential Link (Arc Hydro) works
Usage
z
Tool works on a selected set of HydroJunctions and will process all features if there is no selected
set.
Tool processes only HydroJunctions of hydraulic type culvert, control structure, bridge, dam or
levee by default based on the default XML configuration having as well IsPreferred=1.
Tool processes only HydroJunctions connected to at least one HydroEdge feature having
IsPreferred=1.
Syntax
AddPointStructureHydroEdgesToPreferentialLink_archydro (in_hydrojunction_features,
in_hydroedge_features, in_sinkpoint_features, in_catchment_features, out_preferentialnode_features,
out_preferentiallink_features, {in_HEP_features})
Parameter
Explanation
Input Hydro Junction features to process. Required

fields: HydroID, HYDRAULIC_TYPE_DESC, FType,
Elev, IsPreferred. Tool works on selected set of
HydroJunctions having IsPreferred=1 and
HYDRAULIC_TYPE_DESC=CULV (Culvert), BRID
(Bridge), CS (Control Structure), LEV (Levee) or
DAM (Dam). Junction features of FType 'Boundary
Node' must have the field ELEV populated as it is
used to determine the lowest elevation along a
catchment's boundaries. This field is populated by
the tool Drainage Connectivity Characterization.
Hydro Edge feature class.

Required fields: IsPreferred
Data Type
Feature
Layer
Feature
Layer
HydroEdge features used to generate a preferential

link feature. At least one of the edges associated to
a processed HydroJunction must have
IsPreferred=1 to create a preferential link for that
junction.
Input Sink Point. Required field: HydroID. Used to

generate populate the field SinkID in the output
Preferential Node features.
Feature
Input Catchment. Required field: HydroID. Used to
Layer
populate the fields FEATUREID1 and FEATUREID2 in
the output Preferential Link features.
Output Preferential Node
in_HEP_features
(Optional)
Output Preferential Link

Input Hydraulic Element Point. Required fields:
JUNCTIONID, POINT_TYPE_DESC.
Feature
Layer
Feature
Class
Feature
Class
Feature
Layer
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 5 of 69
Connect Control Structure Junctions (Arc Hydro Tools)
Summary
Connects HydroJunctions of Hydraulic Type Inlet/Outlet (INLET) or Control Structure (CS) associated to
a Control Structure Sequence to the spider web geometric network. A Control Structure Sequence is
defined as default as one or many linear structures of hydraulic type Conduit (CON) or Channel (CHAN)
and point structures of hydraulic type INLET/CS connected together through HydroJunctions and
HydroEdges to move water between Catchments. The junctions and edges hydraulic types are default
defined in the XML Configuration.
Learn more about how Connect Control Structure Junctions (Arc Hydro) works
Usage
Syntax
ConnectControlStructureJunctions_archydro (in_hydrojunction_features, in_hydroedge_features,
{in_drainageline_features}, in_catchment_features, in_flowdir_raster)
Parameter
Explanation
Data Type
Feature Layer
Input Hydro Junction features to process. Tool works

on a selected set of junctions or on all junctions if
there is no selection. Only HydroJunctions having
(HYDRAULIC_TYPE_DESC IN ('INLET', 'CS') AND
INCLUDECONNECT_DESC = '1' will be processed.
Hydro Edge feature class processed.
Feature Layer
Input Drainage Line feature class.
Feature Layer
Input Catchment
Feature Layer
in_flowdir_raster
Input Flow Direction Grid used to trace from the

HydroJunctions into the associated Sink/Drainage
Line.
(Optional)
Raster Layer
Environments
ArcView: No
ArcInfo: Yes
Connect HydroJunctions (Arc Hydro Tools)
12/8/2014
Page 6 of 69
Summary
Connects structure HydroJunctions created manually and of hydraulic type Bridge, Culvert, Levee, Dam
or Control Structure, i.e. having JUNCTION_PLACEMENT_DESC = 'MAN ' (Manual) and
HYDRAULIC_TYPE_DESC in ('BRID', 'CULV', 'DAM', 'LEV', 'CS'), to the Hydro geometric network. These
hydraulic types are the default types set in the XML configuration for the tool.
The tool connects the junctions by creating new HydroEdge features of FType 'Structure Link' starting
at the boundary junction and ending into a sink junction, as well as the corresponding Boundary
DrainageLine features and connectivity records of type 'Junction' in the DrainConn table.
Learn more about how Connect HydroJunctions (Arc Hydro) works
Usage
z
Tool works on selected set of HydroJunctions and will process all HydroJunctions if there is no
selected set.
Tool connects HydroJunctions having the following characteristics:
CONNECTDONE = 0 or is null. This field is optional and will be created and populated with Null
if it does not exist.
JUNCTION_PLACEMENT_DESC = 'MAN ' (Manual)
HYDRAULIC_TYPE_DESC in ('BRID', 'CULV', 'DAM', 'LEV', 'CS') (Default values read from the
XML configuration associated to the tool).
Junction is located on a Drainage Boundary feature.
The tool should be run after the function Snap HydroJunctions available on the SWFWD Connectivity Tools toolbar, installed with the Arc Hydro Tools, that snaps the HydroJunctions to
their correct location on the boundary lines.
Syntax
ConnectHydroJunctions_archydro (in_hydrojunction_features, in_hydroedge_features,
in_drainage_area_features, in_drainageboundary_features, in_boundarydrainageline_features,
in_drainageconn_table, in_flowdir_raster)
Parameter
Explanation
Data Type
Feature
Input Hydro Junction features to process. Tool will
Layer
connect junctions having
JUNCTION_PLACEMENT_DESC = 'MAN ' (Manual)
and HYDRAULIC_TYPE_DESC in ('BRID', 'CULV',
'DAM', 'LEV', 'CS') and CONNECTDONE=0 or NULL
that are located on a Drainage Boundary feature.
Input Hydro Edge feature class belonging to the

geometric network. New HydroEdge feature of
type 'Structure Link' connecting the boundary
junctions being processed to their associated sink
junctions will be generated
Feature
Layer
in_drainage_area_features
Input Drainage Area feature class.
in_drainageboundary_features
Input Drainage Boundary feature class.
in_boundarydrainageline_features
Input Boundary Drainage Line feature class.
in_drainageconn_table
Input Drainage Connectivity table.
Feature
Layer
Feature
Layer
Feature
Layer
Table
in_flowdir_raster
Input Flow Direction grid.
Raster
Layer
Environments
12/8/2014
Page 7 of 69
ArcView: No
ArcInfo: Yes
Define Overland Preferential Node Link Schema (Arc Hydro Tools)
Summary
Creates a Preferential Node/Link schema that defines the "main" overland flow paths between
catchments. The input HydroEdge and HydroJunction feature classes used by the tool are the ones
created with the Terrain Morphology Drainage Connectivity Characterization tool, and NOT the ones
created manually and/or during the creation of HEPs. The HydroJunctions of FType 'Boundary Node'
must have the elevation field (Elev) populated with the elevation of the junction.
Learn more about how Define Overland Preferential Node Link Schema (Arc Hydro) works
Usage
z
The tool works on a selected set of Catchments and will process all input catchments if there is
not selected set.
The digitized direction for the edges connecting the boundary Junctions to the Sink points must be
from the boundary to the sink.
The tool will not create duplicate Preferential Nodes but may create duplicate Links if the Catchment
has already been processed (it does not check whether the link already exists).
The tool does not reset the field IsPreferred in the HydroEdge features but only updates the field
to 1 for all HydroEdges belonging to the newly defined paths.
Syntax
DefineOverlandPreferentialNodeLink_archydro (in_catchment_features, in_sinkpoint_features,
in_hydrojunction_features, in_hydroedge_features, in_terrain_raster, out_preferentialnode_features,
Parameter
Explanation
Data Type
Feature
Layer
Input Catchment. Required field: HydroID. Tool

works on selected set of Catchment features or on
all features if there is no selected set.
Input Sink Point. Required field: HydroID. Used to

populate the field SinkID in the associated output
Preferential Node.
Input Hydro Junction features to process. Required

field: HydroID, FType, Elev. HydroJunctions
defining the lower elevation along the Boundaries
must have FType='Boundary Node' and their field
elevation must be populated.
Hydro Edge feature class to process. Tool will

update the field IsPreferred with 1 for the edges
belonging to the preferential paths. The digitized
direction of the Boundary Link HydroEdges must be
toward the sink points.
Feature
Layer
in_terrain_raster
Input DEM Grid providing the cell size used to set
Raster Layer
Feature
Layer
Feature
Layer
12/8/2014
Page 8 of 69
the search tolerance for the spatial joins.

Output Preferential Node feature class storing the

nodes located on the preferential paths.
Output Preferential Link feature class defining the
preferred paths. HydroEdge features associated to
the paths are assigned IsPreferred=1.
Feature
Class
Feature
Class
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Flip Preferential Path (Arc Hydro Tools)
Summary
Flips selected input Preferential Link features and switch the attributes FeatureID1/FeatureID2 and
FNID/TNID. Updates FlowDir in preferred HydroEdge features associated to the selected links and
having DrainID populated (i.e. Boundary Link, Structure Link and Linear Structure FType).
Learn more about how Flip Preferential Path (Arc Hydro) works
Usage
z
Tool works on selected set only.
Syntax
FlipPreferentialPath_archydro (in_preferentiallink_features, in_hydroedge_features)
Parameter
Explanation
Input Preferential Links feature to flip. Must be a
selected set.
Hydro Edge features used to create the links. FlowDir
field will be flipped and populated with 1
(WithDigitized) or 2 (AgainstDigitized) for the edges
associated to the links having IsPreferred=1, DrainID
populated and FlowDir=1 or FlowDir=2 (e.g. the
HydroEdges of FType 'Boundary Link', 'Linear
Structure' or 'Structure Link' created respectively by
the tools Drainange Area Connectivity, Connect
Control Structure Junctions and Connect
HydroJunctions.
Data Type
Feature Layer
Feature Layer
Environments
12/8/2014
Page 9 of 69
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Set Flow Direction Using Preferential Link (Arc Hydro Tools)
Summary
Populates the FlowDir field in the HydroEdge features based on the direction of the first intersecting
Preferential Link features.
Learn more about how Set Flow Direction Using Preferential Link (Arc Hydro) works
Usage
z
The tool works on a selected set of HydroEdge features and will process all features if there is no
selected set.
Syntax
SetFlowDirectionUsingPreferentialLink_archydro (in_hydroedge_features, in_preferentiallink_features)
Parameter
Explanation
Data Type
Hydro Edge feature class to process. FlowDir field will Feature Layer
be populated with 1 (WithDigitized) or 2
(AgainstDigitized)
Input Preferential Link features used to define the

flow direction of the intersecting HydroEdge features.
Feature Class
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Sink Identification by HEP (Arc Hydro Tools)
Summary
Sets the field IsSink to 1 in the input Sink Polygon features containing Hydraulic Element Points
features. The field IsSink will be created if it does not already exist.
Learn more about how Sink Identification by HEP (Arc Hydro) works
12/8/2014
Page 10 of 69
Usage
z
The tool works on a selected set of Sink Polygon features. It will process all features if there is no
selected set.
Syntax
SinkIdentificationByHEP_archydro (in_sinkPoly_features, in_HEP_features)
Parameter
Explanation
Data Type
in_sinkPoly_features
Sink Polygon features for which IsSink field will be

populated.
Feature Layer
in_HEP_features
Input Hydraulic Element Point
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Update Preferential Node Link Schema (Arc Hydro Tools)
Summary
Generates Overland Preferential Link and Preferential Node feature classes defining the main flow paths
between catchments based on the 'IsPreferred' attribute in the input HydroEdge feature class of FType
'Boundary Link' or 'Structure Link'. The tool works on a selected set of catchment features and will
process all features if there is no selected set.
Learn more about how Update Preferential Node Link Schema (Arc Hydro) works
Usage
Syntax
UpdatePreferentialNodeLink_archydro (in_catchment_features, in_sinkpoint_features,
in_hydroedge_features, in_drainageboundary_features, in_terrain_raster, out_preferentialnode_features,
Parameter
Explanation
Data Type

works on selected set of Catchment features or on
all features if there is no selected set.
Feature
Layer
Input Sink Point. Required field: HydroID.
Hydro Edge feature class processed
Input Drainage Boundary used to retrieve the

elevations at the HydroJunctions.
Feature
Layer
Feature
Layer
Feature
Layer
in_terrain_raster
Input DEM Grid providing the cell size used to set
Raster Layer
12/8/2014
Page 11 of 69
the search tolerance.

Output Preferential Node
Output Preferential Link
Feature
Class
Feature
Class
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Add Linear Structure HydroEdges to Preferential Link
(Arc Hydro) works
This tool adds the Linear Structures (e.g. HydroEdges) associated to control structure sequences (i.e.
Conduit or Channel and associated inlets/control structures) representing a Pipe to the Preferential Link
feature class. These linear structure edges should not be confused with the PIPE_BARREL edges associated
to the culverts. The tool works on a selected set of 'HydroEdge' features. If nothing is selected, all features
will be processed.
Notes
1.
Although the function processes all features when there is no selection, it is better to work on
selected features as this is a GIS intensive function and quality control at each step is
essential.
2.
HydroEdges MUST have geometric network flow direction set (Run Set FlowDirectionfrom Arc
Hydro Network tools and set the flow in the digitized direction).
How the tool works

1.
The tool loops through all selected HydroEdges and processes only the HydroEdge features
that have the following attributes:
z
IsPreferred=1
z
FType="Linear Structure"
and have their From Point intersecting the FromPoint of another HydroEdge feature (i.e. only
the Linear Structure edge connected to the From Point of the Hydro Edge will generate the
associated Preferential Path, not the Linear Structure edge connected to the to point).
2.
It traces from the FromPoint to find all downstream HydroEdges (Conduit/Channel as well as
Linear Structures Edges).
3.
The tool merges the geometries of all resulting HydroEdges and creates a new PreferentialLink
feature. The FromPoint of the feature is the ToPoint of the HydroEdge feature of FType Linear
Structure being processed and its ToPoint is the end of the trace (i.e. the ToPoint of the
HydroEdge of FType Linear Structure at the downstream end (sink)).
Need to check the direction when the Linear Structure HydroEdge(s) being processed crosses
the pipes Hydro Edges.
4.
The tool creates output Preferential Node features at each Sink Point located at the ToPoint of
the Linear Structure HydroEdges at both ends of the Preferential Link. The SinkID is populated
12/8/2014
Page 12 of 69
with the HydroID of the Sink Point.

5.
For Preferential Link, set FNID=HydroID of the 'From Preferential Node' and TNID= HydroID of
the 'To Preferential Node'.
6.
Input Catchment is needed to assign FeatureID1 and FeatureID2 (HydroID of the From and To
Catchments) for the Preferential Links. Catchments are retrieved by spatial query using the
Sink Point features.
Note
When the HydroEdges that are pipes (HEP lines) cross Linear Structures, the digitized direction
(FromNode and ToNode) will not be maintained since new vertices will be introduced at the intersecting
points. However FNID, TNID, FeatureID1 and FeatureID2 will be maintained to establish the flow.
Sink Point
Role
Field
Type
Description
Required
HydroID
Integer

Used to populate SinkID in the Preferential Node feature class.
Attributes table of Sink Point
Catchment
Role
Field
Type
Description
Required
HydroID
Integer

Used to populate thefields FeatureID1 and FeatureID2 in the
Preferential Link feature class.
Hydro Edge
Role
Field
Type
Description
Required
IsPreferred
Integer
Indicate whether the feature was used to create a

Preferential Link (1/0).
Required
FType
String
Edge feature type. The tool will only process edges

with FType='Linear Structure'.
Created/Populated
FlowDir
Integer
Flow direction for the edge. Populated with 1

(WithDigitized) for Linear Structure edges
connected to the to node and 2 (AgainstDigitized)
for Linear Structure edges connected to the from
node of the associated link.
Attributes table of Hydro Edge
Preferential Node
Role
Field
Type
Description
Created
HydroID
Integer
Created
SinkID
Integer
HydroID of the associated Sink Point.
Created
DrainID
Integer
HydroID of the associated Catchment.
Attributes table of Preferential Node
Preferential Link
Role
Field
Type
Description
Created
HydroID
Integer
Created
IsFlipped
Integer
Indicate whether link has been flipped. Populated with 0 (No).
Created
FNID
Integer
HydroID of the associated From Preferential Node.
12/8/2014
Page 13 of 69
Created
TNID
Integer
HydroID of the associated To Preferential Node.
Created
FeatureID1
Integer
HydroID of origin Catchment.
Created
FeatureID2
Integer
HydroID of destination Catchment.
Learn more about how Add Point Structure HydroEdges to Preferential Link
(Arc Hydro) works
This tool generates Preferential Link and Node features associated to HydroEdge features connected to the
input HydroJunction features of hydraulic type culvert ('CULV'), control structure ('CS'), bridge ('BRID'),
dam ('DAM') or levee ('LEV') having IsPreferred set to 1. These types are the ones defined in the default
configuration for the tool in the XML configuration file (see below the XML Configuration section).
The tool works on a selected set of HydroJunction. It will process all features if there is no selected set.
Input/Output
Input
Output
"Preferential Node" Point Feature Class
"Preferential Link" Line Feature Class
"Sink Point" Feature Class

"Hydraulic Element Point" Feature Class (optional)
How the tool works

1.
The tool looks for all HydroJunctions with HYDRAULIC_TYPE_DESC in

('CULV','CS','BRID','DAM','LEV') (i.e. of type culvert, control structure, bridge, dam or levee default types set in the configuration XML) having IsPreferred = 1.
2.
For each HydroJunction meeting the previous criteria, the tool looks for HydroEdges connected
to the junction and proceeds if there is at least one HydroEdge having IsPreferred=1. If there
are more than 2 connected HydroEdges and the tool cannot determine which one to use to
generate the link (i.e. only one has IsPreferred=1, and there is more than 1 with IsPreferred
<>1), then the tool skips the HydroJunction and gives a warning message.
3.
If the tool can identify only one HydroEdge (e.g. HydroJunction located on the external
boundary), it generates the link from that feature and sets it direction from the structure to
the sink. The node associated to the from point of the link will be populated with SinkID and
DrainID set to -1 to indicate that there are no associated Sink Point and Catchment.
4.
If the tool can identify the 2 HydroEdges to use to generate the link, it tries next to determine
the direction of the new link using one of the 2 methods described below:
z
If the HydroJunction is a culvert ('CULV') and the optional input Hydraulic Element Point
feature class has been specified, the tool looks for the Barrel subelements defining the
culvert (i.e. having JUNCTIONID = HydroID of the culvert HydroJunction) and looks up
the content of the attribute POINT_TYPE_DESC. This field is populated with either UIC
(Upstream Invert of Culvert) or DIC (Downstream Invert of Culvert) and is used to
determine the direction of the new link.
z
If the HydroJunction is a bridge ('BRID'), a control structure ('CS'), a dam ('DAM'), levee
('LEV') or a culvert ('CULV') with the optional input Hydraulic Element Point not specified,
12/8/2014
Page 14 of 69
the tool cannot use element points to define the direction of the link. In these cases, it
uses the same method as with the overland links. It identifies the lowest Boundary Node
FType HydroJunctions on the boundaries of the 2 catchments and sets the directions
from the catchment with the higher elevation to the catchment with the lower elevation.
If both catchments have the same lower elevation, the direction is set from the smaller
catchment to the bigger one.
5.
The tool merges the 2 HydroEdge features to generate the output link and sets it in the
correct direction. It populates the field ISFLIPPED with '0' (not flipped).
6.
The tools checks whether Preferential Node features already exist at the ends of the new link
and create the node(s) if needed. It looks for the Sink Point and Catchment features
associated to the new node(s), if any, and populates the fields SinkID and DrainID with
respectively the HydroIDs of the Sink Point and Catchment, or with -1 if there are no
associated features.
Hydro Junction
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the feature in the Arc Hydro

geodatabase.
Required
HYDRAULIC_TYPE_DESC
String
Hydraulic type. Tool processes only

HydroJunction of type culvert (CULV), bridge
(BRID), control structure (CS), dam (DAM) or
levee (LEV) by default based on the
configuration in the XML file.
Required
FType
String
Junction type (e.g. Boundary Node)
Required
Elev
Double
Elevation of the junction. Populated by

Drainage Connectivity Characterization tool for
Boundary Node junctions and used to locate
the lowest junction along a catchment's
boundaries.
Required
IsPreferred
Integer
Indicates whether a preferential path should be

created for the HydroJunction.
Attributes table of Hydro Junction
Hydro Edge
Role
Field
Type
Description
Required
HydroID
Integer

geodatabase.
Required
IsPreferred
Integer
Set to 1 for a HydroEdge that belongs to a preferential path.

At least one of the HydroEdge connected to the
HydroJunction to process must have IsPreferred=1.
Sink Point
Role
Field
Type
Description
Required
HydroID
Integer

Used to populate the DrainID field in the Preferential Node
feature class.
Catchment
Role
Field
Type
Description
Required
HydroID
Integer

Used to populate the field DrainID in the Preferential Node
12/8/2014
Page 15 of 69
features and the fields FEATUREID1 and FEATUREID2 in the

Preferential Link features.
Hydraulic Element Point

Role
Field
Type
Description
Required
JUNCTIONID
Integer
HydroID of the associated HydroJunction.
Required
POINT_TYPE_DESC
String
Description of the subelement. Used to determine

the direction of the culvert.
Attributes table of Hydraulic Element Point
Preferential Link
Role
Field
Type
Description
Created
HydroID
Integer
Created
IsFlipped
Integer
Indicate whether the link has been flipped. Initialized with 0.
Created
FNID
Integer
Created
TNID
Integer
Created
FeatureID1
Integer
Created
FeatureID2
Integer
Preferential Node
Role
Field
Type
Description
Created
HydroID
Integer
Created
SinkID
Integer
Created
DrainID
Integer
XML Configuration
The hydraulic types of the junctions that can be added to the preferential path are defined in the
ArcHydroTools.xml configuration file that gets loaded in memory in ArcMap under the node
HydroConfig/ProgParams/ApFunctions/ApFunction(ConnectJunctions)/JunctionTypes. Note that that this
configuration is also used by the tool Connect HydroJunctions. Each Junction child node under this node
is defined with the following attributes:
z
Name: Hydraulic type of the junction (e.g. 'BRID' for Bridge).
ConnectionMethod: Must be set to 'BridgeType".
Learn more about how Connect Control Structure Junctions (Arc Hydro)
works
Connects structure HydroJunctions of hydraulic type Inlet/Outlet or Control Structure associated to a linear
structure of type Conduit ('CON') or Channel ('CHAN') to the spider web geometric network by creating new
Linear Structure Hydro Edges. The structure junctions and their associated structure edges define a
"Control Structure Sequence". The objective of this tool is to connect the end points of the sequences to the
associated sink point or drainage line.The tool works on a selected set of HydroJunctions having
12/8/2014
Page 16 of 69
HYDRAULIC_TYPE_DESC set to INLET (Inlet/Outlet) or CS (Control Structure) and

INCLUDECONNECT_DESC set to 1 and will process all HydroJunctions meeting these criteria if there is no
selected set. The types of the junctions and edges to process are defined in the XML configuration file (refer
to XML Configuration section below).
The tool will set the flow direction in the new linear structures HydroEdges features in the digitized
direction.
Input/Output
Input
Output

"Flow Direction" Grid
Assumption
HydroJunctions features exist at both ends of each HydroEdge feature that participates in the Control
Structure Sequence.
How the tool works

z
The tool loops through the HydroJunction features having INCLUDECONNECT_DESC=1 and
HYDRAULIC_TYPE_DESC=INLET (Inlet/Outlet) or CS (Control Structure) (default configuration read
from the XML) and "groups" them into unique Control Structure Sequences based on network
connectivity. The tool performs a trace to find the connected junctions and edges for each junction
12/8/2014
Page 17 of 69
to process after setting all network elements except the HydroEdges of Hydraulic Type CON
(Conduit) or CHAN (Channel) as barriers (edges hydraulic types defined in the XML configuration as
well).
z
For each Control Structure Sequence, the tool looks for the From Point and the To Points of the
sequence and determines whether they are located within different catchments. If it is the case, the
tool determines whether there are any HydroEdge features coming in/going out of the end junctions.
If there is no HydroEdge features at the From or at the To Points of the sequence, the tool traces
from the HydroJunction at the From/To Points and connect them to the sink (as identified as Trace
end point if within the catchment) or Drainage Line feature.
The newly traced geometries from the HydroJunctions to the Sink Point/Drainage Line features become
overland connector HydroEdge features and have the following attributes populated:
HydroEdge
z
HydroID: Unique identifier of the HydroEdge in the database
HYDROEDGE_TYPE_DESC: 'HYD' (HYDRAULIC ELEMENT)
HYDROEDGE_HYDRAULIC_TYPE_DESC: 'SC' (SHALLOW CONCENTRATED)
HYDROEDGE_PLACEMENT_TXT: 'AH' (ARCHYDRO)
FType: Linear Structure
EdgeType: 1
FlowDir: 0 (Uninitialized)
DrainID: HydroID of the Catchment where the HydroEdge is located
NextDownID: -1
Enabled: True
IsPreferred: 1
HydroJunction
z
HydroID: Unique identifier of the HydroJunction in the database
NextDownID: -1
FType: Sink Node or Structure Confluence
SchemaRole: 1
AncillaryRole: 0
Enabled: True
JUNCTION_PLACEMENT_DESC: 'AH' (ARCHYDRO)
JUNCTION_TYPE_DESCRIPTION: 'HE' or 'CON'
HYDRAULIC_TYPE_DESC: 'NONE'
IsPreferred: 1
When the Control Structure Sequence has multiple From/To points, the tool will check if at least one
From Point and one To Points are in different catchments before connecting all From/To Points to the
Sinks/Drainage Line.
Hydro Edge
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the

feature in the Arc Hydro
geodatabase.
Created/Populated
DrainID
Integer
HydroID of the
associated catchment.
Created/Populated
NextDownID
Integer
HydroID of the next
12/8/2014
Page 18 of 69
downstream HydroEdge
feature. Populated with
-1.
Created/Populated
FType
String
Feature type (i.e.

Linear Structure,
Synthetic Channel,
Boundary Link)
Required
Enabled
Short
Integer
Populated with True by

default.
Created/Populated
FlowDir
Short
Integer
Populated with 0 by
default.
Created/Populated
EdgeType
Integer
Populated with 1 by
default.
Created
IsPreferred
Integer
Set to 1 for a
HydroEdge merged to
create a Preferential
Link.
Created/Populated
HYDROEDGE_TYPE_DESC
String
HYDRAULIC_ELEMENT
Created/Populated
HYDROEDGE_HYDRAULIC_TYPE_DESC
String
SHALLOW
CONCENTRATED
Created/Populated
HYDROEDGE_PLACEMENT_TXT
String
Indicates how the

feature was created:
AH (ARCHYDRO), MAN
(Manual).
Created/Populated
DrainID
Integer
HydroID of the
catchmebt in which the
edge is created.
Created/Populated
IsPreferred
Integer
Indicates whether the

HydroEdge is part of a
preferential link. Set to
1 (Preferred) by
default.
Hydro Junction
Role
Field
Type
Description
Populated
HydroID
Integer
the feature in the Arc
Hydro geodatabase.
Populated
NextDownID
Integer
HydroID of the next

downstream
HydroEdge feature.
Populated with -1.
Populated
FType
String
Feature type for the

junction. Populated
with 'Sink Node' or
'Structure
Confluence'.
Populated
Enabled
Short
Integer
Indicates whether
the feature is
enabled in the
network. Populated
with 1(True) by
default.
Populated
AncillaryRole
Short
Indicates whether
12/8/2014
Page 19 of 69
Integer
the feature acts as a

source or a sink in
the network.
Populated by default
with 0 (no role).
Populated
SCHEMAROLE
Short
Integer
Role played by the

junction in the model
schema.Populated
with 1 by default.
Populated
JUNCTION_PLACEMENT_DESC
String
Indicate how the

junction was created:
AH (Arc Hydro) or
MAN (Manually).
Populated
JUNCTION_TYPE_DESC
String
Type of the junction.

with HE (Hydraulic
Element) or CON
(Stream Confluence).
Populated
HYDRAULIC_TYPE_DESC
String
Hydraulic type of the

junction (e.g. Bridge,
Culvert, etc.).
Populated with
'None'.
Created/Populated
IsPreferred
Short
Integer
Indicates whether
the HydroJunction is
part of a preferential
link. Populated with 1
by default.
Drainage Line
Role
Field
Type
Description
Required
DrainID
Integer
HydroID of the associated Catchment feature in the

geodatabase.
Attributes table of Drainage Line
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the feature in the geodatabase.
Note
z
It is possible to have multiple From Points and To Points for the Control Structure Sequence. In that
case, each end point will be connected to a sink or a drainage line feature.
IsPreferred=1 and FType=Linear Structure can be modified manually by the user before using the
tool Add Linear Structure HydroEdges to Preferential Link to add the newly created Linear Structure
HydroEdges to the Preferential Links.
XML Configuration
The hydraulic types of the junctions that can be connected and of the edges participating to a control
structure sequence are defined in the ArcHydroTools.xml configuration file that gets loaded in memory
in ArcMap under the node HydroConfig/ProgParams/ApFunctions/ApFunction
(ConnectControlStructuresJunctions):
EdgeTypes. Each Edge child node under this node is defined with the following attributes:
12/8/2014
Page 20 of 69
Name: Hydraulic type of the edge participating to the controls structure sequence (e.g. 'CON' for
Conduit, 'CHAN' for Channel.
JunctionTypes. Each Junction child node under this node is defined with the following attributes:
z
Name: Hydraulic type of the junction to connect (e.g. 'INLET' for Inlet/Outlet, 'CS' for Control
Structure, 'NONE').
Learn more about how Connect HydroJunctions (Arc Hydro) works

The Connect HydroJunctions tool (AH Connectivity Refinement toolset) allows creating a spider web for
HydroJunctions having JUNCTION_PLACEMENT_DESC = 'MAN ' (Manual) and HYDRAULIC_TYPE_DESC in
('BRID', 'CULV', 'DAM', 'LEV', 'CS') by default. These types are the default read from the XML configuration
for the tool (See XML configuration section below). This tool must be run after the Drainage Boundary
Processing tools that creates the required spider web (Drainage Boundary Processing toolset) and the
function Snap HydroJunctions from the SWFWD - Connectivity Tools toolbar that moves the HydroJunctions
to their correct location on the boundary lines. The tool works on a selected set of Hydro Junctions.
The function generates a link from the "center" of one drainage area to the "center" of the connected
drainage area. This link (one feature) will consist of two geometric segments - one segment going from the
center of one drainage area to the Hydro Junction on the boundary between the two drainage areas and the
other segment from that Hydro Junction on the boundary to the "center" of the drainage area. These links
are stored both in the Hydro Edge and in the Boundary Drainage Line feature classes. The function also
creates a new record in the Drainage Connectivity table that defines the new connection.
Input
Output
"Hydro Edge"
"Drainage Area" Feature Class
"Boundary Drainage Line"
"Drainage Boundary" Feature Class
"Drainage Connectivity" table
"Hydro Junction"
"Hydro Edge"
"Boundary Drainage Line"
"Drainage Connectivity" table
If there is a grid theme that has a tag "Flow Direction Grid", it will be used as a default for the input grid. If
not, the user needs to select an existing grid theme name that will be tagged with the "Flow Direction Grid"
If there is a polygon feature class that has a tag "Drainage Area", it will be used as a default for the second
"Drainage Area" tag at the end of the operation.
Required fields:
z
HydroID: Unique identifier in the geodatabase.
JunctionID: HydroID of the related Hydro Junction.
If there is a theme that has a tag "Drainage Boundary", it will be used as a default for the input line feature
class. If not, the user needs to specify a feature class name that will be tagged with the "Drainage
Boundary" tag at the end of the operation.
12/8/2014
Page 21 of 69
Required field:
z
HydroID: Unique identifier of the Drainage Boundary in the geodatabase.
If there is a theme that has a tag "Hydro Junction", it will be used as a default for the input network
junction feature class. If not, the user needs to specify a feature class name that will be tagged with the
"Hydro Junction" tag at the end of the operation.
Required fields:
z
JUNCTION_PLACEMENT_DESC: Placement method used for the HydroJunction. Only the junctions with
value "MAN" - MANUAL will be processed.
HYDRAULIC_TYPE_DESC: Hydraulic type of the HydroJunction. Only the junctions with value
"Populated with values defined in XLM (e.g. in ('BRID', 'CULV', 'DAM', 'LEV', 'CS')) will be processed.
INCLUDECONNECT_DESC: Indicates whether the junction should be connected (1) or not (0) to the
network. Field is optional and junction will be connected if the field contains Null.
Field created:
z
CONNECTDONE: Indicates whether the junction has already been processed by the current function or
not (1/0). Populated with 1 by the function after being processed.
If there is a theme that has a tag "Hydro Edge", it will be used as a default for the complex edge feature
class. If not, the user needs to specify a feature class name that will be tagged with the "Hydro Edge" tag
at the end of the operation. New features are appended to the existing feature class.
Fields created:
z
DrainID: Unique identifier of the associated drainage area in the Hydro database.
FType: Feature Type. Populated with "Structure Link".
WithDigitized flow direction.
EdgeType: Type of Edge (Associated domain: HydroEdgeType). Available values are Flowline and
Shoreline. Default to Flowline.
Enabled: Indicate whether the feature is enabled (True) or disabled (False) in the geometric network
(Associate domain: EnabledDomain). A feature that is disabled in the network acts as a barrier when
the network is traced.
If there is a theme that has a tag "Boundary Drainage Line", it will be used as a default for the output line
feature class. If not, the user needs to specify a feature class name that will be tagged with the "Boundary
Drainage Line" tag at the end of the operation.
Fields created:
z
DrainID: HydroID of the related drainage area.
LinkID: HydroID of the corresponding Boundary Line.
FType: Feature type. Populated with "Structure Link".
If there is a table that has a tag "Drainage Connectivity", it will be used as a default for the input Drainage
Connectivity table. If not, the user needs to specify table name that will be tagged with the "Drainage
Connectivity" tag at the end of the operation.
Required fields:
z
FeatureID: HydroID of the corresponding Hydro Junction
FeatureID1: HydroID of the drainage area to the left of the junction.
FeatureID2: HydroID of the drainage area to the right of the junction.
ConnectType: Indicates the connection type. Populated with "Junction".
12/8/2014
Page 22 of 69
How the tool works

The tool performs the following steps:
For each selected Hydro Junction:
z
Retrieve the HydroID of the Hydro Junction being processed as well as the value of the field
CONNECTDONE.
Proceed if CONNECTDONE = 0 or is null. Otherwise move to next Hydro Junction.
Retrieve the HYDRAULIC_TYPE_DESC of the Hydro Junction and check whether it is included in the
list of BridgeType defined in the XML (e.g. 'BRID', 'CULV', 'DAM', 'LEV', 'CS'). Proceed if it is in the
list otherwise move to next Hydro Junction.
Check that the junction has JUNCTION_PLACEMENT_DESC = 'MAN '. MOve to next HydroJunction
otherwise.
Search for the Boundary Drainage feature (boundary line) that intersects the Hydro Junction and
proceed if one is found. Otherwise move to next Hydro Junction.
Retrieve the HydroID of the Boundary Drainage feature.
Look in the Drainage Connectivity table for record with FeatureID matching the HydroID of the
boundary line. This record must be created by using the function Drainage Boundary Definition prior
to using this function.
Retrieve the FeatureID1 and FeatureID2 for the record(s) - these IDs are the HydroIDs of the
drainage areas separated by the boundary line.
Create a new record in the Drainage Connectivity table with the following attributes:
FeatureID: HydroID of the Hydro Junction being processed. The junction is located on the boundary
line.
FeatureID1: HydroID of the drainage area to the left of the boundary line.
FeatureID2: HydroID of the drainage area to the right of the boundary line.
ConnectType: Indicates the connection type. Populated with "Junction".
Generate the flow path from the Hydro Junction on the boundary into each of the two drainage
areas.
Look for an existing HydroJunction associated to each drainage area. For dendritic drainage areas,
the JunctionID field in the drainage area (catchment) feature class is populated with the HydroID of
the associated HydroJunction when the Hydro network is generated for the dendritic network. If a
HydroJunction is found, the function moves the To-Point of the flow path defined for that area to this
HydroJunction. The From-Point for each flow path is the Hydro Junction on the boundary.
Create HydroEdge of type "Structure Link" to represent the link in the network. The HydroEdge will
be populated as follows:
HydroID: unique identifier of the feature in the geodatabase.
DrainID: HydroID of the drainage area where the link is located.
FType: Structure Link.
FlowDir: 0 (Uninitialized).
EdgeType: 1 (Flowline).
Enabled: 0 (Disabled).
Create the Boundary Drainage Line associated to the link and populate the following attributes:
LinkID: HydroID of the corresponding Hydro Junction.
DrainID: HydroID of the associated Drainage Area.
FType: Structure Link.
Populate IsDone with 1 for the Hydro Junction and move to the next Hydro Junction.
Note
12/8/2014
Page 23 of 69
The geometric network itself will not be created by the function if it does not already exists (may be
created by the function Hydro Network Generation). In this case, the network needs to be created
manually in ArcCatalog.
XML Configuration
The hydraulic types of the junctions that can be connected are defined in the ArcHydroTools.xml
configuration file that gets loaded in memory in ArcMap under the node
HydroConfig/ProgParams/ApFunctions/ApFunction(ConnectJunctions)/JunctionTypes. Each Junction child
node under this node is defined with the following attributes:
z
ConnectionMethod: Must be set to 'BridgeType".
Learn more about how Define Overland Preferential Node Link Schema (Arc
Hydro) works
Generates the Preferential Node and Preferential Link feature classes defining the "main" overland flow
paths between non dendritic (pitted) catchments or between a non dendritic and a dendritic catchment. A
pitted catchment has Boundary Link connecting his Sink to each of its boundaries with neighboring
catchment. The objective of this tool is to identify into which of its neighbors a pitetd catchment is more
likely to spill after filling up.
The tool works on a selected set of Catchment polygon features and will process all features if there is no
selected set.
12/8/2014
Page 24 of 69
Input/Output
Input
Output
"Catchment"" Feature Class

"DEM" Grid
How the tool works

1.
The tool identifies the Hydro Junction features of FType 'Boundary Node' associated to each
catchment having the lowest value in the elevation (Elev) field. These fields are both
populated by the tool Drainage Connectivty Characterization.
2.
The tool identifies the lowest junctions associated to the selected non dendritric input
catchments.
3.
The tool performs a spatial join between the lowest junctions and the intersecting HydroEdges
and performs some cleanup to keep only the edges connected to the junctions through their
end vertex.
4.
The tool identifies the valid HydroEdges that are in the source catchments and flips the
direction of those edges so that the resulting paths will go from the sinks toward the boundary
junctions. The direction of the paths is defined so that water goes from the pitted catchment
with the lowest junction having the higher elevation either:
z
into the pitted catchment having the lowest junction with the lower elevation. If the
lower junctions associated to the catchments have the same elevation, the direction is
set from the smaller catchment into the bigger one.
z
into the dendritic catchment sharing the boundary since the outlet of the dendritic
catchment will always have a lower elevation than any 'Boundary Node' junction located
12/8/2014
Page 25 of 69
on its boundaries.
5.
The paths will be created from Sink Node to Sink Node, Sink Node to external Boundary Node,
external Boundary Node to Sink Node or from Sink Node to Outlet (for dendritic area). The
tool will merge the edges connected through the lowest junctions. The tool processes
separately the edges that are duplicates or connected to duplicate edges. Duplicate edges are
valid - they are created when one catchment is connected to more than one other catchment
through the same HydroJunction.
a. Non duplicates: the tool dissolves the 2 edges connected through a lowest junction
to generate the output paths.
b.
Duplicates and connected edges: the tool merges the duplicate edge with each
valid edge connected through the lowest junction.
6.
The tool identifies the sink point feature within the catchment and copies this feature into the
output "Preferential Node" feature class. It populates the HydroID field with a new unique
identifier and the field SinkID with the HydroID of the source Sink Point. The DrainID field is
populated with the HydroID of the catchment feature.
7.
The tool identifies the lowest junctions located on the external boundaries and copies these
features in the output "Preferential Node" feature class. The tool populates the field DrainID
nas SinkID with -1.
8.
The tool identifies the outlet for the dendritic areas and copies these features in the output
"Preferential Node" feature class.
9.
The tool populates the field IsPreferred with 1 for the HydroEdges used to generate the
preferential paths.
10.
The tool populates the attributes for the new Preferential paths features as follows:
z
IsFlipped: Indicate whether the link has been edited and flipped. Default to 0 ("No").
z
FNID: HydroID of the Preferential Node in the source Catchment
TNID: HydroID of the Preferential Node in the destination Catchment
FeatureID1: HydroID of source Catchment
FeatureID2: HydroID of destination Catchment
Data
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
Sink Point
Role
Field
Type
Description
Required
HydroID
Integer
Hydro Junction
Role
Field
Type
Description
Required
HydroID
Integer
Attributes table of HydroJunction
Hydro Edge
Role
Field
Type
Description
Required
HydroID
Integer

geodatabase.
12/8/2014
Created
IsPreferred
Integer
Page 26 of 69
Set to 1 for a HydroEdge merged to create a Preferential

Link.
Attributes table of HydroEdge
Preferential Node
Role
Field
Type
Description
Created
HydroID
Integer
Created
SinkID
Integer
Created
DrainID
Integer
Created
JunctionID
Integer
HydroID of associated HydroJunction. Populated for outlet

(Dendritic junction) and Boundary junction.
Preferential Link
Role
Field
Type
Description
Created
HydroID
Integer
Created
IsFlipped
Integer
Indicates whether the link has been edited and flipped.

Default to 0 (No).
Created
FNID
Integer
Created
TNID
Integer
Created
FeatureID1
Integer
Created
FeatureID2
Integer
Flip Preferential Path

This tool flips the preferential paths through a 3 steps process:
1.
Flips digitized direction of the preferential link features.
2.
Switches the fields FeatureID1/FeatureID2 and FNID/TNID so that they remain synchronized
with the digitized direction of the preferential links.
3.
Updates the attribute FlowDir in the HydroEdge features used to create the links so that it
remains synchronized with the digitized direction of the links. Only the preferred edges having
FTYPE equal to 'Boundary Link', 'Structure Link' and 'Linear Structure' (e.g. with DrainID
populated, and not defining a Conduit or Channel) will be updated. The Conduit or Channel
edges are always assumed to have a flow in their digitized direction and will not be updated
with this tool.
Learn more about how Set Flow Direction Using Preferential Link (Arc Hydro)
works
12/8/2014
Page 27 of 69
Sets the Flow Direction in the HydroEdge features using the Preferential Link.
How the tool works

The tool populates the FlowDir field in the input HydroEge based on the digitized direction of the first
intersecting Preferential Link features. The direction will be set either to 1 (With Digitized) or 2 (Against
Digitized). The tool Set Flow Direction may be used after this tool to set the Flow Direction in the
geometric network based on the FlowDir field. The resulting network reflects the preferential flow paths.
i.e. the traces will go only through preferential paths and will use the direction of the paths.
Learn more about how Sink Identification by HEP (Arc Hydro) works
Identifies sink polygons using Hydraulic Element Point features.
How the tool works

The tool identifies sink polygons as those intersected by the input Hydraulic Element Point features.
The tool sets the field IsSink to 1 in the input Sink Polygon features containing Hydraulic Element Points
features. The field IsSink will be created if it does not already exist.
Learn more about how Update Preferential Node Link Schema (Arc Hydro)
works
Generates Overland Preferential Link and Preferential Node features based on the 'IsPreferred' attribute in
the input HydroEdge feature class. The tool works on a selected set of Catchment features and will process
all features if there is no selected set. It processes only the HydroEdges having FType='Boundary Link',
'Structure Link' or 'Linear Structure'.
Notes
The Define Overland Preferential Node Link Schema generates PreferentialLink and PreferentialNode
feature classes based on the lowest point(s) along the boundary features. This tool also populates the
field "IsPreferred" with 1 for the HydroEdge features used to generate the Preferential Links.
The Add Point Structure HydroEdges to Preferential Link tool generates links and nodes using the
HydroEdges of FType 'Structure Link' with at least one having IsPreferred=1.
The Add Linear Structure HydroEdges to Preferential Link generates links and nodes using the
HydroEdges of FType 'Linear Structure' having IsPreferred=1.
The users may run these tools first, then manually edit the attribute 'IsPreferred' to specify which
HydroEdges are really preferential, and then run this tool to recreate "final" PreferentialLink and
PreferentialNode feature classes from the HydroEdges of FType 'Boundary Link', 'Structure Link' and
'Linear Structure'.
This tool may generate additional links compared to the links created after running the 3 tools
mentioned above in cases where there are HydroEdges with IsPreferred=1 connecting to a
HydroJunction located at the end of 2 boundary lines. One link will be generated for each pair of
connecting HydroEdge segment (3) , whereas the other tools will create only 2 links.
Input/Output
12/8/2014
Page 28 of 69
Input
Output

"DEM" Grid
How the tool works

For each Catchment feature being processed:
z
The tool looks for all HydroEdges with FType = ('Boundary Link' or 'Structure Link') and IsPreferred
= 1 within the catchment and identifies the lowest elevation on the boundary at the from point of
the connected HydroEdge(s). These HydroEdges will be used to create the path(s) from the
processed Catchment. If there are duplicates, only one the duplicate edges will be processed.
The tool identifies the Sink Point within the processed Catchment and copies this feature into
Preferential Node feature class if not already there. It populates the field SinkID with the HydroID of
the Sink Point and DrainID with the HydroID of the catchment. The field populates the field
IsConnected with 1 if at least one HydroEdge is found in the catchment to indicate that the node is
connected, and 0 otherwise.
The tool checks whether the HydroEdges found for the catchment have already been processed. For
each edge that has not already been processed, it looks for a HydroEdge feature that connects to
the From Point of that HydroEdge (i.e. to the end of the HydroEdge located on the boundary of the
catchment).
If there is a connected Hydro Edge, the tool checks whether it is of type 'Boundary Link' or
'Structure Link' and has IsPreferred=1. If it is, the tool merges the geometries of the 2
HydroEdges to create a new Preferential Link. The direction of the link is set using the lowest
elevation found in each catchment using only the from point of the edges participating to the
preferential paths. The direction of the link is set to go from the catchment having the higher
elevation to the catchment having the lower elevation. If both catchment have the same lower
elevation, the direction is set from the smaller into the bigger catchment. If the connected
HydroEdge does not have IsPreferred set to 1, the tool will log it internally and display a
warning at the end indicating that this path belongs to the list of Preferential Links that are
generated from "Incomplete" pathways.
If there is no connected HydroEdge, the tool creates a Preferential Link by using the HydroEdge
in the Catchment only, and it creates a new Preferential Node feature at the end of the link (on
the catchment boundary).
The tool checks whether the FlowDir field is populated in the preferred edges and whether the
flow direction based on the field match the flow direction based on the topography. If they do
not match, the tool will set the field IsFlipped to 1 in the new link and reverse the link to match
the direction from the FlowDir field in the edges. The tool will update the FlowDir for the new
preferred edges (but it will not reset this field to 0 for edges that have been removed from the
preferred edges).
The tool creates a new Preferential Node at the SinkPoint of the adjacent catchment if there is a
connected edge or at the end of the Hydro Edge being processed if there is no connected edge.
The tool populates the SinkID and DrainID of this new point the HydroIDs of its associated Sink
Point and catchment. If there is no connected edge, the tool populates these fields with -1 to
indicate that this a Preferential Node located on the boundary and that it does not have an
associated SinkPoint/catchment. It populates the field IsConnected with 1 to indicate that the node
is connected to a link.
The tool populates the fields FNID and TNID in the Preferential Link feature class with the HydroIDs
12/8/2014
Page 29 of 69
of its associated From Preferential Node and To Preferential Node. It populates the fields FeatureID1
and FeatureID2 with the HydroID of its associated From Catchment and To Catchment, or -1 if there
is no associated catchment (e.g. link from sink point to catchment boundary when there is no
connected HydroEdge).
z
The tool calls the tool Add Linear HydroEdges to Preferential Link to generate the links associated to
the HydroEdges of FType 'Linear Structure'.
Note
No log file is created but instead a warning message is added to the GP messages with the list of Links
in which one of the two merged edges has IsPreferred = 0
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
Sink Point
Role
Field
Type
Description
Required
HydroID
Integer

Used to populate the DrainID field in the Preferential Node
feature class.
Hydro Edge
Role
Field
Type
Description
Required
DrainID
Integer
HydroID of associated Catchment in the Arc Hydro

geodatabase.
Required
FlowDir
Short
Integer
Flow Direction of edges based on associated Preferential

Link. Link will respect this direction if this field is
populated.
Required
IsPreferred
Integer
Set to 1 for a HydroEdge that belongs to a preferential

path. This field may be set by using the tool Define
Overland Preferential Node Link Schema or through manual
edits.
Required
FType
String
Type of HydroEdge (e.g. Boundary Link, Structure Link,

Linear Structure).
Drainage Boundary
Role
Field
Type
Description
Required
HydroID
Integer
Attributes table of Drainage Boundary
Preferential Node
Role
Field
Type
Description
Created
HydroID
Integer

geodatabase.
Created
SinkID
Integer
HydroID of the associated Sink Point. Populated with -1 if

there is no associated Sink Point.
Created
DrainID
Integer
HydroID of the associated Catchment. Populated with -1 if

there is no associated Catchment (i.e. the point is created on
the external Boundary and not on a Sink Point).
12/8/2014
Created
IsConnected
Integer
Page 30 of 69
Indicates whether the node is connected to a path (1) or not

(0).
Preferential Link
Role
Field
Type
Description
Created
HydroID
Integer
Created
IsFlipped
Integer
Indicate whether the flow direction has been flipped.

Initialized with 0 (No) or 1 (Yes).
Created
FNID
Integer
Created
TNID
Integer
Created
FeatureID1
Integer
Created
FeatureID2
Integer
An overview of the Drainage Boundary Processing toolset

The Drainage Boundary toolset contains the following tools:
Tools
Description
Cross Section Direction
Set the orientation of a cross section from left to right when looking in
the digitized direction of the intersecting input Line feature.
Drainage Area
Characterization
Generate elevation, area and volume curves for the input Drainage Area
features.
Drainage Boundary
Definition
Generate 3D boundaries lines for the polygon features in the input

Drainage Area feature class.
Drainage Boundary
Direction
Set the digitized direction of the selected Drainage Boundary lines based
on user-provided Preferential Link line features.
Drainage Boundary
Smoothing
Create new Smooth Drainage Boundary features with jaggy removed by

applying out-of-the-box smoothing algorithms (PEAK) to the input
Drainage Boundary feature class.
Drainage Connectivity
Characterization
Generate network connectivity between drainage areas through lowest

point on the boundaries.
Elevation-Width-Area
Characterization
Compute the width, perimeter and cross-section area associated with

slices of 3D lines and store these characteristics in the output "Boundary
EWA" table.
Station-Elevation
Characterization
Compute Station (Measure)-Elevation for every vertex in the input 3D

line.
Cross Section Direction (Arc Hydro Tools)
12/8/2014
Page 31 of 69
Summary
Sets the orientation of a cross section from left to right when looking in the digitized direction of the
intersecting input Line feature. If there is no intersecting Line feature, the direction of the cross section
will not be modified.
The tool works on a selected set of cross section features. The tool will process all the cross section
Learn more about how Cross Section Direction (Arc Hydro) works
Usage
Syntax
CrossSectionDirection_archydro (in_crosssection_features, in_line_features)
Parameter
Explanation
Data Type
in_crosssection_features
Input cross section feature classes with directions to

set. The tool works on a selected set of Cross Section
features and will process all features if there is no
selected set.
Feature Layer
in_line_features
Input Line features used to set the direction of the

intersecting cross section features. The direction of a
cross section is set from left to right when looking in
the digitized direction of the intersecting input Line
feature.
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Drainage Area Characterization (Arc Hydro Tools)
Summary
Characterizes input areas.
Learn more about how Drainage Area Characterization (Arc Hydro) works
Usage
Syntax
DrainageAreaCharacterization_archydro (in_drainage_area_features, in_terrain_raster,
in_exclusion_area_features, out_eav_table, {extrusion_value}, {slice_count}, {slice_increment},
{overwrite_eav})
Parameter
Explanation
Data Type
Feature Layer
12/8/2014
Page 32 of 69
Input drainage area features to process.

in_terrain_raster
Input DEM.
Raster Layer
in_exclusion_area_features
Optional exclusion areas features defining the areas

that will not be characterized.
Feature Layer
out_eav_table
Output elevation-area-volume table characterizing

the slices.
Table
extrusion_value
Input extrusion value used to create one additional

slice (optional).
Double
Number of slices used for the characterization.
Integer
Height of the slices used for the characterization.
Double
Indicates whether to overwrite the existing

characterizations.
Boolean
(Optional)
slice_count
(Optional)
slice_increment
(Optional)
overwrite_eav
(Optional)
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Drainage Boundary Definition (Arc Hydro Tools)
Summary
Generates 3D boundaries lines for the polygon features in the input Drainage Area feature class and
stores these lines in the output Drainage Boundary 3D polyline feature class (Zs are stored in linear unit
of the terrain). Stores in the output Drainage Connectivity table the HydroID of each boundary lines
together with the HydroIDs of the 2 drainage areas it separates.
The tool works on all features in the input Drainage Areas feature class.
Note: The tool sets the field IsIncluded to 1 for the boundaries adjacent to at
least one "deranged" area, i.e. a drainage area with an internal pit.
These areas are characterized by setting the field IsPitted for the
deranged drainage areas.
The tool "Drainage Connectivity Characterization" relies on IsIncluded
to select the boudaries to process when creating connectivy for
deranged areas.
The tool will create the field IsPitted if it does not exist and it will
populate the field with "1" if all records have Null values.
Learn more about how Drainage Boundary Definition (Arc Hydro) works
Usage
12/8/2014
Page 33 of 69
Syntax
DrainageBoundaryDefinition_archydro (in_drainage_area_features, in_terrain_raster,
out_drainageboundary_features, out_drainconn_table)
Parameter
Explanation
Input Drainage Area feature class which will be
processed. Must contain the fields HydroID. The
field IsPitted will be created and initialized with 1 if
it does not exist.
Data Type
Feature
Layer
IsPitted indicates whether the drainage area

contains a pit and is draining internally
(IsPitted=1).
in_terrain_raster
Input Digital Elevation Model used to retrieve

elevations.
Raster
Layer
out_drainageboundary_features
Output 3D drainage boundary lines associated to

the input Drainage Area features.
Feature
Class
out_drainconn_table
Output Drainage Connectivity table storing the

HydroIDs of the Drainage Area features located on
each side of a boundary line.
Table
Environments
ArcView: No
ArcEditor: No
ArcInfo: Yes
Drainage Boundary Direction (Arc Hydro Tools)
Summary
Sets the digitized direction of the selected Drainage Boundary lines based on user-provided Preferential
Link line features. A Preferential Link is a line feature that connects 2 Drainage Area features and its
direction defines the preferred flowpath between the 2 Drainage Area features. The digitized direction
of a Drainage Boundary line is set from left to right when looking in the digitized direction of the
intersecting Preferential Link feature.
Learn_more_about_how_Drainage_Boundary_Definition_Arc_Hydro_works
Usage
Syntax
DrainageBoundaryDirection_archydro (in_drainageboundary_features, in_drainconn_table,
in_preferentiallink_features, in_drainage_area_features)
Parameter
Explanation
Drainage Boundary lines whose direction will be set
based on the direction of the intersecting
Preferential Link lines. Direction will be set from left
Data Type
Feature
Layer
12/8/2014
Page 34 of 69
to right when looking in the direction of the

intersecting link. The tool works on a selected set
of Drainage Boundary features and will process all
in_drainconn_table
Drainage Connectivity table that will be updated

based on the Preferential Link feature class.
FeatureID1 will be updated with HydroID of the
Drainage Area located on the left of the boundary
line, and FeatureID2 with the HydroID of the
Drainage Area located on its right.
Table
Preferential Link features defining the preferential

flow path direction between 2 drainage areas and
used to set the direction of the Drainage Boundary
lines.
Feature
Layer
Drainage Area feature class used to identify the

areas located to the left and to the right of the
Drainage Boundary line features after assigning the
direction.
Feature
Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Drainage Boundary Smoothing (Arc Hydro Tools)
Summary
Creates new Smooth Drainage Boundary features with jaggy removed by applying out-of-the-box
smoothing algorithms (PEAK) to the input Drainage Boundary feature class. The intent is to generate a
line that will closely represent the true length of the Drainage Boundary feature.
Learn more about how Drainage Boundary Smoothing (Arc Hydro) works
Usage
Syntax
DrainageBoundarySmoothing_archydro (in_drainageboundary_features, smoothing_tolerance,
out_smoothdrainageboundary_features)
Parameter
Explanation
Input Drainage Boundary with 3d line features

to smooth. Tool works on selected set of
Drainage Boundary features or on all features
if there is no selected set.
smoothing_tolerance
Smoothing tolerance used by the PAEK

algorithm. Must be greater than 0.
Data
Type
Feature
Layer
Double
12/8/2014
Page 35 of 69
PAEK: Polynomial Approximation with

Exponential Kernel. Calculates a smoothed line
that will not pass through the input line
vertices.
out_smoothdrainageboundary_features
Output smoothed 3D line feature class.
Feature
Class
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Drainage Connectivity Characterization (Arc Hydro Tools)
Summary
Generates connectivity for deranged terrain through the lowest elevations on the boundaries.
Learn more about how Drainage Connectivity Characterization (Arc Hydro) works
Usage
z
Tool works on selected set of Drainage Boundary features having IsDone set 0 or Null and will
process all features having IsDone=0 or Null if there is no selected set.
Syntax
DrainageConnectivityCharacterization_archydro (in_terrain_raster, in_flow_direction_raster,
in_drainage_area_features, in_drainageboundary_features, in_drainagepoint_features,
in_drainconn_table, out_hydroedge_features, out_hydrojunction_features,
out_boundarydrainageline_features)
Parameter
Explanation
Data Type
in_terrain_raster
Input Digital Elevation Model used to find lowest

cell elevation near the boundary junctions.
Raster
Layer
Input Flow Direction Grid used to generate the

links from the lowest point on the shared
boundaries to the catchment sink or stream
confluence junction.
Raster
Layer
Input drainage area features associated to

drainage boundaries being processed.
Feature
Layer
Input Drainage Boundaruy features being

processed. Tool will process only features having
IsDone=0 or Null.
Input Drainage Point feature class.
in_drainconn_table
Input Drainage Connectivity table storing the

HydroIDs of the drainage boundaries and of the
Feature
Layer
Feature
Layer
Table
12/8/2014
Page 36 of 69
associated drainage areas (-1 for external area).

out_hydroedge_features
Feature
Class
Ouput network edge storing the connectivy

between the drainage areas.
out_hydrojunction_features
Output network junction feature class storing the

connectivity between the areas.
out_boundarydrainageline_features
Feature
Class
Feature
Class
Output boundary drainage lines.
Environments
Elevation-Width-Area Characterization (Arc Hydro Tools)
Summary
Computes the width, perimeter and cross-section area associated with slices of 3D lines and stores
these characteristics in the output "Boundary EWA" table.
Learn more about how Elevation-Width-Area Characterization (Arc Hydro) works
Usage
Syntax
ElevationWidthAreaCharacterization_archydro (in_line_features_3d, out_ewa_table, {extrusion_value},
{slice_count}, {slice_increment}, {zfactor}, {overwrite_ewa})
Parameter
in_line_features_3d
Explanation
Line 3D feature class to characterize. Tool works on a
selected set of Line 3D features and will process all
Data Type
Feature Layer
out_ewa_table
Boundary Elevation-Width-Area table storing the

characteristics of the 3D lines
Table
extrusion_value
Extrusion value. Default to 0. Elevation of the additional

slice added on top of the upper slice. This is usely setup
for modeling purposes. The Z Factor will not be applied
to the extrusion value.
Double
Number of slices to use for the characterization. Default

to 10. Slice Increment is disabled when Slice Count is
enabled and inversely. To enable Slice Count when
disabled, delete the value set for Slice Increment.
Integer
Elevation of each used for the characterization. Default

to 10. Slice Increment is disabled when Slice Count is
enabled and inversely. To enable Slice Increment when
disabled, delete the value set for Slice Count.
Double
(Optional)
slice_count
(Optional)
slice_increment
(Optional)
zfactor
(Optional)
overwrite_ewa
(Optional)
Multiplier applied to the elevations stored in the input

Line 3D features. Default to 1.
Indicates whether to overwrite existing records in the
EWA table.
Double
Boolean
12/8/2014
Page 37 of 69
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Station-Elevation Characterization (Arc Hydro Tools)
Summary
Computes Station (Measure)-Elevation for every vertex in the input 3D line. The tool works on a
selected set of 3D lines and will process all the lines if there is no selected set.
Learn more about how Station-Elevation Characterization (Arc Hydro) works
Usage
Syntax
StationElevationCharacterization_archydro (in_line_features_3d, measure_format, out_se_table,
{zfactor}, {use_m}, {overwrite_se})
Parameter
Explanation
Data Type
in_line_features_3d
Line 3D features to process. The tool works on a selected Feature Layer

set of 3D Line features and will process all the features if
there is no selected set.
measure_format
Format that may be selected to save the measures in the String

output SETable. One or multiple formats may be
specified and the corresponding field will be created and
populated in the output table.
out_se_table
Station Elevation Table associated to the input 3D Line

feature class. Stores the HydroID of the associated line
as well as the elevation and measure of each vertex of
the line.
Table
zfactor
Multiplier applied to the elevations retrieved from the 3D

Line features.
Double
(Optional)
use_m
(Optional)
overwrite_se
(Optional)
Boolean
Indicates whether to retrieve the measures from the M
values already defined in an input Polyline 3DM feature
or whether to recompute them on the fly for each vertex.
Indicates whether to overwrite existing records
associated to the selected Input Line 3D in the output
Station Elevation table.
Boolean
Environments
ArcView: Yes
12/8/2014
Page 38 of 69
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Cross Section Direction (Arc Hydro) works
Sets direction of cross section lines based on direction of intersecting boundaries.
Learn more about how Drainage Area Characterization (Arc Hydro) works
The Drainage Area Characterization tool (Terrain Morphology menu) generates elevation, area and volume
curves for a set of selected drainage areas. The function divides each drainage area into slices and
calculates each slice's elevation characteristics, as well as the cumulative area and volume that are below
the elevation of the top of the slice. These characteristics are stored in an output Drainage EAV table. The
function works with a selected set of drainage areas or with all drainage areas within the input feature class
Note: Areas that have already been processed will be reprocessed if they are
part of the selected set, or if there is no selected set.
The elevation may be retrieved either from a grid (DEM) or from a TIN. The type of data to use for this
extraction is defined using the Data Management Terrain Morphology function in the Terrain Morphology
menu.
Input
Output
"Drainage EAV" table
"Terrain Grid" or "Terrain TIN"

"Exclusion Area" Feature Class
Extrusion value (in linear units)
Number of slices or Incremental elevation per slice (in linear units)
Note
When specifying a strictly positive extrusion value, one additional slice will be created.
If there is a polygon feature class that has a tag "Drainage Area", it will be used as a default for the first
Required field: HydroID
Fields created:
z
MinElev: Minimum elevation for the drainage area in XY unit
MaxElev: Maximum elevation for the drainage area in XY unit
12/8/2014
Page 39 of 69
IsPitted: created empty. Indicates whether the drainage area contains a pit (1). Required by the
functions Drainage Boundary Characterization and Drainage Connectivity Characterization.
IsDone: Indicates whether the drainage area was successfully processed (1) or not (-1).
If there is a grid theme that has a tag "Terrain Grid" or a TIN theme that has a tag "Terrain Grid", it will be
used as a default for the input grid or TIN. If not, the user needs to select an existing grid or TIN theme
that will be tagged at the end of the operation.
If there is a polygon feature class that has a tag "Exclusion Area", it will be used as a default for the third
input theme. This input is optional and may be set to "Null". To set this input, the user needs to select an
existing polygon feature class that will be tagged with the "Exclusion Area" tag at the end of the operation.
If there is a table that has a tag "Drainage EAV", it will be used as a default for the output Drainage
Elevation Area Volume table. The function will clear all existing record in the table associated to the
drainage areas being processed.
Fields created:
z
FeatureID: HydroID of the corresponding drainage area
BottomElev: Bottom elevation of the slice in XY unit
TopElev: Top elevation of the slice in XY unit
SlcElev: Middle elevation of the slice, i.e. (top + bottom)/2 in XY unit
CumArea: Area of the drainage area having an elevation that is less than or equal to the top elevation
of the slice.
CumVolume: Volume of water needed to fill the drainage area up to the top elevation of the slice.

z
Select the drainage areas to characterize (all areas will be processed if there is no selection).
Select Terrain Morphology > Drainage Area Characterization.
Select the input Terrain (Grid or TIN) containing the elevation values. If the wrong type of elevation
data is requested, close the window and use the Data Management function to modify the type of
Terrain data to use.
Select the Exclusion Area feature class (optional) defining the locations that need to be excluded when
computing the characteristics.
Specify a positive extrusion value in XY units (optional - default to 0, no extrusion). Whenever a

positive value is specified, the function creates one additional record in the output EAV table that
characterizes the slice ranging from the top elevation of the drainage area to the top elevation +
extrusion value. This additional slice may be required for modeling.
Specify the number of slices (Slice count) to create for each drainage area or the incremental
elevation (in XY units) to use to define the slices. Note that in addition to these slices, one initial slice
will be created to characterize the bottom of the drainage area and, optionally, one additional slice
may also be created if a positive extrusion value is specified.
slice count: each drainage area will be divided into the selected number of slices having the same
equal incremental elevation. The incremental elevation will be computed by the function and will be
different for each drainage area.
slice increment: each drainage area will be divided into slices having the specified incremental
elevation. The number of slices will vary for each drainage area.
Enter the name of the output Elevation Area Volume (EAV) table (default name: DrainEAV). If the
table already exists, records corresponding to areas already processed will be overwritten in the table,
whereas records for newly processed areas will be appended. Click OK.
The function performs the following actions:

z
Check that the following fields exist in the Attributes table of Drainage Area and create these fields if
not found:
MinElev: Minimum elevation of the drainage area.
12/8/2014
Page 40 of 69
MaxElev: Maximum elevation of the drainage area.
IsPitted: Indicate whether the drainage area has an internal pit. This field must be populated before
using the Drainage Boundary Characterization function and the Drainage Connectivity Characterization
function.
IsDone: Indicate whether the drainage area was successfully processed (1) or not (-1) by the
Drainage Area Characterization function.
Check whether the output DrainEAV table exists and create the table if not found. The table is visible
in the Source tab in the Table of Contents of ArcMap.
Check whether the output DrainEAV already contains records associated to the drainage areas being
processed and delete these records (i.e. old records will be overwritten). The FeatureID in the
DrainEAV table stores the HydroID of the corresponding drainage area.
Update the fields MinElev, MaxElev in the input Drainage Area feature class.
Create records in the output DrainEAV table to characterize each slice of the drainage area.
Update the field IsDone in the input Drainage Area feature class (1: success, -1: failure).
Report the number of features successfully processed and the number that failed (i.e. IsDone = -1)
The function computes and stores in the attributes table of the input Drainage Area feature class the
minimum and maximum elevation for each selected drainage area. The field IsDone is populated with
1 if the drainage area is successfully processed and -1 otherwise.
How to setup the tool

Default values for the following parameters may be set in the XML under the node
FrameworkConfig/HydroConfig/ProgParams/ApFunctions/ApFunction (DrainageAreaCharacterization):
z
IsDefinedBySliceCount: Indicate whether the slices are defined based on an increment (True or 1) or
based on number of slices (False or 0).
SliceIncrement: Default incremental elevation used when defining slice based on slice increment.
SliceCount: Default number of slices used when defining slices with Slice count.
Extrusion: Default extrusion value.
Learn more about how Drainage Boundary Definition (Arc Hydro) works
The Drainage Boundary Definition tool generates 3D boundaries lines for selected drainage areas and stores
these lines in the output "Drainage Boundary" 3D polyline feature class (Zs are stored in linear unit of the
terrain). The tool stores in the output "Drainage Connectivity" table the HydroID of each boundary lines
together with the HydroIDs of the 2 drainage areas it separates.
Input/Output
Input
Output
"DEM" Grid
"Drainage Connectivity" Table
If there is a "Drainage Area" feature class that has a tag "Drainage Area", it will be used as a default for
12/8/2014
Page 41 of 69
the input feature class. If not, the user needs to select an existing polygon feature class that will be
tagged with the "Drainage Area" tag at the end of the operation.
If there is a grid that has a tag "DEM", it will be used as a default for the input grid. If not, the user
needs to specify a grid that will be tagged with the "DEM" tag at the end of the operation.
The tool operates on all features in the input Drainage Area polygon feature class.
Note:
Drainage areas with internal pits need to be characterized as such before running this function by
setting the attribute "IsPitted" to 1 in the deranged input Drainage Area feature class and 0 in the
dendritic areas. This is required because only the boundary lines associated to pitted drainage areas will
be processed by the tool Elevation-Width-Area Characterization and the tool Drainage Connectivity
Characterization.
If the field IsPitted does not exist, the tool will create it.
If the field IsPitted contains only Null values for all records, the tool will initialize it with "1" for all
records, i.e. all areas will be considered "deranged".
Drainage Area
Role
Field
Type
Description
Required
HydroID
Integer

geodatabase.
Created/Populated
IsPitted
Integer
Indicates whether the drainage area contains a pit

and is draining internally (IsPitted=1). Tool will create
the field and populate it with 1 if it is Null for all
records.
Attributes table of Drainage Area
The tool generates the boundaries as 3D lines with measures (Polyline ZM).
Drainage Boundary
Role
Field
Type
Description
Created
HydroID
Integer
Created
MinElev
Double
Minimum elevation along the drainage boundary in XY unit.
Created
MaxElev
Double
Maximum elevation along the drainage boundary in XY unit.
Created
IsIncluded
Integer
Indicates whether the line borders at least one drainage area

with a pit (i.e. IsPitted=1).
Created
IsDone
Integer
Indicates whether the line has been processed (1) by the

function Drainage Connectivity Characterization. Populated
with 0 (not processed).
Drainage Connectivity
Role
Field
Type
Description
Created
FeatureID
Integer
HydroID of the associated Drainage Boundary line feature.
Created
FeatureID1
Integer
HydroID of the first Drainage Area bordered by the

associated Drainage Boundary line feature. A value of -1
indicates that this is an external boundary.
Created
FeatureID2
Integer
HydroID of the second Drainage Area bordered by the

associated Drainage Boundary line feature. A value of -1
indicates that this is an external boundary.
Created
ConnectType
String
Type of connection between the 2 drainage areas. Set to
12/8/2014
Page 42 of 69
"Boundary" by the tool.

Attributes table of Drainage Connectivity
Learn more about how Drainage Boundary Direction (Arc Hydro) works
Sets digitized direction of Drainage Boundaries feature based on input preferential links.
Learn more about how Drainage Boundary Smoothing (Arc Hydro) works
Creates new Smooth Drainage Boundary features with jaggy removed by applying out-of-the-box
smoothing algorithms (PEAK) to the input Drainage Boundary feature class. The intent is to generate a line
that will closely represent the true length of the Drainage Boundary feature.
Learn more about how Drainage Connectivity Characterization (Arc Hydro)

works
The Drainage Connectivity Characterization tool (Terrain Morphology) generates information about the
connectivity through a shared boundary between a pitted (i.e. non dendritic) drainage area and another
drainage area that may be either pitted or dendritic.
The tool works on a selected set of Drainage Boundary features or on all features if there is no selected set.
It will process the selected Drainage Boundary lines that are characterized with IsIncluded=1 and
IsDone=0 in the attributes table of the Drainage Boundary feature class.
The tool identifies the lowest elevation on the shared boundary between the areas and generates links
through that location from the pitted area sink point to the other area sink point (pitted) or outlet
(dendritic).
The tool stores the lowest location on the boundary as a new HydroJunction of FType 'Boundary Node' and
stores its elevation in the Elev field.
The tool creates new Hydro Junctions of FType 'Sink Node' in the pitted drainage area.
Note: The outlet HydroJunctions associated to the dendritic drainage areas
must already exist and their HydroID must be in the JunctionID field of
the associated area. The tool Hydro Network Generation may be used to
generate dendritic network and populate the field JunctionID in the
drainage area before using the current tool.
The tool performs a trace from the new Boundary Node HydroJunction within each drainage area and
generates 2 HydroEdge features of FType 'Boundary Link' that originate at the HydroJunction and ends in
each drainage area 'Sink Node' or outlet HydroJunction.
12/8/2014
Page 43 of 69
The tool generates as well 2 Boundary Drainage Line features with the same geometry as the HydroEdges
and links them back to the associated boundary by storing the HydroID of the boundary in the LinkID field.
Input/Output
Input
Output
"DEM" Grid
"Boundary Drainage Line"" Feature Class

"Drainage Connectivity" Table
If there is a grid theme that has a tag "DEM Grid", it will be used as a default for the input grid. If not, the
user needs to select an existing grid that will be tagged at the end of the operation.
If there is a grid theme that has a tag "Flow Direction Grid", it will be used as a default for the input grid. If
not, the user needs to select an existing grid theme name that will be tagged with the "Flow Direction Grid"
If there is a polygon feature class that has a tag "Drainage Area", it will be used as a default for the second
12/8/2014
Page 44 of 69
Required fields:
z
IsPitted: Indicates whether the drainage area contains a pit and is an internally draining area
(IsPitted=1).
Field created:
z
JunctionID: HydroID of the related Hydro Junction in a dendritic network. Created empty if does not
exist.
If there is a theme that has a tag "Drainage Boundary", it will be used as a default for the input line feature
class. If not, the user needs to specify a feature class name that will be tagged with the "Drainage
Boundary" tag at the end of the operation.
Required field:
z
HydroID: Unique identifier of the Drainage Boundary feature in the geodatabase.
IsIncluded: Indicates whether the line is the boundary of a drainage area with a pit (i.e. IsPitted=1).
Field created:
z
IsDone: Indicates whether the line has already been processed (1).
If there is a point feature class that has a tag "Drainage Point", it will be used as a default for the input
point feature class. If not, the user needs to specify a point feature class name that will be tagged with the
"Drainage Point" tag at the end of the operation.
Fields created:
z
DrainID: HydroID of the associated drainage area.
If there is a table that has a tag "Drainage Connectivity", it will be used as a default for the input Drainage
Connectivity table. If not, the user needs to specify table name that will be tagged with the "Drainage
Connectivity" tag at the end of the operation.
Required fields:
z
FeatureID: HydroID of the corresponding boundary line
FeatureID1: HydroID of the drainage area to the left of the boundary line
FeatureID2: HydroID of the drainage area to the right of the boundary line
If there is a theme that has a tag "Hydro Edge", it will be used as a default for the output complex edge
feature class. If not, the user needs to specify a feature class name that will be tagged with the "Hydro
Edge" tag at the end of the operation. The new features will be appended to the existing feature class.
Fields created:
z
DrainID: Unique identifier of the associated drainage area.
FType: Feature Type. Default to "Boundary Link".
Uninitialized flow direction.
EdgeType: Type of Edge (Associated domain: HydroEdgeType). Available values are Flowline and
Shoreline. Default to Flowline.
(Associate domain: EnabledDomain). A feature that is disabled in the network acts as a barrier when
If there is a theme that has a tag "Hydro Junction", it will be used as a default for the output network
junction feature class. If not, the user needs to specify a feature class name that will be tagged with the
"Hydro Junction" tag at the end of the operation. The output feature class, if it already exists, is
12/8/2014
Page 45 of 69
automatically overwritten without prompting the user.

Fields created:
z
NextDownID: HydroID of the next downstream Hydro Junction.
FType: Feature type of the Hydro Junction: Dendritic junctions have this field populated with Stream
Confluence, Drainage Outlet, Drainage Inlet for beginning of streams (for the entire drainage area
considered). The tool will create new junctions with FType set to 'Sink Node' or 'Boundary Node'.
SchemaRole: Indicate whether the junction will be used by the function Node/Link Schema Generation
to create the schema. (0: not used for Drainage Inlet, 1: used for Drainage Outlet and Stream
Confluence).
AncillaryRole: Specify whether the feature represents a source, sink or neither. Used to calculate the
flow direction in the geometric network (Associated domain: AncillaryRoleDomain with values 1:
Source, 2: Sink (Drainage Outlet), 0: None)).
(Associated domain: EnabledDomain). A feature that is disabled in the network acts as a barrier when
JUNCTION_PLACEMENT_DESC: Placement method used for the HydroJunction. Populated with value
"AH" - ARCHYDRO.
HYDRAULIC_TYPE_DESC: Hydraulic type of the HydroJunction. Populated with value "STOR" (Storage)
for Sink Nodes and "NO" (Natural Overflow) for Boundary Nodes.
If there is a theme that has a tag "Boundary Drainage Line", it will be used as a default for the output line
feature class. If not, the user needs to specify a feature class name that will be tagged with the "Boundary
Drainage Line" tag at the end of the operation.
Fields created:
z
DrainID: HydroID of the related drainage area.
FType: Feature Type. Populated with "Boundary Link".
How the tool works

For each selected drainage boundary:
1.
Retrieve HydroID, IsIncluded and IsDone for the Drainage Boundary feature being processed.
2.
Check whether IsIncluded = 1 and (IsDone = 0 or IsDone is null) for the Drainage Boundary
feature. Proceed only if these conditions are met otherwise start processing the next drainage
boundary feature.
z
IsIncluded = 1 (i.e. borders a pitted drainage area: this field is populated by the function
Drainage Boundary Definition based on the value of the field IsPitted in the Drainage
Area feature class)
z
IsDone = 0 or null (otherwise already been processed - to reprocess a boundary line,

this field needs to be reset to 0 or null)
3.
Retrieve the record associated to this drainage boundary in the Drainage Connectivity table,
i.e. FeatureID = HydroID of the Drainage Boundary being processed.
4.
Identify and retrieve the 2 drainage areas on each side of the line by looking for features in
the input Drainage Area feature class having a HydroID equal to FeatureID1or FeatureID2.
5.
Identify the point with the lowest elevation along the boundary line. If there is more than one
point at the lowest elevation, the function uses the last point found along the drainage
boundary line.
Find the neighboring cell within each area with the lowest elevation.
12/8/2014
Page 46 of 69
Generate the flow path from the cell found in the previous step for each of the two drainage areas.
Extend each flow path so that it starts from the lowest point on the boundary.
Look for an existing HydroJunction associated to each drainage area. For dendritic drainage areas,
the JunctionID field in the drainage area (catchment) feature class is populated with the HydroID of
the associated HydroJunction when the Hydro network is generated for the dendritic network. If a
HydroJunction is found, the function moves the To-Point of the flow path defined for that area to this
HydroJunction. The From-Point for each flow path is the point previously characterized as the lowest
point along the boundary.
If there is no existing HydroJunction, check whether the drainage area has a pit (IsPitted = 1). If it
does, look for the associated Drainage Point and make it the To-Point of the flow path.
Check whether a HydroJunction already exists at the location of the From-Point located on the
boundary. If not, create the HydroJunction with the following attributes:
NextDownID: HydroID of the next downstream junction. Set to Null.
FType: Boundary Node.
SchemaRole: 1.
AncillaryNode: 0.
Enabled: 1.
JUNCTION_PLACEMENT_DESC: AH
HYDRAULIC_TYPE_DESC: NO
Check whether HydroJunctions already exist at the location of the two To-Points. If not, create the
junction(s) with the following attributes:
NextDownID: HydroID of the next downstream junction. Set to -1 (no downstream junction) if
IsPitted=1 for the corresponding drainage area.
FType: Sink Node.
SchemaRole: 1.
AncillaryNode: 0.
Enabled: 1.
JUNCTION_PLACEMENT_DESC: AH
HYDRAULIC_TYPE_DESC: STOR
Create HydroEdge of type "Boundary Link" to represent the link in the network. The HydroEdge will
be populated as follows:
DrainID: HydroID of the drainage area where the link is located.
FType: Boundary Link.
FlowDir: 0 (Uninitialized).
EdgeType: 1 (Flowline).
Enabled: 1.
Create the Boundary Drainage Line associated to the link and populate the following attributes:
DrainID: HydroID of the associated Drainage Area.
FType: Feature Type. Populated with "Boundary Link".
Set IsDone = 1 for the Drainage Boundary feature.
Notes
12/8/2014
Page 47 of 69
The geometric network itself will not be created by the function if it does not already exists (may be
created by the tool Hydro Network Generation). In this case, the network needs to be created manually
in ArcCatalog.
The function will not set the flow direction to the new features created in an existing geometric network.
You need to run the tool Set Flow Direction to set the flow direction.
Database structure
Drainage Boundary
Role
Field
Type
Description
Required
HydroID
Integer

geodatabase.
Required
IsIncluded
Short
Integer
Indicates whether the feature should be

processed and links crossing the boundary should
be generated.
Created/Populated
IsDone
Short
Integer
Indicates whether the feature has been processed

(1) or needs to be processed (0 or Null or field
not existing).
Drainage Area
Role
Field
Type
Description
Required
HydroID
Integer

geodatabase.
Created/Populated
JunctionID
Integer
HydroID of HydroJunction feature associated to

Drainage Area.
Required
IsPitted
Integer
Indicates whether the catchment is dendritic (0 or

Null) or deranged (1).
Attributes table of Drainage Area
Drainage Point
Role
Field
Type
Description
Required
DrainID
Integer
HydroID of Unique identifier of the feature in the Arc Hydro

geodatabase.
Attributes table of Drainage Point
DrainConn Table
Role
Field
Type
Description
Required
FeatureID
Integer

geodatabase.
Required
FeatureID1
Integer
HydroID of catchment located on one side of the boundary.
Required
FeatureID2
Integer
HydroID of catchment located on the other side of the

boundary.
Attributes table of DrainConn Table
HydroJunction
Role
Field
Type
Description
Created/Populated
HydroID
Integer
the feature in the Arc
Hydro geodatabase.
Created/Populated
NextDownID
Integer
HydroID of the next
12/8/2014
Page 48 of 69
downstream
Junction. Populated
with -1 for sinks or
most downstream
junctions.
Created/Populated
FType
String
Feature type of the

junction. Populated
by the tool with Sink
Node or Boundary
Node.
Created/Populated
Enabled
Short
Integer
Indicates whether
the feature is
enabled in the
geometric network.
Created/Populated
AncillaryRole
Short
Integer
Role of the junction

in the geometric
network (source,
sink, none - 0).
with None (0).
Created/Populated
SchemaRole
Short
Integer
Indicates whether
the junction should
be used when
creating a schema
using the tool
Node/Link Schema
Generation.
Created/Populated
Junction_Placement_Desc
String
Describes how the

junction was created.
Populated with
'AH' (Arc Hydro).
Created/Populated
Hydraulic_Type_Desc
String
Hydraulic Type of the

junction. Populated
with 'STOR' (storage)
for sink nodes and
'NO' (Natural
Overflow) for
Boundary Node.
Created/Populated
Elev
Double
Elevation of the
junction. Populated
for the Boundary
Node
HydroJunctions.
Attributes table of HydroJunction
HydroEdge
Role
Field
Type
Description
Created/Populated
HydroID
Integer

geodatabase.
Created/Populated
DrainID
Integer
HydroID of the drainage area associated to the

edge feature.
Created/Populated
FlowDir
Short
Integer
Flow direction field storing a default flow direction

that may be assigned to the network using the tool
Set Flow Direction. Populated with
'0' (Uninitialized).
Created/Populated
FType
String
Feature type of the HydroEdge. Populated with

'Boundary Link'.
12/8/2014
Page 49 of 69
Created/Populated
EdgeType
Short
Integer
Edge type. Populate with '1' (Flowline).
Created/Populated
Enabled
Short
Integer
Indicates whether the edge is enabled in the

network. Enabled by default.
Attributes table of HydroEdge
Boundary Drainage Line

Role
Field
Type
Description
Created/Populated
LinkID
Integer
HydroID of the associated Drainage Boundary feature.
Created/Populated
DrainID
Integer
HydroID of the associated drainage area.
Created/Populated
FType
String
Type of the feature. Populated with 'Boundary Link'.
Attributes table of Boundary Drainage Line
Learn more about how Elevation-Width-Area Characterization (Arc Hydro)

works
Computes the width, perimeter and cross-section area associated with slices of 3D lines and stores the
characteristics in the output "Boundary EWA" table.
Input/Output
Input
Output
"Line 3D" Feature Class
"Boundary EWA" Table
Line 3D
Role
Field
Type
Description
Required
HydroID
Integer
The tool generates the output Boundary EWA table if it does not already exist and populates it with the
characteristics of the slices for each
Boundary EWA
Role
Field
Type
Description
Created
FeatureID
Integer
HydroID of the Line 3D feature associated to this record.
Created
BottomElev
Double
Created
TopElev
Double
Created
SlcElev
Double
Created
SlcWidth
Double
Created
SlcArea
Double
Created
CumArea
Double
Created
SlcPerimeter
Double
12/8/2014
Page 50 of 69
Learn more about how Station-Elevation Characterization (Arc Hydro) works

The Station-Elevation Characterization tool computes the Station (Measure)-Elevation for every vertex in
the input 3D line. The tool works on a selected set of 3D Line features and will process all features if there
is no selected set.
The function stores in the output "Station Elevation" table the HydroID of the associated 3D Line feature
together with the elevation and measure of each vertex along the line.
Input/Output
Input
Output
"Line 3D" Feature Class
"Station Elevation Table"
Line 3D
Role
Field
Type
Description
Required
HydroID
Integer
Station Elevation Table

Role
Field
Type
Description
Created FeatureID
Integer HydroID of the associated Line 3D feature.
Created Elevation
Double
Elevation at the vertex located at the measure of the associated

line
Created StationMPct
Double
Measure defining the position of the vertex as a percentage of the

length of the line.
StationMFra
Double
Measure defining the position of the vertex as a fraction of the

length of the line.
StationMLen Double
Measure defining the position of the vertex as a distance along the

line.
An overview of the Grouping toolset

The Grouping toolset provides a set of tools that allow capturing the most important elements in the
extended network and storing them in new Group Feature Classes (Group Junctions, Group Basins, Group
Links) to create a simplified connectivity for modeling (e.g. modelling in ICPR).
The Grouping toolset contains the following tools:
Tools
Description
Generate Group Basin features by dissolving the input

Catchment features based on the field GroupID.
12/8/2014
Page 51 of 69
Create a new Group Junction feature class by

reselecting from HydroJunctions the ones that meet
one of the grouped junction criteria.
Generate Group Link
Create a new Group Link feature class that establishes

the connectivity between the Group Basins based on
Group Junctions and Group Flow Direction.
Assign a unique 'GroupID' to selected Catchments.
Modify Terminal Sink in Group Basin
Update Preferential Links, HydroEdges as well as

Catchments and Sink Points to match the new terminal
sinks in the Group Basins.
Remove Duplicate Terminal Sinks from

Group Basin
Update IsPreferred field for HydroEdges located in

duplicate terminal catchments and update associated
preferential paths so that each group has only one
terminal catchment.
Select Upstream Catchments Using

Preferential Link
Assign the same GroupID to the catchments located

upstream of the processed catchment based on
Preferential Link connectivity.
Ungroup selected Catchments by setting their

'GroupID' field to 'Null'.
Summary of the tools in the Grouping toolset
The tools should be used in the following sequence:

1.
Create initial grouping: Select Upstream Catchments Using Preferential Link
2.
Update grouping:
z
Select Upstream Catchments Using Preferential Link
z
3.
4.
Optional: Remove Duplicate Terminal Sinks from Group Basin (after manual grouping if
duplicate terminal sinks have been created) and Generate Group Basin
5.
Optional: Modify Terminal Sinks in Group Basin
6.
7.
Generate Group Link
Generate Group Basin (Arc Hydro Tools)
Summary
Dissolves input Catchment features based on the GroupID attribute and stores the resulting dissolved
polygons in the output Group Basin feature class. Identifies the terminal (i.e. destination) Catchment
and Sink Point features associated to each Group Basin and populates their attribute IsTerminal with 1.
Populates the field IsPitted to indicate whether the Group Basin is deranged (1) or dendritic (0).
Learn more about how Generate Group Basin (Arc Hydro) works
Usage
12/8/2014
Page 52 of 69
The tool processes all input Catchments and ignores the selection set.
The tool resets the fied IsTerminal in the Catchment and Sink Point feature class.
Syntax
GenerateGroupBasin_archydro (in_catchment_features, in_preferentiallink_features,
in_sinkpoint_features, out_groupbasin_features)
Parameter
Explanation
Data Type
Input Catchment. Required fields: HydroID, GroupID. Feature Layer

Tool processes all input Catchment features and
ignore the selection set (if any). The tool dissolves
the Catchment features using GroupID and stores
the resulting polygon features in the output Group
Basin feature class. The tool also populates the field
IsTerminal with 1 in the terminal (destination)
Catchments and Sink Points.
Input Preferential Link. Required field: FeatureID1,

FeatureID2. Used to identify the terminal Catchment
and Sink Point feature associated to each Group
Basin.
Feature Layer
Input Sink Point. Tool will create and populate the

field IsTerminal with 1 to identify the terminal Sink
Point features.
Feature Layer
Output Group Basin polygon feature class generated

by dissolving the input Catchment features based on
the GroupID field. The HydroID of the Group Basin is
populated with the GroupID from the associated
Catchments. The field IsPitted indicates whether the
Group Basin is deranged (1) or dendritic (0).
Feature Class
out_groupbasin_features
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Generate Group Junction (Arc Hydro Tools)
Summary
Creates a new Group Junction point feature class by reselecting from Hydro Junction features that meet
one of the following criteria:
z
Hydro Junction features located on a Group Basin boundary between 2 group basins with at least
one of the 2 having IsPitted = 1 (i.e. deranged) and having a Hydraulic Type set to Bridge
("BRID"), Culvert ("CULV"), Cross Section ("CS"), Dam ("DAM"), Levees ("LEV") (default structures
list read from the configuration XML), or Natural Overflow ("NO"). The field IsPitted is populated by
the tool Generate Group Basin. The Natural Overflow junctions (or Boundary Node) may be created
with the tool Drainage Connectivity Characterization.
12/8/2014
Page 53 of 69
Hydro Junction features located under the terminal sink point associated to the Group Basin. This
sink point is identified by the tool Generate Group Basin that assigns the value 1 in the field
IsTerminal.
Dendritic Hydro Junction features within the Group Basin having FType= "Drainage Inlet",
"Drainage Outlet" or "Stream Confluence". These junctions are created by the tool Hydro Network
Generation.
The tool processes all Group Basin features in the input Group Basin feature class.
Learn more about how Generate Group Junction (Arc Hydro) works
Usage
Syntax
GenerateGroupJunction_archydro (in_groupbasin_features, in_hydrojunction_features,
in_sinkpoint_features, out_groupjunction_features)
Parameter
Explanation
Data Type
Input Group Basin. Tool works on all features in

Group Basin feature class and will update the field
IsPitted.
Feature Class
Input Hydro Junction. The junctions meeting one of

the grouped junction criteria are copied into the
output Group Junction feature class.
Input Sink Point. Used to locate the terminal sink

point associated to the Group Basin and identify
associated Hydro Junction that will be copied into the
output Group Junction feature class with a FType of
"SINK".
Feature Layer
out_groupjunction_features
Output Group Junction. Stores Hydro Junction

features that meet one of the group junction criteria.
Feature Class
Feature Class
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Generate Group Link (Arc Hydro Tools)
Summary
Creates Group Node and Group Link feature classes that establish the connectivity between Group
Basins based on Group Junctions and Hydro Network. Group Links connects the Group Sinks or
dendritic outlets of adjacent Group Basins via the lowest Group Junctions located on the Group Basin
boundaries and via Group Junction structures located on the shared boundaries. It is a preferred
connectivity, similar to the preferential path, at the Group Basin level.
Learn more about how Generate Group Link (Arc Hydro) works
12/8/2014
Page 54 of 69
Usage
Syntax
GenerateGroupLink_archydro (in_groupjunction_features, in_groupbasin_features,
in_hydrojunction_features, in_hydroedge_features, in_catchment_features, in_preferentiallink_features,
out_groupnode_features, out_grouplink_features)
Parameter
Explanation
Data Type
in_groupjunction_features
Input Group Junction. Required field: FType, Elev.

Tool processes the Group Junction having
FType="Stream Confluence" within the Group Basins
and Group Junctions of any type along the
boundaries (lowest elevation). It may create new
Group Junctions of FType "Confluence" if a new
traced Link intersects an existing Group Link feature.
Feature Class
Input Group Basin. Required fields: HydroID,

IsPitted. HydroID is used to populate the field
DrainID in the output Group Link feature class.
Feature Class
Input Hydro Junction features

Input Hydro Edge features
Feature Class
Feature Class
Input Catchment features
Feature Class
Input Preferential Link features
Feature Class
out_groupnode_features
out_grouplink_features
Output Group Node.

Output Group Link. DrainID stores the HydroID of
the related Group Basin feature for dendritic links.
Feature Class
Feature Class
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Group Selected Catchments (Arc Hydro Tools)
Summary
Assigns a unique GroupID for selected Catchments. The selection may be created manually or using the
tool Select Upstream Catchments Using Preferential Node Link.
Learn more about how Group Selected Catchments (Arc Hydro) works
Usage
Syntax
GroupSelectedCatchments_archydro (in_catchment_features, {overwrite_group})
12/8/2014
Parameter
Explanation
Page 55 of 69
Data Type
Input Catchment. Required field: HydroID. Tool works

on selected set of Catchment features or on all features
Feature Layer
overwrite_group
Indicates whether to overwrite the existing GroupIDs.
Boolean
(Optional)
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Modify Terminal Sink in Group Basin (Arc Hydro Tools)
Summary
Update preferential links and nodes, hydroedges as well as sink point and catchments to match the
specified terminal sink in each group basin.
The tool works as follows:
1.
It identifies the group basins with new terminal sinks and selects the original and new
terminal sink catchments.
2.
It looks for the preferential links connecting the original and new terminal sinks in each group
basin that needs to be processed.
3.
It runs the tool Flip Preferential Path on those links so that both the Preferential Links and
their associated HydroEdges are correctly updated.
4.
It updates the field IsTerminal in the SinkPoint and Catchment feature classes to reflect the
new terminal sinks.
Usage
z
Tools works on entire Catchment feature class and ignores any selection set.
New terminal sink Catchments must have the field IsNewTerminal populated with the value 1.
Tool must be run after the Generate Group Basin tool that identifies the terminal catchments/sinks
and after the tool Remove Duplicate Terminal Sinks from Group Basin if the Group Basin feature
class generated contains duplicate terminal sinks.
The Generate Group Basin tool does not need to be rerun after this tool. The terminal Catchments
and Sinks will have the field IsTerminal correctly populated.
Syntax
ModifyTerminalSinkinGroupBasin_archydro (in_groupbasin_features, in_catchment_features,
in_sinkpoint_features, in_hydroedge_features, in_preferentiallink_features)
Parameter
Explanation
Input Group Basin features generated based on the
Data Type
Feature Layer
12/8/2014
Page 56 of 69
current GroupID values in the input Catchment

feature class.
Input Catchment features. The field IsTerminal must

have been populated first by running the tool
Generate Group Basin and the field IsNewTerminal
must have been manually populated. Catchments
having IsNewTerminal = 1 will be used to set the
new terminal sinks.
Feature Layer
Input Sink Point features associated to the

Catchments.
Feature Layer
Input HydroEdge features that will be edited to the

match the new terminal sinks.
Feature Layer
Input Preferential Link feature class that will be

updated in the duplicate terminal catchments to
reflect the new preferred edges.
Feature Layer
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Remove Duplicate Terminal Sinks from Group Basin (Arc Hydro Tools)
Summary
Ensures that each Group Basin contains only one terminal sink identified using the junction with the
lowest elevation along the catchments' boundaries. The tool updates the HydroEdge features and
associated preferential path features so that that the duplicate terminal catchments cab "flow" into the
real terminal catchment defined within each Group Basin.
The tool works as follows:
1.
It identifies the group basins containing multiple terminal catchments as well as the duplicate
terminal catchments and creates a copy of the catchments located within the Group Basin to
process.
2.
It identifies the "real" terminal sink catchment in each Group Basin with duplicates terminal
sinks as the one having the lowest Boundary Node HydroJunction.
3.
It identifies and selects the incorrect terminal catchments and populates their attribute
IsTerminal with -1.
4.
It groups these catchments with all their upstream catchments based on the Preferential
Links. Catchments that are not selected are already correctly grouped with the "real" terminal
sink.
5.
It looks for the lowest Boundary Node HydroJunctions located on the boundaries between the
wrong duplicate terminal catchments and the catchments correctly grouped with the real
terminal catchment.
6.
It identifies in the input Drainage Connectivity table the records associated the 'Boundary'
12/8/2014
Page 57 of 69
connection linking the catchments connecting through the identified junction.

7.
It identifies the Boundary Drainage Line features associated to the connection and their
corresponding HydroEdge features having IsPreferred equal to 0 or Null.
8.
It populates the field IsPreferred with 1 for these HydroEdge features.
9.
It selects the incorrect terminal Catchment features and runs the tool Update Preferential
Path on these catchments wrong duplicate terminal catchments to update the Preferential
Link and Node features.
Usage
z
Tools works on entire catchment feature class and ignores any selection set.
Tool must be run after the Generate Group Basin tool that identifies the terminal catchments/sinks
for the current grouping.
The Generate Group Basin tool must be rerun after this tool to update the terminal Catchments
and Sinks based on the updated preferential paths.
Syntax
RemoveDuplicateTerminalSinksfromGroupBasin_archydro (in_groupbasin_features,
in_catchment_features, in_sinkpoint_features, in_hydroedge_features, in_drainageboundary_features,
in_boundarydrainageline_features, in_drainageconn_table, in_terrain_raster,
out_preferentialnode_features, out_preferentiallink_features)
Parameter
Explanation
Data Type
Input Group Basin features generated based on

the current GroupID values in the input
Catchment feature class. Group Basins with
duplicate terminal sinks have the attribute
"NbTerminalSinks" populated with a value strictly
greater than 1. This field is create and populated
by the tool Generate Group Basin only when at
least one of the Group Basins contains duplicate
terminal sinks.
Feature
Layer
Input Catchment features. The field IsTerminal

must have been populated first by running the
tool Generate Group Basin.
Feature
Layer
Input Sink Point features associated to the

Catchments.
Input HydroEdge features. Features having
IsPreferred=0 and located in duplicate terminal
catchments will be analyzed and the preferred
edges allowing the current grouping will have
IsPreferred set to 1.
Input Drainage Boundary features associated to
the input Catchment features.
Feature
Layer
Feature
Layer
Feature
Layer
in_boundarydrainageline_features
Input Boundary Drainage Line associated to the

Catchment features.
Feature
Layer
in_drainageconn_table
Input Drainage Connectivity table associated to

the Catchment features.
Table
in_terrain_raster
Input DEM.
Output Preferential Node feature class that will be

Raster
Layer
Feature
Class
Output Preferential Link feature class that will be

Feature
Class
12/8/2014
Page 58 of 69
Environments
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Select Upstream Catchments Using Preferential Link (Arc Hydro Tools)
Summary
Traces upstream of user selected catchment(s) using the FeatureID1/FeatureID2 attributes in the
Preferential Link features and returns the upstream catchment features as a selection set of catchments
populated with the same GroupID.
Learn more about how Select Upstream Catchments Using Preferential Link (Arc Hydro) works.
Usage
Tool works on a selected set of Catchments and will process all Catchments if there is no selection.
z
z
Tool will return a selection set only if there is a selected set of Catchments as input.
Tool gives the option to overwrite or not existing GroupID. If choosing not to overwrite,
Catchment features with already populated GroupID will stop the upstream traces.
Syntax
SelectUpstreamCatchmentsUsingPreferentialLink_archydro (in_catchment_features,
in_preferentiallink_features, {overwrite_group})
Parameter
Explanation
Data Type

works on selected set of Catchment features or on all
Feature Layer
Input Preferential Link used to establish the

preferred connectivity between Catchments. Must
contain the fields FeatureID1 and FeatureID2,
populated, which are respectively the HydroIDs of
the source and destination Catchments associated to
the link.
Feature Layer
Indicates whether to overwrite the existing

GroupIDs. If choosing not to overwrite, the
Catchments with GroupID already populated will stop
the upstream traces.
Boolean
overwrite_group
(Optional)
Environments
12/8/2014
Page 59 of 69
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Ungroup Selected Catchments (Arc Hydro Tools)
Summary
Ungroups selected Catchments by setting the attribute GroupID to 'Null' for selected Catchments.
When running outside of Arc Map, the user can either create a new in-memory layer with selection
using out of the box 'Data Management->Make Feature Layer' tool or use the output from the tools
Select Upstream Catchments using Preferential Node Link or Group Selected Catchments.
Usage
Syntax
UngroupSelectedCatchments_archydro (in_catchment_features)
Parameter
Explanation
Input Catchment. Required field: GroupID. Tool works
on selected set of Catchment features or on all features
Data Type
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Generate Group Basin (Arc Hydro) works
The tool dissolves the input Catchment features based on the GroupID attribute. It stores the resulting
dissolved polygons in the output Group Basin feature class. It identifies the terminal (i.e. destination)
Catchment and Sink Point features associated to each Group Basin and populates their attribute IsTerminal
with 1.
The tool works on all features in the input Catchment feature class - it ignores the selection set as the
resulting Group Basin features need to cover the entire Catchment feature class.
The objective of the tool is to generate a simplified Basin schema for modeling, allowing using Group Basin
instead of Catchment. The Catchments are grouped using the preferential paths shows below in purple. The
selected points are the terminal sink points in each group.
The tool populates the field IsPitted with 1 for the Group Basin features having a terminal sink point (i.e.
12/8/2014
Page 60 of 69
draining into a sink) and 0 for the dendritic Group Basins.
Input/Output
Input
Output
"Catchment"" Feature Class

How the tool works

1.
The tool creates the field IsTerminal in the input Catchment and Sink Point feature classes if
they do not already exist and resets these fields to 0 for all features.
2.
It checks whether the field GroupID contains only Null values in the Catchment feature class.
If they do, the tool exits and asks the user to populate this field with unique HydroIDs (as this
field will be used to populate the attribute HydroID in the associated Group Basins).
3.
The tool uses the field GroupID to dissolve the Catchment features so that the Catchment
features sharing the same GroupID become one Group Basin feature having its HydroID set to
the GroupID.
4.
It removes from the output Group Basin feature class the features having the dissolve field
(GroupID or HydroID) set to Null.
5.
The tool performs a spatial join between the Catchments and the Preferential Links to identify
as terminal:
a. The catchments that are never used as source catchments by any of the links
12/8/2014
Page 61 of 69
(HydroID of those catchments are never used as FeatureID1 in any link).

b.
The catchments that have nextdown catchments that are all located in a different
Group or are flowing only into the external Catchment (i.e. FeatureID2 is
associated to a different Group or Null, or maximum of FeatureID2 is -1).
6.
The tool loops through the Group Basin features and set the field IsTerminal to 1 in the
terminal Catchment features and in their associated Sink Point.
7.
The tool populates the field IsPitted with 1 for the deranged Group Basins and for 0 for the
Dendritic Group Basins.
Catchment
Role
Field
Type
Description
Required
HydroID
Integer

geodatabase.
Required
GroupID
Integer
Unique identifier of the group.
Created/Populated
IsTerminal
Short
Integer
Indicates whether the catchment is terminal, i.e.

the destination catchment.
Preferential Link
Role
Field
Type
Description
Required
FeatureID1
Integer
HydroID of source catchment.
Required
FeatureID2
Integer
HydroID of destination catchment.
Sink Point
Role
Field
Type
Description
Created/Populated
IsTerminal
Short Integer
Indicates whether the sink point is terminal.
Group Basin
Role
Field
Type
Description
Created/Populated
HydroID
Integer

geodatabase. Value of the GroupID field in
Catchments used to generate the Group Basin.
Created/Populated
IsPitted
Short
Integer
Indicates whether the Group Basin is dendritic (0)

or deranged (1).
Learn more about how Generate Group Junction (Arc Hydro) works
The Generate Group Junction tool creates a new Group Junction point feature class by reselecting from
Hydro Junction features that meet one of the following criteria:
z
Hydro Junction features located on the Group Basin boundaries having a Hydraulic Type set to Bridge
("BRID"), Culvert ("CULV"), Cross Section ("CS"), Dam ("DAM"), Levees ("LEV") (default list of
structure junctions read from the configuration XML - see XML Configuration section below), or
12/8/2014
Page 62 of 69
Natural Overflow ("NO"). The Natural Overflow junctions are the same as the Boundary Node
junctions generated by the tool Drainage Connectivity Characterization.
z
Hydro Junction features located under the terminal sink point associated to the Group Basin. This sink
point is identified when using the tool Generate Group Basin which sets its attribute IsTerminal to 1.
Dendritic Hydro Junction features within the Group Basin having FType= "Drainage Inlet", "Drainage
Outlet" or "Stream Confluence". These junctions may be created with the tool Hydro Network
Generation.
The tool sets the FType of the Group Junction and populates its JunctionID with the HydroID of the source
HydroJunction
The tool processes all features in the input Group Basin feature class.
The picture below shows the Group Basins and their associated catchments as well as the Group Junctions
of type Sink, Culvert and Natural Overflow generated.
Note
The idea is to capture the most important junctions that move water between grouped basins. Group
Basin, Group Junction and Group Link define a simplified connectivity within the system.
Input/Output
Input
Output
"Group Basin"" Feature Class
"Group Junction" Point Feature Class

How the tool works

For each Group Basin feature in the input Group Basin feature class, the tool performs the following
steps:
1.
The tool identifies the HydroJunction features located on the boundaries of the input Group
Basins having the field Hydraulic_Type_Desc set to "BRID" (bridge), "CS" (cross section),
"CULV" (culvert), Dam ("DAM") or Levees ("LEV") and copies these junctions into the output
GroupJunction feature class. The tool populates the JunctionID of the Group Junction with the
HydroID of the HydroJunction, and the FType with the Hydraulic Type of the HydroJunction.
2.
The tool identifies the lowest HydroJunction features of Hydraulic_Type_Desc "NO" (Natural
Overflow) along the Group Basin boundaries. It copies these features into the output Group
Junction feature class and populates the elevation field Elev for these Group Junctions.
12/8/2014
3.
The tool searches for the terminal Sink Point feature within the Group Basin feature.
z
The tool identifies all terminal sink point features (i.e. IsTerminal = 1) within the Group
Basin features and finds the HydroJunctions intersecting these sink points. It copies
these junctions into the Group Junction feature class and populates the attribute FType
of the Group Junction with "SINK" and the JunctionID with the HydroID of the
HydroJunction.
z
4.
The tool populates the field IsPitted with 1 in the Group Basin features containing a
terminal sink.
The tool searches for the dendritic HydroJunction features that intersect the Group Basin
polygons, i.e. the junction with FType set to "Drainage Inlet", "Drainage Outlet" or "Stream
Confluence".
z
The tool populates the FType field with the FType of the HydroJunction and the
JunctionID field with the HydroID of the HydroJunction.
z
5.
Page 63 of 69
The tool populates the field IsPitted with 0 in the Group Basin feature containing
dendritic junctions.
The tool populates the field HydroID in the Group Junction feature class.
Group Basin
Role
Field
Type
Description
Created/Populated
IsPitted
Short
Integer
Indicates whether the Basin has a terminal Group

Junction (1) or is dendritic (0).
Hydro Junction
Role
Field
Type
Description
Required
HydroID
Integer

geodatabase.
Required
Hydraulic_Type_Desc
String
Hydraulic Type of the junction (i.e. Bridge, Culvert,

etc.)
Required
FType
String
Feature type (i.e. Boundary Node, etc.)
Required
Elev
Double
Junction elevation. Usually populated for Boundary

Node junctions and used to identify the lowest
junctions.
Sink Point
Role
Field
Type
Description
Required
IsTerminal
Short Integer
Indicates whether the sink point is terminal.
Group Junction
Role
Field
Type
Description
Created/Populated
HydroID
Integer

geodatabase.
Created/Populated
FType
String
Feature type of the Group Junction (Bridge, Culvert,

Sink, Drainage Inlet, etc.)
Created/Populated
JunctionID
Integer
HydroID of the associated HydroJunction feature.
Created/Populated
Elev
Double
Elevation of the junction. Populated for Natural

Overflow junction.
Attributes table of Group Junction
12/8/2014
Page 64 of 69
XML Configuration
The hydraulic types of the structure junctions that can be used to create group junction on the group
basins boundaries are defined in the ArcHydroTools.xml configuration file that gets loaded in memory in
ArcMap under the node HydroConfig/ProgParams/ApFunctions/ApFunction
(GenerateGroupJunction)/JunctionTypes. Each Junction child node under this node is defined with the
following attribute:
z
Default configuration: LEV, BRID, CS, DAM, CULV
Learn more about how Generate Group Link (Arc Hydro) works
This tool creates a Group Node and a Group Link feature classes that establish the connectivity between the
Group Basin features using the following type of edge connection:
z
Dendritic Hydro Edges (FType = 'Synthetic Channel').
Boundary HydroEdges (FType = 'Boundary Link') connected via the lowest Natural Overflow Group
Junction on the Group Basin boundaries.
Point structure edges (FType = 'Structure Link') connected to a point structure located on a Group
Basin boundaries.
Linear structure edges (FType='Linear Structure') defining a linear structure sequence linking 2
separates Group Basin features.
The tool ignores the selection set and processes all Group Basin features.
Input/Output
Input
Output
"Group Junction" Feature Class
"Group Node" Feature Class
"Group Link" Feature Class

The tool creates Group Node and Group Link features by merging the HydroEdges intersecting the lowest
Natural Overflow Group Junctions and connecting the end of each edge to its Group Sink for a deranged
Group Basin or to the terminal catchment outlet for a dendritic Group Basin.
How the tool works

1.
Dendritic
The tool identifies all HydroEdges having FType='Synthetic Channel' that intersect a Group
Junction of FType 'Drainage Outlet' or 'Stream Confluence' and copies these features into the
output Group Link Feature class.
2.
Lowest Natural Overflow Group Junction

The tool loops though the pitted Group Basin features and for each Group Basin looks for the
Group Junction(s) with the lowest elevation located on the Group Basin boundaries. It
retrieves and merges the HydroEdge intersecting these Group Junctions and extends the
12/8/2014
Page 65 of 69
resulting line to the GroupJunction of type Sink or Stream Confluence/Drainage Outlet

associated to each Group Basin separated by the Boundary.
a. The tool populates the field GroupFDR for the HydroEdges with the direction based
on the Group Link and the field GroupLink with 1 to indicate that the HydroEdge
participates to the Group Link.
b.
The tool populates the field GroupLink with 1 in the Preferential Link used to
generate the Group Link.
3.
Point Structures located on Group Basin boundaries

The tool identifies the HydroEdges intersecting the Group Junction structures located on the
Group Basin Boundaries.
4.
Linear Structures connecting different Group Basins

The tool identifies the linear structures connecting different Group Basin features and merge
them with their connected Linear StructuresHydroEdges intersecting the Group Junction
structures located on the Group Basin Boundaries.
You can setup the flow direction in the geometric network based on the Group Links by setting the
direction using the field GroupFDR.
Group Junction
Role
Field
Type
Description
Required
JunctionID
Integer
HydroID of associated Hydro Junction.
Required
FType
String
Feature type. May be populated with Sink, NO (Natural

Overflow), Drainage Inlet, Drainage Outlet, Stream
Confluence, LEV, DAM, CULV, CS, BRID (or other structures).
Required
Elev
Double
Elevation for boundary nodes junctions (Natural Overflow).

Used to locate the lowest junction along a Group Basin's
boundaries.
Attributes table of Group Junction
Group Basin
Role
Field
Type
Description
Required
HydroID
Integer

geodatabase.
Required
IsPitted
Short
Integer
Indicates whether the Basin has a terminal Group Junction

(1) or is dendritic (0).
Hydro Junction
Role
Field
Type
Description
Required
HydroID
Integer
Hydro Edge
Role
Field
Type
Description
Required
HydroID
Integer

geodatabase.
Required
DrainID
Integer
HydroID of associated Catchment.
Required
FType
String
Feature type of the HydroEdge (e.g. Synthetic

Channel, Linear Structure).
Created/Populated
GroupFDR
Short
Integer
Flow Direction of the Edge based on Group Link.
12/8/2014
Created/Populated
GroupLink
Page 66 of 69
Short
Integer
Indicates whether the edge is used to generate

the Group Link.
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
Required
GroupID
Integer
HydroID of associated Group Basin.
Required
JunctionID
Integer
HydroID of HydroJunction associated to Catchment (i.e.

outlet junction for dendritic catchment).
Preferential Link
Role
Field
Type
Description
Created
HydroID
Integer

geodatabase.
Created
DrainID
Integer
HydroID of the associated Group Basin.
Created
IsFlipped
Integer
Indicates whether the link has been edited and

flipped. Default to 0 (No).
Created
FNID
Integer
HydroID of the associated From Group Node.
Created
TNID
Integer
HydroID of the associated To Group Node.
Required
FeatureID1
Integer
Required
FeatureID2
Integer
Created/Populated
GroupLink
Short
Integer
Indicates whether the preferential link is used by

a Group Link (1).
Created/Populated
GroupFDR
Short
Integer
Indicates whether the direction of the Group Link

is the same (1 - With Digitized) or against (2 Against Digitized) the direction of the Group Link.
Group Node
Role
Field
Type
Description
Created
HydroID
Integer
Created
SinkID
Integer
Created
DrainID
Integer
Created
JunctionID
Integer
HydroID of associated HydroJunction. Populated for outlet

(Dendritic junction) and Boundary junction.
Attributes table of Group Node
Group Link
Role
Field
Type
Description
Created
HydroID
Integer

geodatabase.
Created
DrainID
Integer
HydroID of the associated Group Basin.
Created
IsFlipped
Integer
Indicates whether the link has been edited and flipped.

Default to 0 (No).
Created
FNID
Integer
HydroID of the associated From Group Node.
12/8/2014
Created
TNID
Integer
HydroID of the associated To Group Node.
Created
FeatureID1
Integer
HydroID of origin Group Basin.
Created
FeatureID2
Integer
HydroID of destination Group Basin.
Created
CatchmentID1
Integer
Created
CatchmentID2
Integer
Page 67 of 69
Attributes table of Group Link
Learn more about how Group Selected Catchments (Arc Hydro) works
1.
This tool assigns a unique 'GroupID' to the selected Catchments.
2.
The tool allows the user to overwrite existing 'GroupID' by checking the 'Overwrite Existing
GroupID' option.
3.
If any of the selected Catchments already has its 'GroupID' attribute assigned, and 'Overwrite
Existing GroupID' option is not checked, the tool will skip those features and only assign the
GroupID to the features having Null GroupIDs.
4.
If 'Overwrite Existing GroupID' is checked, then the tool will assign a new 'GroupID" to all
selected Catchments and set 'GroupID = Null' for the other Catchments not selected but sharing
the same 'GroupID' as the Catchment(s) selected for grouping.
5.
When running outside of ArcMap, the user can either create a new in-memory layer with
selection using the out of the box 'Data Management->Make Feature Layer' tool or use the
output from the tool Select Upstream Catchments using Preferential Node Link.
Learn more about how Select Upstream Catchments Using Preferential Link
(Arc Hydro) works
The tool allows grouping Catchments based on the connectivity established by the preferential links. The
grouping consists in populating the attribute GroupID with the same value for the Catchments connected
through the preferential link features. The selected node in the picture below shows the location of the
terminal catchments for each group.
12/8/2014
Page 68 of 69
The preferred connectivity between catchments is stored in the Preferential Link features in the attributes
FeatureID1 (source catchment) and FeatureID2 (destination Catchment). FeatureID2=-1 indicates that the
link flows towards the external boundary.
The tool may be used in several ways.
1.
Initially, after establishing the Preferential Path, the tool may be run on the entire Catchment
feature class (no selection set) to generate a first cut for the potential groups.
2.
After reviewing the initial grouping, the tool can be used to create additional groups (i.e.
subdividing existing group) by selecting catchments within established groups and running the
tools with the option 'Overwrite Existing GroupID' checked. In that case, the GroupID of
catchments upstream of the selected catchments will be updated with new GroupIDs.
How the tool works

The tool starts processing from the most downstream catchments (i.e. either the selected input
catchments or, if there is no selection set, the most downstream based on the Preferential Links
connectivity, and starts walking upstream to find the next upstream catchment(s) associated to each
most downstream ones among the valid candidates. The valid candidates are either all catchments or all
catchments with Null GroupIDs if the option not to overwrite existing GroupID has been selected.
The tool keeps looking for the next upstream catchments until completion.
If there is a selection set passed as input for the Catchments, the tool will return a selected set of all
processed catchments together with their upstream catchments.
z
If the downstream catchments are at the same level from their associated most downstream
catchments, the GroupID used will be the smallest GroupID.
if the downstream catchments are at different levels, the GroupID used will be the one associated to
the downstream catchment that is at the higher level. The tool will use the other value first, but will
12/8/2014
Page 69 of 69
later overwrite it.

z
The tool populates the field IsTerminal with 1 for all the most downtream catchments. However, it
resets this field initially to 0 before assigning the values only if there is no selected set of
Catchments.
Data
Catchment
Role
Field
Type
Description
Required
HydroID
Integer

geodatabase.
Created/Populated
GroupID
Integer
Unique identifier of the Group Basin in the Arc

Hydro geodatabase.
Created/Populated
IsTerminal
Integer
Indicates whether the catchment is the most

downstream (i.e. terminal) in the preferred path
within a group. Populated by the tool with 1 for the
most downstream catchments or for the user
selected catchments. Will be repopulated by the
tool Generate Group Basin.
Preferential Link
Role
Field
Type
Description
Required
FeatureID1
Integer
Required
FeatureID2
Integer
Learn more about how Ungroup Selected Catchments (Arc Hydro) works
Resets the field GroupID to Null for all selected catchments.
12/8/2014
An overview of the Terrain Preprocessing toolset
Page 1 of 64

ArcGIS 10
The Terrain Preprocessing toolset contains tools that perform an initial analysis of the terrain and
prepare the dataset for further processing.
A Digital Elevation Model (DEM) of the study area is required as input for terrain preprocessing: a
DEM is a grid in which each cell is assigned the average elevation on the area represented by the
cell.
During the processing, potential problems with the terrain representation can be identified, thus
preventing the DEM errors from propagating to the later stages of the analysis. A successful
preprocessing is an indication that the underlying DEM does not contain major problems that will
prevent further analyses.
The initial basin delineation that is performed during the preprocessing has no meaning for later
basin processing (except for performance during the extraction stage), since all parameters can
be changed. In general, the recommended size for stream threshold definition (which in turn
defines the sub basin delineation during preprocessing) is 1% of the overall area. For increased
performance on large DEMs (over 20,000,000 cells), the size of the threshold may be increased
to reduce the stream network and the number of catchment polygons.
Note
Arc Hydro does not provide specific tools for DEM editing and modification. Standard Spatial
Analyst functionality can be used for such purposes.
The Terrain Preprocessing toolset contains the following tool:
Tools
Description
Accumulate Shapes
Generate for each polygon feature in the

input source feature class the
aggregated polygon features consisting
of the polygon itself and all of its
upstream polygon features.
Adjoint Catchment Processing
Create the adjoint catchment polygon for

each catchment in the input catchment
polygon feature class. An adjoint
catchment is the total upstream area (if
any) draining into a single catchment.
Adjust Flow Direction in Lakes
Edit the input flow direction grid so that

each cell within a lake polygon flows
toward the closest stream within the
lake.
Adjust Flow Direction in Sinks
Edit the input flow direction grid so that

each cell within a sink polygon flows
toward the sink point located within the
sink.
Adjust_Flow_Direction_in_Streams
Create the flow direction grid that

respects flow splits from the input
Stream feature class and generate the
associated Drainage Line feature class.
Append Coastal Catchments
Append coastal catchments to the
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 2 of 64
existing set of catchment features.

Assign CatType Attribute
Populate catchment types for the

existing set of catchments.
Assign Stream Slope
Assign relative elevation to from nodes

and to nodes of input streams.
Elevations decrease with the digitized
direction.
Build Walls
Build walls in a DEM at the boundary of

selected input polygons.
Burn Stream Slope
Burn the linear stream slope into a DEM

to enforce the direction of the flow in the
stream.
Create a catchment grid for segments in

the stream link grid or sinks in the sink
link grid. It identifies areas draining into
each link.
Create catchment polygon feature class

out of the catchment grid.
Combine Stream Link and Sink Link
Generates a link grid combining the

stream link grid representing dendritic
areas and the sink link grid representing
deranged areas (i.e. areas with sinks).
Create Drainage Line Structures
Generates DEM-compliant drainage line

elements.
Create Sink Structures
Generate correctly Arc Hydro configured

sink point and polygon feature classes.
DEM Reconditioning
Enforce linear drainage pattern (vector)

onto a DEM (grid). Implements AGREE
methodology.
Depression Evaluation
Generate and characterize the potential

depressions for a DEM.
Drainage Line Processing
Create streamline line feature class out

of the stream link grid.
Drainage Point Processing
Create a drainage point at the most

downstream point in the catchment
(center of a grid cell with the largest
value in the flow accumulation grid for
that catchment).
Extend_Lines
Extend line features using user specified

distance.
Fill Sinks
Fill sinks for an entire DEM (grid).
Flow Accumulation
Create the flow accumulation grid

associate to a flow direction grid.
Flow Direction
Create the flow direction grid for a DEM

grid.
Create the flow direction grid for a DEM

with sinks that ensures that each cell
within a sink flows toward a sink point.
12/8/2014
Page 3 of 64
Also create Sink Link grid defining the

links for deranged areas (i.e, areas with
sinks).
Global Adjoint Catchment Processing
Generate global adjoint catchments by

merging local adjoint catchments with
their upstream cataloging units.
Level DEM
Fill the selected polygons (e.g. lakes) up

to the FillElev value.
Longest_Flow_Path_for_Adjoint_Catchments
Generate longest flow path features

associated to catchment features.
Longest_Flow_Path_for_Catchments
Generate longest flow path features

associated to adjoint catchment
features.
Sink Evaluation
Generate and characterize the potential

sinks for a DEM.
Sink Prescreening
Prescreen the input DEM by filling in the

pits that do not match the criterion
defining a potential sink.
Sink Selection
Select the potential sinks that should be

considered as real sinks in the analysis.
Sink Watershed Delineation
Delineate areas draining into sinks.
Stream Definition
Create stream grid with cells from a flow

accumulation grid that exceed useddefined threshold.
Stream Segmentation
Create a stream link grid from the

stream grid (every link between two
stream junctions gets a unique
identifier).
Terrain Preprocessing toolset's tools
Assign Stream Slope (Arc Hydro Tools)
Summary
Assigns relative elevations to the from/to nodes of input Stream features.
Learn more about how Assign Stream Slope (Arc Hydro) works
Usage
Syntax
AssignStreamSlope_archydro (in_stream_features, number_start_elevation,
number_drop_elevation)
12/8/2014
Parameter
Explanation
in_stream_features
number_start_elevation
number_drop_elevation
Input line feature layer to which elevations will

be assigned.
Elevation assigned to the head nodes.
Value by which elevation will decrease each
time it goes down one node along the digitized
direction.
Page 4 of 64
Data Type
Feature
Layer
Double
Double
Environments
Related Topics
Burn Stream Slope
Find Next Downstream Line
DEM Reconditioning
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Build Walls (Arc Hydro Tools)
Summary
Creates a DEM grid with external and/or internal walls burnt in, except at the location of the
breachlines.
Learn more about how Build Walls (Arc Hydro) works
Usage
Syntax
BuildWalls_archydro (in_dem_raster, innerwall_height, innerwall_buffer, breachline_buffer,
out_walleddem_raster, {in_external_wall_features}, {in_internal_wall_features},
{in_breachline_features})
Parameter
Explanation
in_dem_raster
Input dem onto which the walls will be built.
innerwall_height
Height added to the input dem at the location

of the inner walls to build in these walls. The
height of the external wall is twice this height.
Data Type
Raster
Layer
Double
12/8/2014
Page 5 of 64
innerwall_buffer
Buffer in number of cells used when building

the inner walls. Default to 0 no buffering - i.e
the walls will be one cell wide.
Integer
breachline_buffer
Buffer in number of cells used when building

the breach lines. Default to 0 no buffering i.e the breaches will be one cell wide.
Integer
out_walleddem_raster
Output dem with walls built in.
in_external_wall_features
Optional. Polygon feature class defining the

locations where the external walls will be built.
Raster
Layer
Feature
Layer
(Optional)
in_internal_wall_features
(Optional)
in_breachline_features
(Optional)
Optional. Polygon, point or line feature class

defining the locations where the internal walls
will be built onto the input dem.
Feature
Layer
Optional. Line feature class indicating the

locations where the walls will not be built so
that the wall can be breached and the water
can flow through the breach.
Feature
Layer
Environments
ArcInfo: Yes
Burn Stream Slope (Arc Hydro Tools)
Summary
Burns streams in input DEM with slopes built based on FromElev and ToElev values in the
input Stream feature class.
Learn more about how Burn Stream Slope (Arc Hydro) works
Usage
Syntax
BurnStreamSlope_archydro (in_dem_raster, in_stream_features, out_streamslope_raster,
out_editpoints_features)
Parameter
Explanation
Data Type
in_dem_raster
The stream slopes will be burnt into this DEM.
Raster Layer
in_stream_features
Stream Feature Layer whose elevations will be
Feature
12/8/2014
Page 6 of 64
burnt into the Input DEM.
Layer
out_streamslope_raster
DEM with burnt in stream slopes.
Raster Layer
out_editpoints_features
Points storing the old and new elevation for

each modified cell.
Feature
Class
Environments
Related Topics
Assign Stream Slope
ArcInfo: Yes
Create Drainage Line Structures (Arc Hydro Tools)
Summary
Generates DEM-compliant drainage line elements.
Usage
z
Tool works on all input Stream features and do not honor any selection set.
The temporary EditPoints and HydroRiverPoints feature class are deleted by default.
These outputs can be saved by setting the configuration parameter
HydroConfig\ProgParans\Debug to an integer different from 0.
Syntax
CreateDrainageLineStructures_archydro (in_rawdem_raster, in_stream_features,
{in_stream_features}, out_streamfdr_raster, out_streamlink_raster,
out_drainageline_features, {clear_right_angle})
Parameter
in_rawdem_raster
in_stream_features
in_stream_features
(Optional)
out_streamfdr_raster
Explanation
Data Type
Raster
Layer
Input Stream lines. Must contain HydroID field. Feature
Layer
Boolean
Clean
Input DEM used to set the raster environment.
Output Stream Flow Direction grid storing flow Raster

direction within the stream cells that match the Dataset
digitized direction of the Drainage Line
12/8/2014
Page 7 of 64
features. This grid may be used as input by the

Adjust Flow Direction in Streams tool to adjust
the direction in stream cell.
out_streamlink_raster
Output Stream Link grid associate to output

Drainage Line. The Link IDs in the grid are
populated by using the HydroID of the
associated Drainage Line features.
Raster
Dataset
out_drainageline_features
Output Drainage Line features representing a

rasterized and cleaned up (i.e. no 90 degrees
angles) version of the input streams. The
Drainage Line feature class can handle flow
splits.
Feature
Class
clear_right_angle
Indicates whether to eliminate 90 degrees

angles from the ouput Drainage Line features.
Defaults to false (ClearRightAngle_YES,
ClearRightAngle_NO).
Boolean
(Optional)
Environments
ArcView: No
ArcInfo: Yes
Create Sink Structures (Arc Hydro Tools)
Summary
Defines correctly configured Arc Hydro sink point and polygon feature classes and grids based
on the input deranged polygon and reference DEM. Optional stream (line) and point layers
can be used to specify known sink points.
Usage
z
Default location of output layers is determined by the location of input layers
Tool validation will automatically set default locations for output layers based on the
location of input layers.
User can change name and location of output layers.
HydroID of the sink point is SinkID of the sink polygon.
Sink points are defined in the following way:

If there is is an optional line feature class, the TO_NODE of the line ending in the
sink polygon will be used.
If there is an optional draft sink point feature, those points that are in the sink
12/8/2014
Page 8 of 64
polygons that do not already have a sink point from the line feature class are used.
If both the stream end point and draft sink point are present in the same deranged
polygon, the point coming from the stream layer takes precedence .
All other sink polygons have their sink point generated as the centroid of the
deranged polygon using the Data Management's Feature_To_Point tool with the
Inside option.
Syntax
CreateSinkStructures_archydro (DEM_Grid, Deranged_Polygon_Layer,
Output_Sink_Polygon_Layer, Output_Sink_Polygon_Grid, Output_Sink_Point_Layer,
Output_Sink_Point_Grid, {Input_Stream_Line_Layer}, {Input_Draft_Sink_Point_Layer})
Parameter
Explanation
Data
Type
DEM_Grid
Used to snap resulting sink point and

polygon layers and define rasterization cell
size.
Raster
Layer
Deranged_Polygon_Layer
Polygon layer defining known deranged

areas. Deranged polygons will be rasterized
into sink polys using the DEM grid as a
reference.
Feature
Layer
Output_Sink_Polygon_Layer
Sink polygon layer (vector).
Output_Sink_Polygon_Grid
Sink polygon layer (raster).
Output_Sink_Point_Layer
Sink point layer (vector).
Output_Sink_Point_Grid
Sink point layer (raster).
Feature
Layer
Raster
Layer
Feature
Layer
Raster
Layer
Feature
Layer
Input_Stream_Line_Layer
(Optional)
Input_Draft_Sink_Point_Layer
(Optional)
Optional stream layer. Ends of streams

ending in deranged polygons will become
sink points. All streams within a single
deranged polygon should be snapped to a
single "to node".
Optional draft sink point layer. Points
defining known sink points. Points in this
layer will be enforced as sink points if they
reside within a deranged polygon. There
should be only one draft point per deranged
polygon.
Feature
Layer
Environments
ArcView: No
ArcEditor: No
ArcInfo: Yes
12/8/2014
Page 9 of 64
DEM Reconditioning (Arc Hydro Tools)
Summary
Modifies Digital Elevation Models (DEMs) by imposing linear features onto them
(burning/fencing). This function is an implementation of the AGREE method developed by
Ferdi Hellweger at the University of Texas at Austin in 1997.
Learn more about how DEM Reconditioning (Arc Hydro) works
Usage
Syntax
DEMReconditioning_archydro (in_rawdem_raster, in_agreestream_features,
number_cells_buffer, zdrop_smooth, zdrop_sharp, out_agreedem_raster, raise_negative)
Parameter
Explanation
Data Type
in_rawdem_raster
Input DEM that will be burnt in.
Raster Layer
in_agreestream_features
Stream that will be burnt into the DEM.
number_cells_buffer
Number of cells defining the size of the

buffered area around the stream where the
elevation will be modified.
Feature
Layer
Double
zdrop_smooth
Smooth drop value in the buffered area.
Double
zdrop_sharp
Sharp drop value under the stream
Double
out_agreedem_raster
Output DEM with streams burnt in
Raster Layer
raise_negative
Indicates whether to raise the resulting DEM so

that it does not contain negative values.
Boolean
Environments
Related Topics
Burn Stream Slope
ArcInfo: Yes
12/8/2014
Page 10 of 64
Depression Evaluation (Arc Hydro Tools)
Summary
Generates and characterizes potential depressions in a DEM.
Learn more about how Depression Evaluation (Arc Hydro) works
Usage
Syntax
DepressionEvaluation_archydro (in_dem_raster, out_depression_features,
out_depression_drainage_features)
Parameter
Explanation
in_dem_raster
Input DEM to evaluate.
out_depression_features
Output Depression features.
out_depression_drainage_features
Output drainage areas associated to the

depression features.
Data
Type
Raster
Layer
Feature
Class
Feature
Class
Environments
ArcInfo: Yes
Fill Sinks (Arc Hydro Tools)
Summary
Fills sinks in a grid. If a cell is surrounded by higher elevation cells, the water is trapped in
that cell and cannot flow. The Fill Sinks tool modifies the elevation value to eliminate these
problems.
Learn more about how Fill Sinks (Arc Hydro) works
Usage
12/8/2014
Page 11 of 64
Syntax
FillSinks_archydro (in_dem_raster, out_hydrodem_raster, {fill_threshold},
{in_deranged_poly_features}, {use_issinkfield})
Parameter
Explanation
in_dem_raster
Input DEM
out_hydrodem_raster
Output Hydro DEM
fill_threshold
Fill Threshold
(Optional)
in_deranged_poly_features
(Optional)
use_issinkfield
(Optional)
Data Type
Raster
Layer
Raster
Layer
Double
Input Deranged Polygon feature layer
Feature
Class
Use IsSink field
Boolean
Environments
Related Topics
Flow Direction
Sink Evaluation
Sink Selection
ArcInfo: Yes
Level DEM (Arc Hydro Tools)
Summary
Levels the DEM by filling the Lake polygons up to their FillElev - offset value.
May be used to eliminate elevation noises in a DEM or to ensure that the elevations within a
given polygon (e.g. sinks) are lower than the elevations in the surrounding areas and the
polygon acts as a magnet for water.
Learn more about how Level DEM (Arc Hydro) works
Usage
z
Tool works on a selected set of input Lake Polygon features or on all features if there is
no selected set.
The polygons having null values in the specified Fill Elevation fields will be ignored and
12/8/2014
Page 12 of 64
the output Level DEM will retain the original elevations from the input DEM.
Syntax
LevelDEM_archydro (in_rawdem_raster, in_lake_features, out_leveldem_raster,
{fillelev_field}, {fillelev_offset})
Parameter
Explanation
Data Type
in_rawdem_raster
Input Raw DEM
Raster Layer
in_lake_features
Input Lake Polygon
Feature Layer
out_leveldem_raster
Output Level DEM
Raster Layer
fillelev_field
Optional. Fill Elevation field that stores the fill

elevation for the polygon. The specified offset will
be subtracted from the fill elevation to calculate
the Level Elevation that will be burnt into the
DEM under the corresponding lake polygon. If the
field is left blank, the Fill Elevation will be
recomputed as the lowest elevation along each
polygon's boundaries and stored in the FillElev
field.
Field
(Optional)
To set this field to blank, select one of the

existing field first and then delete this field.
fillelev_offset
(Optional)
Optional. Offset subtracted from the Fill Elevation

to calculate the Level Elevation used to level the
DEM. This ensures that the elevations within the
input Lake polygons are below the elevations in
the surrounding areas and make the Lakes act as
Sink Polygons.
Double
Environments
ArcInfo: Yes
Sink Evaluation (Arc Hydro Tools)
Summary
Generates and characterizes the Sink Polygon and Sink Drainage Area feature classes for the
input DEM.
Learn more about how Sink Evaluation (Arc Hydro) works
12/8/2014
Page 13 of 64
Usage
Syntax
SinkEvaluation_archydro (in_dem_raster, out_sink_features, out_sink_drainage_features)
Parameter
Explanation
Data Type
in_dem_raster
Raster
Input DEM being evaluated for sinks. The
Layer
linear and z units should be explicitly set. If
the z unit is not set, the tool will assumes that
the z-unit is the same as the linear unit.
out_sink_features
Output Sink Polygon features defining the

potential sinks and their characteristics (area,
depth, etc.).
out_sink_drainage_features
Output Sink Drainage Area associated to the

potential sink polygons.
Feature
Class
Feature
Class
Environments
Related Topics
Sink Prescreening
Sink Selection
Fill Sinks
ArcInfo: Yes
Sink Prescreening (Arc Hydro Tools)
Summary
Prescreens the potential sinks in the input Raw DEM by filling the pits having a drainage area
that is smaller than the specified threshold area. This tool is useful to improve performance
when running the Sink Evaluation tool by removing up front the pits that should not be
considered as potential sinks.
Learn more about how Sink Prescreening (Arc Hydro) works
Usage
12/8/2014
Page 14 of 64
Syntax
SinkPrescreen_archydro (in_rawdem_raster, prescreen_area, out_prefildem_raster,
out_sink_raster)
Parameter
Explanation
Data Type
in_rawdem_raster
Input Raw DEM
Raster Layer
prescreen_area
Minimum drainage area for potential sinks in data

unit
Double
out_prefildem_raster
Output Prefilled DEM
Raster Layer
out_sink_raster
Output Sink Grid
Raster Layer
Environments
Related Topics
Sink Selection
Sink Evaluation
ArcInfo: Yes
Sink Selection (Arc Hydro Tools)
Summary
Sets the field IsSink to 1 for the features in the Deranged Polygon layer that meet the
specified criteria to be considered as sinks.
Learn more about how Sink Selection (Arc Hydro) works
Usage
Syntax
SinkSelection_archydro (in_deranged_poly_features, {min_depth}, {min_area},
{min_volume}, {min_drainage_area}, overwrite_selection)
Parameter
Explanation
Input Deranged Polygon
min_depth
Minimum depth
(Optional)
Data Type
Feature
Layer
Double
12/8/2014
min_area
(Optional)
min_volume
(Optional)
min_drainage_area
(Optional)
overwrite_selection
Page 15 of 64
Minimum Area
Double
Minimum Volume.
Double
Minimum Drainage Area
Double
Overwrite selection
Boolean
Environments
Related Topics
Sink Prescreening
Sink Evaluation
Fill Sinks
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
An overview of the Vector QC toolset

The Vector QC toolset contains tools that performs QC checks on vector data used as inputs by
the the Terrain Preprocessing tools.
Tools
Description
Create Initial QC
GDB
Create a QC file geodatabase and a "Layers" feature dataset in it

with the same spatial reference as the provided reference DEM.
Non Draining
Watersheds
Populate the attribute "NonDraining" with 1 if the watershed

polygon does not contain either a stream or a sink (using intersect
operation
Stream Connectivity
Parameters
Generate required attributes in stream FC for stream QC (HydroID,

FROM_NODE, TO_NODE, NextDownID, FlowSplitCnt) and generate
Stream_AllEndPt point fc with stream line end points.
Stream QC
Generate a rasterized vector version of the input Stream feature

class using the input DEM.
Streams Near
Processing Area
Boundary
Populate attribute "NearBnd" in the input Stream feature class with

1 if the streams are near the processing area boundary (otherwise
"null").
Streams Near
Watershed
Boundary
Populate attribute "NearWsh" in the input stream feature class with

1 if the streams are near the watershed boundary (otherwise
"null").
12/8/2014
Page 16 of 64
Summary of the tools in the Vector QC toolset
Create Initial QC GDB (Arc Hydro Tools)
Summary
Create a QC file geodatabase and a "Layers" feature dataset in it with the same spatial
reference as the provided reference DEM.
ProcessingArea and ProcessingAreaOutline feature classes will be created in the feature
dataset based on the extent of the provided reference DEM.
Optional vector layers will be loaded into the feature dataset if provided.
Usage
Syntax
CreateInitialQCGDB_archydro (Target_Directory, Target_GDB_Name, Reference_DEM,
{Stream_FC}, {Sink_FC}, {Waterbody_FC}, {Watershed_FC})
Parameter
Explanation
Data Type
Target_Directory
Target directory where the QC geodatabase will be Workspace

created.
Target_GDB_Name
Name of the QC geodatabase to create.
Reference_DEM
DEM providing the spatial reference for the feature Raster Layer
dataset created in the QC geodatabase. This DEM
also defines the processing area extent that will be
used for ProcessingArea (polygon) and
ProcessingAreaOutline (line) feature classes that
will be created in the QC geodatabase.
Stream_FC
Optional input Stream feature class. If provided it

will be loaded as "Stream" feature class into the
"Layers" feature dataset in the QC geodatabase.
Feature Layer
Optional input Sink feature class. If provided it will

be loaded as "Sink" feature class into the "Layers"
feature dataset in the QC geodatabase.
Feature Layer
(Optional)
Sink_FC
(Optional)
Waterbody_FC
(Optional)
Watershed_FC
(Optional)
String
Feature Layer
Optional input Waterbody feature class (non
sinks). If provided it will be loaded as "Waterbody"
feature class into the "Layers" feature dataset in
the QC geodatabase.
Optional input Watershed feature class. If
provided it will be loaded as "Watershed" feature
class into the "Layers" feature dataset in the QC
geodatabase.
Feature Layer
12/8/2014
Page 17 of 64
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Non Draining Watersheds (Arc Hydro Tools)
Summary
Populate the attribute "NonDraining" with 1 if the watershed polygon does not contain either
a stream or a sink (using intersect operation).
Usage
z
Syntax
NonDrainingWatersheds_archydro (Input_Watershed, {Input_Stream}, {Input_Sink})
Parameter
Input_Watershed
Input_Stream
(Optional)
Input_Sink
(Optional)
Explanation
Input Watershed layer having the attribute
"NonDraining" populated with 1 for features not
intersecting an input stream or sink.
Input Stream polyline layer (optional).
Input Sink polygon layer (optional).
Data Type
Feature Layer
Feature Layer
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Stream Connectivity Parameters (Arc Hydro Tools)
12/8/2014
Page 18 of 64
Summary
Generate required connectivity attributes in the specified input Stream feature class for
stream QC (HydroID, FROM_NODE, TO_NODE, NextDownID, FlowSplitCnt). Generate the
derived output Stream_AllEndPt point feature class storing the input stream line end points.
Usage
z
Syntax
StreamConnectivityParameters_archydro (Stream)
Parameter
Stream
Explanation
Input Stream Layer
Data Type
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Stream QC (Arc Hydro Tools)
Summary
Generate a rasterized vector version of the input Stream feature class using the input DEM.
The tool performs the following checks and writes the resulting error code in the field
QCVALUE in the output feature class.
z
1: VerticesWithinCell. Vertices in a line loop back to a single cell, basically a river line
visited the same cell > 1 times
2: SegmentLTCellSize. River line is < 5.8 * cell size.
4: LinesParallelOrX. 2 river lines come too close (< 1 cellsize).
8: OutletLinesTooShort. Outlet line (nextdownid = -1) does not extend over the DEM's
edge.
16: StreamsCloseToEdge. Outlet line comes too close to the DEM edge (distance <
n*cellsize, n*cellsize defines the Agree's buffer extent).
Usage
z
12/8/2014
Page 19 of 64
Syntax
StreamQC_archydro (in_dem_raster, in_stream_features, out_adjusted_stream_line)
Parameter
Explanation
Data Type
in_dem_raster
Input DEM used to specify the raster

environment for the rasterization of the input
stream lines.
Raster
Layer
in_stream_features
Input Stream feature layer to QC.
out_adjusted_stream_line
Output Stream Adjusted feature class.
Feature
Layer
Feature
Class
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Streams Near Processing Area Boundary (Arc Hydro Tools)
Summary
Populate attribute "NearBnd" in the input Stream feature class with 1 for streams located
near the processing area boundary (otherwise "null").
Usage
Syntax
StreamsNearProcessingAreaBoundary_archydro (Input_Stream_Layer,
Input_Processing_Area_Outline_Layer, Input_Search_Distance)
Parameter
Explanation
Data
Type
Input_Stream_Layer
Input Stream Layer. This layer will get

the "NearBnd" field populated.
Feature
Layer
Input_Processing_Area_Outline_Layer
Input Processing Area Outline Layer.

Linear feature layer defining the
processing area boundaries.
Feature
Layer
Input_Search_Distance
Input Search Distance used to

determine whether a stream feature is
located near the processing area
boundary.
Double
12/8/2014
Page 20 of 64
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Streams Near Watershed Boundary (Arc Hydro Tools)
Summary
Populate attribute "NearWsh" in the input stream feature class with 1 if the streams are near
the watershed boundary (otherwise "null").
Usage
Syntax
StreamsNearWatershedBoundary_archydro (Input_Stream_Layer,
Input_Watershed_Outline_Layer, Input_Search_Distance)
Parameter
Explanation
Data
Type
Input_Stream_Layer
Input Stream Layer. This layer will get the

"NearWsh" field populated.
Feature
Layer
Input_Watershed_Outline_Layer
Linear feature layer defining the watershed

boundaries.
Feature
Layer
Input_Search_Distance
Input Search Distance used to determine

whether a stream feature is located near
the watershed boundary.
Double
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 21 of 64
Accumulate Shapes (Arc Hydro Tools)

Summary
Generates for each polygon feature in the input feature class the aggregated polygon feature
consisting of the polygon itself and all of its upstream polygon features.
Usage
z
Syntax
AccumulateShapes_archydro (in_tracelayer_features, nextDownID_field,
in_sourcelayer_features, out_accumulated_features)
Parameter
Explanation
Data Type
FeatureLayer
in_tracelayer_features
Input Trace layer used to identify the

upstream features. Must contain the field
HydroID as well as a field storing the next
down HydroID (e.g. NextDownID).
nextDownID_field
Field in the Trace Layer storing the next down Field

HydroID (usually NextDownID).
in_sourcelayer_features
Source layer containing the polygon features

to aggregate. May be the same as the Input
Trace Layer if it is a polygon feature class or
any polygon feature classes that is explicitly
related to the source layer.
Feature
Layer
out_accumulated_features
Target feature class storing the aggregated

shapes. The field FeatureID stores the
HydroID of the associated source feature.
Feature
Class
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Adjoint Catchment Processing (Arc Hydro Tools)
Summary
Generates the aggregated upstream catchments from the "Catchment" feature class. For
12/8/2014
Page 22 of 64
each catchment that is not a head catchment, a polygon representing the whole upstream
area draining to its inlet point is constructed and stored in a feature class that has an
"Adjoint Catchment" tag. This feature class is used to speed up the point delineation process.
Learn more about how Adjoint Catchment Processing (Arc Hydro) works
Usage
Syntax
AdjointCatchment_archydro (in_drainageline_features, in_catchment_features,
out_adjoint_features)
Parameter
Explanation
Drainage Line Feature Layer
Input Catchment Feature Layer
out_adjoint_features
Output Adjoint Catchments storing the

upstream aggregated catchments
corresponding to each input catchment feature.
Data Type
Feature
Layer
Feature
Layer
Feature
Class
Environments
Related Topics
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Adjust Flow Direction in Lakes (Arc Hydro Tools)
Summary
The tool edits the input Flow Direction grid within the selected Lake Polygon features so that
each cell flows toward the closest stream grid cell in that lake. If there is no selected set, the
tool processes all features.
Learn more about how Adjust Flow Direction in Lakes (Arc Hydro) works
Usage
z
The tool processes the selected input Polygon features. If there is no selected set, it
12/8/2014
Page 23 of 64
processes all features.
Syntax
AdjustFlowDirectionInLakes_archydro (in_flow_direction_raster, in_lake_features,
in_stream_raster, out_bowlflowdirection_raster)
Parameter
Explanation
Data Type
Input Flow Direction Grid that will be edited.
Raster
Layer
Feature
Layer
in_lake_features
Input Lake Polygon features defining the

areas that will be edited. The tool works on a
selection set and processes all features if
there is no selection set.
in_stream_raster
Input Stream Grid used to edit the input Flow

Direction grid. Each cell within the input lakes
will flow toward the closest stream grid cell
within the lake.
Raster
Layer
out_bowlflowdirection_raster
Output bowled flow direction grid created by

editing the input Flow Direction grid within
the selected input Lake Polygon features so
that each cell within a lake flows toward the
closest stream grid cell within the lake.
Raster
Layer
Environments
ArcInfo: Yes
Adjust Flow Direction in Sinks (Arc Hydro Tools)
Summary
Adjust flow direction within input sink polygon grid so that all traces in a sink polygon end at
the input sink point grid located within the sink polygon.
Learn more about how Adjust Flow Direction in Sinks (Arc Hydro) works
Usage
Syntax
AdjustFlowDirectioninSinks_archydro (in_flow_direction_raster, in_sink_point_raster,
in_sink_poly_raster, out_deranged_flowdirection_raster)
12/8/2014
Parameter
Page 24 of 64
Data
Type
Explanation
Input Flow Direction grid that will be

edited.
Raster
Layer
in_sink_point_raster
Input Sink Point grid storing the terminal

location of the traces in each sink polygon
grid.
Raster
Layer
in_sink_poly_raster
Raster
Layer
Input Sink Polygon grid defining the sink

areas where the flow direction will be
edited.
out_deranged_flowdirection_raster
Raster
Layer
Input Sink Polygon grid defining the sink

areas where the flow direction will be
edited.
Environments
ArcInfo: Yes
Adjust Flow Direction in Streams (Arc Hydro Tools)
Summary
Mosaics flow direction and stream flow direction
Usage
Syntax
AdjustFlowDirectioninStreams_archydro (in_flowdir_raster, in_streamfdr_raster,
out_streamadjusted_fdr_raster)
Parameter
Explanation
in_flowdir_raster
Input Flow Direction grid.
in_streamfdr_raster
Input Stream Flow Direction grid.
out_streamadjusted_fdr_raster
Output Stream Adjusted Flow Direction Grid

created by replacing the values in the
streams in the input Flow Direction grid with
the values from the Stream Flow Direction
grid, which grid may be created by using the
Data
Type
Raster
Layer
Raster
Layer
Raster
Dataset
12/8/2014
Page 25 of 64
Create Drainage Line Structures tool.
Environments
Append Coastal Catchments (Arc Hydro Tools)
Summary
Appends coastal catchments to the existing set of catchments (vector representation).
Usage
z
Output catchment polygon layer is the same as the input catchment polygon layer.
If the users want to keep regular catchments separately from coastal catchments, they
have to manually create a copy of regular catchments before running this function.
This is an optional step in Arc Hydro terrain preprocessing that may be used when the
terrain has significant areas not draining into drainage lines or sinks.
This tool should be executed after the initial catchments have been generated using the
Catchment_Polygon_Processing Arc Hydro function.
The tool identifies all areas that have not yet been assigned to catchments defined by
the input catchment grid. It creates "coastal" catchment polygons out of those areas
and appends these polygons to the existing set of catchments.
If the input catchment feature class has the attribute "CatType", it will be set to "Coast"
for coastal catchments. If that field is not present, the Arc Hydro function Assign
CatType Attribute may be used to populate this attribute once the coastal catchments
have been appended.
Syntax
AppendCoastalCatchments_archydro (Input_DEM_Grid, Input_Catchment_Grid,
Input_Catchment_Features)
Parameter
Explanation
Input_DEM_Grid
Input DEM grid.
Input_Catchment_Grid
Input Catchment Grid.
Input_Catchment_Features
Input catchment feature class/layer.
Data Type
Raster
Layer
Raster
Layer
Feature
Layer
Environments
12/8/2014
Page 26 of 64

ArcInfo: Yes
Assign CatType Attribute (Arc Hydro Tools)
Summary
Sets catchment types for the existing set of catchments by populating the CatType attribute.
Usage
z
Output catchment polygon layer is the same as the input catchment polygon layer.
This function should be executed after all catchment generation processes have been
completed (drainage, sink, coastal).
Existing values for "CatType" will be overwritten.
Catchments with matching drainage lines (using HydroID->DrainID Arc Hydro

relationship) are assigned CatType = "Drainage".
Catchment feature class must have HydroID field populated.
Drainage line feature class must have DrainID field populated (and matching the right
catchment HydroID).
Relationship class between catchment and drainage line feature class does NOT have to
exist.
Catchments containing sink points are assigned CatType = "Sink".
Coastal catchments are not assigned (they will be assigned by the Append Coastal
Catchments tool when the coastal catchments are created). If, for some reason,
CatType has not been already assigned for coastal catchments, if both drainage line and
sink point feature classes are provided, the remaining catchments that have not been
assigned CatType attribute are most likely coastal catchments and can be set manually
to "Coast".
Syntax
AssignCatTypeAttribute_archydro (Input_Catchment_Features,
{Input_Drainage_Line_Feature_Class}, {Input_Sink_Point_Feature_Class})
Parameter
Explanation
Input_Catchment_Features
Input catchment feature class/layer.
Input_Drainage_Line_Feature_Class
Input drainage line feature class/layer.

This is an optional input. If the layer is
not provided, catchments will not be
evaluated for being of "Drainage" type
(this can be the case for completely
(Optional)
Data
Type
Feature
Layer
Feature
Layer
12/8/2014
Page 27 of 64
"deranged" terrains where there is no

developed stream system and drainage
lines are not explicitly modeled).
Input_Sink_Point_Feature_Class
(Optional)
Input sink point feature class/layer. This

is an optional input. If the layer is not
provided, catchments will not be
evaluated for being of type "Sink" (this
can be the case for completely "dendritic"
terrains where there are no sinks).
Feature
Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Catchment Grid Delineation (Arc Hydro Tools)
Summary
Creates a grid in which each cell carries a value (grid code) indicating to which catchment the
cell belongs. The value corresponds to the value carried by the stream segment that drains
that area, defined in the input Link grid.
Learn more about how Catchment Grid Delineation (Arc Hydro) works
Usage
Syntax
CatchmentGridDelineation_archydro (in_flow_direction_raster, in_link_raster,
out_catchment_raster)
Parameter
Explanation
Data Type
Flow Direction grid defining how the water flows

on the surface
Raster Layer
in_link_raster
Link grid used as source to delineate the

catchment grid.
Raster Layer
out_catchment_raster
Output catchment grid obtained by delineating

with the link grid as source.
Raster Layer
Environments
12/8/2014
Page 28 of 64
Related Topics
ArcInfo: Yes
Catchment Polygon Processing (Arc Hydro Tools)
Summary
Converts an input catchment grid into a catchment polygon feature class.
Learn more about how Catchment Polygon Processing (Arc Hydro) works
Usage
Syntax
CatchmentPolyProcessing_archydro (in_catchment_raster, out_catchment_features)
Parameter
Explanation
Data Type
in_catchment_raster
Source catchment grid that will be converted to

polygon features.
Raster Layer
out_catchment_features
Catchment Polygon Feature Class obtained by

converting the catchment grid to polygon and
populating attributes.
Feature
Class
Environments
Related Topics
ArcInfo: Yes
12/8/2014
Page 29 of 64
Combine Stream Link and Sink Link (Arc Hydro Tools)
Summary
Generates the combined link grid representing both dendritic and deranged terrains.
Learn more about how Combine Stream Link and Sink Link (Arc Hydro) works
Usage
Syntax
CombineStreamLinkAndSinkLink_archydro (in_streamlink_raster, in_sinklink_raster,
{in_drainageline_features}, out_link_raster)
Parameter
Explanation
Data Type
in_streamlink_raster
Input Stream Link Grid
Raster Layer
in_sinklink_raster
Input Sink Link Grid
Raster Layer
Input Drainage Line Feature Class (optional).

The tool will update the GridID field to keep it
synchronized with values of the associated
links.
Feature
Layer
Output Link Grid
Raster Layer
(Optional)
out_link_raster
Environments
Related Topics
Stream Segmentation
GUID-9693CF52-4640-431B-8203-3271C5A50F13
ArcInfo: Yes
Drainage Line Processing (Arc Hydro Tools)
12/8/2014
Page 30 of 64
Summary
Converts the input Stream Link grid into a Drainage Line feature class. Each line in the
feature class carries the identifier of the catchment in which it resides and how it connects to
its downstream features.
Learn more about how Drainage Line Processing (Arc Hydro) works
Usage
Syntax
DrainageLineProcessing_archydro (in_link_raster, in_flow_direction_raster,
out_drainageline_features)
Parameter
Explanation
Data Type
in_link_raster
Link grid used to generate the drainage line

features.
Raster
Layer
Flow direction grid used to set downstream

connectivity of the drainage line features.
Raster
Layer
out_drainageline_features
Output Drainage Line
Feature
Class
Environments
Related Topics
ArcInfo: Yes
Drainage Point Processing (Arc Hydro Tools)
Summary
Creates a drainage point at the most downstream point in the catchment (center of a grid cell
with the largest value in the flow accumulation grid for that catchment).
Learn more about how Drainage Point Processing (Arc Hydro) works
Usage
12/8/2014
Page 31 of 64
Syntax
DrainagePointProcessing_archydro (in_flowacc_raster, in_catchment_raster,
in_catchment_features, out_drainagepoint_features)
Parameter
Explanation
in_flowacc_raster
Input Flow Accumulation Grid
in_catchment_raster
Input Catchment Grid
Input Cachment feature layer
out_drainagepoint_features
Output Drainage Point feature class.
Data Type
Raster
Layer
Raster
Layer
Feature
Layer
Feature
Class
Environments
ArcInfo: Yes
Extend Lines (Arc Hydro Tools)
Summary
Extend input line features using user specified distance.
Usage
Syntax
ExtendLines_archydro (in_line_features, extend_type, extend_distance,
out_extendedline_features)
Parameter
Explanation
in_line_features
Input line features to extend.
extend_type
Extension method:
extend_distance
Start: extend at the start of the lines only.
End: extend at the end of the lines only.
All: extend both at the start and and the

end of the lines.
Extension distance and unit.
out_extendedline_features
Data Type
Feature
Layer
String
Linear Unit
Feature
12/8/2014
Extension distance and unit.
Page 32 of 64
Class
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Flow Accumulation (Arc Hydro Tools)
Summary
Computes the flow accumulation grid that contains the accumulated number of cells
upstream of a cell, for each cell in the input flow direction grid.
Learn more about how Flow Accumulation (Arc Hydro) works
Usage
Syntax
FlowAccumulation_archydro (in_flow_direction_raster, out_flow_accumulation_raster)
Parameter
Explanation
out_flow_accumulation_raster
Output Flow Accumulation Grid
Data
Type
Raster
Layer
Raster
Layer
Environments
Related Topics
Flow Direction
Stream Definition
ArcInfo: Yes
12/8/2014
Page 33 of 64
Flow Direction (Arc Hydro Tools)
Summary
Generates the flow direction grid where each cell indicates the direction of the steepest
descent from that cell. If an Outer Wall Polygon is specified, the resulting Flow Direction Grid
will be masked to this feature class. This allows getting rid of the expanded extent created by
the Build Walls Function.
Learn more about how Flow Direction (Arc Hydro) works
Usage
Syntax
FlowDirection_archydro (in_hydrodem_raster, {in_external_wall_features},
out_flow_direction_raster)
Parameter
Explanation
in_hydrodem_raster
Edited Hydro DEM
Optional outer wall polygon feature class.
(Optional)
out_flow_direction_raster
Output flow direction grid
Data Type
Raster
Layer
Feature
Layer
Raster
Layer
Environments
Related Topics
Flow Accumulation
ArcInfo: Yes
Flow Direction with Sinks (Arc Hydro Tools)
12/8/2014
Page 34 of 64
Summary
Generates the Flow Direction grid for a filled DEM with unfilled deranged polygons (e.g. sinks)
by forcing each cell within a deranged polygon to flow toward a sink point located within the
deranged polygon.
Learn more about how Flow Direction with Sinks (Arc Hydro) works
Usage
Syntax
FlowDirWithSinks_archydro (in_hydrodem_raster, in_deranged_poly_features,
out_flow_direction_raster, out_sinkpoint_features, out_sinklink_raster,
out_sinkwatershed_raster, {in_external_wall_features})
Parameter
Explanation
in_hydrodem_raster
Input Hydro DEM
Input Deranged Polygon
out_flow_direction_raster
Output Flow Direction Grid
out_sinkpoint_features
Output Sink Point feature class
out_sinklink_raster
Output Sink Link Grid
out_sinkwatershed_raster
Output Sink Watershed Grid
Optional input outer wall polygon feature class

used to cookie cut the grid
(Optional)
Data Type
Raster
Layer
Feature
Layer
Raster
Layer
Feature
Class
Raster
Layer
Raster
Layer
Feature
Layer
Environments
Related Topics
Flow Direction
Fill Sinks
Sink Evaluation
Sink Selection
ArcInfo: Yes
Global Adjoint Catchment Processing (Arc Hydro Tools)
12/8/2014
Page 35 of 64
Summary
Generates Global AdjointCatchment by merging local AdjointCatchments with their upstreams
cataloging units.
Usage
Syntax
GlobalAdjointCatchmentProcessing_archydro (CUEdge, CUJunction, CUPolygon)
Parameter
Explanation
Data Type
CUEdge
Input global edge feature class establishing

connectivity with upstream cataloging units.
Feature Layer
CUJunction
Input junction feature class connected to cataloging

unit polygons through HydroID/JunctionID
relationship.
Feature Layer
CUPolygon
Input cataloging unit polygons. Will be merged with

downstream AdjointCatchments to generate
GlobalAdjoint features.
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Longest Flow Path for Adjoint Catchments (Arc Hydro Tools)
Summary
Generates longest flow path for each adjoint catchment feature in the input Adjoint
Catchment feature layer. The resulting layer is used as underlying layer to speed up the
generation of Longest Flow Path for watersheds when using the tool Longest Flow Path for
Watersheds.
Usage
Syntax
LongestFlowPathforAdjointCatchments_archydro (in_flow_direction_raster,
in_adjointcatchment_features, in_longestflowpathforcatchments_features,
out_longestflowpathadjcat)
12/8/2014
Parameter
Page 36 of 64
Explanation
Data
Type
Input Flow Direction gris used to

generate flow paths.
Raster
Layer
in_adjointcatchment_features
Input adjoint catchment features

defining the areas where each flow
path will be generated.
Feature
Layer
in_longestflowpathforcatchments_features
out_longestflowpathadjcat
Input preprocessed longest flow

paths generated for the
catchments associated to the
adjoint catchment features being
processed.
Output longest flow path features
associated to the input adjoint
catchment features. The attribute
DrainID is populated with the
HydroID of the associated Adjoint
Catchment.
Feature
Layer
Feature
Class
Environments
ArcInfo: Yes
Longest Flow Path for Catchments (Arc Hydro Tools)
Summary
Generates longest flow path features for each catchment in the input Catchment feature
class. This layer is used as input to generate the layer Longest Flow Path for Adjoint
Catchments (Longest_Flow_Path_for_Catchments). It is also used as underlying layer to
speed up the generation of Longest Flow Path for subwatersheds (Longest Flow Path for
Subwatersheds).
Running this function may be time-consuming.
Usage
z
The tool works on a selected set of catchment features or on all catchment features if
there is no selected set. The tool will overwrite any existing features having
DrainID=HydroID of one of the Catchments being processed. Using selected sets may be
required when the input grid is large to restrict the processing extent internally for some
of the processes (a subset of the grid cannot be used as input to the tool as the cost
12/8/2014
Page 37 of 64
paths must be calculated to the "end of the world" to obtain correct downstream
lengths).
z
The DrainID field in the output Longest Flow Path for Catchments features stores the
The LengthDown field in the output Longest Flow Path for Catchments features stores the
length from the from node of each feature to the outlet it would flow towards in the entire
Flow Direction Grid. This field is used by the tool
Longest_Flow_Path_for_Adjoint_Catchments when assessing the lengths of the flow path
associated to related Catchments.
All Catchment features must be processed before using the tool

Longest_Flow_Path_for_Adjoint_Catchments.
Syntax
LongestFlowPathforCatchments_archydro (in_catchment_features, in_flow_direction_raster,
out_longestflowpathcat_features)
Parameter
Explanation
Data
Type
Input catchment features for which longest

flow paths will be generated.
Feature
Layer
Input Flow Direction grid used to generate

the flow paths. The grid must cover the
entire area the project as using a subset
would generate incorrect lengths since the
outlet(s) defined by a subset would be
different from the outlet(s) defined for the
entire grid.
Raster
Layer
out_longestflowpathcat_features
Output longest flow path features

associated to each input catchment.
Feature
Class
Fields created: HydroID, DrainID (HydroID

of associated Catchment), LengthDown
(length to the outlet defined by the Flow
Direction Grid).
Environments
ArcInfo: Yes
Sink Watershed Delineation (Arc Hydro Tools)
12/8/2014
Page 38 of 64
Summary
Delineates areas draining into sinks (sink watersheds). Creates both raster and vector
representations of sink watersheds.
Usage
z
Location of output layers is determined by the location of input layers. These locations
should not be changed (in order to preserve Arc Hydro HydroID-based relationships).
Tool validation will automatically set default locations for output layers based on the
location of input layers.
User can change names of output layers.
Input flow direction should have already been adjusted for sinks. Adjust Flow Direction
in Sinks Arc Hydro function may be used to develop compliant flow direction grid.
Input sink grid and sink point feature classes need to be Arc hydro compliant. Create
Sink Structures Arc Hydro function may be used to create sink point grid and feature
class.
Sink catchment and its watershed are not necessarily the same. They will be the same
only if there are no drainage lines flowing into the sink.
Syntax
SinkWatershedDelineation_archydro (Flow_Direction_Grid, Sink_Point_Grid,
Sink_Point_Feature_Class, Output_Sink_Watershed_Grid,
Output_Sink_Watershed_Feature_Class)
Parameter
Explanation
Data
Type
Flow_Direction_Grid
Input flow direction grid.
Sink_Point_Grid
Input sink grid (sink points in grid

format) for which delineation will be
performed.
Sink_Point_Feature_Class
Input sink point feature class. GridID

needs to be populated and has to
match the grid_code of the sink point
grid. HydroID also needs to be
populated. HydroID of the sink point
will be assigned as SinkID of the
resulting sink watershed.
Feature
Layer
Output_Sink_Watershed_Grid
Output sink watershed grid. Default

workspace for the output sink
watershed grid is the workspace of
the input sink point grid. User should
not change this target directory (but
can change the output grid name).
Default name is SinkWshGrid.
Raster
Layer
Output_Sink_Watershed_Feature_Class
Output sink watershed feature class.

Default workspace for the output sink
watershed feature class is the
workspace of the input sink point
feature class. User should not change
this target directory (but can change
Feature
Layer
Raster
Layer
Raster
Layer
12/8/2014
Page 39 of 64
the output feature class name).

Default name is SinkWatershed.
Environments
ArcInfo: Yes
Slope (Arc Hydro Tools)
Summary
Generates slope grid.
Usage
Syntax
Slope_archydro (in_rawdem_raster, out_slope_raster, {output_measurement})
Parameter
Explanation
Data Type
in_rawdem_raster
Input DEM for which the slope will be generated.
Raster Layer
out_slope_raster
Output Slope raster.
Raster Layer
output_measurement
Output Slope Measurement Type (Degree or

Percentage).
String
(Optional)
Environments
ArcInfo: Yes
Stream Definition (Arc Hydro Tools)
12/8/2014
Page 40 of 64
Summary
Takes a flow accumulation grid as input and creates a Stream Grid for a user-defined
threshold. This threshold is defined as a number of cells.
Learn more about how Stream Definition (Arc Hydro) works
Usage
Syntax
StreamDefinition_archydro (in_flowaccumulation_raster, number_cells, out_stream_raster,
{area_sqkm})
Parameter
Explanation
in_flowaccumulation_raster
Input Flow Accumulation Grid
number_cells
Number of cells to define stream
out_stream_raster
Output Stream Grid
area_sqkm
Area in square kilometers to define stream
(Optional)
Data Type
Raster
Layer
Integer
Raster
Layer
Double
Environments
Related Topics
Stream Segmentation
Flow Accumulation
ArcInfo: Yes
Stream Segmentation (Arc Hydro Tools)
Summary
Creates a grid of stream segments that have a unique identification.
Learn more about how Stream Segmentation (Arc Hydro) works
Usage
Syntax
12/8/2014
Page 41 of 64
StreamSegmentation_archydro (in_stream_raster, in_flow_direction_raster,

out_streamlink_raster, {in_sink_watershed_raster}, {in_sink_link_raster})
Parameter
Explanation
Data Type
in_stream_raster
Input Stream Grid
out_streamlink_raster
Output Stream Link Grid
in_sink_watershed_raster
Input Sink Watershed Grid. Used to mask the

sink watersheds when stream segments should
not be created within sink watersheds.
(Optional)
in_sink_link_raster
Input Sink Link Grid. Used to mask the sinks

when stream segments should not be created
within sinks.
(Optional)
Raster
Layer
Raster
Layer
Raster
Layer
Raster
Layer
Raster
Layer
Environments
ArcInfo: Yes
Learn more about how Adjoint Catchment Processing (Arc Hydro)

works
The Adjoint Catchment Processing tool generates the aggregated upstream catchments from the
"Catchment" feature class. For each catchment that is not a head catchment, a polygon
representing the whole upstream area draining to its inlet point is constructed and stored in a
feature class that has an "Adjoint Catchment" tag. This feature class is used to speed up the
point delineation process.
Input/Output
Input
Output
"Adjoint Catchment" Feature Class

"Drainage Line Flow Split" Table (not
prompted)
"Catchment_FS" Flow Split Table (not

prompted)
If there is a linear feature class that has a tag "Drainage Line", it will be used as a default for
the first input theme. If not, the user needs to select an existing linear feature class that will
12/8/2014
Page 42 of 64
be tagged with the "Drainage Line" tag at the end of the operation. The Drainage Line needs
to relate the Catchment feature class through a GridID/GridID relationship.
Drainage Line
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the drainage line in the Arc

Hydro database.
Required
GridID
Integer
Grid code of the catchment the drainage line

segment belongs to.
Required
From_Node
Integer
From Node number of the drainage line segment.
Required
To_Node
Integer
To Node number of the drainage line segment.
Required
NextDownID
Integer
HydroID of the next downstream drainage line
Created
DrainID
Integer
HydroID of the Catchment in which the drainage

line is located.
If there is a polygon feature class that has a tag "Catchment", it will be used as a default for
the second input theme. If not, the user needs to select an existing polygon feature class that
will be tagged with the "Catchment" tag at the end of the operation.
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the feature in the Arc

Hydro geodatabase.
Required
GridID
Integer
GridCode of the corresponding Catchment

grid.
Created
NextDownID
Integer
HydroID of the next down catchment.

Populated with "-1" if there is no downstream
catchment.
Created
with SDE
JunctionID
Integer
Created empty (if not previously existing)
If there is a Drainage Line Flow Split table associated to the input Drainage Line, the function
will automatically use this table as input without prompting the user. The name of the table is
the concatenation of the name of the Drainage Line feature class and of the suffix "_FS". This
table stores the additional next down features when there is more than one.
DrainageLine_FS
Role
Field
Type
Description
Required
FeatureID
Integer
HydroID of the associated Drainage Line feature.
Required
NextDownID
Integer
HydroID of one of the next downstream Drainage

Line features.
Attributes table of DrainageLine_FS
If there is a polygon feature class that has a tag "Adjoint Catchment", it will be used as a
default for the output feature class. If not, the user needs to specify a feature class name that
will be tagged with the "AdjointCatchment" tag at the end of the operation.
12/8/2014
Page 43 of 64
Adjoint Catchment
Role
Field
Type
Description
Created
HydroID
Integer
Unique identifier of the Adjoint Catchment in the hydro

database.
Created
DrainID
Integer
HydroID of the catchment located downstream from

the Adjoint Catchment.
Created
GridID
Integer
GridID of the catchment located downstream from the

Adjoint Catchment.
Attributes table of Adjoint Catchment
The function will automatically create or clear the output Catchment flow split table. The name
of the table is constructed by appending the suffix "_FS" to the name of the Catchment
feature class.
Catchment_FS
Role
Field
Type
Description
Created
FeatureID
Integer
HydroID of the Catchment feature.
Created
NextDownID
Integer
HydroID of an additional next downstream

catchment feature.
Attributes table of Catchment_FS

1.
The tool first populates the field DrainID in the Drainage Line feature class with the
HydroID of the associated Catchment based on the GridID/GridID relationship.
2.
The tool then populates the field NextDownID in the Catchment feature class and
Catchment_FS table with the HydroID of the next downstream (or additional next
downstream) catchment.
3.
The tool finally builds the Adjoint Catchment features for each catchment and stores
in the attributes feature class the DrainID and GridID of the associated catchment.
Learn more about how Adjust Flow Direction in Lakes (Arc Hydro)
works
The Adjust Flow Direction in Lakes function (Terrain Preprocessing toolset) allows modifying the
input Flow Direction grid to force each cell within each selected lake polygon to flow toward the
closest stream grid cell within the lake. The function works on a selected set of Lake Polygon
features or on all features if there is no selected set.
Input
Output
"Bowled Flow Direction Grid"
"Lake Polygon" Feature Class

"Stream Grid"
12/8/2014
Page 44 of 64
How to use the tool

z
Select the Lake Polygon features you want to process.
Select Adjust Flow Direction in Lakes.
Select the input Flow Direction Grid, Lake Polygon feature class and Stream Grid. Click OK.
For each selected lake polygon feature, the function checks whether there are internal stream(s)
and modifies the flow direction within the lake except under the stream feature(s) so that each
cell within the lake flows toward the closest steam grid cell within the lake. The original flow
direction will be kept under the streams.
Learn more about how Adjust Flow Direction in Sinks (Arc Hydro)
works
The tool Adjust Flow Direction in Sinks allows editing the input flow direction grid so that once
the water reaches the boundary of a sink polygon, it flows towards the sink point located within
that sink polygon.
Learn more about how Flow Direction with Streams (Arc Hydro)
works
The Flow Direction with Streams tool creates an updated Flow Direction grid and Drainage Line
feature class that ensures that the water flows downstream within the streams once it reaches a
stream.
Input/Output
Input
Output
"Stream Sloped Flow Direction Grid"
"Stream" Feature Class
"Stream Link Grid"

Data Requirements
The input Flow Direction grid should be generated from a DEM where the input Stream
features have been burnt in using DEM Reconditioning. This DEM may also be filled if relevant.
The input Stream feature class used by this function must be the same as the one used to
burn in the streams.
12/8/2014
Page 45 of 64
Learn more about how Assign Stream Slope (Arc Hydro) works
The Assign Stream Slope tool assigns relative elevations to the from/to nodes of input Stream
features.
Input/Output
Input
Output
"Stream" Feature
Class
Fields "FromElev" and "ToElev" populated in "Stream" Feature

Class
If there is a grid theme that has a tag "Stream", it will be used as a default for the input line
feature class. If not, the user needs to select an existing line feature class name that will be
tagged with the "Stream" tag at the end of the operation.
Stream
Role
Field
Type
Required
From_Node
Integer
Required
To_Node
Integer
Created
FromElev
Double
Created
ToElev
Double
How to use the tool

z
Select Terrain Preprocessing>DEM Manipulation>Assign Stream Slope.
Select as input a Stream feature class with FromNode and ToNode populated (e.g. using
Generate From/To Node for Lines) and click OK.
The function performs the following steps:
Step 1: Generate an initial list of head reaches.
Step 2: Loop through the list of head streams: For each head reach, travel downstream to
the outlet based on FromNode/ToNode.
At each node, check if the elevation has been assigned:
If elevation has not been assigned: assign StartElevation to FromNode of head reach
and an elevation that is one DropElevation lower than the upstream node.
If elevation has been assigned: check whether the assigned elevation is lower than
the upstream elevation:
{ If yes: do nothing
{
If no: drop the elevation by one DropElevation unit from the upstream node
and continue processing downstream
At each node, check if there is more than one downstream reach.

{ If yes: proceed along one of the downstream reach and add the other to the
12/8/2014
Page 46 of 64
head reach for later processing.

{
If no: proceed along the downstream reach
Once all downstream nodes are processed, the processing of that head reach is
completed.
z
Step 3: Go to the next head reach in the list and repeat the process.
Learn more about how Build Walls (Arc Hydro) works

The Build Walls tool builds onto the input DEM external and/or internal walls, except at the
location of the specified (optional) breach lines.
Input/Output
Input
Output
"DEM" Grid
"Walled DEM" Grid
"Inner Wall Height"

"Inner Wall Buffer"
"Breachline Buffer"
"Outer Wall Polygon" Feature Class
"Inner Wall" Feature Class
"Breach Line" Feature Class
The input Outer Wall Polygon, Inner Wall and Breach Line feature classes are each optional but at
least one must be specified.
The Outer Wall Polygon feature class must be a polygon feature class. The output DEM will be
cookie cut using the boundaries expanded by 3 cells. The external walls will be built by adding
twice the inner wall height to the values of the expanded cells. If the expanded cells are no data
cells in the input DEM, then the maximum value from the input DEM is added to twice the inner
wall height to create the external wall in these cells. The values of the cells within the polygon
features will not be modified.
The Inner Wall feature class may be a point, line or polygon feature class. It is used to build the
internal walls - for example if you want to enforce known areas such as internal watersheds in
your study area.
The Breach Line feature class is a line feature class that defines the locations where the walls will
not be created and the cells will retain their original value. Breach lines are used to ensure that
the water can flows out so that the area surrounded by a wall does not get considered as a sink
and filled in when using the Fill Sinks function.
The user needs to enter three parameters:
z
Inner Wall Height (Z-Unit) this is the amount in vertical units that will be added to the
cells located under inner wall features. Twice that height will be added to the cells located
12/8/2014
Page 47 of 64
under the external walls features.

z
Inner Wall Buffer (Number of cells) this is the number of cells around each feature where
the inner walls are to be built by adding the inner wall height to the initial cell value.
Breachline Buffer (Number of cells) this is the number of cells around each line feature
where no external wall or internal wall will be built.
The walled in DEM should be processed with the Fill Sinks function to ensure that the potential
sinks generated in the streams are removed. The resulting filled DEM will be used to compute the
flow direction/flow accumulation.
Note: Topographic analyses should be conducted on the original "Raw DEM" (before building
walls and reconditioning), to ensure that correct elevations are extracted (e.g. for slope
computation).
Learn more about how Burn Stream Slope (Arc Hydro) works
The Burn Stream Slope tool allows burning streams with slopes built based on FromElev and
ToElev values in the input Stream feature class. This function may be used on top of DEM
Reconditioning since it burns only the cells located under the Stream features (no buffering).
Input/Output
Input
Output
"DEM" Grid
Stream Sloped DEM" Grid
"Stream" Feature Class with FromElev and ToElev populated
"Edit Points" Feature Class
How to use the tool

z
Select Terrain Preprocessing>Burn Stream Slope.
Select the input DEM to modify and "Stream" feature class preprocessed using the Assign
Stream Slope function. Enter the name of the output "Stream Sloped DEM" and "Edit
Points" feature class and click OK.
Retrieve the step size from the XML. It is defined as a fraction of cell size and default to
0.75.
Retrieve the minimum elevation of the input DEM.
Create Edit Points for each from node and to node, as well as for point located along each
line using the previous step size as interval.
For each point stores the current DEM elevation of the underlying cell as well as the new
elevation computed by linear interpolation of the FromElev and ToElev along this line
feature.
Set the elevation of each cell under an Edit Point feature to the Minimum elevation of the
input DEM Maximum FromElev from Stream feature class + New Elevation stored
associated to the point. Basically, the elevations along the streams will be dropped below
the minimum elevation of the input DEM and will be decreasing towards the outlet.
12/8/2014
Page 48 of 64
Raise the DEM by maximum drop value + 10 to ensure positive values in the DEM.
Learn more about how Catchment Grid Delineation (Arc Hydro)

works
The Catchment Grid Delineation tool creates a grid in which each cell carries a value (grid code)
indicating to which catchment the cell belongs. The value corresponds to the value carried by the
stream segment that drains that area, defined in the input Link grid.
The input Link Grid may be generated as follows:
Terrain Type
Input Link Grid Generated by Tools
Dendritic
Stream Link Grid
Stream Segmentation (threshold

used to define streams)
Flow Direction with Streams(existing

Stream feature class used to define
streams)
Deranged
Sink Link Grid
Combination (Dendritic +
Deranged)
Link Grid
Combine Stream Link and Sink Link
Input/Output
Input
Output
"Catchment Grid"
"Link Grid"
If there is a grid theme that has a tag "Flow Direction Grid", it will be used as a default for the
first input grid. If not, the user needs to select an existing grid theme (of flow direction type)
that will be tagged with the "Flow Direction Grid" tag at the end of the operation.
If there is a grid theme that has a tag "Link Grid", it will be used as a default for the second
input grid. If not, the user needs to specify a grid name that will be tagged with the "Link
Grid" tag at the end of the operation.
If there is a grid theme that has a tag "Catchment Grid", it will be used as a default for the
output grid. If not, the user needs to specify a grid name that will be tagged with the
"Catchment Grid" tag at the end of the operation.
Learn more about how Catchment Polygon Processing (Arc Hydro)

works
12/8/2014
Page 49 of 64
The Catchment Polygon Processing tool takes as input a catchment grid ('Catchment Grid" tag)
and converts it into a catchment polygon feature class ("Catchment" tag). The adjacent cells in
the grid that have the same grid code are combined into a single area, whose boundary is
vectorized. The single cell polygons and the "orphan" polygons generated as the artifacts of the
vectorization process are dissolved automatically, so that at the end of the process there is just
one polygon per catchment.
Input/Output
Input
Output
"Catchment Grid"
input grid. If not, the user needs to select an existing grid theme name that will be tagged
with the "Catchment Grid" tag at the end of the operation.
the output feature class. If not, the user needs to specify a feature class name that will be
tagged with the "Catchment" tag at the end of the operation.
Catchment
Role
Field
Type
Description
Created
HydroID
Integer

Hydro geodatabase.
Created
GridID
Integer
GridCode of the corresponding Catchment grid.
Created
with SDE
NextDownID
Integer
HydroID of the next down catchment.

Populated with "-1" if there is no downstream
catchment.
Created
with SDE
DrainID
Integer
Created
with SDE
JunctionID
Integer
If the target database is an ArcSDE database, all the fields defined in the XML for the layer
Catchment will also be created by the function. The following additional fields will be created
when using the default XML:
Learn more about how Combine Stream Link and Sink Link (Arc
Hydro) works
The Combine Stream Link and Sink Link tool allows creating a Link Grid combining both the
dendritic (Stream Link) and deranged (Sink Link) grids, that uniquely identifies each stream and
sink. This grid will then be used as an input by the function Catchment Grid Delineation.
12/8/2014
Page 50 of 64
Input/Output
Input
Output
"Stream Link Grid"
"Link Grid"
"Sink Link Grid"

"Drainage Line" Feature Class (optional)
The tool first creates a new Stream Link containing values distinct from the input Sink Link Grid
by adding to the input Stream Link Grid:
z
0, if the minimum value in the input Stream Link grid is strictly greater than the maximum
value in the input Sink Link Grid.
The maximum value in the input Sink Link Grid otherwise. In this case the tool will also edit
the GridID field in the optional input Drainage Line feature class so that the values match
the updated Stream Link values.
The tool then mosaics the edited Stream Link and the input Link Grid by giving priority to the
values from the Sink Link grid to generate the combined Link Grid.
Learn more about how DEM Reconditioning (Arc Hydro) works

The DEM Reconditioning tool modifies Digital Elevation Models (DEMs) by imposing linear
features onto them (burning/fencing). This tool is an implementation of the AGREE method
developed by Ferdi Hellweger at the University of Texas at Austin in 1997.
Input/Output
Input
Output
"Raw DEM" Grid
"Agree DEM" Grid
Agree Stream" Feature Class

Stream buffer (number of cells)
Smooth drop/raise (in DEM Z-unit)
Sharp drop/raise (in DEM Z-unit)
If there is a grid theme that has a tag "Raw DEM", it will be used as a default for the input
grid. If not, the user needs to select an existing grid theme name that will be tagged with the
"Raw DEM" tag at the end of the operation.
If there is a linear feature class that has a tag "Agree Stream", it will be used as a default for
the input feature class. If not, the user needs to select an existing linear feature class that will
be tagged with the "Agree Stream" tag at the end of the operation.
If there is a grid theme that has a tag "Agree DEM", it will be used as a default for the output
12/8/2014
Page 51 of 64
grid. If not, the user needs to specify a grid name that will be tagged with the "Agree DEM"
tag at the end of the operation. If the specified output grid already exists, the user is
prompted whether to remove the existing dataset.
The user needs to enter three reconditioning parameters:
z
Stream buffer (cells) this is the number of cells around the linear feature class for which
the smoothing will occur.
Smooth drop/raise this is the amount (in vertical units) that the river will be dropped (if
the number is positive) or the fence extruded (if the number is negative). This value will
be used to interpolate DEM into the buffered area (between the boundary of the buffer
and the dropped/raised vector feature).
Sharp drop/raise this is the additional amount (in vertical units) that the river will be
dropped (if the number is positive) or the fence extruded (if the number is negative). This
has the effect of additional burning/fencing on top of the smooth buffer interpolation. It
needs to be performed to ensure preserving the linear features used for burning/fencing.
The values used for the AGREE parameters depend on the nature of the DEM and the issues
that are being resolved. In many cases, a trial and error approach is needed before
satisfactory results are obtained. Refer to the original paper for some guidelines on the initial
parameter selection.
The reconditioned AGREE DEM should be processed with the Fill Sinks function to ensure that
the potential sinks generated in the streams are removed. The resulting filled DEM will be
used to compute the flow direction/flow accumulation.
Note: Topographic analyses should be conducted on the original "Raw DEM" (before building
walls and reconditioning), to ensure that correct elevations are extracted (e.g. for slope
computation).
Learn more about how Depression Evaluation (Arc Hydro) works

The Depression Evaluation tool (Terrain Preprocessing toolset) allows generating the Depression
and Depression Drainage Area feature classes for the input DEM as well as characterizing the
depressions. Depressions are defined by subtracting the input DEM from its filled DEM.
Input
Output
"DEM" Grid
"Depression" Polygon Feature Class

"Depression Drainage Area" Polygon Feature Class
How to use the tool

z
Select Depression Evaluation.

z
Fill the input DEM grid and generate the Depression by subtracting the DEM from the filled
DEM.
Generate the Flow Direction Grid associated to the filled DEM.
12/8/2014
Page 52 of 64
Generate the drainage areas associated to the depression using the Flow Direction Grid.
The tool populates the following attributes:

Depression
z
DrainID: HydroID of the associated drainage area.
IsSink: Indicator (0/1) populated with 0 by default. Populated by the tool Sink Selection.
Fill Depth: FillElev - BottomElev
FillArea: Area of the depression feature in data units.
FillVolume: Volume of the depression.
BottomElev: Lowest elevation within the depression feature in data unit.
FillElev: Lowest elevation of the boundary cells located outside of the depression (e.g.
lowest elevation of the outside cell along the boundary of the depression where the spill
would occur first when the depression fills)
DrainArea: Area of the associated drainage area in data unit.
Depression Drainage Area

z
HydroID: Unique identifier of the drainage area in the geodatabase.
Learn more about how Drainage Line Processing (Arc Hydro) works
The Drainage Line Processing tool converts the input Stream Link grid into a Drainage Line
feature class. Each line in the feature class carries the identifier of the catchment in which it
resides as well as the identifier of its next downstream feature.
Input/Output
Input
Output
"Stream Link Grid"
"DrainageLine_FS" Table
If there is a grid theme that has a tag "Stream Link Grid", it will be used as a default for the
first input grid. If not, the user needs to select a grid name that will be tagged with the
"Stream Link Grid" tag at the end of the operation.
second input grid. If not, the user needs to select an existing grid theme (of flow direction
type) that will be tagged with the "Flow Direction Grid" tag at the end of the operation.
If there is a theme that has a tag "Drainage Line", it will be used as a default for the output
line feature class. If not, the user needs to specify a feature class name that will be tagged
with the "Drainage Line" tag at the end of the operation.
12/8/2014
Page 53 of 64
The name of the output DrainageLine_FS Table is constructed by appending the suffix "_FS",
meaning flow split, to the name of the output Drainage Line feature class. This table will
stores the additional connectivity for the drainage line features having more than one
downstream line.
Drainage Line
Role
Field
Type
Description
Created
HydroID
Integer
Unique identifier of the drainage line in the Arc

Hydro database.
Created
GridID
Integer
Grid code of the catchment the drainage line

segment belongs to.
Created
From_Node
Integer
From Node number of the drainage line

segment.
Created
To_Node
Integer
To Node number of the drainage line segment.
Created
NextDownID
Integer
HydroID of the next downstream drainage line.

Populated with "-1" if there is no next
downstream line.
Created
with SDE
DrainID
Integer
If the target database is an ArcSDE database, all the fields defined in the XML for the layer
DrainageLine will also be created by the function.
DrainageLine_FS
Role
Field
Type
Description
Created
FeatureID
Integer
HydroID of the associated Drainage Line feature.
Created
NextDownID
Integer
HydroID of one of the next downstream Drainage

Line features.
Note
One of the tasks performed by this function is the identification of upstream-downstream
relationship. In rare cases, this relationship cannot be determined automatically based on
connectivity and DEM, and the user will be asked to identify whether a segment is an outlet or
not. This situation usually occurs when a drainage line segment is very short and the elevation
at its beginning and end is the same, thus preventing the application from identifying the
correct directionality.
In such cases, the questionable segment will be highlighted, the application will zoom to it,
and an input box will be brought up. The input box enables the user to zoom in or out of the
segment and specify whether the segment is an outlet (most of the times) or not. This
process is repeated for every such segment until the directionality is fully established.
Learn more about how Drainage Point Processing (Arc Hydro) works
12/8/2014
Page 54 of 64
The Drainage Point Processing tool allows generating the drainage points associated to the
catchments, i.e. the points in each catchment where the flow accumulation is the largest.
Input/Output
Input
Output
"Flow Accumulation Grid"
"Catchment Grid"
If there is a grid theme that has a tag "Flow Accumulation Grid", it will be used as a default
for the first input grid. If not, the user needs to select an existing grid theme (of type flow
accumulation) that will be tagged with the "Flow Accumulation Grid" tag at the end of the
operation.
second input grid. If not, the user needs to select a grid name that will be tagged with the
"Catchment Grid" tag at the end of the operation.
the input Catchment feature. If not, the user needs to select a polygon feature class that will
be tagged with the "Catchment" tag at the end of the operation.
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the catchment feature.
If there is a point feature class that has a tag "Drainage Point", it will be used as a default for
the output point feature class. If not, the user needs to specify a point feature class name that
will be tagged with the "Drainage Point" tag at the end of the operation.
DrainagePoint
Role
Field
Type
Description
Created
HydroID
Integer
Unique identifier of the point feature.
Created
GridID
Integer
GridID of the catchment draining to the drainage point.
Created
DrainID
Integer
HydroID of the catchment draining to this drainage

point (this field may also be populated by the function
Hydro Network Generation).
Learn more about how Fill Sinks (Arc Hydro) works
12/8/2014
Page 55 of 64
The Fill Sinks tool fills sinks in a grid. If a cell is surrounded by higher elevation cells, the water is
trapped in that cell and cannot flow. The Fill Sinks tool modifies the elevation value to eliminate
these problems.
A Deranged Polygon feature class may be specified to define areas that should not be filled. A
threshold may also be specified in that cases only sinks, whose depth is lower than the
threshold will be filled.
Note that the function works on a selected set of Deranged Polygon features, or on all features if
there is no selected set. The polygons to use may further restricted by using the IsSink field to
define the sinks (Populated by function Sink Selection).
The tool takes as input a DEM grid ("DEM" tag), which can be either an unprocessed DEM or a
preprocessed DEM created with functions Build Walls and/or DEM Reconditioning ("AgreeDEM "
tag). The tool produces as output a grid ("Hydro DEM" tag) where sinks meeting the specified
criteria have been filled.
A default threshold may be set in the XML with the parameter FillThreshold located under the
node FrameworkConfig/HydroConfig/ProgParams/ApFunctions/ApFunction (FillSinks).
Input/Output
Input
Output
"DEM" Grid
"Hydro DEM" Grid
"Deranged Polygon" Feature Class (optional)

Fill Threshold (optional)
If there is a grid theme that has a tag "DEM", it will be used as a default for the input grid. If
not, the user needs to specify an existing grid theme name that will be tagged with the "DEM"
If there is a polygon feature class that has a tag "Deranged Polygon", it will be used as a
default for the input polygon feature class. If not, the user needs to specify a feature class
name that will be tagged with the "Deranged Polygon" tag at the end of the operation.
If there is a grid theme that has a tag "Hydro DEM", it will be used as a default for the output
grid. If not, the user needs to specify a grid name that will be tagged with the "Hydro DEM"
Filling sinks is an iterative process that can be time-consuming. The status of the processing
will be displayed in the ArcMap status bar.
Filling sinks is an operation that needs to be executed with care. The resulting DEM will have
no inner depressions, that is, all the runoff from the DEM will reach its edges. In most cases,
this is a correct assumption (when depressions are the artifacts of DEM generation), but in
some cases that is not correct (e.g. inner lakes). In such cases, the hydrologically correct DEM
needs to be developed in a different manner outside of Arc Hydro, and provided to Arc Hydro
for processing. The Fill Sinks operation should not be performed, but rather the hydrologically
correct DEM should be used in place of the "Hydro DEM".
12/8/2014
Page 56 of 64
Learn more about how Flow Accumulation (Arc Hydro) works

The Flow Accumulation tool takes as input a flow direction grid ("Flow Direction Grid" tag). It
computes the associated flow accumulation grid ("Flow Accumulation Grid" tag) that contains the
accumulated number of cells upstream of a cell, for each cell in the input grid.
Input/Output
Input
Output
input grid. If not, the user needs to select an existing grid theme name that will be tagged
with the "Flow Direction Grid" tag at the end of the operation.
for the output grid. If not, the user needs to specify a grid name that will be tagged with the
"Flow Accumulation Grid" tag at the end of the operation. If the specified output grid already
exists, the user is prompted whether to remove the existing dataset.
Flow accumulation processing is the most time consuming task in the terrain preprocessing
and can take a lot of time to complete. It requires significant computer memory (at least
64MB of RAM, preferably more) and a significant amount of hard disk space (about 5 times
the size of the final flow accumulation GRID). If the function fails to operate properly, the
most likely reason is the lack of hard disk space. The lack of memory can greatly increase the
time required for processing.
Learn more about how Flow Direction (Arc Hydro) works

The Flow Direction tool takes a grid ("Hydro DEM" tag) as input, and computes the corresponding
flow direction grid ("Flow Direction Grid" tag). The values in the cells of the flow direction grid
indicate the direction of the steepest descent from that cell.
If an Outer Wall Polygon is specified, the resulting Flow Direction Grid will be masked to this
feature class. This allows getting rid of the expanded extent created by the Build Walls Function.
Input/Output
Input
Output
"Hydro DEM" Grid
"Outer Wall Polygon" Feature Class (optional)

12/8/2014
Page 57 of 64
If there is a grid theme that has a tag "Hydro DEM", it will be used as a default for the input
"Hydro DEM" tag at the end of the operation.
If there is a polygon feature class that has a tag "Outer Wall Polygon", it will be used as a
default for the input polygon feature class. If not, the user needs to select an existing polygon
feature class that will be tagged with the "Outer Wall Polygon" tag at the end of the operation.
output grid. If not, the user needs to specify a grid name that will be tagged with the "Flow
Direction Grid" tag at the end of the operation. If the specified output grid already exists, the
user is prompted whether to remove the existing dataset.
Learn more about how Flow Direction with Sinks (Arc Hydro) works
The Flow Direction with Sinks tool allows generating the Flow Direction grid for a filled DEM with
unfilled deranged polygons (e.g. sinks) by forcing each cell within a deranged polygon to flow
toward a sink point located within the deranged polygon.
The tool works on a selected set of deranged polygon features or on all features if there is no
selected set. If the Deranged Polygon has the field "IsSink", only the features within the selected
set having IsSink=1 will be processed.
If an Outer Wall Polygon is specified, the resulting Flow Direction Grid will be masked to this
feature class. This allows getting rid of the expanded extent created by the Build Walls Function.
The output Sink Link Grid is created from the HydroIDs of the selected "Deranged Polygon"
feature having IsSink=1. It may be used as input by the tool Catchment Grid Delineation to
generate deranged catchments only or by the tool Combine Stream Link and Sink Link to create
12/8/2014
Page 58 of 64
a Link grid representing both dendritic and deranged terrain that will be then be used as input to
generate catchments.
The Sink Watershed Grid represents the watershed associated to the specified sinks.
Input/Output
Input
Output
"Hydro DEM" Grid
"Outer Wall Polygon" Feature Class (optional)
"Deranged Polygon" Feature Class
"Sink Link" Grid
"Sink Watershed" Grid

How to use the tool

z
Select Flow Direction with Sinks.
Select the input Hydro DEM Grid and Deranged Polygon feature class. Click OK.
The function checks whether the input Deranged Polygon feature class contains the field
IsSink and restricts the polygons being processed to the features having IsSink=1.For
each processed deranged polygon, the function creates a sink point within the sink and
generates the flow direction grid so that the flow direction within each deranged polygon
flows toward the sink point. It also generates the Sink Link and Sink Watershed
grids.The Sink Link grid may be used as input Link Grid in the function Catchment Grid
Delineation to generate catchment grids for a deranged terrain, or it can be combined
with a Stream Link Grid using the function Combine Stream Link and Sink Link to
generate the input Link Grid.
Learn more about how Level DEM (Arc Hydro) works

The Level DEM tool allows filling in the specified Lake Polygon features up to their FillElev value.
Input/Output
Input
"Raw DEM" Grid
Output
"Level DEM" Grid
"Lake" Polygon Feature Class

"Fill Elevation" Field
"Fill Elevation Offset in Linear Unit"
All the cells within a polygon feature will be set to the value stored in the LevelElev field
computed by subtracting the offset from the Fill Elevation field.
The Field Elevation field may be either provided by the user (features with null value will be
ignored) or left blank in which case the field will be recomputed as the lower elevation along each
polygon's boundary.
12/8/2014
Page 59 of 64
To blank the field, select first one of the existing fields and then delete its value.
The recomputed Fill Elevation will be stored in the FillElev field.
Note
If the input Raw DEM grid is a floating point grid and the FillElev needs to be recomputed, an
integer DEM created by multiplying the input RawDEM by the Integer Factor defined in the
XML under the ApFunction(SinkEvaluation) is used internally in the computation process. This
factor defaults to 1000, which means that 3 decimals will be preserved for an input floating
point grid.
Learn more about how Sink Evaluation (Arc Hydro) works

The Sink Evaluation tool allows generating and characterizing the Sink Polygon (in red) and Sink
Drainage Area (in black) feature classes for the input DEM.
Input/Output
Input
"DEM" Grid
Output
"Sink Polygon" Feature Class
"Sink Drainage Area" Polygon Feature Class
How to use the tool
12/8/2014
Page 60 of 64
Select Sink Evaluation.

z
Generates the Flow Direction Grid associated to the input DEM and uses this grid to define
the Sink Polygon features.
Generates the drainage areas associated to the sinks using the Flow Direction Grid.
Characterizes the sinks and populates the attributes table of the output Sink Polygon
feature class with their depth, area, drainage area, bottom and fill elevation and volume.
The tool used the linear and z units defined by the input DEM when characterizing the sinks. If
the z unit is not set, the tool assumes that the z-unit is the same as the linear unit for the
DEM (i.e. Z factor = 1).
Data
Sink Polygon
Role
Field
Type
Description
Created/Populated
HydroID
Integer
Unique identifier of the feature in the

Arc Hydro geodatabase.
Created/Populated
GridID
Integer
Unique identifier derived from Grid

processing.
Created/Populated
DrainID
Integer
HydroID the associated Sink Drainage

Area.
Created/Populated
IsSink
Short
Integer
Indicates whether the feature should be

considered as a real sink
(0/1).Populated with 0 by default and
updated by the tool Sink Selection.
Created/Populated
FillDepth
Double
FillElev BottomElev
Created/Populated
FillArea
Double
Area of the sink polygon feature in data

units.
Created/Populated
FillVolume
Double
Volume of the sink.
Created/Populated
BottomElev
Double
Lowest elevation within the sink feature

in data unit.
Created/Populated
FillElev
Double
Lowest elevation of the boundary cells

located outside of the sink (e.g. lowest
elevation of the outside cell along the
boundary of the sink where the spill
would occur first when the sink fills).
Created/Populated
DrainArea
Double
Area of the associated drainage area in

data unit.
Attributes table of Sink Polygon
Sink Drainage Area

Role
Field
Type
Description
Created/Populated
HydroID
Integer

Hydro database.
Created/Populated
GridID
Integer
Unique identifier derived from Grid

processing.
12/8/2014
Page 61 of 64
Attributes table of Sink Drainage Area
Learn more about how Sink Prescreening (Arc Hydro) works

The Sink Prescreening tool allows prescreening the potential sinks in the input Raw DEM by filling
the pits having a drainage area that is smaller than the specified threshold area. This function is
useful to improve performance when running the Sink Evaluation function by removing up front
the pits that should not be considered as potential sinks.
Input/Output
Input
Output
"Raw DEM" Grid
"PreFilled DEM" Grid

"Sink" Grid
How to use the function

z
Select Sink Prescreening.
Specify the input DEM to screen and the output PreFilled DEM and Sink Grid.
Specify the minimum drainage area that defines a pit as a potential sink. Pits having a
drainage area smaller than the specified threshold areas will be filled in the output
PreFilled DEM. Click OK.
The function generates the output Sink grid showing the prescreened sinks and the
PreFilled DEM grid where the pits not meeting the criteria have been filled.
Learn more about how Sink Selection (Arc Hydro) works

The Sink Selection tool allows selecting the Deranged Polygon features (e.g. sinks, depressions)
that should be considered as sinks. The function works on a selected set of features or on all
Input/Output
Input
Output
"Deranged Polygon" Feature Class

How to use the tool

- Select Sink Selection.
- Select the input feature class containing the polygons that need to be characterized as sinks.
12/8/2014
Page 62 of 64
Click OK.
The tool checks that the selected input contains the required fields.
Deranged Polygon
Required fields (populated by function Sink Evaluation)
- FillDepth
-FillArea
-FillVolume
-DrainArea
Field created
- IsSink
The tool displays the Sink Selection form used to characterize the sinks.
- Specify the criteria defining a sink and click OK. Only the input features having values
strictly greater than the specified thresholds are considered as sinks
The tool updates the attribute IsSink and sets it to 1 for the features that meet the criteria
specified. If "Overwrite existing sinks" is unchecked, the function will not reset to 0 the
features not meeting the criteria that have IsSink set to 1.
Learn more about how Stream Definition (Arc Hydro) works

The Stream Definition tool takes a flow accumulation grid as input and creates a Stream Grid for
a user-defined threshold. This threshold is defined as a number of cells or as an area in square
kilometers.
This initial stream definition (and related Catchments definition) has no meaning for later basin
processing (except for performance during the extraction stage), since all parameters can be
changed. In general, the recommended size for stream threshold definition (which in turn defines
the sub basin delineation during preprocessing) is 1% of the overall area. For increased
performance on large DEMs (over 20,000,000 cells), the size of the threshold may be increased
to reduce the stream network and the number of catchment polygons.
The resulting stream grid contains a value of "1" for all the cells in the input grid that have a
value greater than the given threshold. All other cells in the Stream Grid contain no data.
Input/Output
Input
Output
"Stream Grid"
Number of cells to define a stream

Area SqKm to define a stream (optional)
12/8/2014
Page 63 of 64
for the input grid. If not, the user needs to select an existing grid theme name that will be
tagged with the "Flow Accumulation Grid" tag at the end of the operation.
If there is a grid theme that has a tag "Stream Grid", it will be used as a default for the output
grid. If not, the user needs to specify a grid name that will be tagged with the "Stream Grid"
The user is prompted to enter a threshold to define the stream. This threshold is defined as a
number of cells or an area in square kilometers - it should be by default 1% of the maximum
flow accumulation value.
Learn more about how Stream Segmentation (Arc Hydro) works

The Stream Segmentation tool creates a grid of stream segments that have a unique
identification. Either a segment may be a head segment, or it may be defined as a segment
between two segment junctions. All the cells in a particular segment have the same grid code
that is specific to that segment. The input Sink Watershed grid is optional and may be used to
specify the areas located within sink drainage areas, where the stream links should not be
generated. The input Sink Link is also optional it may be used also to specify the areas where
the stream links should not be generated. These 2 grids may be created with the function Flow
Direction with Sinks. The Sink Link grid may be combined with the Stream Link grid generated by
the current function by using the function Combine Stream Link and Sink Link to create a Link
grid that will represents both dendritic (streams) and deranged (sinks) terrain.
Input/Output
Input
Output
"Stream Link Grid"
"Stream Grid"
"Sink Watershed" Grid
"Sink Link" Grid
first input grid. If not, the user needs to select an existing grid theme (of flow direction type)
that will be tagged with the "Flow Direction Grid" tag at the end of the operation.
If there is a grid theme that has a tag "Stream Grid", it will be used as a default for the
second input grid. If not, the user needs to select an existing grid theme that will be tagged
with the "Stream Grid" tag at the end of the operation.
If there is a grid that has a tag "Sink Watershed Grid", it will be used as a default for the third
input. If not, the user needs to select a grid that will be tagged with the "Sink Watershed
Grid" tag at the end of the operation. This input is optional.
12/8/2014
Page 64 of 64
If there is a grid that has a tag "Sink Link", it will be used as a default for the fourth input. If
not, the user needs to select a grid that will be tagged with the "Sink Link Grid" tag at the end
of the operation. This input is optional.
If there is a grid theme that has a tag "Stream Link Grid", it will be used as a default for the
output grid. If not, the user needs to specify a grid name that will be tagged with the "Stream
Link Grid" tag at the end of the operation. If the output grid already exists, the user is
12/8/2014
An overview of the Terrain Preprocessing Workflows toolset
Page 1 of 5

ArcGIS 10
The Terrain Preprocessing Workflows toolset contains a model describing basic terrain
preprocessing workflow by stringing together individual Terrain Preprocessing tools and a tool
alllowing running geoprocessing models in batch mode.
Models
Description
Basic Combined Terrain

Processing
Terrain preprocessing workflow for terrain combining both

dendritic and deranged areas that starts with a DEM.
Basic Dendritic Terrain

Processing
Terrain preprocessing workflow for dendritic terrains (i.e.

no sinks) that starts with a filled DEM.
Basic Deranged Terrain

Processing
Terrain preprocessing workflow for and deranged areas

that starts with a DEM.
Batch Processing
Run geoprocessing model in batch mode. Create the

vector location for each run if it does not already exist.
Dendritic Terrain Processing

with Imposed Drainage Line
and Wall
Terrain preprocessing workflow for dendritic terrains (i.e.

no sinks) that starts with a filled DEM and used existing
streams and boundaries.
Terrain Preprocessing Workflows toolset's models
Basic Combined Terrain Processsing (Arc Hydro Tools)
Summary
Geoprocessing model performing the basic combined terrain processing workflow.
Usage
Syntax
BasicCombinedTerrainProcessing_archydro (DEM, Number_of_cells_to_define_stream)
Parameter
Explanation
DEM
Input DEM.
Number_of_cells_to_define_stream
Minimum number of upstream cells

defining a stream. Cells having a greater
number of upstream cells will be
considered to be in a stream.
Data
Type
Raster
Layer
Double
Environments
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6DEB.htm
12/8/2014
Page 2 of 5
ArcInfo: Yes
Basic Dendritic Terrain Processing (Arc Hydro Tools)
Summary
Geoprocessing model performing the steps to preprocess a dendritic terrain (i.e. a terrain
with no sinks).
Learn more about how Basic Dendritic Terrain Processing (Arc Hydro) works
Usage
Syntax
BasicDendriticTerrainProcessing_archydro (Fil, Number_of_cells_to_define_stream)
Parameter
Explanation
Data
Type
Fil
Input DEM for the basic dendritic terrain

preprocessing.
Raster
Layer
Number_of_cells_to_define_stream
Number of cells to define stream
Integer
Environments
ArcInfo: Yes
Basic Deranged Terrain Processing (Arc Hydro Tools)
Summary
Geoprocessing model performing the basic deranged terrain processing workflow.
12/8/2014
Page 3 of 5
Usage
Syntax
BasicDerangedTerrainProcessing_archydro (DEM)
Parameter
DEM
Explanation
Input DEM raster to process.
Data Type
Raster Layer
Environments
ArcInfo: Yes
Batch Processing (Arc Hydro Tools)
Summary
Executes input geoprocessing model in batch mode. The tool will run the model for each
subdirectory located under the specified Input Global Data Location.
Learn more about how Batch Processing (Arc Hydro) works
Usage
Syntax
BatchProcessing_archydro (in_globaldata_location, in_model, in_spatialrefgridname)
Parameter
Explanation
Data Type
in_globaldata_location
Input Global Data Location
Directory
in_model
Model and command line argument for the

model.
String
in_spatialrefgridname
Name of input grid setting the spatial reference

for the data created by the model.
String
Environments
ArcView: Yes
12/8/2014
Page 4 of 5
ArcEditor: Yes
ArcInfo: Yes
Dendritic Terrain Processing with Imposed Drainage Line and Wall

(Arc Hydro Tools)
Summary
Geoprocessing model performing a dendritic terrain processing using input Drainage Line and
wall features.
Usage
Syntax
DendriticTerrainProcessingwithImposedDLAndWall_archydro (RawDEM, AgreeStream,
Inner_Wall_Height__DEM_Z-Unit_, {Input_Outer_Wall_Polygon})
Parameter
Explanation
Data Type
RawDEM
Input RawDEM raster to process.
Raster Layer
AgreeStream
Input RawDEM raster to process.
Inner_Wall_Height__DEM_ZUnit_
Height of inner wall. Height of external

walls will be twice this height.
Feature
Layer
Double
Input_Outer_Wall_Polygon
Height added to the input dem at the

location of the inner walls to build in these
walls. The height of the external wall is
twice this height.
(Optional)
FeatureLayer
Environments
ArcInfo: Yes
Learn more about how Basic Dendritic Terrain Processing (Arc Hydro)
works
This workflow allows performing all basic steps that preprocess a dendritic dem to generate the
supporting data used for delineation.
12/8/2014
Page 5 of 5
The model performs the following Terrain Preprocessing steps:

z
Flow Direction
Flow Accumulation
Stream Definition
Stream Segmentation
It takes as input a filled DEM and a threshold in number of cells to defining a stream.
Learn more about how Batch Processing (Arc Hydro) works

Runs geoprocessing models in batch mode.
12/8/2014
An overview of the Utility toolset
Page 1 of 22

ArcGIS 10
The Utility toolset contains various utility tools.

Tools
Description
Convert 3D Line
to Raster
Create line raster by performing linear interpolation from 3D line

vertices.
Create Thiessen
Polygons
Create the Thiessen polygons for an input point feature and transfer
the HydroID of the points into the FeatureID of the associated Thiessen
polygon feature.
Download Time
Series Data
Download Time Series Data associated to input Data Cart into an Arc
Hydro geodatabase.
Export Data Cart

to XML
Export a Data Cart layer/table to XML.
Generate
Processing Units
Generate connected processing unit areas by aggregating input

catchments based on RiverOrder.
Intersect Areas
Intersect two polygon layers and attributes the intersection layer with
the percentage in area from each input polygon layer.
Point TSValue to
3D Line
Interpolate or extrapolate elevations along a line based on field value

in input points.
Terrain Profile
Generate 3D lines as well as associated jpg and xml displaying

elevation profiles.
Update TSValue
on Points
Update field in input point based on specified time step and variable.
Weighted
Average
Transfer a value from a source layer into a target layer by computing

area weighted average.
Utility toolset's tools
Convert3DLineToRaster (Arc Hydro Tools)
Summary
Convert 3D Line to Raster.
Usage
Syntax
Convert3DLineToRaster_archydro (in_raster_raster, in_line3d_features, out_lineraster_raster)
Parameter
Explanation
in_raster_raster
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
Data Type
Raster Layer
12/8/2014
Page 2 of 22
Input raster used to setup output raster cell size

and extent.
in_line3d_features
Input 3D line features to convert.
Feature Layer
out_lineraster_raster
Ouput 3D line raster.
Raster
Dataset
Environments
ArcInfo: Yes
Create Thiessen Polygons (Arc Hydro Tools)
Summary
Creates Thiessen polygons associated to input points and stores the HydroID of the points in
the FeatureID of the associated Thiessen polygon features.
Thiessen polygons have the unique property that each polygon contains only one input point,
and any location within a polygon is closer to its associated point than to the point of any
other polygon.
Learn more about how Create Thiessen Polygons (Arc Hydro) works
Usage
z
Thiessen polygons can be used to apportion a point layer into polygons known as
Thiessen or Voronoi polygons. Each polygon contains only one input point. Each polygon
has the unique property that any location within the polygon is closer to the polygon's
point that to the point of any other polygon.
The Thiessen polygons are constructed as follows:

All points are triangulated irregular network (TIN) that meets the Delaunay criterion.
The perpendicular bisectors for each triangle edge are generated, forming the edges of
the Thiessen polygons. The location at which the bisectors intersect determine the
locations of the Thiessen polygon vertices.
The outside boundary of the Thiessen polygons is the extent of the points used plus an
additional 10%. If the Extent environment is set to a specific set of values,
CreateThiessenPolygons will use the environment to set its outside boundary.
Syntax
CreateThiessenPolygons_archydro (in_point_features, out_thiessen_poly_features,
12/8/2014
Page 3 of 22
output_fields)
Parameter
Explanation
Data Type
in_point_features
The points for which the Thiessen polygons

will be generated. Must contain the HydroID
field.
Feature
Layer
out_thiessen_poly_features
The polygon feature class that will contain the

Thiessen features.
Feature
Class
The FeatureID field stores the HydroID of the

associated point.
output_fields
Determines which attributes from the Input

Point Layer will be transferred to the Output
Thiessen Polygon Feature Class.
z
ONLY_FID Only the FID field from the

Input Point Layer will be transferred to the
Output Thiessen Polygon Feature Class.
This is the default.
ALL All the attributes from the Input

Point Layer will be transferred to the
Output Thiessen Polygon Feature Class.
String
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Download Time Series Data (Arc Hydro Tools)
Summary
Downloads Time Series Data based on the data requests stored in the input Data Cart. The
data, both spatial and tabular, is saved into a new output personal geodatabase (mdb or gdb
file).
The tool works on the selected set if using an input Data Cart of type Layer/Table. It will
download the data for all the records in the input Data Cart if there is no selected set or if the
input Data Cart is an XML file.
Learn more about how Download Time Series Data (Arc Hydro) works.
Usage
Syntax
12/8/2014
Page 4 of 22
DownloadTimeSeriesData_archydro (input_datacarttype, {input_datacarttable},

{input_datacartxmlfile}, output_geodatabase)
Parameter
input_datacarttype
Explanation
Data Type
Type of input Data Cart used: Layer/Table or XML String

File.
If Layer/Table is selected, Input Data Cart
Layer/Table is enabled and Input Data Cart XML
File is disabled.
If XML File is selected, Input Data Cart
Layer/Table is disabled and Input Data Cart XML
File is enabled.
input_datacarttable
(Optional)
input_datacartxmlfile
(Optional)
output_geodatabase
Input Data Cart (Layer/Table). Optional. Enabled

if Input Data Cart Type is set to Layer/Table.
Feature
Layer/Table
Input Data Cart XML File. Optional. Enabled if

Input Data Cart Type is set to XML File.
File Location
New Output Personal Geodatabase (.mdb

or .gdb) where the time series data will be
exported.
Personal
Geodatabase
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Export Data Cart to XML (Arc Hydro Tools)
Summary
Converts a Data Cart provided as table/layer into Data Cart XML file that may be more easily
copies or transferred.
Learn more about how Export Data Cart to XML (Arc Hydro) works.
Usage
Syntax
ExportDataCartToXML_archydro (input_datacarttable, output_datacartxmlfile)
Parameter
input_datacarttable
Explanation
Input Data Cart (Layer/Table)
Data Type
Feature
Layer/Table
12/8/2014
output_datacartxmlfile
Page 5 of 22
Output Data Cart XML File
File Location
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Generate Processing Units (Arc Hydro Tools)
Summary
Generates processing units polygons and associated river features by merging input
Catchment using their RiverOrderField so that the resulting polygons have an area greater
than the specified input Minimum Processing Unit Area. The input Drainage Line features are
also processed so that there is one Processing Unit River feature for each Processing Unit
Area feature.
Learn more about how Generate Processing Units (Arc Hydro) works
Usage
Syntax
GenerateProcessingUnits_archydro (inRiverFL, inCatFL, RiverOrderField, inPUAreaSize,
outRiverFL, outCatFL)
Parameter
Explanation
Data Type
inRiverFL
Input Drainage Line feature layer. Must have the

field RiverOrder populated using the PU_Order or
Shreve method (does not work with Strahler).
Feature Layer
inCatFL
Input Catchment feature layer.
Feature Layer
RiverOrderField
River Order field in input Catchment feature layer.
Field
inPUAreaSize
Minimum area of processing units generated.
Long
outRiverFL
Output processing unit river.
Feature Layer
outCatFL
Output processing unit area.
Feature Layer
Environments
12/8/2014
Page 6 of 22
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Intersect Areas (Arc Hydro Tools)
Summary
Intersects polygon layers having the HydroID field. The resulting layer will store the
HydroIDs of the 2 corresponding intersected features in the KeyFrom and KeyTo fields and
the percentage of the area of each intersected feature in the PctFrom and PctTo fields.
Learn more about how Intersect Areas (Arc Hydro) works
Usage
Syntax
IntersectAreas_archydro (in_from_features, in_to_features, out_intersect_features,
join_attributes)
Parameter
in_from_features
Explanation
Polygon feature class with value to transfer.
Data Type
Feature Layer
Must contain the HydroID field.

in_to_features
Target polygon feature class into which values

will be transferred.
Feature Layer
Must contain the HydroID field.

out_intersect_features
Polygon feature class resulting from the

intersection of the From Layer and To Layer
polygon layers.
Feature Class
The following fields will be created:
join_attributes
KeyFrom: HydroID of the associated From

Layer feature
PctFrom: Percent of the area of the

associated From Layer feature
KeyTo: HydroID of the associated To layer

feature
PctTo: Percent of the area of the associated

To Layer feature
Determines which attributes from the Input

Features will be transferred to the Output
Feature Class.
z
String
ALL All the attributes from the Input

Features will be transferred to the Output
12/8/2014
Page 7 of 22
Feature Class.
z
NO_FID All the attributes except the FID

from the Input Features will be transferred
to the Output Feature Class.
ONLY_FID Only the FID field from the

Input Features will be transferred to the
Output Feature Class. This is the default.
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
PointTSValueto3DLine (Arc Hydro Tools)
Summary
Interpolates or extrapolates elevations along a line based on field value in input points.
Usage
Syntax
PointTSValueto3DLine_archydro (in_point_features, in_line_features, {in_raster_raster},
out_line3D_features, {TransferWaterLevel}, {WaterLevelCheck})
Parameter
in_point_features
in_line_features
in_raster_raster
Explanation
Input Point features.
Input Line features.
Data Type
Feature Layer
Feature Layer
Raster Layer
out_line3D_features
Feature Class
TransferWaterLevel
Indicates whether to perform water level check at

confluences. Yes/No. Default to No.
Boolean
Indicates whether to perform water level check at

confluences. Yes/No. Default to No.
Boolean
(Optional)
(Optional)
WaterLevelCheck
(Optional)
Environments
12/8/2014
Page 8 of 22
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Terrain Profile (Arc Hydro Tools)
Summary
Generates 3D line, jpg and xml file showing elevation profile associated to the input line.
Usage
Syntax
TerrainProfile_archydro (ProfileLineIn, ProfileLineOut, outjpg, outxml, {in_xmlconfig})
Parameter
ProfileLineIn
ProfileLineOut
Explanation
Input lines to process.
Output 3D line corresponding to the input lines.
Data Type
Feature Layer
Feature Layer
outjpg
Image of the profile along the line.
Feature Layer
outxml
3D coordinates (x,y,z,s) of the profile.
Feature Layer
in_xmlconfig
Optional. Configuration file used by the tool. If not

specified, the default Arc Hydro configuration is
used.
Feature Layer
(Optional)
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Update TSValue on Points (Arc Hydro Tools)
Summary
12/8/2014
Page 9 of 22
Updates field in input point based on specified time step and variable.
Usage
Syntax
UpdateTSValueonPoints_archydro (in_point_features, in_table_ts, VARID, TSTime)
Parameter
Explanation
Data Type
in_point_features
Input point features
Feature Layer
in_table_ts
Input Time Series table
Table
VARID
Variable
String
TSTime
Data and time of the values to retrieve.
String
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Weighted Average (Arc Hydro Tools)
Summary
Transfers values from a field in the input From Layer for Intersect feature class into the same
field in the To Layer for Intersect feature class by performing an area weighted average. The
Intersect Areas (Arc Hydro) tool may be used to generate some of the inputs needed by the
tool.
Learn more about how Weighted Average (Arc Hydro) works
Usage
Syntax
WeightedAverage_archydro (in_from_features, from_transfer_field, in_to_features,
in_intersect_features)
Parameter
Explanation
Data Type
in_from_features
Input Layer containing the value to transfer. Must Feature Layer

contain the HydroID field.
from_transfer_field
Value to transfer using weighted average.
String
12/8/2014
Page 10 of 22
in_to_features
Feature Layer where the values will be

transferred. Must contain the HydroID field.
Feature Layer
in_intersect_features
Feature Layer resulting from the intersection of

the Input From Layer for Intersect with the Input
To Layer for Intersect. Must contain the fields
KeyFrom, KeyTo, PctFrom and PctTo.
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Create Thiessen Polygons (Arc Hydro) works
The Create Thiessen Polygons tool allows generating the Thiessen polygons associated to input
points and storing the HydroID of the points in the FeatureID of the associated Thiessen polygon
features.
Input/Output
Input
Output
"Point" Feature Class
"Thiessen Polygon" Feature Class
Point
Role
Field
Type
Description
Required
HydroID
Integer
Unique identifier of the point feature.
Attributes table of Point
Thiessen Polygon
Role
Field
Type
Description
Created
FeatureID
Integer
HydroID of the associated input point.
Attributes table of Thiessen Polygon
Learn more about how Download Time Series Data (Arc Hydro)
12/8/2014
Page 11 of 22
works
The Download Time Series Data tool allows downloading the time series data specified in the
input Data Cart into a new output personal geodatabase. The tools works on a selected set or on
all records if there is no selected set.
Input/Output
Input
Output
"Data Cart Type"
"Personal Geodatabase (.mdb or .gdb)" storing the

downloaded data.
"Data Cart Layer/Table"

"Data Cart XML File" Feature
Class
Each record in a the input data cart defines a data request for time series data for given sites.
The following information is required for each record in the data cart.
Required fields/attributes in input data cart
Input
Definition
Required
ServCode
e.g. NWISDV
Yes
SiteCode
Unique identifier of the site (e.g. 07233500).
Yes
VarCode
Unique identifier of the variable to download.
Yes
Vocabulary
Same as ServCode.
Yes
StartDate
EndDate
LocType
e.g. SiteCode, LatLongPoint, LatLongBox
WaterMLURI e.g. http://river.sdsc.edu/wateroneflow/NWIS/DailyValues.asmx?

WSDL
Yes
WMSURI
Note:
The following parameters are set in the Arc Hydro configuration file under the ApFunction
(DownloadTimeSeriesData) node.
z
UseLocalOp: Indicates whether to use a local dll (1) or a remote web service (1).
WSURL: Web service URL used for downloading the data when UseLocalOp is set to 0.
SaveXML: Indicates whether to save the Input Data Cart Layer/Table records being
processed as an XML Data Cart stored in the XML directory in the same location as the
output geodatabase.
SchemaDB: Name of the geodatabase schema used by the tool. Default to

DownloadSchema.mdb. By default this database as well as the DownloadSchema.gdb
schema geodatabase are installed in the ArcHydro9\bin directory.
12/8/2014
Page 12 of 22
SchemaDir: Location of the Download Schema geodatabase. If path is incorrect or blank,

the tool uses the ArcHydro9\bin location by default.
Learn more about how Export Data Cart to XML (Arc Hydro) works
The Export Data Cart to XML tool allows exporting a Data Cart in Layer/Table format into an
output Data Cart in XML format. The tool works on a selected set or on all records if there is no
selected set.
Input/Output
Input
Output
"Data Cart Layer/Table"
"Data Cart XML File" Feature Class
Learn more about how Intersect Areas (Arc Hydro) works

The Intersect Area tool creates an intersect polygon layer based on 2 input polygon feature
classes.
Input/Output
Input
Output
"From Layer for Intersect" Feature Class
"Output Intersect Polygon" Feature Class
"To Layer for Intersect" Feature Class

From Layer for Intersect
Role
Field
Type
Description
Required
HydroID
Integer
Type
Description
Integer
Attributes table of From Layer for Intersect
To Layer for Intersect

Role
Field
Required
HydroID
Attributes table of To Layer for Intersect
Intersect Layer
Role
Field
Type
Description
12/8/2014
Page 13 of 22
Created
HydroID
Integer
HydroID of the new feature.
Created
KeyFrom
Integer
HydroID of the corresponding From Layer feature.
Created
KeyTo
Integer
HydroID of the corresponding To Layer feature.
Created
PctFrom
Double
Percentage of the associated From Layer feature's

area.
Created
PctTo
Double
Percentage of the associated To Layer feature's area.
Attributes table of Intersect Layer
Learn more about how Generate Processing Units (Arc Hydro) works
The tool allows aggregating input catchment features covering a big study area into smaller
areas that can be processed using one of the Terrain Preprocessing workflows. Units River and
Area features that will be used to subdivide a study area in smaller processing units that can be
processed through one of the Terrain Preprocessing workflow.
This tool takes as input a Catchment feature class and its associated Drainage Line feature class.
It merges the catchments using the RiverOrder attribute and the NextDownID field to preserve
the connectivity and to ensure that the size of the resulting processing unit polygons is greater
than the specified minimum area.
How the tool works
1.
Copy the input Catchment features into the new output PUArea feature class.
2.
Copy the input Drainage Line features into the new PURiver feature class.
a. a. Add a field "IsHead" and set it to 1 for all lines that have PO = 1 and 0
everywhere else (this indicates if the river is a head river and can be
deleted if its area is being merged).
3.
Pick the "sequence" field from the UI (PO/Shreve).
4.
Get the count of "sequence" numbers to process.
5.
For each N (in sequence range starting with 2 - note that Shreve values are not
necessarily sequential, so the list might have gaps in values - e.g. 1,2,3,6,7,10,17;
for PU_Order the values will be sequential):
Learn more about how Weighted Average (Arc Hydro) works

The Weighted Average tool computes the weighted average for a specified value in the input
12/8/2014
Page 14 of 22
From Layer for Intersect and stores it in the To Layer For Intersect.
Input/Output
Input
Output
"From Layer for

Intersect" Feature Class
"From Transfer Value Field" added and populated in "To Layer

for Intersect Feature Class" by performing a weighted average.
"From Transfer Value

Field"
"To Layer for Intersect"
Feature Class
"Intersect Polygon"
Feature Class
From Layer for Intersect
Role
Field
Type
Description
Required
HydroID
Integer
Required
"Transfer Value"
Numeric
Field to transfer.
Attributes table of From Layer for Intersect
To Layer for Intersect

Role
Field
Type
Description
Required
HydroID
Integer
Created
"Transfer Value"
Numeric
Field transferred.
Attributes table of To Layer for Intersect
The Intersect Layer feature class may be generated with the tool Intersect Areas (Arc Hydro).
Intersect Layer
Role
Field
Type
Description
Required
KeyFrom
Integer
HydroID of the corresponding From Layer feature.
Required
KeyTo
Integer
HydroID of the corresponding To Layer feature.
Required
PctFrom
Double
Percentage of the associated From Layer feature's

area.
Required
PctTo
Double
Percentage of the associated To Layer feature's area.
Attributes table of Intersect Layer
An overview of the Support toolset

The Support toolset contains supporting python tools used in model builder that allows using
12/8/2014
Page 15 of 22
varaibles as input as well as chaining between the tools.

Toolset
Description
Create Directory
Create directory if it does not already exist at the location specified

by the user. Can be chained to the output of the Select Path tool in
model builder.
Create TIN
Call CreateTIN_3D tool while allowing the user specify all inputs
using string so that they can be set in model builder by using model
variables.
Get Coordinate
System from Vector
Retrieve coordinate system from input vector that can be used as

input by other tools in model builder (e.g. to create a feature
dataset).
Get Field
Allow selecting input field from a list of fields associated to the input
feature layer.
Get Field Alias
Allow returning input field selected from a list of fields associated to

the input feature layer as a string using its alias.
Get Field Alias by

Alias
Allow returning input field selected from a list of fields alias names
associated to the input feature layer as a string using its alias.
Get Spatial
Reference from
Raster
Retrieves the spatial reference associated to the input raster layer.
Get Spatial
Reference from
Vector
Retrieves the spatial reference associated to the input feature layer.
TIN to Raster
Calls TIN to Raster by providing some of the inputs as string that be

modified using model variables (e.g. cell size used to set the
sampling distance).
Summary of the tools in the Terrain Morphology toolset
Create Directory (Arc Hydro Tools)
Summary
Create directory using user-specified path if the directory does not already exist. The Input
Location parameter is a string that can be chained directly in model builder with the output of
the Select Path model tool.
Usage
Syntax
CreateDirectory_archydro (Input_Location, Input_Directory_Name)
Parameter
Explanation
Input_Location
Data Type
String
12/8/2014
Page 16 of 22
Path where the directory will be created if it

does not already exist.
Input_Directory_Name
Name of the directory to create.
String
Environments
Create TIN (Arc Hydro Tools)
Summary
Creates TIN. This tool allows the user to specify the inputs using string. It then calls the
standard Create TIN tool from the 3D Analyst. It also editing the input parameters in model
builder.
Usage
Syntax
CreateTIN_archydro (Output_TIN, {spatial_reference},
Input_feature_class_height_field_SF_type_tag_field, {constrained_delaunay})
Parameter
Explanation
Data
Type
Output_TIN
The output TIN that

will be created.
spatial_reference
The spatial reference of Spatial

Reference
the output TIN.
(Optional)
Input_feature_class_height_field_SF_type_tag_field
Semi colon (;)

separated list of
feature class
height_field SF_Type
Tag_field combination
used to generate the
output TIN (e.g.
"featureclass1
height_field1 hardline
<None>;featureclass2
height_field2 hardline
'object identifier'").
TIN
String
Add references to one

or more feature classes
that will be included in
the TIN. For each
feature class you need
to set properties that
indicate how the
12/8/2014
Page 17 of 22
feature class is used to

define the surface.
Feature Class: The
input feature class
name to be used to
construct the TIN.
Height Field: The
height_field supplying
heights for the
features. If z-values
are coming from the
feature geometry, then
the Shape field is
listed; otherwise, it will
be either the name of a
numeric field or, in the
case of z-less features,
the keyword <None>.
Z-less features have no
heights and their
values are interpolated
from the surface before
they get added.
Surface Feature Type:
The SF_type defines
how the feature
geometry gets
incorporated into the
triangulation for the
surface. There are
mass points,
breaklines, and several
polygon types.
Breaklines and
polygons also have
'hard' and 'soft'
qualifiers. These
indicate to an
interpolator whether
the surface crosses
over the features
smoothly (soft) or with
a potentially sharp
discontinuity (hard).
Tag Field: The
tag_value fill polygons
assign integer values,
which are used as a
simple form of
attribution, to
triangles. Their
boundaries are
enforced in the
triangulation as
breaklines. Triangles
inside these polygons
are attributed with the
tag values. Specify the
name of the feature
12/8/2014
Page 18 of 22
class attribute to use

as tag values in the
TIN. If tag values are
not to be used, specify
<none>.
constrained_delaunay
Indicates whether to
use the Constrained
Delaunay option.
(Optional)
Boolean
A constrained Delaunay
triangulation conforms
to Delaunay rules
everywhere except
along breaklines. When
using conforming
Delaunay triangulation,
breaklines are densified
by the software,
therefore one input
breakline segment can
result in multiple
triangle edges. When
using constrained
Delaunay triangulation
no densication occurs
and each breakline
segment is added as a
single edge.
z
Unchecked- The
triangulation will
fully conform to
the Delaunay rules.
This is the default.
Checked- The
Delaunay
triangulation will
be constrained.
Environments
GetCoordinateSystemFromVector (Arc Hydro Tools)
Summary
Retrieves coordinate system from input vector so that it can be used as input in model
builder (e.g. to generate a feature dataset).
Usage
12/8/2014
Page 19 of 22
Syntax
GetCoordinateSystemFromVector_archydro (Input_Feature_Layer)
Parameter
Input_Feature_Layer
Explanation
Input feature layer from which the spatial
reference will be retrieved.
Data Type
Feature Layer
Environments
Get Field (Arc Hydro Tools)
Summary
Retrieves list of field from input feature class so that the user can select an existing field.
Usage
Syntax
GetField_archydro (Input_Feature_Layer, Input_Field)
Parameter
Explanation
Data Type
Input_Feature_Layer
Input feature layer from which the field will be

selected.
Feature Layer
Input_Field
Input field to retrieve. The list of fields displayed

is read from the specified input feature layer.
Field
Environments
Get Field Alias (Arc Hydro Tools)
Summary
Returns alias name of selected input field as string.
Usage
Syntax
12/8/2014
Page 20 of 22
GetFieldAlias_archydro (Input_Feature_Layer, Input_Field)

Parameter
Explanation
Data Type
Input_Feature_Layer
Input Feature Layer from which the list of fields

will be retrieved.
Feature Layer
Input_Field
Alias names of the fields associated to the input

featuyre layer.
Field
Environments
Get Field Alias by Alias (Arc Hydro Tools)
Summary
Selects the input field based on the fields' alias names and returns the selected field alias as
string.
Usage
Syntax
GetFieldAliasbyAlias_archydro (Input_Feature_Layer, Input_Field_Alias_Name)
Parameter
Explanation
Data Type
Input_Feature_Layer
Input feature layer from which the list of fields

will be retrieved.
Feature
Layer
Input_Field_Alias_Name
Input field alias names. The selected field alias

will be returned as string by the tool.
Field
Environments
Get Spatial Reference from Raster (Arc Hydro Tools)
Summary
Retrieves the spatial reference from an input raster.
Usage
12/8/2014
Page 21 of 22
Syntax
GetSpatialReferenceFromRaster_archydro (Input_Raster)
Parameter
Input_Raster
Explanation
Input raster.
Data Type
Raster Layer
Environments
Get Spatial Reference from Vector (Arc Hydro Tools)
Summary
Retrieves the spatial reference from an input vector.
Usage
Syntax
GetSpatialReferencefromVector_archydro (Input_Feature_Layer)
Parameter
Input_Feature_Layer
Explanation
Input feature layer from which the spatial
reference will be retrieved.
Data Type
Feature Layer
Environments
Tin to Raster (Arc Hydro Tools)
Summary
Calls the 3D Analyst TIN to Raster tool by passing all the inputs as string so that they can be
parsed and modified in model builder. For example, the cell size input can be read from a
variable and passed to the out-of-the-box tool as CELLSIZE %cellsize%.
Usage
Syntax
12/8/2014
Page 22 of 22
TINtoRaster_archydro (Input_TIN, Output_Raster, Output_Data_Type, Method,

Sampling_Distance, Z_Factor)
Parameter
Explanation
Data Type
Input_TIN
Input TIN layer.
TIN Layer
Output_Raster
Output raster generated by the tool.
Raster Dataset
Output_Data_Type
Data type of the output raster (FLOAT or INT).

Defaults to FLOAT.
String
Method
Interpolation method used to generate the raster

(LINEAR or NATURAL_NEIGHBORS). Defaults to
LINEAR.
String
Sampling_Distance
Sampling distance used to generate the raster.

String expression set using a combination of
keywork and associated value (OBSERVATIONS
250 or CELLSIZE 10 for example. Defaults to
OBSERVATIONS 250.
String
Z_Factor
The factor by which the heights of the resultant

raster will be multiplied from those of the input
TIN; used to convert z-units to x and y-units.
Double
Environments
12/8/2014
An overview of the Watershed Processing toolset
Page 1 of 30

ArcGIS 10
The toolset contains tools that support the delineation and characterization of watershed
features.
Tools
Description
Batch Global Watershed

Delineation
Create a global watershed and compute selected characteristics

for each point in the batch point feature class.
Batch Subwatershed
Delineation
Create a subwatershed for every point in the batch point

feature class. Subwatersheds are non-overlapping if points are
on the same stream.
Batch Watershed
Delineation
Create a watershed for every point in the batch point feature

class. Watersheds on the same stream are overlapping.
Batch Watershed
Delineation for Polygons
Create a watershed for each selected polygon feature in the

batch polygon feature class.
Construct 3D Line
Build 3D lines from a selected set of 2D lines by extracting

elevations from an underlying DEM.
Delineate from Multiple

Inlets and Outlets
Create the watershed associated to a set of inlet and outlet

points.
Drainage Area Centroid
Create a point at the centroid of each drainage area and store

it in the Centroid feature class.
Flow Path Parameters

from 2D Line
Compute the length, slope and 10-85 slope of a longest flow

path by extracting elevations from a DEM.
Flow Path Parameters

from 3D Line
Compute the length, slope and 10-85 slope of a 3D longest

flow path by extracting elevations from the line.
Interactive Delineation
Interactive watershed delineation model based on Batch

Watershed Delineation tool.
Longest Flow Path
Create a line following the longest flow path in a drainage area

feature class based on steepest descent as defined by the flow
direction grid.
Longest Flow Path for

Subwatersheds
Generate longest flow path features for subwatersheds using

preprocessed data to improve performance.
Longest Flow Path for

Watersheds
Generate longest flow path features for watersheds using

preprocessed data to improve performance.
Main Flow Path
Generate main flow paths.
Smooth 3D Line
Smooth 3D lines linearly along the downstream direction of the

line.
Subwatershed from
Watershed
Generate subwatersheds based on watersheds.
Watershed Processing toolset's tools
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 2 of 30
An overview of the Line Processing toolset

The Line Processing toolset contains two tools processing an input line feature class.
Tools
Description
Create Analysis Line
Create lines for a specific analysis from an input Line feature class.
Remove Stream
Pseudo Nodes
Remove pseudo nodes from input Stream feature class to ensure

that the connectivity is correctly established.
Summary of the tools in the Line Processing toolset
Create Analysis Line (Arc Hydro Tools)
Summary
Create lines for a specific analysis from an input Line feature class.
Usage
Syntax
CreateAnalysisLine_archydro (in_stream_fc, in_xpoint_fc, out_stream_fc, {in_flowdir})
Parameter
in_stream_fc
in_xpoint_fc
Explanation
Input Stream feature class used as source to create
the analysis lines. Must contain the following
attributes:
z
HydroID: used to populate the field FeatureID

in the output AnalysisLine feature class.
From_Node
To_Node
NextDownID
Input Point feature class used to defined the

analysis lines. Must have the attribute ACTIONTYPE
populated with the following values:
z
1: Trim
2: Extend
3: Split
Data Type
Feature Layer
Feature Layer
The field IsDone is created by the tool if it does not

already exist and populated with 1 once the point
has been used.
out_stream_fc
Output AnalysisLine feature class generated based

on the input Stream feature class and XPoint
feature class.
Feature Class
12/8/2014
Page 3 of 30
FeatureID is populated with the HydroID of the

original stream' feature or with the ObjectID of the
associated PointX feature if the AnalysisLine is an
extended line.
The fields HydroID, From_Node, To_Node and
NextDownID are created and populated.
in_flowdir
(Optional)
Input FlowDirection raster. Optional.
Raster Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Remove Stream Pseudo Nodes (Arc Hydro Tools)
Summary
Remove pseudo nodes in input stream feature class so that the connectivity can be correctly
established.
Usage
Syntax
RemoveStreamPseudoNodes_archydro (in_stream_fc, out_stream_fc)
Parameter
Explanation
Data Type
in_stream_fc
Input Stream feature layer to cleanup.
Feature Layer
out_stream_fc
Output feature class generated by removing the

pseudo nodes from the input Stream features.
Feature Layer
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
12/8/2014
Page 4 of 30
Batch Global Watershed Delineation (Arc Hydro Tools)
Summary
Delineates global watersheds for batch points located in Catalog Units.
Learn more about how Batch Global Delineation (Arc Hydro) works
Usage
z
The tool processes selected batch point having the field IsDone = 0 or Null.
Syntax
BatchGlobalWatershedDelineation_archydro (in_batchpoint_features, in_cujunction_features,
in_cuedge_features, in_cupolygon_features, datapath, clear_features,
out_globalwatershed_features, out_globalwatershedpoint_features)
Parameter
Explanation
Data
Type
Input Batch Point features to process.

Tool will work on features having
IsDone=0 or Null.
Feature
Layer
in_cujunction_features
Input cataloging unit junctions related to

upstream cataloging unit polygons.
Feature
Layer
in_cuedge_features
Input cataloging unit edge defining the

global network connectivity between the
cataloging unit polygons though the
junctions.
Feature
Layer
in_cupolygon_features
Input cataloging unit polygons.

Preprocessed data is associated to each
polygon and used to perform local
delineation within each polygon.
Feature
Layer
datapath
Path to the parent directory to the

cataloging unit data.
String
clear_features
Indicates whether to delete existing

watershed point and watershed features.
Default to False (do not clear existing
features).
Boolean
out_globalwatershed_features
Output global watershed feature class.

Contains both the local and global
watershed features associated to each
point.
Feature
Class
out_globalwatershedpoint_features
Output Global Watershed point.
Feature
Class
Environments
12/8/2014
Page 5 of 30
ArcInfo: Yes
Batch Subwatershed Delineation (Arc Hydro Tools)
Summary
Delineates batch subwatershed polygons.
Learn more about how Batch Subwatershed Delineation (Arc Hydro) works
Usage
z
The tool works on selected batch point features having IsDone=0 or Null.
Syntax
BatchSubwatershedDelineation_archydro (in_batchpoint_features, in_flow_direction_raster,
in_stream_raster, out_subwatershed_features, out_subwatershedpoint_features)
Parameter
Explanation
Data
Type
Input batch point features to delineate.

Tool will process only selected features
having IsDone=0 or Null.
Feature
Layer
Input flow direction grid supporting the

delineation.
Raster
Layer
in_stream_raster
Input stream grid allowing to snap the

points on the closest stream cell.
Raster
Layer
out_subwatershed_features
Output delineated subwatershed features.
out_subwatershedpoint_features
Output subwatershed point features.
Feature
Class
Feature
Class
Environments
ArcInfo: Yes
12/8/2014
Page 6 of 30
Batch Watershed Delineation (Arc Hydro Tools)
Summary
Performs batch watershed delineations.
Learn more about how Batch Watershed Delineation Arc Hydro works
Usage
z
The tool works on selected input Batch Point features having IsDone=0 or Null.
Syntax
BatchWatershedDelineation_archydro (in_batchpoint_features, in_flow_direction_raster,
in_stream_raster, {in_snapstream_raster}, in_catchment_features,
in_adjointcatchment_features, {clear_features}, out_watershed_features,
out_watershedpoint_features)
Parameter
Explanation
Data Type
Input Batch Point features to process.

Tool will process features having
IsDone=0 or Null.
Feature Layer
Input flow direction grid used to perform

a local delineation with the catchment
containing the point to delineate.
Raster Layer
in_stream_raster
Input stream grid used to determine

whether the point to delineate is
downstream of an adjoint catchment
feature.
Raster Layer
in_snapstream_raster
Raster Layer
Input snap raster used to snap the point
to delineate to snap cells. Default to input
Stream Grid if not set.
(Optional)
Input Catchment features used to restrict

the extent of the local delineation to
perform.
Feature Layer
Input AdjointCatchment features defining

upstream areas associated to each
catchment.
Feature
Layer;Feature
Layer
clear_features
Indicates whether to clear existing

watershed and watershed point features.
Default to False (do not clear).
Boolean
out_watershed_features
Output watershed features generated.
Feature Class
out_watershedpoint_features
Ouput watershed point features

generated.
Feature Class
(Optional)
12/8/2014
Page 7 of 30
Environments
ArcInfo: Yes
Batch Watershed Delineation for Polygons (Arc Hydro Tools)
Summary
Delineates batch watersheds associated to polygon features.
Learn more about how Batch Watershed Delineation for Polygons (Arc Hydro) works
Usage
Syntax
BatchWatershedDelineationForPolygons_archydro (in_batchpolygon_features,
in_flow_direction_raster, out_watershed_features)
Parameter
Explanation
Data Type
in_batchpolygon_features
Input batch polygon to process.
Input flow direction grid supporting the

delineation.
Feature
Layer
Raster
Layer
Output watershed feature classes storing the

delineated watersheds.
Feature
Class
Environments
ArcInfo: Yes
Construct 3D Line (Arc Hydro Tools)
12/8/2014
Page 8 of 30
Summary
Generates 3D line features.
Usage
Syntax
Construct3DLine_archydro (in_line2d_features, in_rawdem_raster, out_line3d_features)
Parameter
Explanation
Data Type
in_line2d_features
Input Line2D features to process.
Feature Layer
in_rawdem_raster
Input DEM used to extract the elevations.
Raster Layer
out_line3d_features
Ouput 3D Line features generated.
Feature Class
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Delineate from Multiple Inlets and Outlets (Arc Hydro Tools)
Summary
Delineates watersheds based on input inlet and outlet points. Learn more about how
Delineate from Multiple Inlets and Outlets (Arc Hydro) works
Usage
z
The tool works on a selected set of inlet and outlet points and will process all points if
there is no selected set.
The field SrcType indicates whether the input point is an inlet (1) or Outlet (0). This
field is optional and will be created if it does not exist. Null values are considered as
outlets.
The field SnapOn indicates whether the source point must be snapped to the stream
grid (Snap: 1, Do not snap: 0).
Syntax
DelineateFromMultipleInletsAndOutlets_archydro (in_pointsource_features,
in_flow_direction_raster, in_stream_raster, out_watershed_features,
out_watershedpoint_features)
12/8/2014
Parameter
Explanation
Page 9 of 30
Data Type
in_pointsource_features
Input inlet and outlet points. May be created

using the Batch Point Generation function on
the Arc Hydro Tools toolbar.
Feature
Layer
Input Flow Direction grid supporting the

delineation.
Raster
Layer
in_stream_raster
Input Stream Grid used for snapping.
Output watershed associated to the input

inlets and outlets.
Raster
Layer
Feature
Class
out_watershedpoint_features
Output watershed points storing the snapped

inlets and outlets.
Feature
Class
Environments
ArcInfo: Yes
Drainage Area Centroid (Arc Hydro Tools)
Summary
Generates drainage area centroid.
Learn more about how Drainage Area Centroid (Arc Hydro) works
Usage
Syntax
DrainageAreaCentroid_archydro (in_drainage_area_features, out_centroid_features)
Parameter
Explanation
out_centroid_features
Output centroid features associated to areas.
Data Type
Feature
Layer
Feature
Class
Environments
12/8/2014
Page 10 of 30

ArcInfo: Yes
Flow Path Parameters from 2D Line (Arc Hydro Tools)
Summary
Calculates flow path parameters for 2D lines. Learn more about how Flow Path Parameters
from 2D Line (Arc Hydro) works
Usage
Syntax
FlowPathParametersFrom2DLine_archydro (in_longestflowpath_features, in_rawdem_raster,
out_slp1085point_features)
Parameter
Explanation
Data Type
Input Longest Flow Path feature class.
in_rawdem_raster
Input DEM used to retrieved elevation along

the lines.
Feature
Layer
Raster
Layer
out_slp1085point_features
Output Slope 10-85 points associated to the

input lines.
Feature
Class
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Flow Path Parameters from 3D Line (Arc Hydro Tools)
Summary
Calculates flow path parameters for 3D lines.Learn more about how Flow Path Parameters
12/8/2014
Page 11 of 30
from 3D Line (Arc Hydro) works
Usage
Syntax
FlowPathParametersFrom3DLine_archydro (in_longestflowpath3d_features,
out_slp1085point_features)
Parameter
Explanation
Data
Type
in_longestflowpath3d_features
Input 3D Longest Flow Path features to

characterize.
Feature
Layer
out_slp1085point_features
Output 1085 Slope Point features associated

to the input lines.
Feature
Class
Environments
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Interactive Delineation (Arc Hydro Tools)
Summary
Interactive watershed delineation model based on Batch Watershed Delineation tool.
Usage
Syntax
InteractiveDelineation_archydro (Input_Points_to_Delineate, Input_Flow_Direction_Grid,
Input_Stream_Grid, {Input_Snap_Stream_Grid}, Input_Catchment, Input_Adjoint_Catchment,
Watershed, WatershedPoint)
Parameter
Explanation
Data Type
Input_Points_to_Delineate
Inputs points where the delineations should be

performed.
Feature Set
Input_Flow_Direction_Grid
Input Flow Direction grid used to delineate

within the catchments.
Raster
Layer
Input_Stream_Grid
Input Stream Grid used to defined whether a

point must consider an adjoint catchment.
Raster
Layer
12/8/2014
Input_Snap_Stream_Grid
Page 12 of 30
Input Snap Stream Grid used to snap the input Raster

Layer
points.
(Optional)
Input_Catchment
Input Catchment feature class used to define

the areas where the local delineation should
be performed to improve performance.
Feature
Layer
Input_Adjoint_Catchment
Input Adjoint Catchment defining upstream

aggregated areas for each catchmnent.
Feature
Layer
Watershed
Output Watershed features.
WatershedPoint
Output Watershed Point features.
Feature
Layer
Feature
Layer
Environments
ArcInfo: Yes
Longest Flow Path (Arc Hydro Tools)
Summary
Generates longest flow path features associated to input drainage areas.
Learn more about how Longest Flow Path (Arc Hydro) works
Usage
Syntax
LongestFlowPath_archydro (in_drainage_area_features, in_flow_direction_raster,
Parameter
Explanation
Data Type
Input Flow Direction grid used to define the

longest path within each area.
Feature
Layer
Raster
Layer
Output longest flow path features associated

to each input area.
Feature
Class
Environments
12/8/2014
Page 13 of 30
ArcInfo: Yes
Longest Flow Path for Subwatersheds (Arc Hydro Tools)
Summary
Generates longest flow paths for subwatersheds using preprocessed data, and in particular
the "Longest Flow Path Adjoint Catchment", to speed up the computation of the longest flow
paths. If the preprocessed data is not available, the function Longest Flow Path may be used
instead.
Usage
z
The tool works on a selected set of input subwatershed features. If there is no selected
set, the tool will process all features in the input Subwatershed feature class.
Syntax
LongestFlowPathForSubwatersheds_archydro (in_subwatershed_features,
in_subwatershedpoint_features, in_catchment_features, in_longestflowpathforcat_features,
in_flow_direction_raster, out_longestflowpath_features)
Parameter
Explanation
Data
Type
Input subwatershed features to process.
in_subwatershedpoint_features
Input subwatershed point features

associated to subwatersheds to process.
Feature
Layer
Feature
Layer
Input catchment features associated to

subwatersheds to process.
Feature
Layer
in_longestflowpathforcat_features
Input Longest Flow Path for catchment

features associated to subwatersheds to
process.
Feature
Layer
Input Flow Direction Grid associated to

subwatersheds to process.
Raster
Layer
Output longest flow path features.
Feature
Class
Environments
12/8/2014
Page 14 of 30

ArcInfo: Yes
Longest Flow Path for Watersheds (Arc Hydro Tools)
Summary
Generates longest flow paths for watershed using preprocessed data, and in particular the
"Longest Flow Path Adjoint Catchment" feature class, to speed up the computation of the
longest flow paths. If the preprocessed data is not available, the function Longest Flow Path
may be used instead to generate the flow paths.
Usage
z
The tool works on a selected set of input watershed features. If there is no selected set,
the tool will process all features in the input Watershed feature class.
For each subwatershed, the function performs the following steps:

Step 1 - Identify the associated SubwatershedPoint feature.
Step 2 - Identify the Catchment feature that contains the SubwatershedPoint.
Step 3 - Identify the catchment longest flowpath features that are completely within
the SubWatershed.
Step 4 - Find the Longest Flowpath for Catchment that has the longest lengthdown.
Step 5 - Find the From point of the flowpath and compute costpath.
Step 6 - Trim the longest flowpath using the Subwatershed polygon.
Step 7 - Compute the longest flowpath for the intersect polygon between Catchment
and Subwatershed
Step 8 - Store the longest between the paths generated at steps 6 and 7.
Syntax
LongestFlowPathForWatersheds_archydro (in_watershed_features,
in_watershedpoint_features, in_catchment_features, in_adjointcatchment_features,
in_longestflowpathadjcat_features, in_drainageline_features, in_flow_direction_raster,
Parameter
Explanation
in_watershed_features
Input watershed features to process.
in_watershedpoint_features
Input watershed point features associated

to watersheds to process.
Input Catchment features associated to

watersheds to process.
Data
Type
Feature
Layer
Feature
Layer
Feature
Layer
12/8/2014
Page 15 of 30
Input Adjoint Catchment features

associated to watersheds to process.
Feature
Layer
in_longestflowpathadjcat_features
Input Longest Flow Path Adjoint

Catchment features associated to
Feature
Layer
Input Drainage Line features associated to

Feature
Layer
Input Flow Direction Grid associated to

Raster
Layer
Output Longest Flow Path features.
Feature
Class
Environments
ArcInfo: Yes
Main Flow Path (Arc Hydro Tools)
Summary
Generates main flow paths.
Usage
Syntax
MainFlowPath_archydro (in_watershed_features, in_watershedpoint_features,
in_drainageline_features, in_catchment_features, in_rawdem_raster, in_flow_direction_raster,
in_flow_accumulation_raster, number_cells, out_main_flowpath_features, {area_sqkm})
Parameter
Explanation
Data Type
in_watershed_features
Input Watershed features to process.
in_watershedpoint_features
Input Watershed Point features associated to

the watersheds to process.
Feature
Layer
Feature
Layer
Input Drainage Line features associated to

the watersheds to process.
Feature
Layer
Input Catchment features associated to the

Feature
Layer
in_rawdem_raster
Raster
12/8/2014
Input Raw DEM.

Input Flow Direction Grid.
in_flow_accumulation_raster
Input Flow Accumulation Grid.
number_cells
Number of cells to define small stream

threshold.
out_main_flowpath_features
Output Main Flow Path feature class.
area_sqkm
Area in square kilometers to define small

stream threshold.
(Optional)
Page 16 of 30
Layer
Raster
Layer
Raster
Layer
Double
Feature
Class
Feature
Class
Environments
ArcInfo: Yes
Smooth 3D Line (Arc Hydro Tools)
Summary
Smooths 3D lines linearly in the digitized direction.
Usage
Syntax
Smooth3DLine_archydro (in_line3d_features, out_smoothline3d_features)
Parameter
Explanation
in_line3d_features
Input 3D line feature classes to smooth.
out_smoothline3d_features
Output smoothed 3D line feature class.
Data Type
Feature
Layer
Feature
Class
Environments
ArcView: Yes
ArcEditor: Yes
12/8/2014
Page 17 of 30
ArcInfo: Yes
Subwatershed from Watershed (Arc Hydro Tools)
Summary
Develops Arc Hydro subwatershed polygon and subwatershed point feature classes from Arc
Hydro watershed polygon and watershed point feature classes. The input watershed polygon
and point feature classes have to be correctly attributed (HydroID, DrainID, Name). The
output subwatershed point feature class will have the same attributes as the input watershed
point feature class as well as DrainID that links the feature to the HydroID of the
corresponding subwatershed polygon feature
Usage
z
When deriving subwatersheds for large DEMs (e.g. 10,000 by 10,000 cells or larger), it
is more efficient (performance) to first develop a set of watersheds based on batch
points, and then run this function to generate the subwatersheds instead of using the
Arc Hydro "Batch Subwatershed Delineation" function.
The output feature classes are stored in the same geodatabase/feature dataset as the
input watershed feature class if only the name of the resulting layer is provided, or in
the user specified location if a full path is provided.
Syntax
SubWatershedFromWatershed_archydro (Input_Watershed, Input_Watershed_Point,
Output_Subwatershed, Output_Subwatershed_Point)
Parameter
Input_Watershed
Explanation
Input watershed polygon feature class.
Input_Watershed_Point
Input watershed point feature class.
Output_Subwatershed
Name of the output subwatershed polygon

feature class.
Data Type
Feature
Layer
Feature
Layer
Feature
Layer
It will be placed in the same location as the

input watershed feature class if only the
name of the resulting layer is provided, or in
the user specified location if a full path is
provided.
Output_Subwatershed_Point
Name of the output subwatershed point

feature class.
Feature
Layer
It will be placed in the same location as the

input watershed feature class if only the
name of the resulting layer is provided, or in
the user specified location if a full path is
provided.
12/8/2014
Page 18 of 30
Environments
ArcInfo: Yes
Learn more about how Batch Global Delineation (Arc Hydro) works
The Batch Global Watershed Delineation tool allows delineating global watersheds for batch
points located in Catalog Units. The tool performs first a local delineation in the point's Catalog
Unit. It then merges the resulting local watershed with the Catalog Units polygons located
upstream.
The tool also allows computing global parameters by performing operations such as average,
weighted average, sum (see list under Configuring a new standard parameter) or by using
custom operators (e.g. 10-85 slope computation). Parameters for global watersheds may also
be computed with the tool Compute Global Parameters.
Input
Output
"Catalog Unit Junction" Network Class
"Global Watershed Point"
"Catalog Unit Edge" Network Class
"Global Watershed"
"Catalog Unit Polygon" Feature Class

"Batch Point" Feature Class
If there is a network junction feature class that has a tag "Catalog Unit Junction", it will be
used as a default for the input theme. If not, the user needs to select an existing network
junction theme name that will be tagged with the "Catalog Unit Junction" at the end of the
operation.
If there is a network edge feature class that has a tag "Catalog Unit Edge", it will be used as a
default for the input theme. If not, the user needs to select an existing network junction
theme name that will be tagged with the "Catalog Unit Edge" at the end of the operation.
If there is a polygon feature class that has a tag "Catalog Unit Polygon", it will be used as a
theme name that will be tagged with the "Catalog Unit Polygon" at the end of the operation.
Required field: Name
If there is a polygon feature class that has a tag "Catalog Unit Polygon", it will be used as a
theme name that will be tagged with the "Catalog Unit Polygon" at the end of the operation.
12/8/2014
Page 19 of 30
Required field: Name

If there is a point feature class that has a tag "Batch Point", it will be used as a default for the
Batch Point theme. If not, the user needs to select an existing point feature class that will be
tagged with the "Batch Point" tag at the end of the operation.
Optional Fields: Name, Descript, Batchdone (created), SnapOn
Note: The values in the fields Name and Descript, if defined, will be copied in to the output
Global Watershed and Global Watershed Point features.
If there is a theme that has a tag "Global Watershed Point ", it will be used as a default for the
output point feature class. If not, the user needs to specify a feature class name that will be
tagged with the " Global Watershed Point " tag at the end of the operation.
The Global Watershed Point feature class stores the points created by the user. This theme
has the following structure:
z
HydroID - Unique identifier of the Global Watershed Point in the Arc Hydro database.
DrainID - HydroID of the Global Watershed linked to the feature.
Name - Name copied from the input Batch Point
Descript - Description of the Global Watershed copied from the input Batch Point.
If there is a theme that has a tag "Global Watershed ", it will be used as a default for the
output polygon feature class. If not, the user needs to specify a feature class name that will
be tagged with the "Global Watershed" tag at the end of the operation.
This theme has the following structure:
z
HydroID - Unique identifier of the Global Watershed in the Arc Hydro database.
Name - Name copied from the input Batch Point.
Descript - Description copied from the input Batch Point.
GlobalWsh - Indicate whether the feature is a global (1) or a local (1) watershed. A local
watershed is the local part of a global watershed. Both features are stored in the Global
Watershed layer.
RelatedOIDs - OIDs of Cataloging Unit Polygons located upstream of the feature for local
watersheds. OID of associated local watershed for global watershed.
DrainID - Unique identifier (HydroID) of the Global Watershed associated to the feature.
Same as HydroID for Global Watershed.
Prerequisites
One and only one relationship (e.g. HUCHasJunction) must exist between the Catalog Unit
Junction and the Catalog Unit Polygon Feature class. The name of the relationship must match
the name defined in the XML file.
Data must be stored in the Unit Catalog folder (refer to the document on Global Point
Delineation), and must follow the naming convention set in the XML (for Flow Direction Grid,
Stream Grid, Catchment, AdjointCatchment, Network Name). Refer to the document Global
Delineation with EDNA Data for additional information on data requirements.
Global parameters must be defined in the XML with the operation that must be performed
(e.g. sum, average, weighted average).

z
Select Watershed Processing>Batch Global Watershed Delineation.
12/8/2014
Select the parameters of interest.
Specify the input/output layers and click OK.
Page 20 of 30
The function will then retrieve the data path defined in the XML under
"FrameworkConfig/HydroConfig" "/ProgParams/ApFunctions/ApFunction(GlobalDelineation)".
Data Path is the root directory under which the directories corresponding to each catalog unit
are located. These directories contain the input layers needed for the delineation. The name of
the input layers in each directory must be the same, and the layer names set in the XML must
match these names. These inputs are Flow Direction Grid, Stream Grid, Catchment, Adjoint
Catchment, NetworkName and Relationship Name. The XML may be edited using XML
Manager.
The function will prompt for the data path if it is not already set.
z
Browse to the directory and click Add.
The function will then prompt for the snapping method to use. 3 options are available:
z
Snap all points
Do no snap all points
Use SnapOn field in Batch Point to decide whether to snap (SnapOn=1) or not
(SnapOn<>1).
Select the snapping method and specify the snapping tolerance. Click OK.
The function will look for the points in the input Batch Point feature class having BatchDone
set to 0 or null and process these points. It will follow the following steps for each of these
points:
z
Retrieve the name of the Catalog Unit Polygon in which the point is located.
Perform snapping, if selected, using the snap tolerance set in the XML.
Perform a local delineation within the catalog unit polygon for the point.
Check whether the snapped point is located on the network edge using the search
tolerance set in the XML.
If the point is on the network edge, place a flag at the location of the point, and trace
upstream to select the junctions located upstream in the network.
Retrieve all the Catalog Unit Polygons corresponding to the selected junctions, based on
the relationship between the polygons and junctions: the JunctionID in the polygon relates
to the HydroID field in the Junction feature class.
Merge all the selected polygons together with the locally delineated watershed, and save
the resulting polygon in the Global Watershed feature class.
Compute the selected global parameters.
Set BatchDone to 1 for the Batch Point if the process is successful without warning, 2 if
the delineation is successful but the point has been snapped into a different catchment
and -1 if the process fails.
Function Definition in XML

Under node HydroConfig/ProParams/ApFunctions/ApFunction(GlobalPointDelineation)
z
SnapToleranceNumCells: default number of cells used for snapping displayed in the

snapping form. Default to 6 cells.
SearchToleranceNumCells: number of cells used for searching for the stream network.
Default to 0.5 cells, i.e. point must be located in the same cell as a network stream
12/8/2014
Page 21 of 30
feature to be considered on the stream.

z
DataPath: Path to the global directory containing the CU directories.
FlowDirGrid: Name of the flow direction grid in the CU directories.
StreamGrid: Name of the stream grid in the CU directories.
SnapStreamGrid: Optional. Name of the stream grid used for snapping. The StreamGrid
must be a subset of the SnapStreamGrid. If not specified, the StreamGrid will be used for
snapping.
Catchment: Name of the catchment polygon feature class in the CU directories.
AdjointCatchment: Name of the adjoint catchment polygon feature class in the CU

directories.
NetworkName: Name of the global geometric network (e.g. HUC_Net).
RelationshipName: Name of the relationship between CU Poly and CU Junction.
GlobalParameter: Definition of global computation methods for Global Parameters
Under node HydroConfig/ProParams/ApFunctions/ApFunction(WshpParams)

z
ApFields/ApField(Parameter): Defines name and local computation method for

parameters.
Learn more about how Batch Subwatershed Delineation (Arc Hydro)

works
The Batch Subwatershed Delineation tool (Watershed Processing toolset) allows delineating
subwatersheds for all the points in a selected Point Feature Class. Points may be added to the
BatchPoint feature class with the tool Batch Point Generation available on the Arc Hydro toolbar.
Input
Output
"Subwatershed Point" Feature Class
"Stream Grid"
"Subwatershed" Polygon Feature Class
Flow Direction Grid. If not, the user needs to select an existing grid theme (of flow direction
If there is a grid theme that has a tag "Stream Grid", it will be used as a default for the Stream
Grid. If not, the user needs to select an existing grid theme that will be tagged with the "Stream
Required Fields: Name, Descript, BatchDone, SnapOn.
12/8/2014
Page 22 of 30
The user is prompted for two themes, used to store the result of the computation. These two
themes will be created and added to the ArcMap Table of Contents, if not already there:
The first layer created is the SubwatershedPoint feature class ("Subwatershed Point" tag), which
stored the location of the processed batch points. The points are moved to the center of the cell
in which they are located if no snapping is performed, otherwise they are moved to the snapped
locations. If there is a feature class name that has a tag "Subwatershed Point", it will be used as
a default for the Watershed Point output feature class. If not, the user needs to specify a feature
class name that will be tagged with the "WatershedPoint" tag at the end of the operation. If the
output feature class name already exists, all the existing features will be deleted and the new
points will be then added in this existing feature class.
Fields created:
z
HydroID - Unique identifier of the watershed point in the Hydro database.
DrainID - HydroID of the associated watershed.
Name - Name retrieved from the Batch Point input layer.
Descript - Description retrieved from the Batch Point input layer.
The second output layer is the Subwatershed polygon feature class ("Subwatershed" tag), which
stores the delineated subwatersheds. If there is a feature class name that has a tag
"Subwatershed", it will be used as a default for the Subwatershed output polygon feature class. If
not, the user needs to specify a feature class name that will be tagged with the "Subwatershed"
tag at the end of the operation. If the output feature class name already exists, all existing
features will be cleared and the new polygons will be appended in this existing feature class.
Fields created:
z
HydroID - Unique identifier of the watershed in the Hydro database.
DrainID - Same as HydroID, since Watershed is a drainage area.
Learn more about how Batch Watershed Delineation (Arc Hydro)

works
The Batch Watershed Delineation tool (Watershed Processing toolset) allows delineating
watersheds in batch for points defined in the BatchPoint feature class. Points may be added to
the BatchPoint feature class with the tool Batch Point Generation available on the Arc Hydro Tools
toolbar. .
The user is prompted for the following five input themes and two output themes:
Input
Output
"Watershed Point" Feature Class
"Stream Grid"
"Watershed" Polygon Feature Class
"Snap Stream Grid" (optional)

12/8/2014
Page 23 of 30
"Adjoint Catchment" Polygon Feature Class

If there is a grid theme that has a tag "Snap Stream Grid", it will be used as a default for the
input Snap Stream Grid. If not, the user needs to select an existing grid theme that will be
tagged with the "Stream Grid" tag at the end of the operation or leave this optional input Null. If
the input is Null, the tool will use the Stream Grid instead..
If there is a polygon feature class that has a tag "Catchment", it will be used as a default for the
Catchment theme. If not, the user needs to select an existing polygon feature class that will be
tagged with the "Catchment" tag at the end of the operation.
Required Fields: GridID
If there is a polygon feature class that has a tag "Adjoint Catchment", it will be used as a default
for the Adjoint Catchment theme. If not, the user needs to select an existing polygon feature
class that will be tagged with the "Adjoint Catchment" tag at the end of the operation.
Required Fields: GridID
Required Fields: Name, Batchdone, Snapon, Descript
The first layer created is the WatershedPoint feature class ("Watershed Point" tag), which stored
the location of the processed batch points. The points are moved to the center of the cell in
which they are located if no snapping is performed, otherwise they are moved to the snapped
locations. If there is a feature class name that has a tag "Watershed Point", it will be used as a
default for the Watershed Point output feature class. If not, the user needs to specify a feature
class name that will be tagged with the "WatershedPoint" tag at the end of the operation. If the
output feature class name already exists, the new points will be appended in this existing feature
class.
Fields created:
z
Descript - Description retrieved from the Batch Point input layer.
The second output layer is the Watershed polygons feature class ("Watershed" tag), which stores
the delineated watersheds. If there is a feature class name that has a tag "Watershed", it will be
used as a default for the Watershed output polygon feature class. If not, the user needs to
12/8/2014
Page 24 of 30
specify a feature class name that will be tagged with the "Watershed" tag at the end of the
operation. If the output feature class name already exists, the new polygons will be appended in
this existing feature class.
Fields created:
z
DrainID - Same as HydroID, since Watershed is a drainage area.

The tool performs the following operations:
z
Prompt the user for the name of the themes to use as input/output.
Check the value of the field "BatchDone" for each point in the input BatchPoint feature
class:
If BatchDone=1, -1 or 2: the tool ignores this point, for which the batch watershed
delineation has already been performed or attempted.
If BatchDone=0: the tool performs the batch watershed delineation for this point.
Add the point for which a watershed is delineated in the WatershedPoint feature class
("WatershedPoint" tag). The function checks the value of the field SnapOn in the
BatchPoint feature class to perform the snapping. If snapping is requested, all the points
located within 6 cells (default) of a Snap Stream Grid cell (or Stream grid cell if Snap
Stream Grid is left null) will be snapped onto the closest cell on the stream. If the snapped
point is not located in the same catchment as the original point, the tool populates the
field BatchDone with the value 2 to flag the input point.
Create the associated watershed in the Watershed feature class ("Watershed" tag), even
for the points that could not be snapped.
Update the value of the field BatchDone from '0' to '1' for the point in the input batch
point feature class if the delineation was successful without warning, to '2' if the
delineation was successful with a warning (point snapped to different catchment) and to '1' if the delineation failed.
Note
The default snapping tolerance is read from the configuration XML and is set to 6 cells. This
value can be modified by editing the parameter
HydroConfig/ProgParams/ApFunctions/ApFunction
(BatchWatershedDelineation/SnapToleranceNumCells
Learn more about how Batch Watershed for Polygons (Arc Hydro)
works
The Batch Watershed Delineation for Polygons function (Watershed Processing toolset) allows
delineating watersheds for source polygon features (e.g. lakes) in the selected Batch Polygon
12/8/2014
Page 25 of 30
feature class.
Input
Output
"Batch Polygon" Feature Class
If there is a polygon feature class that has a tag "Batch Polygon", it will be used as a default for
the Batch Polygon theme. If not, the user needs to select an existing polygon feature class that
will be tagged with the "Batch Polygon" tag at the end of the operation.
Fields Created:
z
DrainID - HydroID of the associated delineated watershed.
BatchDone - Indicates whether the polygon has been already processed (0-not processed,
1-processed, -1-processed with error).
The user is prompted for a Watershed polygon feature class layer ("Watershed" tag) used to
store the result of the delineation. This layer will be created and added to the ArcMap Table of
Contents, if not already there. If there is a feature class name that has a tag "Watershed", it will
be used as a default for the Watershed output polygon feature class. If not, the user needs to
operation. If the output feature class name already exists, all existing features will be cleared
and the new polygons will be appended in this existing feature class.
Fields created:
z
HydroID - Unique identifier of the watershed in the Arc Hydro database.
Learn more about how Construct 3D Line (Arc Hydro) works
Learn more about how Delineate from Multiple Inlets and Outlets
(Arc Hydro) works
The Delineate from Multiple Inlets and Outlets tool (Watershed Processing toolset) allows
delineating watersheds based on input inlet and outlet points. The function works on a selected
set of Point Source features and prompts whether to process all points if there is no selected set.
At least one of the input point must be an outlet (i.e. SrcType=0). If the SrcType and SnapOn
12/8/2014
Page 26 of 30
fields are not present, they will be created with Null values (Same as outlet).
Input
Output
"Stream Grid"
"Watershed Point" Feature Class
"Point Source" Feature Class
If there is a point feature class that has a tag "Point Source", it will be used as a default for the
Point Source theme. If not, the user needs to select an existing point feature class that will be
Optional Fields:
z
Name - Name of point source.
Descript - Description of point source.
SrcType - Source type (0 - outlet, 1 - inlet). Field is created with null value if it does not
exist. Null is considered the same as 0 (outlet).
SnapOn - Indicates whether the point should be snapped (1) or not to the Stream Grid.
The first layer created is the WatershedPoint feature class ("Watershed Point" tag), which stores
the location of the processed point sources. If there is a feature class name that has a tag
"Watershed Point", it will be used as a default for the Watershed Point output feature class. If
not, the user needs to specify a feature class name that will be tagged with the "WatershedPoint"
tag at the end of the operation. If the output feature class name already exists, the new points
will be appended in this existing feature class.
Fields created:
z
Name - Name of point source.
Descript - Description of point source.
SrcType - Type of associated point source (0-outlet, 1-inlet).
OnRiver - Indicate whether the point is located on the stream grid (0-not on stream grid/1on stream grid).
The second output layer is the Watershed polygons feature class ("Watershed" tag), which stores
the delineated watersheds. If there is a feature class name that has a tag "Watershed", it will be
used as a default for the Watershed output polygon feature class. If not, the user needs to
12/8/2014
Page 27 of 30
operation. If the output feature class name already exists, the new polygons will be appended in
this existing feature class.
Fields created:
How the tool works

The tool performs the following operations:
z
Check whether there is a selection set of point sources and prompts the user whether to
proceed with all features if there is no selection set.
Check that there is at least one outlet among being processed. Abort otherwise.
Copy the point sources being processed into the output watershed point feature class.
Check whether each point is located on the stream grid and populated the field OnRiver
with 1 if it is the case, 0 otherwise.
Copy the field SrcType with the value from the corresponding Point Source. Set the value
to 0 (outlet) if the field is not populated.
Populate the field DrainID with -99 to identify the point as being processed.
Generate the watersheds for the outlets and subtract watershed from inlets.
Update the DrainID field for the watershed points with the HydroID of the watershed.
Learn more about how Drainage Area Centroid (Arc Hydro) works
Generates Centroid points for input drainage areas.
Learn more about how Flow Parameters from 2D Line (Arc Hydro)
works
The Flow Path Parameters from 2D Line tool (Watershed Processing toolset) allows computing
slopes,10-85 slopes and 10-85 points for the longest flow path.
Input
Output
"Raw DEM " Grid
"Slope 1085 Point" 3D Feature Class
"Longest Flow Path" Feature

Class
Parameters fields added/populated in "Longest Flow Path"

Feature Class
If there is a grid theme that has a tag "Raw DEM", it will be used as a default for the first input
12/8/2014
Page 28 of 30
"Raw DEM" Grid tag at the end of the operation.
If there is a line feature class that has a tag "Longest Flow Path", it will be used as a default for
the second input theme. If not, the user needs to select an existing line feature class that will be
tagged with the "Longest Flow Path " tag at the end of the operation.
Fields created:
z
LengthMi: Length of Longest Flow Path in miles.
SlpFM: Slope in feet per mile.
Slp1085FM: 10-85 slope in feet per mile.
Slp: Dimensionless slope.
Slp1085: Dimensionless 10-85 slope.
ElevUP: Upstream elevation in XY units of the input DEM.
ElevDS: Downstream elevation in XY units of the input DEM.
Elev10: Elevation at 10% in XY units of the input DEM.
Elev85: Elevation at 85% in XY units of the input DEM.
If there is a 3D point feature class that has a tag "Slope 1085 Point", it will be used as a default
for the output feature class. If not, the user needs to specify a feature class name that will be
tagged with the "Slope 1085 Point" tag at the end of the operation. The records in the existing
output feature class with the same DrainID will be cleared
Fields created:
z
HydroID: Unique identifier of the feature in the database.
DrainID: HydroID of the drainage area corresponding to the longest flow path and 10-85
points.
Name: Indicates whether the point is located at 10% or 85% along the flow path from the
outlet.
Elev: Elevation in XY units of the input DEM.

For each selected line feature in the "Longest Flow Path" feature class, the function creates (if
needed) and populates the parameters fields. Slopes are computed based on the elevations
read from the input DEM grid. The function also generates and stores the associated 10-85
points.
Learn more about how Flow Path Parameters from 3D Line (Arc
Hydro) works
The Flow Path Parameters from 3D Line function (Watershed Processing toolset) allows
computing slopes and 10-85 slopes for the longest flow path based on input 3D lines.
Input
Output
"Longest Flow Path 3D"
12/8/2014
Feature Class
Page 29 of 30
"Slope 1085 Point" 3D Feature Class

Parameters fields added/populated in "Longest Flow Path"
Feature Class
If there is a 3D line feature class that has a tag "Longest Flow Path 3D", it will be used as a
default for the second input theme. If not, the user needs to select an existing line feature class
that will be tagged with the " Longest Flow Path " tag at the end of the operation.
Fields created:
z
LengthMi: Length of Longest Flow Path in miles.
SlpFM: Slope in feet per mile.
Slp1085FM: 10-85 slope in feet per mile.
Slp: Dimensionless slope.
Slp1085: Dimensionless 10-85 slope.
ElevUP: Upstream elevation.
ElevDS: Downstream elevation.
Elev10: Elevation at 10%.
Elev85: Elevation at 85%.
If there is a 3D point feature class that has a tag "Slope 1085 Point", it will be used as a default
for the output feature class. If not, the user needs to specify a feature class name that will be
tagged with the "Slope 1085 Point" tag at the end of the operation. The records in the existing
output feature class with the same DrainID will be cleared
Fields created:
z
HydroID: Unique identifier of the feature in the database.
DrainID: HydroID of the drainage area corresponding to the longest flow path and 10-85
points.
Name: Indicates whether the point is located at 10% or 85% along the flow path from the
outlet.
Elev: Elevation in meters.
How the tool works

For each selected line feature in the "Longest Flow Path 3D" feature class, the function creates
(if needed) and populates the parameters fields. Slopes are computed based on the elevations
stored in the 3D lines. The function also generates and stores the associated 10-85 points.
Learn more about how Interactive Delineation (Arc Hydro) works

Interactive watershed delineation model based on Batch Watershed Delineation tool.
12/8/2014
Page 30 of 30
Learn more about how Longest Flow Path (Arc Hydro) works
Generates longest flow paths associated to input areas.
Learn more about how Smooth 3D Line (Arc Hydro) works

Smooths 3D line in the downstream direction.
12/8/2014

Arc Hydro Toolbox

Caricato da

Informazioni sul documento

Copyright

Formati disponibili

Condividi questo documento

Condividi o incorpora il documento

Opzioni di condivisione

Hai trovato utile questo documento?

Questo contenuto è inappropriato?

Copyright:

Formati disponibili

Arc Hydro Toolbox

Caricato da

Copyright:

Formati disponibili

An overview of the Arc Hydro toolbox

An overview of the Arc Hydro toolbox

Arc Hydro Setup

Define default target locations for the tools.

Populate attributes in the Arc Hydro geodatabase.

GIS Data Exchange

Export/Import data between geodatabases and XML files.

Contain toolsets supporting hydrologic and hydraulic modeling

Perform operation on the geometric network.

Characterize point features.

Perform analyses on a non-dendritic (i.e. flat) terrain.

Preprocess terrain data for delineation.

Typical terrain preprocessing workflow (e.g. Dendritic terrain)

Various utilities tools.

Delineate and characterize watersheds.

Arc Hydro Tools toolbox's toolsets

Copyright 1995-2013 Esri. All rights reserved.

Arc Hydro Tools

-5i Assign WatershediD

""'\ Compute Global Parameters

Compute Subwatershed Parameters

Find Next Downstream Junction

Generate From/To Node for lines

Generate From/To Node for lines

)a Iden:ify Riparian Water Bodies

B ~ Arc Hydro Setup

)a Flood From Stream W5E

" Recompute Flows

Generate Flow Path

Assign Stream Slope

Generate Point Connectivity

Burn Stream Slope

Create Drainage line Structures

Set Flow Direction Using Preferential link

Generate Group link

..!j Create Sink Structures

Append Coastal Catchments

Get Field Alias by Alias

Batch Watershed Delineation for Polygons

Drainage Area Centroid

;}a Identify Updated Catchments

.si' Update ApUniqueiD Table

~ Update Raster Data

crJ Conversion Tools

11 crJ Data Interoperability Tools

An overview of the Arc Hydro Setup toolset

An overview of the Arc Hydro Setup toolset

Create the vector target database/dataset and raster vector location if

Overview of Arc Hydro Setup Toolset

Copyright 1995-2013 Esri. All rights reserved.

Set Batch Target Locations (Arc Hydro Tools)

An overview of the Arc Hydro Setup toolset

Copyright 1995-2013 Esri. All rights reserved.

Set Target Locations (Arc Hydro Tools)

Application for which the default locations are being

Define the dataframe in the map for which the

Workspace where the output rasters generated by

Vector workspace where the vector data generated

An overview of the Arc Hydro Setup toolset

Copyright 1995-2013 Esri. All rights reserved.

Copyright 1995-2013 Esri. All rights reserved.

Arc Hydro Default Configuration

An overview of the Attribute Tools toolset

An overview of the Attribute Tools toolset