name: v.stream.profiler description: Build a linked stream network: each link knows its downstream link keywords: [ vector, stream network, hydrology, geomorphology ]

v.stream.profiler

Build a linked stream network: each link knows its downstream link

Command linePython (grass.script)

v.stream.profiler cat=string streams=name [outstream=name] [direction=string] [elevation=name] [accumulation=name] [slope=name] [units=string] [accum_mult=float] [window=name] [plots=string [,string,...]] [outfile_original=string] [outfile_smoothed=string] [--overwrite] [--verbose] [--quiet] [--qq] [--ui]

Example:

v.stream.profiler cat=string streams=name

grass.script.run_command("v.stream.profiler", cat, streams, outstream=None, direction="downstream", elevation=None, accumulation=None, slope=None, units=None, accum_mult=1, window=None, plots=None, outfile_original=None, outfile_smoothed=None, overwrite=False, verbose=False, quiet=False, superquiet=False)

Example:

gs.run_command("v.stream.profiler", cat="string", streams="name")

Parameters

Command linePython (grass.script)

cat=string [required]
    Starting line segment category
streams=name [required]
    Vector input of stream network created by r.stream.extract
    Or data source for direct OGR access
outstream=name
    Vector output stream
    Name for output vector map
direction=string
    Which directon to march: up or down
    Allowed values: upstream, downstream
    Default: downstream
elevation=name
    Topography (DEM)
    Name of input raster map
accumulation=name
    Flow accumulation raster
    Name of input raster map
slope=name
    Map of slope created by r.slope.area
    Name of input raster map
units=string
    Flow accumulation units
    Allowed values: m2, km2, cumecs, cfs
accum_mult=float
    Multiplier to convert flow accumulation to your chosen unit
    Default: 1
window=name
    Averaging distance [map units]
    Name of input raster map
plots=string [,string,...]
    Plots to generate
    Allowed values: LongProfile, SlopeAccum, SlopeDistance, AccumDistance
outfile_original=string
    output file for data on original grid
outfile_smoothed=string
    output file for data on smoothed grid
--overwrite
    Allow output files to overwrite existing files
--help
    Print usage summary
--verbose
    Verbose module output
--quiet
    Quiet module output
--qq
    Very quiet module output
--ui
    Force launching GUI dialog

cat : str, required
    Starting line segment category
streams : str, required
    Vector input of stream network created by r.stream.extract
    Or data source for direct OGR access
    Used as: input, vector, name
outstream : str, optional
    Vector output stream
    Name for output vector map
    Used as: output, vector, name
direction : str, optional
    Which directon to march: up or down
    Allowed values: upstream, downstream
    Default: downstream
elevation : str, optional
    Topography (DEM)
    Name of input raster map
    Used as: input, raster, name
accumulation : str, optional
    Flow accumulation raster
    Name of input raster map
    Used as: input, raster, name
slope : str, optional
    Map of slope created by r.slope.area
    Name of input raster map
    Used as: input, raster, name
units : str, optional
    Flow accumulation units
    Allowed values: m2, km2, cumecs, cfs
accum_mult : float, optional
    Multiplier to convert flow accumulation to your chosen unit
    Default: 1
window : str, optional
    Averaging distance [map units]
    Name of input raster map
    Used as: input, raster, name
plots : str | list[str], optional
    Plots to generate
    Allowed values: LongProfile, SlopeAccum, SlopeDistance, AccumDistance
outfile_original : str, optional
    output file for data on original grid
outfile_smoothed : str, optional
    output file for data on smoothed grid
overwrite: bool, optional
    Allow output files to overwrite existing files
    Default: False
verbose: bool, optional
    Verbose module output
    Default: False
quiet: bool, optional
    Quiet module output
    Default: False
superquiet: bool, optional
    Very quiet module output
    Default: False

DESCRIPTION

v.stream.profiler builds and exports plots and data sets of river long profiles, slope-accumulation (e.g., slope-area), and more for topographic analysis. It currently works only in a downstream-directed walk, for a single channel, from the chosen segment until the downstream-most point in the network. It takes in the adjacency structure supplied by v.stream.network.

REFERENCES

None (yet)

AUTHOR

Andrew D. Wickert

SOURCE CODE

Available at: v.stream.profiler source code (history)
Latest change: Thursday Feb 20 13:02:26 2025 in commit 53de819