NAME

KEYWORDS

SYNOPSIS

Flags:

-o

Calculate parameters for outlets (outlet mode) instead of (default) streams

-s

Calculate parameters for subbasins (ignored in stream mode)

-n

Calculate nearest local maximum (ignored in downstream calculation)

--overwrite

Allow output files to overwrite existing files

--verbose

Verbose module output

--quiet

Quiet module output

Parameters:

stream=string

Name of streams (outlets) mask input map

dir=string

Name of flow direction input map

dem=string

Name of elevation map

method=string

Calculation method

Options: upstream,downstream

Default: downstream

distance=string

Output distance map

elevation=string

Output elevation map

OPTIONS

-o

Downstream method only. Calculate distance and elevation against basin outlets instead of streams. It choose only last outlets in the network ignoring nodes.

-s

Downstream method only. Calculate distance and elevation against stream nodes instead of streams. It create distance and elevation parameters not for whole basins but for subbasins

-n

For upstream method only. Calculate distance and elevation to the nearest local maximum/divide. With the default option distance/elevation is calculated to the farthest possible maximum/divide

stream

Stream network: name of input stream map on which ordering will be performed produced by r.watershed or r.stream.extract. Because streams network produced by r.watershed and r.stream.extract may slighty differ in detail it is required to use both stream and direction map produced by the same module. Stream background shall have NULL value or zero value. Background values of NULL are by default produced by r.watershed and r.stream.extract. If not 0 or NULL use r.mapcalc to set background values to null.

dir

Flow direction: name of input direction map produced by r.watershed or r.stream.extract. If r.stream.extract output map is used, it only has non-NULL values in places where streams occur. NULL (nodata) cells are ignored, zero and negative values are valid direction data if they vary from -8 to 8 (CCW from East in steps of 45 degrees). Direction map shall be of type CELL values. Region resolution and map resoultion must be the same. Also stream network map must have the same resolution. It is checked by default. If resolutions differ the module informs about it and stops. Region boundary and maps boundary may be differ but it may lead to unexpected results.

elev

Elevation: name of input elevation map. Map can be of type CELL, FCELL or DCELL. It is not restricted to resolution of region settings as stream and dir.

method

It is possible to calculate distance with two method: downstream from any raster cell to the nearest stream cell/ junction cell or outlet or upstream from any cell upstream to the local maximum

OUTPUTS

elevation

Returns elevation above the targer (outlet, node stream) along watercoures. The map is of FCELL type

distance

Returns distance to the targer (outlet, node stream) along watercoures. The map is of FCELL type

DESCRIPTION

Module r.stream.distance may calculate distance using two methods: downstream and upstream.

The default is downstream method when it calculate distance to streams and outlets and elevation above streams and outlets. The distance and elevation is calculated along watercourses. In outlets mode it can also calculate parameters for subbasins.

In streams mode (default) it calculates that parameters downstream to streams which are added as stream mask. In outlets mode there are some additional possibilities. If subbasin is off it calculate parameters only for last point of last (downstream) CELL. In subbasin mode it calculates parameters for every subbasin separately. Subbasin mode acts similar to subbasin mask. Streams file prepared to create basins and subbasins with r.stream.basins can use to to calculate distance and elevation parameters.

With upstream method it calculate distance to the local maximum or divide. Opposite to downstream method, where every cell has one and only one downstream cell in upstream method every cell has usually more than one upstream cell. So it is impossible to determine nterchangeable path from any cell. The upstream method offers two alternative modes switched with -n flag: nearest local maximum/divide: means the shortest path to local maximum and default option farthest maximum/divide means the longest path. In hydrological sense nearest mode means the shortest path which particle of water must run from divide to reach particular cell, while farthest mode means the possible longest path.

NOTES

If there are more than one point or one stream networks and some separate points or separate streams networks are in catchment area defined by others it will results as in subbasin mode. In stream mode subbasin options is ommited. Input maps must be in CELL format (default output of r.watershed, r.stream.order and r.stream.extract) The distance are calculated in meters both for planimeters and Latitude-Longitude projections. The distance is calculated for flat areas not corrected by topography. Distance correction by topography may be done with following mapcalc formula:

echo 'dist_corrected = sqrt(distance^2 + elevation ^2)'|r.mapcalc

Module can work only if direction map, stream map and region map has same settings. It is also required that stream map and direction map come from the same source. For lots of reason this limitation probably cannot be omitted. this means if stream map comes from r.stream.extract also direction map from r.stream.extract must be used. If stream network was generated with MFD method also MFD direction map must be used.

SEE ALSO