deltametrics.plan.compute_surface_deposit_time¶
- deltametrics.plan.compute_surface_deposit_time(data, surface_idx=-1, **kwargs)¶
Compute the time of last deposition for a single time.
This method computes the timing of last deposition for each location for a given time_index. This is done by finding the last time the bed elevation was outside of a “stasis tolerance” length scale at each location. Therefore, the function requires the spacetime dataset of bed elevation, at a minimum, up to the point in time of interest.
Warning
only works for indices (not times) as implemented.
- Parameters:
data (
DataCube,ndarray,DataArray) – Input data to compute the surface deposit time from. Must be DataCube or a array-like (ndarray or DataArray) containing bed elevation history, at a minimum, up until the time of interest.surface_idx (
int) – The index along the time dimension of the array (dim0) to compute the surface deposit time for. This number cannot be greater than data.shape[0].**kwargs – Keyword arguments passed to supporting function
_compute_surface_deposit_time_from_etas. Hint: you may want to control the stasis_tol parameter.
- Returns:
sfc_time – The time of the surface.
- Return type:
ndarray
Examples
