dominosee.eventorize.get_event¶
- dominosee.eventorize.get_event(da, threshold, extreme, event_name=None, select=None, select_period=None)[source]¶
Apply get_event to an xarray DataArray.
- Parameters:
da (xarray.DataArray) – DataArray containing data with dimension ‘time’
threshold (float) – Threshold value
extreme ({‘above’, ‘below’}, optional) – Whether to select values above or below the threshold, by default “above”
event_name (str, optional) – Name of the event, by default “event”
select ({‘burst’, ‘wane’, ‘start’, ‘end’}, optional) – Type of event selection, by default None
select_period (int, optional) – Number of time steps to select from the beginning or end of each event, by default None
- Return type:
- Returns:
xarray.DataArray – DataArray with the events in datatype bool