priority_flow.stream_distance
=============================

.. py:module:: priority_flow.stream_distance

.. autoapi-nested-parse::

   Find the distance to the nearest stream point following drainage directions.

   Line-by-line translation of Stream_Distance.R (StreamDist) from the R
   PriorityFlow package. R uses 1-based indexing; we use 0-based.



Functions
---------

.. autoapisummary::

   priority_flow.stream_distance.stream_dist


Module Contents
---------------

.. py:function:: stream_dist(direction: numpy.ndarray, streammask: numpy.ndarray, domainmask: Optional[numpy.ndarray] = None, d4: Tuple[int, int, int, int] = (1, 2, 3, 4)) -> Dict[str, numpy.ndarray]

   Find stream distance using flow-direction traversal upstream from streams.