fastscapelib.FlowSnapshot

class fastscapelib.FlowSnapshot

Flow snapshot operator.

A special flow operator used to save intermediate states of the flow graph and/or topographic elevation values while applying the other operators in chain.

Those saved states are accessible from FlowGraph.graph_snapshot() and FlowGraph.elevation_snapshot().

__init__(self, snapshot_name: str, save_graph: bool = True, save_elevation: bool = False) → None

FlowSnapshot initializer.

Parameters:

• snapshot_name (str) – Name of the snapshot.

• save_graph (bool) – If True (default), save the intermediate graph state.

• save_elevation (bool) – If True, save the intermediate topography elevation (default: False).

Methods

__init__(self, snapshot_name[, save_graph, ...])

FlowSnapshot initializer.

Attributes

elevation_updated
graph_updated
in_flowdir
name	Flow operator's name.
out_flowdir
save_elevation	If True, saves the intermediate topography elevation.
save_graph	If True, saves the intermediate graph state.
snapshot_name	The snapshot name.