alignPeaks

fiducia.rawProcess.alignPeaks(timesFrame, df, peaksFrame, channels, peakAlignIdx=0, referenceTime=1e-09, plot=False)[source]
Parameters

  • timesFrame (pandas.core.frame.DataFrame) – A dataframe containing time axis values corresponding to signals in df.

  • df (pandas.core.frame.DataFrame) – A dataframe of corrected/calibrated dante signal measurements.

  • peaksFrame (pandas.core.frame.DataFrame) – Dataframe containing positions of N highest peaks and sorted from earliest in time to latest in time. See getPeaks().

  • peakAlignIdx (int) – Picks which peak to align to. 0 is first peak, 1 is second peak in peaksFrame, etc.

  • referenceTime (float) – Time in s to which align peaks. Default is 1e-9 s or 1 ns.

  • plot (bool) – Flag for plotting aligned dante signals. Default is False.

Returns

timesAligned – Returns a dataframe identical in shape to timesFrame, but with the times for each dante channel offset such that the selected peaks are temporally aligned.

Return type

pandas.core.frame.DataFrame

Notes

Examples