NetMap's Technical Help Guide

1.2 Survey Overlay - by request, available 2014/2015

Survey Overlay
User version not yet available, under development (2015 - 2016)
 
Description: Survey Overlay is found in the River Builder module (RB) and is used to write an input file of attribute parameters and to run the Overlay program. Overlay generates NetMap river attributes for a shapefile of segments provided by the user, based on node-based river networks which were previously run using BldGrds.
 
Data Type:
Output: Stream survey segments in shapefile format.
Input: Node-based river files that were previously generated by BldGrds, a DEM covering the area, and other binary (.flt) files generated by BldGrds. Other files as required for selected attributes.
Description:
 
 
The RB is designed to run two programs, Netrace and Overlay.  The user will check ‘Add attributes to stream survey data’ to run Overlay. Overlay enables users to enter their river segments and add NetMap attributes to those segments.  This option does not generate a full river network.
By checking the default attribute box, only the following attributes will be added to the rivers:  reach ID, reach length, reach gradient, elevation, contributing drainage area, valley width at 5 x channel depth, and mean annual precipitation. The user will need to provide a channel depth regression equation and a raster for mean annual precipitation (typically PRISM data are used).
 
Users can add the location of the data to the GIS metadata file (xml) that is generated for the network.
 
The RB UI will open in the tab for Paths and Files. Six tabs comprise the RB UI, and these allow the user to enter required data for paths and file names, to add optional attributes, to use the Equationator for calculating regional regressions and other equations, and to calculate summary attributes from categorical and continuous rasters. The second tab, called Survey Overlay, enables the entry of river survey data and is only enabled when the “Add attributes to river survey data (Overlay)” option is checked.
 
Load input file allows the user to load an existing file into the RB interface and edit or adjust values.
Save input file and run writes the input file to the designated path and will ask the user if they want to run Netrace or Overlay (as selected above).
Close will quit the RB interface without saving any changes that the user may have made.
This interface generates an input file which is necessary to run Netrace, the six minimum inputs are marked by ’*': 
the output path name where data are to be saved;
the text file to write parameters for Netrace or Overlay – this is typically called input.txt and is generated by the RB UI; 
the DEM in floating point format (.flt, this can be converted from raster or Field Grid format in FieldGIS);
the data ID – a 3-5 letter abbreviation for the data set – it is used as the directory name and as a suffix on datasets (e.g. reach_xxx.shp);
the path and name of the reach shapefile that is generated;
the path and name of the parameter file which must have the format Netrace_Parameters.xxx where xxx is a data id. A matching Netrace_Instruction.xxx file must exist in the same folder.  Use of these files will eventually be phased out.
Details on how to enter values (path, file names, and parameters) for each field in the Paths and Files tab are given in Table 1 along with an example and some notes. Other parameters are tabulated for Survey (Table 2.), Attributes (Table 3.), Rasters (Table 4.). These tables also illustrate how to edit the text files in a text editor, if that is the preference.
Raster input and output files are always in .flt format. Use FieldGIS Conversion tools to convert FieldGrids to .flt.
An upright line ‘|’ between text indicates input options. For example,  m|f. DEMs in meters or feet can be entered and the units should be indicated as a single letter.
Output fieldnames must be less than 10 characters.
Path names require a following back slash, e.g., c:\data\
The tables are followed by an example input file (Figure 2). More examples and description of input parameters can be found on the NetBlog:  http://earthsystems.net/?p=601 
Table 1. Path and Files: Parameter entry by keyword, with the program that uses it, an example, and notes.
Key Word
Parameters / Args
Example
Notes
OUTPUT PATH:
 
c:\work\data\hoh\
This should contain the DEM, accum_ID.flt, and ang_ID.flt
DEM FILE:
 
c:\work\data\hoh\elev_hoh
.flt format
DEM UNITS:
m | f
 
default = meters (m)
DATA_ID
 
hoh
Used to identify files with standardized names, typically 3-5 characters, (accum_ID, ang_ID, bcont_ID, grad_XX_ID, plan_XX_ID, D8_ID)
SCRATCH PATH:
 
c:\work\temp\scratch\
Ideally, the scratch space will be on the fastest hard drive available. Will use output path if unspecified
PARAMETER FILE DIRECTORY:
 
c:\work\data\hoh\
 
PARAMETER FILE EXTENSION:
 
hoh
 
DRAINAGE WING GRID:
FILE=
e:\data\hoh\ID_test
Output raster name
SURVEY UNIT FILE:
FILE=path&filename, SURVEY TYPE =CONTINUOUS|REACH
c:\work\data\PDE\KTIHabData, REACH, SHAPEFILE    or   e:\data\ocr\ODFW-OP_UTM_Coordinates.csv, REACH
 Input files for survey units can be continuous with data in a table; discontinuous or point with data in table or shapefile
OUTPUT SHAPEFILE:
 
c:\work\data\hoh\test_hoh
Path and file without extension. If the file already exists, it is overwritten.
OUTPUT CSV FILE:
 
c:\work\data\hoh\test
Path and file without extension. If the file already exists, it is overwritten.
REACH LENGTH:
FIXED LENGTH =.| MINLENGTH = ., MAXLENGTH = ., MINAREA = , MAXAREA = . | CHANNEL WIDTHS= | HOMOGENEOUS,   FILTER=100
REACH LENGTH: CHANNEL WIDTHS, 20.
Fixed or channel widths, then value, filter deletes channel heads < filter
VALLEY PARAMETER FILE:
 
c:\work\netmap\valwidthbymean_input.txt
path and file
LAKE MASK:
FILE=flt |shp
 
 The extension on the filename will indicate if it is a shapefile or raster file. For now, it will default to a raster file, because code is not yet written to read a polygon shapefile.
 
 
Table 2. Entries for the Survey tab.
Key Word
Parameters / Args
Example
Notes
# Data overlay
These inputs are csv input only, csv assumes a format (not documented yet).
 
 
ID FIELD NAME:
 
id_num
 
START X FIELD NAME:
 
start_utm_e
 
START Y FIELD NAME:
 
start_utm_n
 
END X FIELD NAME:
 
end_utm_e
 
END Y FIELD NAME:
 
end_utm_n
 
MIDPOINTS:
 
1
= number of midpoints
MID X FIELD NAME:
 
pt_utm_e
> 1
MID Y FIELD NAME:
 
pt_utm_n
> 1
MINIMUM AREA FILTER:
 
0.01
km2, min contributing area for channels
 
Table 3. Entries for the Attribute tab. Arguments common to all are: OUTPUT FIELD=|FIELD NAME=, len= , deccnt=.
Key Word
Parameters / Args
Example
Notes
ATTRIBUTE LIST:
Common args: OUTPUT FIELD=|FIELD NAME= (<=10 chars),REPLACE (in NodeAttributes_ID.dat), len= , deccnt=
 
flag end with END ATTRIBUTE LIST:
REACH ID:
 
 
Use survey reach id
DOWN REACH ID:
 
 
Not calculated for scattered survey reaches
CHANNEL ID:
 
 
 
REACH LENGTH:
 
 
 
 
 
 
 
CONTRIBUTING AREA:
 
 
 
ELEVATION:
 
 
 
MEAN ANNUAL PRECIP:
PRECIP FILE=path&filename,  INPUT UNITS= m|mm
c:\work\data\pde\pptmm_83utm11,m; c:\work\data\pde\prec_kal, FIELD NAME = MEANPREC
1st argument gives .flt file; 2nd argument gives units of the input precipitation grid default = meters , output in mm
MEAN ANNUAL FLOW:
 
len = 12, deccnt = 6, FIELD NAME = MEAN_CMS
Equationator: Requires regional regression coeffs in Netrace_Parameters file, output is CMS
WIDTH:
 
 
Equationator: Requires regional regression coeffs in Netrace_Parameters file, ouput is meters
DEPTH:
 
 
Equationator: Requires regional regression coeffs in Netrace_Parameters file, ouput is meters
SINUOSITY:
CHANNEL WIDTH=x (default, 40)|  FIXED LENGTH= x
 
 
GRADIENT:
 
deccnt = 5
 
VALLEY WIDTH:
CHANNEL DEPTHS =, OUTPUT FIELD =
CHANNEL DEPTHS=3, OUTPUT FIELD = vw3
argument specifies number of channel depths at which to estimate valley width
VALLEY FLOOR MASK:
CHANNEL DEPTHS = , CHANNEL ID = , OUTPUT = , OUTFILE = ,
CHANNEL DEPTHS = 3, CHANNEL ID = 0, OUTPUT = REACHID, OUTFILE = c:\work\data\pri\valMask3cd, OUTPUT FIELD = VALPOLY3CD
 
BARRIER POINT SHAPEFILE:
ID FIELD = , RADIUS = , SNAP TO LARGEST CHANNEL =
FILE = c:\work\data\PRI\barriers, ID FIELD = ID, RADIUS = 250., OUTPUT FIELD = BARRIER_ID, SNAP TO LARGEST CHANNEL = YES
 
CHANNEL MEAN:
INPUT FIELD =  , FIELD NAME =
INPUT FIELD = GRADIENT, FIELD NAME = CHANGRAD
 
IP:
path&file, _COHO, _CHINOOK, _STEELHD, OUTFIELD=,
IP: INPUT FILE = c:\work\netmap\cohoIP.txt, OUTFIELD = IP_COHO
 
DISTANCE TO OUTLET:
DOWNSTREAM|UPSTREAM|MIDPOINT
to edge of DEM
Defaults to downstream
DISTANCE TO SOURCE:
DOWNSTREAM|UPSTREAM|MIDPOINT
 
Defaults to downstream
DISTANCE TO MOUTH:
DOWNSTREAM|UPSTREAM|MIDPOINT
to channel
Defaults to downstream
BARRIERS:
FILE=, ID FIELD = ID, RADIUS =  ., OUTPUT FIELD = xx, SNAP TO LARGEST CHANNEL = NO (default) | YES
 
can use multiple files using FILENAME and ID FIELD
#AZIMUTH:
Not yet implemented
 
 
#ORDER:
Not yet implemented
 
 
#VALCNSTRNT:
Not yet implemented
 
 
 
 
 
 
END ATTRIBUTE LIST:
 
 
 
 
Table 3. Entries for the Raster tab.
Key Word
Parameters / Args
Notes
Example
RASTER LIST:
 
 
 
FILE:
file name, CONTINUOUS|CATEGORICAL, NUMCAT = X (if categorical)
 
 
spatial context
CONTRIBUTING AREA, NOBUFFER|  CONTRIBUTING AREA, BUFFER| LOCAL (drainage wings)| LOCAL,  BUFFER=
 
 
For Categorical rasters
NUMCAT=
CAT LIST                                    …                                            END CAT LIST:
Import csv table of categories or user input in interface: 
NUMCAT = 3               CAT LIST                        cat1, water                  cat2, grassland           cat3, forest                          END CAT LIST:
For Continuous rasters
MEAN | PROPORTION ABOVE SPECIFIED VALUE | PROPORTION BELOW SPECIFIED VALUE
 
 
 
 OUTPUT FIELD = xxxxx, len=15, deccnt=1
 
 
END CAT LIST:
 
 
 
 
 
 
 
END RASTER LIST:
 
 
 
Figure 2. An example of an input file written by the Stream Network Builder for entry to Overlay.
 
 
 
 
 
 
 
 
 
 

Made with help of Dr.Explain

Copyright TerrainWorks 2014