bycycle.utils.drop_samples_df

bycycle.utils.drop_samples_df(df_features)

Remove cyclepoints sample columns from a dataframe.

Parameters:

df_featurespandas.DataFrame

Dataframe output of compute_features() or :func`~.compute_shape_features`.

Returns:

df_featurespandas.DataFrame

A dataframe without sample indices columns removed.

Examples

Drop cyclepoint sample columns from a dataframe:

>>> from neurodsp.sim import sim_bursty_oscillation
>>> from bycycle.features import compute_features
>>> fs = 500
>>> sig = sim_bursty_oscillation(10, fs, freq=10)
>>> df_features = compute_features(sig, fs, f_range=(8, 12), center_extrema='peak')
>>> df_features = drop_samples_df(df_features)