Summary
Generates an inundation depth map for river reaches based on forecasted flows and precomputed hydraulic properties. It uses the Height Above Nearest Drainage (HAND) raster, catchment IDs, and a synthetic rating curve to interpolate stage from flow, then computes cell inundation depth as max(stage − HAND, 0). Inputs include HAND and catchment rasters, optional mask, a flow forecast table, and hydraulic property table from catchhydrogeo. Outputs a raster file of inundation depths and optionally a CSV of reach depths.
Usage
Command Prompt Syntax:
mpiexec -n <number of processes> inundepth
-hand <handfile>
-catch <catchfile>
-mask <maskfile>
-fc <forecastfile>
-hp <hydropropertyfile>
-inun <outputinundationfile>
[-depth <outputdepthfile>]
Parameters:
- handfile: File name of the hand raster file (input)
- catchfile: File name of the catchment raster file (input)
- maskfile: File name of the mask raster file (input - optional)
- forecastfile: File name of the inundation forecast CSV file (input). This file has 2 columns - id and flow.
- hydropropertyfile: File name of the hydro property text file (input)
- outputinundationfile: File name of the inundation raster file (output)
- outputdepthfile: File name of the inundation depth text/CSV file (output - optional)
| Parameter | Explanation | Data Type |
|---|---|---|
| Input_handfile | The Height Above Nearest Drainage (HAND) raster. Each pixel stores elevation above stream. Commonly generated from Dinfinity Distance Down with the -v (vertical drop) option. | Raster Layer |
| Input_catchfile | Catchment (watershed) ID raster. Each pixel labeled by its catchment ID. A separate synthetic rating curve for the stream reach associated with each catchment is used to evaluate inundation. | Raster Layer |
| Input_maskfile (Optional) | Cells to be excluded from calculations such as permanent water bodies (e.g., lakes). | Raster Layer |
| Input_forecastfile |
Flow table file containing Id and flow (m3/s).
Example Id, flow_m3s 3, 277.3314643 10, 69.78496714 1, 64.16075885 2, 11.20897164 11, 398.7079813 |
Comma Separated Variables (CSV) |
| Input_hydropropertyfile | Hydraulic property and synthetic rating curve file obtained from catchhydrogeo. | CSV |
| Input_Number_of_Processes | The number of stripes that the domain will be divided into and the number of MPI parallel processes that will be spawned to evaluate each of the stripes. | Long |
| Output_outputinundationfile | Output raster showing the calculated inundation depth (i.e., H - HAND) for valid cells. | Raster Layer |
| Output_outputdepthfile (Optional) | Reach depths that were computed. Columns Id, flow, depth. | CSV file |
Code Samples
There are no code samples for this tool.
Tags
There are no tags for this item.
Credits
There are no credits for this item.
Use limitations
There are no use limitations for this item.