deltametrics.plan.compute_surface_deposit_age

deltametrics.plan.compute_surface_deposit_age(data, surface_idx, **kwargs)

Compute the age (i.e., how much time ago) the surface was deposited.

Warning

only works for indices (not times) as implemented.

Hint

This function internally uses compute_surface_deposit_time and is simply the current time/idx of interest minute the date of deposition (with handling for wrapping negative indices).

Parameters:

• data (DataCube, ndarray, DataArray) – Input data to compute the surface deposit age 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 age 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.

Examples

(Source code, png, hires.png)