stalta

function of dascore.transform.stalta

source

stalta(
    patch: Patch ,
    **kwargs ,
)-> ‘PatchType’

Compute the short-term / long-term average (STA/LTA) ratio along a patch dimension.

Parameters

Parameter	Description
patch :	The input DASCore patch.
sta : float	Short window length in seconds. If None, it defaults to 20 samples.
lta : float	Long window length in seconds. If None it defaults to 5*short.
**kwargs	Used to pass dimension and short/longterm windows. For example time=(0.1, 0.5) uses windows of 0.1 and 0.5 seconds along the time axis. Note that a good first guess is to choose the long-term window 5x the length of the short-term window.

Returns

PatchType A new patch containing the STA/LTA ratio.

Example

import dascore as dc

p = dc.examples.example_event_2()

s = p.envelope(dim='time').stalta(time=(0.002, 0.01))
ax = s.viz.waterfall(cmap = 'RdGy_r', scale = [0, 2], scale_type = 'absolute')