topotoolbox.FlowObject

class topotoolbox.FlowObject(grid: GridObject)

Bases: object

A class containing containing (water-) flow information about a given digital elevation model (DEM).

__init__(grid: GridObject)

The constructor for the FlowObject. Takes a GridObject as input, computes flow direction information and saves them as an FlowObject.

Parameters:

grid (GridObject) – The GridObject that will be the basis of the computation.

Notes

Large intermediate arrays are created during the initialization process, which could lead to issues when using very large DEMs.

Methods

__init__(grid)	The constructor for the FlowObject.
show([cmap])	Display the FlowObject instance as an image using Matplotlib.

show(cmap: str = 'terrain')

Display the FlowObject instance as an image using Matplotlib.

Parameters:

cmap (str, optional) – Matplotlib colormap that will be used in the plot.