glucopy.metrics.samp_en#
- glucopy.metrics.samp_en(df: DataFrame, delay: int | None = 1, dimension: int | None = 2, tolerance: float | str | None = 'sd', **kwargs)[source]#
Calculates the Sample Entropy using neurokit2.entropy_sample()
For more information on the parameters and details see
neurokit2.complexity.entropy_sample()
.- Parameters:
per_day (bool, default False) – If True, returns a
pandas.Series
with the Sample Entropy for each day. If False, returns the Sample Entropy for the entire dataset.others – For more information on the rest of the parameters see
neurokit2.complexity.entropy_sample()
.
- Returns:
samp_en – Entropy Sample.
- Return type:
float
Notes
This function is meant to be used by
glucopy.Gframe.samp_en()