ID properties

Full feature extraction

---

get_candidate_data

 get_candidate_data (candidate:dict, data:xarray.core.dataarray.DataArray,
                     **kwargs)

---

select_data_by_timerange

 select_data_by_timerange (data:xarray.core.dataarray.DataArray, tstart,
                           tstop, neighbor:int=0)

---

get_data_at_times

 get_data_at_times (data:xarray.core.dataarray.DataArray, times,
                    method='nearest')

Select data at specified times.

Pipelines

---

calc_events_mva_features

 calc_events_mva_features (df, data, tr_cols=['t_us', 't_ds'], **kwargs)

---

calc_events_duration

 calc_events_duration (df, data, tr_cols=['tstart', 'tstop'], **kwargs)

---

calc_events_tr_features

 calc_events_tr_features (df:polars.dataframe.frame.DataFrame, data,
                          tr_cols=['tstart', 'tstop'], func=None,
                          **kwargs)

---

calc_events_vec_change

 calc_events_vec_change (df:polars.dataframe.frame.DataFrame,
                         data:xarray.core.dataarray.DataArray, name='dB',
                         start='t_us', end='t_ds')

Utils function to calculate features related to the change of the magnetic field

---

calc_events_cross_normal

 calc_events_cross_normal (df:polars.dataframe.frame.DataFrame,
                           data:xarray.core.dataarray.DataArray,
                           name='n_cross', start='t_us', end='t_ds')

Computes the normal directions(s) at two different time steps.

Data processing

---

process_events

 process_events (events:polars.dataframe.frame.DataFrame,
                 data:xarray.core.dataarray.DataArray,
                 method:Literal['fit','derivative']='fit', **kwargs)

Process candidates DataFrame

	Type	Default	Details
events	DataFrame		potential candidates DataFrame
data	DataArray
method	Literal	fit
kwargs