hysteresisCorrect

fiducia.rawProcess.hysteresisCorrect(timesFrame, df, channels, order=5, prominence=0.2, width=10, avgMult=1)[source]

Corrects for hysteresis by detecting edges of signal containing region and fitting a polynomial background to regions that do not belong to signal. This background is then subtracted.

Parameters

  • timesFrame (pandas.core.frame.DataFrame) – Time corresponding to df

  • df (pandas.core.frame.DataFrame) – Dataframe of dante signals. See loadCorrected().

  • channels (list) – A list of channels for which to apply analyis.

  • order (int) – Polynomial order to be fitted to hysteresis/background.

  • prominence (float) – Prominence threshold for identifying peaks in scipy’s find_peaks().

  • width (int) – Width in index units for identifying peaks in scipy’s find_peaks().

  • avgMult (float) – Multiplicative factor for setting minimum intensity threshold for indentifying peaks in scipy’s find_peaks(). This is a multiple of the signal average.

Returns

dfPoly – Returns a dataframe of hysteresis corrected dante signals.

Return type

pandas.core.frame.DataFrame

Notes

Examples