pyPPG.ppg_bm package

pyPPG.ppg_bm.bm_extraction

class pyPPG.ppg_bm.bm_extraction.BmExctator(data: DotMap, peak_value: float, peak_time: float, next_peak_value: float, next_peak_time: float, onsets_values: array, onsets_times: array, sample_rate: int, list_biomarkers: list, fiducials: DataFrame)

Class that extracts the PPG biomarkers.

Parameters:

• data (DotMap) –

  struct of PPG,PPG’, PPG”, PPG’”:

  • data.ppg: segment of PPG timeseries to analyse and extract biomarkers as a np array

  • data.vpg: segment of PPG’

  • data.apg: segment of PPG”

  • data.jpg: segment of PPG’”

• peak_value (float) – PPG peak value

• peak_time (float) – the time corresponding to the peak detected

• next_peak_value (float) – PPG next peak value

• next_peak_time (float) – the time corresponding to the peak detected

• onsets_values (Numpy array) – array of PPG two onsets values surrounding the peak

• onsets_times (Numpy array) – array of the two times corresponding to each onset detected

• sample_rate (int) – segment data sample rate

• list_biomarkers (list) – list of biomarkers

• fiducials (DataFrame) – location of fiducial points of the given pulse wave

pyPPG.ppg_bm.bm_extraction.get_biomarkers(s: PPG, fp: Fiducials, biomarkers_lst)

The function calculates the biomedical biomarkers of PPG signal.

Parameters:

• s (pyPPG.PPG object) – object of PPG signal

• fp (pyPPG.Fiducials object) – object of fiducial points

Returns:

• df: data frame with onsets, offsets and peaks

• df_biomarkers: data frame with PPG signal biomarkers

pyPPG.ppg_bm.ppg_sig

pyPPG.ppg_bm.ppg_sig.get_ppg_sig(s: PPG, fp: Fiducials)

This function returns the biomarkers of PPG signal.

Parameters:

• s (pyPPG.PPG object) – object of PPG signal

• fp (pyPPG.Fiducials object) – object of fiducial points

Returns:

• df_pw: data frame with onsets, offsets and peaks

• df_biomarkers: dictionary of biomarkers of PPG signal

• biomarkers_lst: list a biomarkers with name, definition and unit

pyPPG.ppg_bm.sig_ratios

pyPPG.ppg_bm.sig_ratios.get_sig_ratios(s: PPG, fp: Fiducials)

This function returns the biomarkers of Signal ratios.

Parameters:

• s (pyPPG.PPG object) – object of PPG signal

• fp (pyPPG.Fiducials object) – object of fiducial points

Returns:

• df_pw: data frame with onsets, offsets and peaks

• df_biomarkers: dictionary of biomarkers of Signal ratios

• biomarkers_lst: list a biomarkers with name, definition and unit

pyPPG.ppg_bm.ppg_derivs

pyPPG.ppg_bm.ppg_derivs.get_ppg_derivs(s: PPG, fp: Fiducials)

This function returns the biomarkers of PPG derivatives.

Parameters:

• s (pyPPG.PPG object) – object of PPG signal

• fp (pyPPG.Fiducials object) – object of fiducial points

Returns:

• df_pw: data frame with onsets, offsets and peaks

• df_biomarkers: dictionary of biomarkers of PPG derivatives

• biomarkers_lst: list a biomarkers with name, definition and unit

pyPPG.ppg_bm.derivs_ratios

pyPPG.ppg_bm.derivs_ratios.get_derivs_ratios(s: PPG, fp: Fiducials)

This function returns the biomarkers of Derivatives ratios.

Parameters:

• s (pyPPG.PPG object) – object of PPG signal

• fp (pyPPG.Fiducials object) – object of fiducial points

Returns:

• df_pw: data frame with onsets, offsets and peaks

• df_biomarkers: dictionary of biomarkers of Derivatives ratios

• biomarkers_lst: list a biomarkers with name, definition and unit

pyPPG.ppg_bm.statistics

pyPPG.ppg_bm.statistics.get_statistics(peaks: Series, onsets: Series, ppg_biomarkers: dict)

The function compares the different biomedical features of PPG signal.

Parameters:

• peaks (Series) – 1-d array, peaks of the signal

• onsets (Series) – 1-d array, onsets of the signal

• ppg_biomarkers (dict) – dictionary of the PPG biomarkers

Returns:

df_windows: data frame with summary of PPG features