Documente Academic
Documente Profesional
Documente Cultură
Page 1 of 1
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
Attribute Tools
H&H Modeling
Network Tools
Point Characterization
Terrain Morphology
Terrain Preprocessing
Terrain Preprocessing
Workflows
Utility
Watershed Processing
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2E9A.htm
12/8/2014
'
B ~ 10 Management
'\, Assign HydroiD
'
Assign UniqueiD
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
.---i
'
'
'
'
'
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
"
"
Compute Flows
Edit Computed Parameters
-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
'
'
Build Walls
"
Snap Point
'
'
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
'
'
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
'
'
'
~~
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
)a
"\
"\
"\
"\
"\
.si'
B
ArcHydroPartiaiTerrainUpdate
~ Add Field Long
)0 Basic Deranged Terrain Processing
)a Basic Deranged Terrain Processing for Update
~ Compact HydroiD
)0 Create OEM for Reprocessing
11
11
11
Coverage Tools
c;,
Page 1 of 4
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
Set Target
Locations
Create the specified target raster and vector locations and update the
active configuration in ArcMap. All licenses supported.
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
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
String
in_mapname
String
in_rasterlocation
Workspace
in_vectorlocation
Environments
This tool does not use any geoprocessing environments
Related Topics
Set Batch Target Locations
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhD360.htm
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhD360.htm
12/8/2014
Page 1 of 29
The Attribute Tools toolset contains tools that populate attributes in the Arc Hydro geodatabase.
Tools
Description
ID Management
toolset
Models toolset
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
Subwatershed
Parameters
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
Percent by Zone
Model calculating the percent of a given type in each zone. Used by the
Compute Global Parameters tool.
Populate JunctionID with HydroID of the area outlet using Drainage Point
Proximity method.
Populate JunctionID with HydroID of the area outlet using the Junction
Intersect method.
Populate JunctionID with HydroID of the arae outlet using the Next
Downstream Area method.
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
Compact HydroID
Select by Attribute
Select by attribute.
Select by WatershedID
Select by WatershedID.
Sync HydroID
Update HydroID
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
This tool does not use any geoprocessing environments
Related Topics
Find Next Downstream Line
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 3 of 29
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
Table
String
Boolean
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 4 of 29
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
ArcGIS\Desktop10.x\ArcToolbox\Scripts\ArcHydro directory.
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})
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Parameter
Input_Workspace
HydroIDBase
(Optional)
Explanation
Page 5 of 29
Data Type
Workspace
Long
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Workspace
Workspace
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 6 of 29
Usage
Syntax
SelectbyWatershedID_archydro (WatershedID)
Parameter
WatershedID
Explanation
Data Type
Input WatershedID.
String
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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.
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 configuration for the tool is defined in the AHPyConfig.xml configuration file located in the
ArcGIS\Desktop10.x\ArcToolbox\Scripts\ArcHydro directory.
The list of feature classes/tables that should not be synchronized is read under the <ApFunction Name =
"SyncHydroID"> node in the configuration file.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
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
Workspace
Workspace
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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).
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
Data Type
Workspace
12/8/2014
WorkspaceSDE
Page 8 of 29
Workspace
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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 configuration for the tool is defined in the AHPyConfig.xml configuration file located in the
ArcGIS\Desktop10.x\ArcToolbox\Scripts\ArcHydro directory.
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
This tool does not use any geoprocessing environments
Licensing Information
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 9 of 29
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Type
Description
IDNAME
String
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
LAYERKEY
String IDNAME in the APUNIQUEID used as source for the unique identifier for this
layer/table-field combination.
ApUniqueID table
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 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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
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.
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
ID_Field
Category_Raster
Category_Field
Result_Table
Snap_Raster
(Optional)
Calculate_Percentages
(Optional)
Data Type
Composite
Geodataset
Field
Raster Layer
Field
Table
Raster Layer
Raster Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 11 of 29
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
Raster Layer
Result_Table
Table
Boolean
Ignore_NoData_in_calculations
(Optional)
Statistics_type
Snap_Raster
(Optional)
String
Raster Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Summary
Accumulate attributes.
Usage
z
Syntax
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 12 of 29
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
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
Field
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Summary
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
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
TableView
Field
String
TableView
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 14 of 29
Syntax
CalculateLengthDownstreamforEdges_archydro (input_edge_features)
Parameter
Explanation
input_edge_features
[input_edge_features,...]
Data Type
Feature
Layer;Feature
Layer
Environments
This tool does not use any geoprocessing environments
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_features,...]
Data Type
Feature
Layer;Feature
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Summary
Computes selected parameters for global watersheds.
Learn more about how Compute Global Parameters (Arc Hydro) works.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
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
global_datapath
input_parameters
Data Type
Feature Layer
Feature Layer
Directory
String
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
Folder
12/8/2014
(Optional)
Page 16 of 29
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 17 of 29
Syntax
FindNextDownstreamLine_archydro (in_line_features)
Parameter
in_line_features
Explanation
Data Type
Feature Layer
Environments
This tool does not use any geoprocessing environments
Related Topics
Assign HydroID
Assign Stream Slope
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
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
in_hydrojunction_features
in_drainagepoint_features
search_tolerance
Search tolerance.
Data Type
Feature Layer
Feature Layer
Feature Layer
Linear Unit
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
in_hydrojunction_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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
Data Type
Feature Class
Feature Layer
Boolean
Boolean
12/8/2014
Page 19 of 29
tolerance).
search_tolerance
(Optional)
compareupdownedges
(Optional)
checkedgesinarea
Boolean
Boolean
(Optional)
Boolean
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Feature Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 20 of 29
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
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
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
Input/Output Management
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"
Network preparation
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
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
Input/Output Management
Input/Output Management
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 23 of 29
Role
Field
Type
Description
Required
HydroID
Integer
Required
FROM_NODE
Integer
Required
TO_NODE
Integer
Created
NextDownID
Integer
Field
Type
Description
Created
FeatureID
Integer
Created
NextDownID
Integer
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
Input/Output Management
Input/Output Management
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
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
Input/Output Management
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 25 of 29
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
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.
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 the outlet junction based on the Junction Intersect, 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 Junction Intersect method requires the user to select as input a Hydro Junction feature class and an
Area feature class.
Input
Output
Input/Output Management
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.
Field created: JunctionID
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:
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
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.
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
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.
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 uses the Next Downstream Area method for locating the outlet junction:
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 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
Input/Output Management
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
Field created: JunctionID
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 29 of 29
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh3C5F.htm
12/8/2014
Page 1 of 10
The GIS Data Exchange toolset contains tools that import/export data between an XML file and a
geodatabase.
Tools
Description
Excel
Exchange
GWIS to
FEMA
Export GWIS data into FEMA database format. This toolset require the
Data Interoperability extension.
XML
Exchange
Description
Excel_to_Map
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
String
out_toolparams_table
Table
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2FF1.htm
12/8/2014
Page 3 of 10
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Export Tool Parameters (Arc Hydro) works
Exports geoprocessing tool or model parameters into a table.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2FF1.htm
12/8/2014
Page 4 of 10
Description
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
DestDataset_GEODATABASE_FILE
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2FF1.htm
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)
String
String
String
String
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Data Interoperability
ArcEditor: Requires Data Interoperability
ArcInfo: Yes
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
(Optional)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2FF1.htm
Data Type
Multiple
Value
Workspace
String
12/8/2014
SOURCE_CIT_S_HYDRO_REACH
(Optional)
SOURCE_CIT_S_NODES
(Optional)
Page 6 of 10
String
String
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Data Interoperability
ArcEditor: Requires Data Interoperability
ArcInfo: Yes
Description
Transform XML
Summary
Inserts information on coordinate system in existing XML file by editing the first node
'.//WKT' in the input XML.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2FF1.htm
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
File
Input_Coordinate_System
Coordinate
System
Overwrite_Coordinate_System_in_XML
Boolean
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
String
input_export_controlfile
File Location
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2FF1.htm
12/8/2014
output_export_xmlfile
Page 8 of 10
File Location
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
File Location
output_filegeodatabase
File
Geodatabase
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2FF1.htm
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
File Location
input_xslfile
File Location
output_file
File Location
Environments
This tool does not use any geoprocessing environments
Licensing Information
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2FF1.htm
12/8/2014
Page 10 of 10
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh2FF1.htm
12/8/2014
Page 1 of 63
The H&H Modeling toolset contains a set of toolsets that support hydrologic and hydraulic modeling.
Toolset
Description
GeoICPR
Map to Map
Streamstats
Time of Concentration
Utility
Description
Mosaic Floodplains
The tools generating ICPR data should be used in the following sequence:
1.
2.
3.
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
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
Feature Layer
Feature Layer
ICPRNodeResult
Input ICPR Node Max Stage (Ft) Table storing the results of the ICPR
modeling run.
Table View
ICPRBasin
Feature Layer
RawDEM
Input Digitial Elevation Model used to extract data to compute the depth
rasters.
Raster Layer
VariableDefinition
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
Feature Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
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
Feature Layer
ICPRNodeResult
Input ICPR Node Max Stage (Ft) Table storing the results of the ICPR
modeling run.
Table View
ICPRBasin
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
in_icprlink_features
in_groupbasin_features
in_catchment_features
in_preferentiallink_features
Data Type
Feature Layer
Feature Layer
Feature Layer
Feature Layer
Input Catchment
Input Preferential Link
Feature Layer
in_flow_direction_raster
Raster Layer
in_icprbasin_features
Feature Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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_groupbasin_features
in_icpr_seedpoint_features
in_grouplink_features
in_hydroedge_features
in_hydrojunction_features
Explanation
Data Type
Feature Layer
Feature Layer
Feature Layer
Feature Layer
Feature Layer
in_groupjunction_features
Feature Layer
in_icprnode_features
Feature Layer
in_hep_features
Feature Layer
in_icprlink_features
Input ICPR Link. Required fields: NAME, TYPE. Generated ICPR links will
be saved in this feature class.
Feature Layer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 5 of 63
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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)
in_icprnode_features
Explanation
Data Type
Feature Layer
Feature Layer
Feature Layer
The tool will delete all existing records in this feature class.
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
Data Type
Directory
Table
Table
12/8/2014
Page 6 of 63
out_node_hydrograph_table
out_link_hydrograph_table
Table
Table
Table
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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.
3.
Select as "Time Field": OBJECTID (the rasters in the rmosaic dataset have been sorted correcly by the tool).
4.
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Generate ICPR Basin (Arc Hydro) works
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
No Channel ICPR Link: ICPR Basins are identical to the input Group Basins and are draining into Stage/Area ICPR Nodes.
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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.
ICPR Link
Role
Field
Type
Description
Required
Type
String
Type of ICPR link. Populated with coded values from domain dICPR_LINKTYPE: WEIR,
CHANNEL.
Group Basin
Role
Field
Type
Description
Required
HydroID
String
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
Required
GroupID
Integer
Required
IsTerminal
Integer
Preferential Link
Role
Field
Type
Description
Required
FeatureID1
Integer
Required
FeatureID2
Integer
ICPR Basin
Role
Field
Type
Description
Created/Populated
HydroID
Integer
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".
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 9 of 63
Input
Output
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 12 of 63
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.
Field
Type
Description
Required
Name
String
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
Hydro Junction
Role
Field
Type
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
Description
12/8/2014
Page 13 of 63
Required
HydroID
Integer
Required
HYDRAULIC_TYPE_DESC
String
Required
JUNCTION_TYPE_DESC
String
Group Junction
Role
Field
Type
Description
ICPR Node
Role
Field
Type
Description
Created
Type
String
Type of ICPR node. Populated with coded values from domain dICPR_NODETYPE:
STAGE/AREA, TIME/STAGE, STAGE/VOLUME, MANHOLE, CHANNEL, PIPE, DROP
STRUCTURE. Tool uses features of type CHANNEL.
Created
IsIncluded
Short
Integer
Field
Type
Description
Required
JUNCTIONID
Integer
Required
SUBELEMENTID
Integer
Required
SUBELEMENT_TYPE
String
ICPR Link
Role
Field
Type
Description
Created
HydroID
Integer
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.
Output
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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.
Field
Type
Description
Required
TYPE
String
Group Node
Role
Field
Type
Description
Required
TYPE
String
ICPR Node
Role
Field
Type
Description
Created
HydroID
Integer
Created
Name
String
Created
Type
String
Type of ICPR node. Populated with coded values from domain dICPR_NODETYPE:
STAGE/AREA, TIME/STAGE, STAGE/VOLUME, MANHOLE or CHANNEL.
Created
IsIncluded
Short
Integer
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Input
Page 15 of 63
Output
"TSTypeInfo" Table
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.
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)
NAME
NAME (Text)
YR100_1DAY
YR100_1DAY (Float)
YR100_5DAY
YR100_5DAY (Float)
YR500_1DAY
YR500_1DAY (Float)
YR500_5DAY
YR500_5DAY (Float)
ICPR_NODE_HYDROGRAPH (GWIS)
NAME
NAME (Text)
SIM
Variable (Text)
TIME
TSTime (Float)
STAGE
TSValue (Float)
ICPR_LINK_HYDROGRAPH (GWIS)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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>
Description
Accumulate Incremental
Time Series
Accumulate incremental time series steps associated to the input subwatershed features.
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 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 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.
Create input files allowing running ICPR for Green and Ampt Basins. This tool works in ArcMap
only, not in ArcCatalog.
Create input files allowing running ICPR for Impervious SCS Basins. This tool works in ArcMap
only, not in ArcCatalog.
Summary
Accumulates incremental time series associated to input subwatershed features.
Learn more about how Accumulate Incremental TimeSeries (Arc Hydro) works
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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_subwatershed_features
in_timeseries_table
in_variabledefinition_table
tsvarid_source
tsvarid_target
Data Type
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
Table
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
in_subwatershed_features
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
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
in_variabledefinition_table
Table
tsvarid_rainfall
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
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
Double
effective_saturation
Double
out_timeseries_table
Output Time Series table where the excess rainfall time series will be
stored.
Table
report_slurp
Boolean
output_timestep_increment
export_rai
rai_path
(Optional)
Integer
Boolean
Directory
Environments
This tool does not use any geoprocessing environments
Related Topics
Compute Green and Ampt Parameters
Create Green and Ampt Parameter Rasters
Export to ICPR Green and Ampt Rainfall Excess
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 19 of 63
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_subwatershed_features
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
Raster Layer
Raster Layer
Raster Layer
Raster Layer
Environments
This tool does not use any geoprocessing environments
Related Topics
Compute Green and Ampt Excess Rainfall
GUID-D3A6D8B9-857B-49F0-AB5B-B0143820B30C
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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.
in_soil_lookup_table
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.
in_landuse_lookup_table
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)
Feature Layer
Table
Raster Layer
Raster Layer
Raster Layer
Raster Layer
Raster Layer
Porosity Grid
Raster Layer
Grid used to setup the cell size for the output grids.
Raster Layer
Environments
This tool does not use any geoprocessing environments
Related Topics
GUID-D3A6D8B9-857B-49F0-AB5B-B0143820B30C
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
in_subwatershed_features
Feature Layer
in_soil_landuse_precip_features
Feature Layer
in_soil_lookup_table
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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.
in_landuse_lookup_table
Table
rai_path
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
This tool does not use any geoprocessing environments
Related Topics
Export to ICPR Green and Ampt Rainfall Excess
Licensing Information
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
in_subwatershed_features
Feature Layer
rai_path
File Location
icprexport_xmlpath
File Location
Environments
This tool does not use any geoprocessing environments
Related Topics
Export to ICPR Green and Ampt Parameters
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Learn more about how Compute Green and Ampt Excess Rainfall (Arc Hydro) works
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
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
Required
Name
String
Field
Type
Description
Required
HydroID
Integer
Required
KeyFrom
Integer
Required
PctFrom
Double
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
Created
PctImp
Double
Percent Impervious
Created
KSat
Double
Created
Sst
Double
Created
Ssu
Double
Created
Porosity
Double
Porosity. Unitless.
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 23 of 63
Required
Sst
Double
Required
Ssu
Double
Required
Porosity
Double
Porosity. Unitless.
Field
Type
Description
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.
Required
PctImp
Double
Percent impervious.
Required
DCIA
Double
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.
Field
Type
Description
Required
FeatureID
Integer
Required
VarID
Integer
Required
TSTime
DateTime
Required
TSValue
Double
Created
TSDateTime_DBL
Double
Date and time of the corresponding time step stored as double to improve
performance while processing.
Field
Type
Description
Required
VarID
Integer
Required
TSTime
Integer
Time Interval.
Required
TSUnits
String
Required
DataType
String
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 24 of 63
Created
FeatureID
Integer
Created
VarID
Integer
Created
TSTime
DateTime
Created
TSValue
Double
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.
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
"DCIA Grid"
"Percent Impervious Grid"
"Hydraulic Conductivity"Grid"
"Soil Storage Grid"
"Soil Suction Grid"
"Porosity Grid"
Input/Output Management
Subwatershed
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 25 of 63
Role
Field
Type
Description
Required
HydroID
Integer
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
"DCIA Grid"
"DEM" Grid
Input/Output Management
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
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
Required Sst
Required Ssu
The Landuse Lookup table must contain the LanduseCode field (e.g. FLUCCSCODE) as well as the DCIA and PctImp (Percent
Impervious) fields.
Landuse Lookup Table
Role
Field
Type
Description
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
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
Required DCIA
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
Output
RAI subdirectory with RAI storing rainfall files in the same location as the
output XML
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
Field
Type
Description
Required
HydroID
Integer
Required
KeyFrom
Integer
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.
Land use code key field. Used to relate to the SLURP feature class. The name of this
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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.
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 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
Required
Sst
Double
Required
Ssu
Double
Required
Porosity
Double
Porosity. Unitless.
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
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
Field
Type
Description
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 28 of 63
Required
FeatureID
Integer
Required
VarID
Integer
Required
TSTime
DateTime
Required
TSValue
Double
Created
TSDateTime_DBL
Double
Date and time of the corresponding time step stored as double to improve
performance while processing.
Variable DefinitionTable
Role
Field
Type
Description
Required
HydroID
Integer
Required
TimeStep
Integer
Time Interval.
Required
TimeUnits
String
Required
DataType
String
Field
Type
Description
Created
FeatureID
Integer
Created
VarID
Integer
Created
TSTime
DateTime
Created
TSValue
Double
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.
Output
RAI subdirectory with RAI files storing excess rainfall in the same location as the
output XML
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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 creates the ICPR XML file and stores it in the target location.
Description
Export to DSS
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 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
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
in_variabledefinition_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
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Workspace
Target_Vector_Location_Workspace
Workspace
Target_Feature_Dataset
String
WSEAlongStream
Composite
Geodataset
Stream
Feature Layer
DEM
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 31 of 63
ArcInfo: Yes
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
Data Type
Workspace
Composite
Geodataset
String
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires 3D Analyst
ArcEditor: Requires 3D Analyst
ArcInfo: Yes
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_
Start_Time__mm_dd_yyyy_00_00_00_
Data Type
File
Date
End_Time__mm_dd_yyyy_00_00_00_
Date
Time_Interval
Input_RAS_Project_File___prj_
Input_Cross_Section_Features
Input_GeoRAS2GXDE_XSLT_File
Output_Directory
Long
File
Feature Layer
File
Folder
Environments
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 32 of 63
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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.
in_variabledefinition_table
Feature Layer
Table
tstype_id
Integer
dssfile_for_import
File Location
out_timeseries_table
Table
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
Text
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 34 of 63
Usage
Syntax
SDFToXML_archydro (input_sdffile, out_xml_file)
Parameter
Explanation
Data Type
input_sdffile
File Location
out_xml_file
File Location
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Table View
Variable
String
TSTime
String
Line
Raster
Line_Raster
Line3D
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
DSS File
Gage File
TS Layer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
Page 36 of 63
Field
Type
Description
Required
FeatureID
Integer
Required
VarID
Integer
Required
TSTime
DateTime
Required
TSValue
Double
Created
TSTime_DBL
Double
Date and time of the corresponding time step stored as double to improve
performance while processing.
Field
Type
Description
Required
HydroID
Integer
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
Required
DataType
String
Required
IsRegular
Integer
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 Import from DSS (Arc Hydro) works
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
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
Field
Type
Description
Required
HydroID
Integer
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
Required
DataType
String
Required
IsRegular
Integer
Required
VarUnits
String
Units of measurement. Must match the name of one of the AHUnits defined in the
configuration file under ApFunction(DSSExportImport)
Field
Type
Description
Required
FeatureID
Integer
Required
VarID
Integer
Required
TSTime
DateTime
Required
TSValue
Double
Created
TSTime_DBL
Double
Date and time of the corresponding time step stored as double to improve
performance while processing.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 38 of 63
DSSVUE.
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).
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).
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'.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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 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()
Description
Compute Flows
Recompute Flows
Compute global parameters for Streamstats (Parameters list is not updated based on
configuration but tool can be published).
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 40 of 63
Delineation
Streamstats toolset's 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
in_globalwatershed_features
Feature Layer
in_globalwatershedpoint_features
Feature Layer
out_flowxml
File
out_flowhtm
in_xmlconfig
(Optional)
input_flowstypes
(Optional)
out_vectorlocation
(Optional)
File
File
String
Workspace
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
Summary
Edits parameters in NSS Flows XML file.
Learn more about how Edit Computed Parameters (Arc Hydro) works
Usage
Syntax
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 41 of 63
Explanation
Data Type
in_flowxml
Flows XML File generated by the tool Compute Flows, Recompute Flows
or Edit Computed Parameters.
XML file
in_parameters
ValueTable
out_editedflowxml
in_xmlconfig
(Optional)
XML file
XML file.
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
XML File
XML File
XML File
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
in_globalwatershed_features
Feature Layer
in_globalwatershedpoint_features
Feature Layer
input_parameters
Multivalue
out_paramsxml
out_paramshtm
in_xmlconfig
(Optional)
out_vectorlocation
(Optional)
File
File
File
Worspace
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
in_globalwatershed_features
in_globalwatershedpoint_features
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
String
out_paramsxml
File
out_paramshtm
File
in_xmlconfig
File
Worspace
(Optional)
out_vectorlocation
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
(Optional)
Page 43 of 63
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
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
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
Feature Class
(Optional)
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
5.
Page 44 of 63
a.
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.
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.
2.
3.
Check whether there are regions with multiple flow equations and map to the appropriate region (using
ArcHydroSchema.mdb>NSSRegions table).
4.
5.
6.
Compute GIS parameters and generate associated features (e.g. Longest Flow Path, Centroid, etc.).
7.
8.
9.
10.
11.
2.
Look for the layer with matching name or alias in the map.
3.
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 46 of 63
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
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
VECTORDATAPATH
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)
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
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:
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 48 of 63
ApField defining the drainage area parameter. Must be defined with AdditionalParams
ISWATERSHED=1
Learn more about how Edit Computed Parameters (Arc Hydro) works
Learn more about how Edit Computed Parameters (Arc Hydro) works.
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 and associated Longest Flow Path for each input
Drainage Area feature.
Compute Time of Concentration and associated Group Longest Flow Path for each
input Group Basin feature.
Compute Time of Concentration for each input Longest Flow Path feature.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 49 of 63
Define the TR55 Zones for each input Longest Flow Path feature.
Create a new TR55 Zone grid that identifies 3 TR55 zones within the extent of the
Drainage Area feature class.
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
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 50 of 63
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
Raster Layer
in_rain2YrInch_raster
in_manningsn_raster
in_surface_raster
in_hydroedge_features
(Optional)
Raster Layer
Raster Layer
Raster Layer
Feature Layer
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
Data Type
12/8/2014
in_groupbasin_features
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
Feature Layer
in_longestflowpath_features
out_grouplongestflowpath_features
Feature Layer
Feature Layer
Feature Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
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.
Learn more about how Compute Time of Concentration (Arc Hydro) works
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
in_longestflowpath_features
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
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
Feature Layer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 52 of 63
in_dem_raster
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
Raster Layer
in_rain2YrInch_raster
Raster Layer
in_manningsn_raster
in_surface_raster
Raster Layer
Raster Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
in_preferentiallink_features
in_hydroedge_features
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
Feature Layer
in_terrain_raster
Raster Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
in_longestflowpath_features
Input Longest Flow Path features for which the TR55 zones will be
defined.
overland_flowdistance
Data Type
Feature Layer
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
overland_flowdistance
Double;Field
Feature Layer
Environments
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 54 of 63
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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 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
in_drainagearea_features
Feature Layer
in_dem_raster
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.
in_longestflowpath_features
(Optional)
sheetflow_buffer_meters
(Optional)
in_hydroedge_features
(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
Feature Layer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
Double
12/8/2014
Page 55 of 63
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
Learn more about how Compute Time of Concentration (Arc Hydro) works
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.
3.
Channel Flow
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.
V = 16.1345(s)0.5
(unpaved)
V = 20.3282(s)0.5
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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:
Tt = Travel time (hr)
L = Flow length (ft)
V = Average velocity (ft/s)
3600 = conversion factor from seconds to hours
where:
V = Average velocity (ft/s)
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:
Tt = Travel time (hr)
L = Flow length (ft)
V = Average velocity (ft/s)
3600 = conversion factor from seconds to hours
The following physical characteristics can be modified through urbanization and consequently impact the time of concentration:
z
Surface roughness
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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.
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:
V = Average velocity (ft/s)
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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:
Tt = Travel time (hr)
L = Segment length (ft)
V = Average velocity (ft/s)
3600 = conversion factor from seconds to hours
- 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.
3.
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.
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).
Description
Densify Fishnet
Thin Cross-Section
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 59 of 63
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 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
Feature Layer
Input_cell_height
Double
Input_cell_width
Output_feature_class_name
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 60 of 63
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 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
Feature Layer
Input_number_of_rows
Long
Input_number_of_columns
Output_feature_class_name
Long
Feature Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 61 of 63
Summary
Densify fishnet based on the values stored in the nDenRow and nDenColumn required attributes of the input fishnet.
z
If both nDenRown and nDenColumn are = 1 or at least one is <null> the polygon is not densified but copied as is
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).
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)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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).
Output_feature_class_name
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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.
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.
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..
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.
Usage
z
The tool works on a selected set on input 3D Cross Section features and processes all features if there is no selection.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
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
Feature Layer
Feature Class
Table
String
Double
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhE0D8.htm
12/8/2014
Page 1 of 9
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
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
in_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
in_drainagepoint_features
network_name
Feature
Layer
String
out_hydroedge_features
Feature
Class
out_hydrojunction_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
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
in_schemajunction_features
out_schemalink_features
out_schemanode_features
Data Type
Feature
Layer
Feature
Layer
Feature
Class
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhCE81.htm
12/8/2014
Page 3 of 9
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
[input_edge_features,...]
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
Summary
Stores flow direction for input edges in FlowDir attribute. Learn more about how Store Flow
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhCE81.htm
12/8/2014
Page 4 of 9
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
[input_edge_features,...]
Data Type
Feature
Layer;Feature
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
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.
Input
Output
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhCE81.htm
12/8/2014
Page 5 of 9
Input/Output Management
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
DrainID: Unique identifier of the associated catchment. Correspond to the GridID in the
Drainage Line feature class.
FlowDir: Flow direction for the edge (Associated domain: HydroFlowDirections). Default to
WithDigitized flow direction.
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
FType: Feature type of the Hydro Junction: Stream Confluence, Drainage Outlet, Drainage
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhCE81.htm
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.
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
Input/Output Management
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhCE81.htm
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
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
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
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
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").
For Watershed Polygons: the Schema Node corresponds to the center of gravity of the
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhCE81.htm
12/8/2014
Page 8 of 9
watershed.
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
Flow direction in a network is stored as esriFlowDirection constants, which have the following
values:
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhCE81.htm
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
Flow direction in a network is stored as esriFlowDirection constants. The constants have the
following values:
z
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhCE81.htm
12/8/2014
Page 1 of 2
The Point Characterization toolset contains a set of tools supporting the characterization of poitn
features.
Tools
Description
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
in_batchpoint_features
Feature
Layer
in_flow_direction_raster
Raster Layer
in_catchment_features
Feature
Layer
in_drainageline_features
Feature
Layer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhC04E.htm
12/8/2014
Page 2 of 2
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhC04E.htm
12/8/2014
Page 1 of 69
The Terrain Morphology toolset contains 3 toolsets that allow processing non dendritic (deranged) terrain.
Toolset
Description
AH Connectivity
Refinement
Drainage
Boundary
Processing
Grouping
Group drainage areas based on preferential path and create groups to simplify
the connectivity for modeling.
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.
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).
Description
Connect HydroJunctions
Define Overland
Preferential Node Link
Schema
Flip_Preferential_Path
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 2 of 69
Set the field IsSink to 1 in the input Sink Polygon features containing
Hydraulic Element Points features.
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.
2.
3.
4.
5.
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
in_hydroedge_features
Feature
Layer
in_sinkpoint_features
Feature
Layer
in_catchment_features
out_preferentialnode_features
out_preferentiallink_features
Feature
Layer
Feature
Class
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
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).
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
in_hydrojunction_features
in_hydroedge_features
Data Type
Feature
Layer
Feature
Layer
in_catchment_features
Feature
Input Catchment. Required field: HydroID. Used to
Layer
populate the fields FEATUREID1 and FEATUREID2 in
the output Preferential Link features.
out_preferentialnode_features
out_preferentiallink_features
in_HEP_features
(Optional)
Feature
Layer
Feature
Class
Feature
Class
Feature
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 5 of 69
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
in_hydrojunction_features
in_hydroedge_features
Feature Layer
Feature Layer
in_catchment_features
Input Catchment
Feature Layer
in_flowdir_raster
in_drainageline_features
(Optional)
Raster Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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.
CONNECTDONE = 0 or is null. This field is optional and will be created and populated with Null
if it does not exist.
HYDRAULIC_TYPE_DESC in ('BRID', 'CULV', 'DAM', 'LEV', 'CS') (Default values read from the
XML configuration associated to the tool).
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
in_hydrojunction_features
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.
in_hydroedge_features
Feature
Layer
in_drainage_area_features
in_drainageboundary_features
in_boundarydrainageline_features
in_drainageconn_table
Feature
Layer
Feature
Layer
Feature
Layer
Table
in_flowdir_raster
Raster
Layer
Environments
This tool does not use any geoprocessing environments
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 7 of 69
Licensing Information
ArcView: No
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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,
out_preferentiallink_features)
Parameter
Explanation
Data Type
Feature
Layer
in_catchment_features
in_sinkpoint_features
in_hydrojunction_features
in_hydroedge_features
Feature
Layer
in_terrain_raster
Raster Layer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
Feature
Layer
Feature
Layer
12/8/2014
Page 8 of 69
Feature
Class
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
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
Syntax
FlipPreferentialPath_archydro (in_preferentiallink_features, in_hydroedge_features)
Parameter
in_preferentiallink_features
in_hydroedge_features
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
This tool does not use any geoprocessing environments
Licensing Information
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 9 of 69
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
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
in_hydroedge_features
Hydro Edge feature class to process. FlowDir field will Feature Layer
be populated with 1 (WithDigitized) or 2
(AgainstDigitized)
in_preferentiallink_features
Feature Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
Feature Layer
in_HEP_features
Feature Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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,
out_preferentiallink_features)
Parameter
Explanation
Data Type
in_catchment_features
Feature
Layer
in_sinkpoint_features
in_hydroedge_features
in_drainageboundary_features
Feature
Layer
Feature
Layer
Feature
Layer
in_terrain_raster
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
Raster Layer
12/8/2014
Page 11 of 69
out_preferentiallink_features
Feature
Class
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
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).
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 12 of 69
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
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
Hydro Edge
Role
Field
Type
Description
Required
IsPreferred
Integer
Required
FType
String
Created/Populated
FlowDir
Integer
Preferential Node
Role
Field
Type
Description
Created
HydroID
Integer
Created
SinkID
Integer
Created
DrainID
Integer
Preferential Link
Role
Field
Type
Description
Created
HydroID
Integer
Created
IsFlipped
Integer
Created
FNID
Integer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 13 of 69
Created
TNID
Integer
Created
FeatureID1
Integer
Created
FeatureID2
Integer
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
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,
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
Required
HYDRAULIC_TYPE_DESC
String
Required
FType
String
Required
Elev
Double
Required
IsPreferred
Integer
Hydro Edge
Role
Field
Type
Description
Required
HydroID
Integer
Required
IsPreferred
Integer
Sink Point
Role
Field
Type
Description
Required
HydroID
Integer
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 15 of 69
Field
Type
Description
Required
JUNCTIONID
Integer
Required
POINT_TYPE_DESC
String
Preferential Link
Role
Field
Type
Description
Created
HydroID
Integer
Created
IsFlipped
Integer
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
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 16 of 69
Input/Output
Input
Output
Assumption
HydroJunctions features exist at both ends of each HydroEdge feature that participates in the Control
Structure Sequence.
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
EdgeType: 1
FlowDir: 0 (Uninitialized)
NextDownID: -1
Enabled: True
IsPreferred: 1
HydroJunction
z
NextDownID: -1
SchemaRole: 1
AncillaryRole: 0
Enabled: True
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
Created/Populated
DrainID
Integer
HydroID of the
associated catchment.
Created/Populated
NextDownID
Integer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 18 of 69
downstream HydroEdge
feature. Populated with
-1.
Created/Populated
FType
String
Required
Enabled
Short
Integer
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
Created/Populated
DrainID
Integer
HydroID of the
catchmebt in which the
edge is created.
Created/Populated
IsPreferred
Integer
Hydro Junction
Role
Field
Type
Description
Populated
HydroID
Integer
Unique identifier of
the feature in the Arc
Hydro geodatabase.
Populated
NextDownID
Integer
Populated
FType
String
Populated
Enabled
Short
Integer
Indicates whether
the feature is
enabled in the
network. Populated
with 1(True) by
default.
Populated
AncillaryRole
Short
Indicates whether
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 19 of 69
Integer
Populated
SCHEMAROLE
Short
Integer
Populated
JUNCTION_PLACEMENT_DESC
String
Populated
JUNCTION_TYPE_DESC
String
Populated
HYDRAULIC_TYPE_DESC
String
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
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
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:
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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').
Output
"Hydro Edge"
"Hydro Junction"
"Hydro Edge"
"Boundary Drainage Line"
"Drainage Connectivity" table
Input/Output Management
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"
tag at the end of the operation.
If there is a polygon feature class that has a tag "Drainage 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
"Drainage Area" tag at the end of the operation.
Required fields:
z
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 21 of 69
Required field:
z
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.
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 "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
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 22 of 69
Retrieve the HydroID of the Hydro Junction being processed as well as the value of the field
CONNECTDONE.
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.
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.
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:
FlowDir: 0 (Uninitialized).
EdgeType: 1 (Flowline).
Enabled: 0 (Disabled).
Create the Boundary Drainage Line associated to the link and populate the following attributes:
Populate IsDone with 1 for the Hydro Junction and move to the next Hydro Junction.
Note
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 24 of 69
Input/Output
Input
Output
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
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
Hydro Edge
Role
Field
Type
Description
Required
HydroID
Integer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Created
IsPreferred
Integer
Page 26 of 69
Preferential Node
Role
Field
Type
Description
Created
HydroID
Integer
Created
SinkID
Integer
Created
DrainID
Integer
Created
JunctionID
Integer
Preferential Link
Role
Field
Type
Description
Created
HydroID
Integer
Created
IsFlipped
Integer
Created
FNID
Integer
Created
TNID
Integer
Created
FeatureID1
Integer
Created
FeatureID2
Integer
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 27 of 69
Sets the Flow Direction in the HydroEdge features using the Preferential Link.
Learn more about how Sink Identification by HEP (Arc Hydro) works
Identifies sink polygons using Hydraulic Element Point features.
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 28 of 69
Input
Output
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
Hydro Edge
Role
Field
Type
Description
Required
DrainID
Integer
Required
FlowDir
Short
Integer
Required
IsPreferred
Integer
Required
FType
String
Drainage Boundary
Role
Field
Type
Description
Required
HydroID
Integer
Preferential Node
Role
Field
Type
Description
Created
HydroID
Integer
Created
SinkID
Integer
Created
DrainID
Integer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Created
IsConnected
Integer
Page 30 of 69
Preferential Link
Role
Field
Type
Description
Created
HydroID
Integer
Created
IsFlipped
Integer
Created
FNID
Integer
Created
TNID
Integer
Created
FeatureID1
Integer
Created
FeatureID2
Integer
Description
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
Drainage Boundary
Direction
Set the digitized direction of the selected Drainage Boundary lines based
on user-provided Preferential Link line features.
Drainage Boundary
Smoothing
Drainage Connectivity
Characterization
Elevation-Width-Area
Characterization
Station-Elevation
Characterization
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
features if there is no selected set.
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
Feature Layer
in_line_features
Feature Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
in_drainage_area_features
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
Data Type
Feature Layer
12/8/2014
Page 32 of 69
Input DEM.
Raster Layer
in_exclusion_area_features
Feature Layer
out_eav_table
Table
extrusion_value
Double
Integer
Double
Boolean
(Optional)
slice_count
(Optional)
slice_increment
(Optional)
overwrite_eav
(Optional)
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 33 of 69
Syntax
DrainageBoundaryDefinition_archydro (in_drainage_area_features, in_terrain_raster,
out_drainageboundary_features, out_drainconn_table)
Parameter
in_drainage_area_features
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
Raster
Layer
out_drainageboundary_features
Feature
Class
out_drainconn_table
Table
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: No
ArcInfo: Yes
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
in_drainageboundary_features
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
Data Type
Feature
Layer
12/8/2014
Page 34 of 69
Table
in_preferentiallink_features
Feature
Layer
in_drainage_area_features
Feature
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
in_drainageboundary_features
smoothing_tolerance
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
Data
Type
Feature
Layer
Double
12/8/2014
Page 35 of 69
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
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
Raster
Layer
in_flow_direction_raster
Raster
Layer
in_drainage_area_features
Feature
Layer
in_drainageboundary_features
in_drainagepoint_features
in_drainconn_table
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
Feature
Layer
Feature
Layer
Table
12/8/2014
Page 36 of 69
Feature
Class
out_hydrojunction_features
out_boundarydrainageline_features
Feature
Class
Feature
Class
Environments
This tool does not use any geoprocessing environments
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
features if there is no selected set.
Data Type
Feature Layer
out_ewa_table
Table
extrusion_value
Double
Integer
Double
(Optional)
slice_count
(Optional)
slice_increment
(Optional)
zfactor
(Optional)
overwrite_ewa
(Optional)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
Double
Boolean
12/8/2014
Page 37 of 69
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
measure_format
out_se_table
Table
zfactor
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
if there is no selected set.
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
Note
When specifying a strictly positive extrusion value, one additional slice will be created.
Input/Output Management
If there is a polygon feature class that has a tag "Drainage Area", 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
"Drainage Area" tag at the end of the operation.
Required field: HydroID
Fields created:
z
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
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.
Select the drainage areas to characterize (all areas will be processed if there is no selection).
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 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.
Check that the following fields exist in the Attributes table of Drainage Area and create these fields if
not found:
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 40 of 69
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.
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.
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
Input/Output Management
Input/Output Management
If there is a "Drainage Area" feature class that has a tag "Drainage Area", it will be used as a default for
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
Created/Populated
IsPitted
Integer
The tool generates the boundaries as 3D lines with measures (Polyline ZM).
Drainage Boundary
Role
Field
Type
Description
Created
HydroID
Integer
Created
MinElev
Double
Created
MaxElev
Double
Created
IsIncluded
Integer
Created
IsDone
Integer
Drainage Connectivity
Role
Field
Type
Description
Created
FeatureID
Integer
Created
FeatureID1
Integer
Created
FeatureID2
Integer
Created
ConnectType
String
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 42 of 69
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.
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
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"
tag at the end of the operation.
If there is a polygon feature class that has a tag "Drainage Area", it will be used as a default for the second
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 44 of 69
input theme. 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.
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
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
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
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
FlowDir: Flow direction for the edge (Associated domain: HydroFlowDirections). Default to
Uninitialized 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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 45 of 69
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)).
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: 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
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
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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:
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.
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:
FlowDir: 0 (Uninitialized).
EdgeType: 1 (Flowline).
Enabled: 1.
Create the Boundary Drainage Line associated to the link and populate the following attributes:
Notes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
Required
IsIncluded
Short
Integer
Created/Populated
IsDone
Short
Integer
Drainage Area
Role
Field
Type
Description
Required
HydroID
Integer
Created/Populated
JunctionID
Integer
Required
IsPitted
Integer
Drainage Point
Role
Field
Type
Description
Required
DrainID
Integer
DrainConn Table
Role
Field
Type
Description
Required
FeatureID
Integer
Required
FeatureID1
Integer
Required
FeatureID2
Integer
HydroJunction
Role
Field
Type
Description
Created/Populated
HydroID
Integer
Unique identifier of
the feature in the Arc
Hydro geodatabase.
Created/Populated
NextDownID
Integer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 48 of 69
downstream
Junction. Populated
with -1 for sinks or
most downstream
junctions.
Created/Populated
FType
String
Created/Populated
Enabled
Short
Integer
Indicates whether
the feature is
enabled in the
geometric network.
Created/Populated
AncillaryRole
Short
Integer
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
Created/Populated
Hydraulic_Type_Desc
String
Created/Populated
Elev
Double
Elevation of the
junction. Populated
for the Boundary
Node
HydroJunctions.
HydroEdge
Role
Field
Type
Description
Created/Populated
HydroID
Integer
Created/Populated
DrainID
Integer
Created/Populated
FlowDir
Short
Integer
Created/Populated
FType
String
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 49 of 69
Created/Populated
EdgeType
Short
Integer
Created/Populated
Enabled
Short
Integer
Field
Type
Description
Created/Populated
LinkID
Integer
Created/Populated
DrainID
Integer
Created/Populated
FType
String
Output
Input/Output Management
Input/Output Management
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
Created
BottomElev
Double
Created
TopElev
Double
Created
SlcElev
Double
Created
SlcWidth
Double
Created
SlcArea
Double
Created
CumArea
Double
Created
SlcPerimeter
Double
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 50 of 69
Output
Input/Output Management
Line 3D
Role
Field
Type
Description
Required
HydroID
Integer
Field
Type
Description
Created FeatureID
Created Elevation
Double
Created StationMPct
Double
StationMFra
Double
StationMLen Double
Description
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 51 of 69
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.
6.
7.
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
in_catchment_features
in_preferentiallink_features
Feature Layer
in_sinkpoint_features
Feature Layer
Feature Class
out_groupbasin_features
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
in_groupbasin_features
Feature Class
in_hydrojunction_features
in_sinkpoint_features
Feature Layer
out_groupjunction_features
Feature Class
Feature Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
Feature Class
in_groupbasin_features
Feature Class
in_hydrojunction_features
in_hydroedge_features
Feature Class
Feature Class
in_catchment_features
Feature Class
in_preferentiallink_features
Feature Class
out_groupnode_features
out_grouplink_features
Feature Class
Feature Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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})
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Parameter
Explanation
Page 55 of 69
Data Type
in_catchment_features
Feature Layer
overwrite_group
Boolean
(Optional)
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
in_groupbasin_features
Explanation
Input Group Basin features generated based on the
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
Data Type
Feature Layer
12/8/2014
Page 56 of 69
Feature Layer
in_sinkpoint_features
Feature Layer
in_hydroedge_features
Feature Layer
in_preferentiallink_features
Feature Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
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'
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 57 of 69
It identifies the Boundary Drainage Line features associated to the connection and their
corresponding HydroEdge features having IsPreferred equal to 0 or Null.
8.
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
in_groupbasin_features
Feature
Layer
in_catchment_features
Feature
Layer
in_sinkpoint_features
in_hydroedge_features
in_drainageboundary_features
Feature
Layer
Feature
Layer
Feature
Layer
in_boundarydrainageline_features
Feature
Layer
in_drainageconn_table
Table
in_terrain_raster
Input DEM.
out_preferentialnode_features
Raster
Layer
Feature
Class
out_preferentiallink_features
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
Feature
Class
12/8/2014
Page 58 of 69
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Yes
ArcInfo: Yes
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
in_catchment_features
Feature Layer
in_preferentiallink_features
Feature Layer
Boolean
overwrite_group
(Optional)
Environments
This tool does not use any geoprocessing environments
Licensing Information
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 59 of 69
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
in_catchment_features
Explanation
Input Catchment. Required field: GroupID. Tool works
on selected set of Catchment features or on all features
if there is no selected set.
Data Type
Feature Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 60 of 69
Input/Output
Input
Output
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 61 of 69
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
Required
GroupID
Integer
Created/Populated
IsTerminal
Short
Integer
Preferential Link
Role
Field
Type
Description
Required
FeatureID1
Integer
Required
FeatureID2
Integer
Sink Point
Role
Field
Type
Description
Created/Populated
IsTerminal
Short Integer
Group Basin
Role
Field
Type
Description
Created/Populated
HydroID
Integer
Created/Populated
IsPitted
Short
Integer
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
Hydro Junction
Role
Field
Type
Description
Required
HydroID
Integer
Required
Hydraulic_Type_Desc
String
Required
FType
String
Required
Elev
Double
Sink Point
Role
Field
Type
Description
Required
IsTerminal
Short Integer
Group Junction
Role
Field
Type
Description
Created/Populated
HydroID
Integer
Created/Populated
FType
String
Created/Populated
JunctionID
Integer
Created/Populated
Elev
Double
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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
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
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
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.
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 65 of 69
The tool populates the field GroupLink with 1 in the Preferential Link used to
generate the Group Link.
3.
4.
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
Required
FType
String
Required
Elev
Double
Group Basin
Role
Field
Type
Description
Required
HydroID
Integer
Required
IsPitted
Short
Integer
Hydro Junction
Role
Field
Type
Description
Required
HydroID
Integer
Hydro Edge
Role
Field
Type
Description
Required
HydroID
Integer
Required
DrainID
Integer
Required
FType
String
Created/Populated
GroupFDR
Short
Integer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Created/Populated
GroupLink
Page 66 of 69
Short
Integer
Catchment
Role
Field
Type
Description
Required
HydroID
Integer
Required
GroupID
Integer
Required
JunctionID
Integer
Preferential Link
Role
Field
Type
Description
Created
HydroID
Integer
Created
DrainID
Integer
Created
IsFlipped
Integer
Created
FNID
Integer
Created
TNID
Integer
Required
FeatureID1
Integer
Required
FeatureID2
Integer
Created/Populated
GroupLink
Short
Integer
Created/Populated
GroupFDR
Short
Integer
Group Node
Role
Field
Type
Description
Created
HydroID
Integer
Created
SinkID
Integer
Created
DrainID
Integer
Created
JunctionID
Integer
Group Link
Role
Field
Type
Description
Created
HydroID
Integer
Created
DrainID
Integer
Created
IsFlipped
Integer
Created
FNID
Integer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Created
TNID
Integer
Created
FeatureID1
Integer
Created
FeatureID2
Integer
Created
CatchmentID1
Integer
Created
CatchmentID2
Integer
Page 67 of 69
Learn more about how Group Selected Catchments (Arc Hydro) works
1.
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
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.
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 69 of 69
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
Created/Populated
GroupID
Integer
Created/Populated
IsTerminal
Integer
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6A14.htm
12/8/2014
Page 1 of 64
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
Adjust_Flow_Direction_in_Streams
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 2 of 64
Build Walls
DEM Reconditioning
Depression Evaluation
Extend_Lines
Fill Sinks
Flow Accumulation
Flow Direction
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 3 of 64
Level DEM
Longest_Flow_Path_for_Adjoint_Catchments
Longest_Flow_Path_for_Catchments
Sink Evaluation
Sink Prescreening
Sink Selection
Stream Definition
Stream Segmentation
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)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Parameter
Explanation
in_stream_features
number_start_elevation
number_drop_elevation
Page 4 of 64
Data Type
Feature
Layer
Double
Double
Environments
This tool does not use any geoprocessing environments
Related Topics
Burn Stream Slope
Find Next Downstream Line
DEM Reconditioning
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
innerwall_height
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
Data Type
Raster
Layer
Double
12/8/2014
Page 5 of 64
innerwall_buffer
Integer
breachline_buffer
Integer
out_walleddem_raster
in_external_wall_features
Raster
Layer
Feature
Layer
(Optional)
in_internal_wall_features
(Optional)
in_breachline_features
(Optional)
Feature
Layer
Feature
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
Raster Layer
in_stream_features
Feature
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 6 of 64
Layer
out_streamslope_raster
Raster Layer
out_editpoints_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Related Topics
Assign Stream Slope
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 7 of 64
Raster
Dataset
out_drainageline_features
Feature
Class
clear_right_angle
Boolean
(Optional)
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
Tool validation will automatically set default locations for output layers based on the
location of input layers.
If there is an optional draft sink point feature, those points that are in the sink
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
Raster
Layer
Deranged_Polygon_Layer
Feature
Layer
Output_Sink_Polygon_Layer
Output_Sink_Polygon_Grid
Output_Sink_Point_Layer
Output_Sink_Point_Grid
Feature
Layer
Raster
Layer
Feature
Layer
Raster
Layer
Feature
Layer
Input_Stream_Line_Layer
(Optional)
Input_Draft_Sink_Point_Layer
(Optional)
Feature
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: No
ArcEditor: No
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 9 of 64
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
Raster Layer
in_agreestream_features
number_cells_buffer
Feature
Layer
Double
zdrop_smooth
Double
zdrop_sharp
Double
out_agreedem_raster
Raster Layer
raise_negative
Boolean
Environments
This tool does not use any geoprocessing environments
Related Topics
Burn Stream Slope
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 10 of 64
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
out_depression_features
out_depression_drainage_features
Data
Type
Raster
Layer
Feature
Class
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
fill_threshold
Fill Threshold
(Optional)
in_deranged_poly_features
(Optional)
use_issinkfield
(Optional)
Data Type
Raster
Layer
Raster
Layer
Double
Feature
Class
Boolean
Environments
This tool does not use any geoprocessing environments
Related Topics
Flow Direction
Sink Evaluation
Sink Selection
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
Raster Layer
in_lake_features
Feature Layer
out_leveldem_raster
Raster Layer
fillelev_field
Field
(Optional)
Double
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
out_sink_drainage_features
Feature
Class
Feature
Class
Environments
This tool does not use any geoprocessing environments
Related Topics
Sink Prescreening
Sink Selection
Fill Sinks
Flow Direction with Sinks
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
Raster Layer
prescreen_area
Double
out_prefildem_raster
Raster Layer
out_sink_raster
Raster Layer
Environments
This tool does not use any geoprocessing environments
Related Topics
Sink Selection
Sink Evaluation
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
in_deranged_poly_features
min_depth
Minimum depth
(Optional)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
Double
Overwrite selection
Boolean
Environments
This tool does not use any geoprocessing environments
Related Topics
Sink Prescreening
Sink Evaluation
Fill Sinks
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Description
Create Initial QC
GDB
Non Draining
Watersheds
Stream Connectivity
Parameters
Stream QC
Streams Near
Processing Area
Boundary
Streams Near
Watershed
Boundary
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 16 of 64
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_GDB_Name
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
Feature Layer
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
Feature Layer
12/8/2014
Page 17 of 64
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
Raster
Layer
in_stream_features
out_adjusted_stream_line
Feature
Layer
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Feature
Layer
Input_Processing_Area_Outline_Layer
Feature
Layer
Input_Search_Distance
Double
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 20 of 64
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Feature
Layer
Input_Watershed_Outline_Layer
Feature
Layer
Input_Search_Distance
Double
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 21 of 64
Usage
z
Syntax
AccumulateShapes_archydro (in_tracelayer_features, nextDownID_field,
in_sourcelayer_features, out_accumulated_features)
Parameter
Explanation
Data Type
FeatureLayer
in_tracelayer_features
nextDownID_field
in_sourcelayer_features
Feature
Layer
out_accumulated_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Summary
Generates the aggregated upstream catchments from the "Catchment" feature class. For
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
in_drainageline_features
in_catchment_features
out_adjoint_features
Data Type
Feature
Layer
Feature
Layer
Feature
Class
Environments
This tool does not use any geoprocessing environments
Related Topics
Catchment Polygon Processing
Drainage Line Processing
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 23 of 64
Syntax
AdjustFlowDirectionInLakes_archydro (in_flow_direction_raster, in_lake_features,
in_stream_raster, out_bowlflowdirection_raster)
Parameter
Explanation
Data Type
in_flow_direction_raster
Raster
Layer
Feature
Layer
in_lake_features
in_stream_raster
Raster
Layer
out_bowlflowdirection_raster
Raster
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Parameter
Page 24 of 64
Data
Type
Explanation
in_flow_direction_raster
Raster
Layer
in_sink_point_raster
Raster
Layer
in_sink_poly_raster
Raster
Layer
out_deranged_flowdirection_raster
Raster
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
in_streamfdr_raster
out_streamadjusted_fdr_raster
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
Data
Type
Raster
Layer
Raster
Layer
Raster
Dataset
12/8/2014
Page 25 of 64
Environments
This tool does not use any geoprocessing environments
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_Catchment_Grid
Input_Catchment_Features
Data Type
Raster
Layer
Raster
Layer
Feature
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 26 of 64
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).
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.
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_Drainage_Line_Feature_Class
(Optional)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
Data
Type
Feature
Layer
Feature
Layer
12/8/2014
Page 27 of 64
Feature
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
in_flow_direction_raster
Raster Layer
in_link_raster
Raster Layer
out_catchment_raster
Raster Layer
Environments
This tool does not use any geoprocessing environments
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 28 of 64
Related Topics
Catchment Polygon Processing
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
Raster Layer
out_catchment_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Related Topics
Catchment Grid Delineation
Drainage Line Processing
Adjoint Catchment Processing
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 29 of 64
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
Raster Layer
in_sinklink_raster
Raster Layer
in_drainageline_features
Feature
Layer
Raster Layer
(Optional)
out_link_raster
Environments
This tool does not use any geoprocessing environments
Related Topics
Flow Direction with Sinks
Stream Segmentation
GUID-9693CF52-4640-431B-8203-3271C5A50F13
Catchment Grid Delineation
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
Raster
Layer
in_flow_direction_raster
Raster
Layer
out_drainageline_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Related Topics
Catchment Polygon Processing
Adjoint Catchment Processing
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
in_catchment_raster
in_catchment_features
out_drainagepoint_features
Data Type
Raster
Layer
Raster
Layer
Feature
Layer
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
extend_type
Extension method:
extend_distance
out_extendedline_features
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
Data Type
Feature
Layer
String
Linear Unit
Feature
12/8/2014
Page 32 of 64
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
in_flow_direction_raster
out_flow_accumulation_raster
Data
Type
Raster
Layer
Raster
Layer
Environments
This tool does not use any geoprocessing environments
Related Topics
Flow Direction
Stream Definition
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 33 of 64
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
in_external_wall_features
(Optional)
out_flow_direction_raster
Data Type
Raster
Layer
Feature
Layer
Raster
Layer
Environments
This tool does not use any geoprocessing environments
Related Topics
Flow Direction with Sinks
Flow Accumulation
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
in_deranged_poly_features
out_flow_direction_raster
out_sinkpoint_features
out_sinklink_raster
out_sinkwatershed_raster
in_external_wall_features
(Optional)
Data Type
Raster
Layer
Feature
Layer
Raster
Layer
Feature
Class
Raster
Layer
Raster
Layer
Feature
Layer
Environments
This tool does not use any geoprocessing environments
Related Topics
Flow Direction
Fill Sinks
Sink Evaluation
Sink Selection
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
Feature Layer
CUJunction
Feature Layer
CUPolygon
Feature Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Parameter
Page 36 of 64
Explanation
Data
Type
in_flow_direction_raster
Raster
Layer
in_adjointcatchment_features
Feature
Layer
in_longestflowpathforcatchments_features
out_longestflowpathadjcat
Feature
Layer
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
HydroID of the associated Catchment.
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.
Syntax
LongestFlowPathforCatchments_archydro (in_catchment_features, in_flow_direction_raster,
out_longestflowpathcat_features)
Parameter
Explanation
Data
Type
in_catchment_features
Feature
Layer
in_flow_direction_raster
Raster
Layer
out_longestflowpathcat_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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.
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
Sink_Point_Grid
Sink_Point_Feature_Class
Feature
Layer
Output_Sink_Watershed_Grid
Raster
Layer
Output_Sink_Watershed_Feature_Class
Feature
Layer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
Raster
Layer
Raster
Layer
12/8/2014
Page 39 of 64
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
Summary
Generates slope grid.
Usage
Syntax
Slope_archydro (in_rawdem_raster, out_slope_raster, {output_measurement})
Parameter
Explanation
Data Type
in_rawdem_raster
Raster Layer
out_slope_raster
Raster Layer
output_measurement
String
(Optional)
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
number_cells
out_stream_raster
area_sqkm
(Optional)
Data Type
Raster
Layer
Integer
Raster
Layer
Double
Environments
This tool does not use any geoprocessing environments
Related Topics
Stream Segmentation
Flow Accumulation
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
Summary
Creates a grid of stream segments that have a unique identification.
Learn more about how Stream Segmentation (Arc Hydro) works
Usage
Syntax
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 41 of 64
Explanation
Data Type
in_stream_raster
in_flow_direction_raster
out_streamlink_raster
in_sink_watershed_raster
(Optional)
in_sink_link_raster
(Optional)
Raster
Layer
Raster
Layer
Raster
Layer
Raster
Layer
Raster
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
Output
Input/Output Management
Input/Output Management
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
Required
GridID
Integer
Required
From_Node
Integer
Required
To_Node
Integer
Required
NextDownID
Integer
Created
DrainID
Integer
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
Required
GridID
Integer
Created
NextDownID
Integer
Created
with SDE
JunctionID
Integer
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
Required
NextDownID
Integer
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 43 of 64
Adjoint Catchment
Role
Field
Type
Description
Created
HydroID
Integer
Created
DrainID
Integer
Created
GridID
Integer
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
Created
NextDownID
Integer
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 44 of 64
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
Input/Output Management
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
Input/Output Management
Input/Output Management
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
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 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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 46 of 64
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.
Output
"DEM" Grid
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 47 of 64
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
Input/Output Management
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.
The tool performs the following steps:
Retrieve the step size from the XML. It is defined as a fraction of cell size and default to
0.75.
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 48 of 64
Raise the DEM by maximum drop value + 10 to ensure positive values in the DEM.
Dendritic
Deranged
Combination (Dendritic +
Deranged)
Link Grid
Input/Output
Input
Output
"Catchment Grid"
"Link Grid"
Input/Output Management
Input/Output Management
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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/Output Management
Input/Output Management
If there is a grid theme that has a tag "Catchment 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 "Catchment Grid" tag at the end of the operation.
If there is a polygon feature class that has a tag "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 "Catchment" tag at the end of the operation.
Catchment
Role
Field
Type
Description
Created
HydroID
Integer
Created
GridID
Integer
Created
with SDE
NextDownID
Integer
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 50 of 64
Input/Output
Input
Output
"Link Grid"
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.
Output
Input/Output Management
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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).
Output
"DEM" Grid
Fill the input DEM grid and generate the Depression by subtracting the DEM from the filled
DEM.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 52 of 64
Generate the drainage areas associated to the depression using the Flow Direction Grid.
IsSink: Indicator (0/1) populated with 0 by default. Populated by the tool Sink Selection.
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)
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
"DrainageLine_FS" Table
Input/Output Management
Input/Output Management
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.
If there is a grid theme that has a tag "Flow Direction Grid", it will be used as a default for the
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
Created
GridID
Integer
Created
From_Node
Integer
Created
To_Node
Integer
Created
NextDownID
Integer
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
Created
NextDownID
Integer
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
"Catchment Grid"
"Catchment" Feature Class
Input/Output Management
Input/Output Management
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.
If there is a grid theme that has a tag "Catchment Grid", it will be used as a default for the
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.
If there is a polygon feature class that has a tag "Catchment", it will be used as a default for
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
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
Created
GridID
Integer
Created
DrainID
Integer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
Input/Output Management
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"
tag at the end of the operation.
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"
tag at the end of the operation. If the specified output grid already exists, the user is
prompted whether to remove the existing dataset.
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".
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 56 of 64
Output
Input/Output Management
Input/Output Management
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" tag at the end of the operation.
If there is a grid theme that has a tag "Flow Accumulation 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
"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.
Output
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 57 of 64
Input/Output Management
If there is a grid theme that has a tag "Hydro 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
"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.
If there is a grid theme that has a tag "Flow Direction 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 "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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
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.
Output
"Level DEM" Grid
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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.
Input/Output
Input
"DEM" Grid
Output
"Sink Polygon" Feature Class
"Sink Drainage Area" Polygon Feature Class
Input/Output Management
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 60 of 64
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
Created/Populated
GridID
Integer
Created/Populated
DrainID
Integer
Created/Populated
IsSink
Short
Integer
Created/Populated
FillDepth
Double
FillElev BottomElev
Created/Populated
FillArea
Double
Created/Populated
FillVolume
Double
Created/Populated
BottomElev
Double
Created/Populated
FillElev
Double
Created/Populated
DrainArea
Double
Field
Type
Description
Created/Populated
HydroID
Integer
Created/Populated
GridID
Integer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 61 of 64
Output
Input/Output Management
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.
Output
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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.
Output
"Stream Grid"
Input/Output Management
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 63 of 64
If there is a grid theme that has a tag "Flow Accumulation 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 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"
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 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.
Output
"Stream Grid"
"Sink Watershed" Grid
"Sink Link" Grid
Input/Output Management
Input/Output Management
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 "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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
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
prompted whether to remove the existing dataset.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhA59D.htm
12/8/2014
Page 1 of 5
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
Batch Processing
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
Data
Type
Raster
Layer
Double
Environments
This tool does not use any geoprocessing environments
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6DEB.htm
12/8/2014
Page 2 of 5
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
Raster
Layer
Number_of_cells_to_define_stream
Integer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
Summary
Geoprocessing model performing the basic deranged terrain processing workflow.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6DEB.htm
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
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
Directory
in_model
String
in_spatialrefgridname
String
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6DEB.htm
12/8/2014
Page 4 of 5
ArcEditor: Yes
ArcInfo: Yes
Usage
Syntax
DendriticTerrainProcessingwithImposedDLAndWall_archydro (RawDEM, AgreeStream,
Inner_Wall_Height__DEM_Z-Unit_, {Input_Outer_Wall_Polygon})
Parameter
Explanation
Data Type
RawDEM
Raster Layer
AgreeStream
Inner_Wall_Height__DEM_ZUnit_
Feature
Layer
Double
Input_Outer_Wall_Polygon
(Optional)
FeatureLayer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6DEB.htm
12/8/2014
Page 5 of 5
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh6DEB.htm
12/8/2014
Page 1 of 22
Description
Convert 3D Line
to Raster
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.
Generate
Processing Units
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
Terrain Profile
Update TSValue
on Points
Update field in input point based on specified time step and variable.
Weighted
Average
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
Feature Layer
out_lineraster_raster
Raster
Dataset
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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 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,
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 3 of 22
output_fields)
Parameter
Explanation
Data Type
in_point_features
Feature
Layer
out_thiessen_poly_features
Feature
Class
String
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 4 of 22
Explanation
Data Type
input_datacarttable
(Optional)
input_datacartxmlfile
(Optional)
output_geodatabase
Feature
Layer/Table
File Location
Personal
Geodatabase
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
Data Type
Feature
Layer/Table
12/8/2014
output_datacartxmlfile
Page 5 of 22
File Location
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Feature Layer
inCatFL
Feature Layer
RiverOrderField
Field
inPUAreaSize
Long
outRiverFL
Feature Layer
outCatFL
Feature Layer
Environments
This tool does not use any geoprocessing environments
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 6 of 22
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Feature Layer
Feature Class
join_attributes
String
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 7 of 22
Feature Class.
z
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Boolean
Boolean
(Optional)
(Optional)
WaterLevelCheck
(Optional)
Environments
This tool does not use any geoprocessing environments
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 8 of 22
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Feature Layer
outxml
Feature Layer
in_xmlconfig
Feature Layer
(Optional)
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Summary
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
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
Feature Layer
in_table_ts
Table
VARID
Variable
String
TSTime
String
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
from_transfer_field
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
String
12/8/2014
Page 10 of 22
in_to_features
Feature Layer
in_intersect_features
Feature Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
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
Input/Output Management
Input/Output Management
Point
Role
Field
Type
Description
Required
HydroID
Integer
Thiessen Polygon
Role
Field
Type
Description
Created
FeatureID
Integer
Learn more about how Download Time Series Data (Arc Hydro)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
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
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
Yes
VarCode
Yes
Vocabulary
Same as ServCode.
Yes
StartDate
EndDate
LocType
Yes
WMSURI
Input/Output Management
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 12 of 22
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
Input/Output Management
Output
Input/Output Management
From Layer for Intersect
Role
Field
Type
Description
Required
HydroID
Integer
Type
Description
Integer
HydroID
Intersect Layer
Role
Field
Type
Description
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 13 of 22
Created
HydroID
Integer
Created
KeyFrom
Integer
Created
KeyTo
Integer
Created
PctFrom
Double
Created
PctTo
Double
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
The tool performs the following steps:
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.
4.
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):
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 14 of 22
From Layer for Intersect and stores it in the To Layer For Intersect.
Input/Output
Input
Output
Input/Output Management
From Layer for Intersect
Role
Field
Type
Description
Required
HydroID
Integer
Required
"Transfer Value"
Numeric
Field to transfer.
Field
Type
Description
Required
HydroID
Integer
Created
"Transfer Value"
Numeric
Field transferred.
The Intersect Layer feature class may be generated with the tool Intersect Areas (Arc Hydro).
Intersect Layer
Role
Field
Type
Description
Required
KeyFrom
Integer
Required
KeyTo
Integer
Required
PctFrom
Double
Required
PctTo
Double
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 15 of 22
Description
Create Directory
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
Get Field
Allow selecting input field from a list of fields associated to the input
feature layer.
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
Get Spatial
Reference from
Vector
TIN to Raster
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
Data Type
String
12/8/2014
Page 16 of 22
String
Environments
This tool does not use any geoprocessing environments
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
spatial_reference
(Optional)
Input_feature_class_height_field_SF_type_tag_field
TIN
String
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 17 of 22
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 18 of 22
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
This tool does not use any geoprocessing environments
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
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
This tool does not use any geoprocessing environments
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
Feature Layer
Input_Field
Field
Environments
This tool does not use any geoprocessing environments
Summary
Returns alias name of selected input field as string.
Usage
Syntax
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 20 of 22
Explanation
Data Type
Input_Feature_Layer
Feature Layer
Input_Field
Field
Environments
This tool does not use any geoprocessing environments
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
Feature
Layer
Input_Field_Alias_Name
Field
Environments
This tool does not use any geoprocessing environments
Summary
Retrieves the spatial reference from an input raster.
Usage
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 21 of 22
Syntax
GetSpatialReferenceFromRaster_archydro (Input_Raster)
Parameter
Input_Raster
Explanation
Input raster.
Data Type
Raster Layer
Environments
This tool does not use any geoprocessing environments
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
This tool does not use any geoprocessing environments
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 22 of 22
Explanation
Data Type
Input_TIN
TIN Layer
Output_Raster
Raster Dataset
Output_Data_Type
String
Method
String
Sampling_Distance
String
Z_Factor
Double
Environments
This tool does not use any geoprocessing environments
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hh4AE1.htm
12/8/2014
Page 1 of 30
The toolset contains tools that support the delineation and characterization of watershed
features.
Tools
Description
Batch Subwatershed
Delineation
Batch Watershed
Delineation
Batch Watershed
Delineation for Polygons
Construct 3D Line
Interactive Delineation
Smooth 3D Line
Subwatershed from
Watershed
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 2 of 30
Description
Create lines for a specific analysis from an input Line feature class.
Remove Stream
Pseudo Nodes
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
From_Node
To_Node
NextDownID
1: Trim
2: Extend
3: Split
Data Type
Feature Layer
Feature Layer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
Feature Class
12/8/2014
Page 3 of 30
Raster Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Feature Layer
out_stream_fc
Feature Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 4 of 30
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
in_batchpoint_features
Feature
Layer
in_cujunction_features
Feature
Layer
in_cuedge_features
Feature
Layer
in_cupolygon_features
Feature
Layer
datapath
String
clear_features
Boolean
out_globalwatershed_features
Feature
Class
out_globalwatershedpoint_features
Feature
Class
Environments
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 5 of 30
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
in_batchpoint_features
Feature
Layer
in_flow_direction_raster
Raster
Layer
in_stream_raster
Raster
Layer
out_subwatershed_features
out_subwatershedpoint_features
Feature
Class
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 6 of 30
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
in_batchpoint_features
Feature Layer
in_flow_direction_raster
Raster Layer
in_stream_raster
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)
in_catchment_features
Feature Layer
in_adjointcatchment_features
Feature
Layer;Feature
Layer
clear_features
Boolean
out_watershed_features
Feature Class
out_watershedpoint_features
Feature Class
(Optional)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 7 of 30
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
in_flow_direction_raster
Feature
Layer
Raster
Layer
out_watershed_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
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
Feature Layer
in_rawdem_raster
Raster Layer
out_line3d_features
Feature Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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)
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Parameter
Explanation
Page 9 of 30
Data Type
in_pointsource_features
Feature
Layer
in_flow_direction_raster
Raster
Layer
in_stream_raster
out_watershed_features
Raster
Layer
Feature
Class
out_watershedpoint_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
in_drainage_area_features
out_centroid_features
Data Type
Feature
Layer
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 10 of 30
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
in_longestflowpath_features
in_rawdem_raster
Feature
Layer
Raster
Layer
out_slp1085point_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
Summary
Calculates flow path parameters for 3D lines.Learn more about how Flow Path Parameters
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 11 of 30
Usage
Syntax
FlowPathParametersFrom3DLine_archydro (in_longestflowpath3d_features,
out_slp1085point_features)
Parameter
Explanation
Data
Type
in_longestflowpath3d_features
Feature
Layer
out_slp1085point_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
ArcInfo: Yes
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
Feature Set
Input_Flow_Direction_Grid
Raster
Layer
Input_Stream_Grid
Raster
Layer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Input_Snap_Stream_Grid
Page 12 of 30
(Optional)
Input_Catchment
Feature
Layer
Input_Adjoint_Catchment
Feature
Layer
Watershed
WatershedPoint
Feature
Layer
Feature
Layer
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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,
out_longestflowpath_features)
Parameter
Explanation
Data Type
in_drainage_area_features
in_flow_direction_raster
Feature
Layer
Raster
Layer
out_longestflowpath_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 13 of 30
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
in_subwatershed_features
in_subwatershedpoint_features
Feature
Layer
Feature
Layer
Feature
Layer
in_catchment_features
in_longestflowpathforcat_features
Feature
Layer
in_flow_direction_raster
Raster
Layer
out_longestflowpath_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 14 of 30
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.
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 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,
out_longestflowpath_features)
Parameter
Explanation
in_watershed_features
in_watershedpoint_features
in_catchment_features
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
Data
Type
Feature
Layer
Feature
Layer
Feature
Layer
12/8/2014
Page 15 of 30
in_adjointcatchment_features
Feature
Layer
in_longestflowpathadjcat_features
Feature
Layer
in_drainageline_features
Feature
Layer
in_flow_direction_raster
Raster
Layer
out_longestflowpath_features
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
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
in_watershedpoint_features
Feature
Layer
Feature
Layer
in_drainageline_features
Feature
Layer
in_catchment_features
Feature
Layer
in_rawdem_raster
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
Raster
12/8/2014
in_flow_accumulation_raster
number_cells
out_main_flowpath_features
area_sqkm
(Optional)
Page 16 of 30
Layer
Raster
Layer
Raster
Layer
Double
Feature
Class
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
ArcInfo: Yes
Summary
Smooths 3D lines linearly in the digitized direction.
Usage
Syntax
Smooth3DLine_archydro (in_line3d_features, out_smoothline3d_features)
Parameter
Explanation
in_line3d_features
out_smoothline3d_features
Data Type
Feature
Layer
Feature
Class
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Yes
ArcEditor: Yes
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 17 of 30
ArcInfo: Yes
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
Output_Subwatershed
Data Type
Feature
Layer
Feature
Layer
Feature
Layer
Feature
Layer
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 18 of 30
Environments
This tool does not use any geoprocessing environments
Licensing Information
ArcView: Requires Spatial Analyst
ArcEditor: Requires Spatial Analyst
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
"Global Watershed"
Input/Output Management
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
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 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
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 Polygon" at the end of the operation.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 19 of 30
HydroID - Unique identifier of the Global Watershed Point in the Arc Hydro database.
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.
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).
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
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
The function will then prompt for the snapping method to use. 3 options are available:
z
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.
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.
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 21 of 30
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.
Output
"Stream Grid"
Input/Output Management
If there is a grid theme that has a tag "Flow Direction Grid", it will be used as a default for the
Flow Direction 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 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.
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.
Required Fields: Name, Descript, BatchDone, SnapOn.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
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
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
Output
"Stream Grid"
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 23 of 30
Input/Output Management
If there is a grid theme that has a tag "Flow Direction Grid", it will be used as a default for the
Flow Direction 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 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.
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
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.
Required Fields: Name, Batchdone, Snapon, Descript
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 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
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
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
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 25 of 30
feature class.
Input
Output
Input/Output Management
If there is a grid theme that has a tag "Flow Direction Grid", it will be used as a default for the
Flow Direction 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 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
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
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, all existing features will be cleared
and the new polygons will be appended in this existing feature class.
Fields created:
z
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
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"
Input/Output Management
If there is a grid theme that has a tag "Flow Direction Grid", it will be used as a default for the
Flow Direction 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 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.
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
tagged with the "Batch Point" tag at the end of the operation.
Optional Fields:
z
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 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 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
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
specify a feature class name that will be tagged with the "Watershed" tag at the end of the
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
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:
HydroID - Unique identifier of the watershed in the Hydro database.
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
Input/Output Management
If there is a grid theme that has a tag "Raw DEM", it will be used as a default for the first input
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Page 28 of 30
grid. If not, the user needs to select an existing grid theme name that will be tagged with the
"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
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
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.
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
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014
Feature Class
Page 29 of 30
Input/Output Management
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
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
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
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.
file:///C:/Users/eweaver/AppData/Local/Temp/arcFA70/~hhFB99.htm
12/8/2014