lair.transects.enhancement#

lair.transects.enhancement(obs, baseline_q=5.0)[source]#

Enhancement above each transit’s own baseline_q-th percentile along the route.

Parameters:
  • obs (np.ndarray) – Transect matrix obs[transit, point].

  • baseline_q (float, optional) – Percentile (0 to 100) of each transit’s values taken as its baseline. Default 5.

Returns:

np.ndarray – obs minus each transit’s baseline, the same shape. Transits with no finite values are NaN throughout.

Return type:

ndarray

See also

robust_z

The enhancement as a score against its own transit.

detection_frequency

How often each point is enhanced.

magnitude

How much each point is enhanced.

Examples

Three transits over four points; with baseline_q=0 each transit’s lowest value is its baseline:

>>> import numpy as np
>>> from lair.transects import enhancement
>>> obs = np.array(
...     [[2.0, 2.1, 2.6, 2.0], [2.2, 2.2, 2.3, 2.9], [2.0, np.nan, 2.5, 2.0]]
... )
>>> enhancement(obs, baseline_q=0).round(2)
array([[0. , 0.1, 0.6, 0. ],
       [0. , 0. , 0.1, 0.7],
       [0. , nan, 0.5, 0. ]])