BPointExtractionDrost2022

class pepbench.algorithms.icg.BPointExtractionDrost2022(handle_missing_events: Literal['raise', 'warn', 'ignore'] = 'warn')

B-point extraction algorithm by Drost et al. (2022).

This algorithm extracts B-points based on the maximum distance of the dZ/dt curve and a straight line fitted between the C-Point and the Point on the dZ/dt curve 150 ms before the C-Point.

For more information, see [Dro22].

References

[Dro22]

Drost, L., Finke, J. B., Port, J., & Schächinger, H. (2022). Comparison of TWA and PEP as indices of a2- and ß-adrenergic activation. Psychopharmacology. https://doi.org/10.1007/s00213-022-06114-8

Methods

clone()	Create a new instance of the class with all parameters copied over.
extract(*, icg, heartbeats, c_points, ...)	Extract B-points from given ICG derivative signal.
get_params([deep])	Get parameters for this algorithm.
set_params(**params)	Set the parameters of this Algorithm.

__init__(handle_missing_events: Literal['raise', 'warn', 'ignore'] = 'warn')

Initialize new BPointExtractionDrost2022 instance.

Parameters:

handle_missing_eventsone of {“warn”, “raise”, “ignore”}, optional

How to handle failing event extraction. Can be one of:

• “warn”: issue a warning and set the event to NaN

• “raise”: raise an EventExtractionError

• “ignore”: ignore the error and continue with the next event

Default: “warn”

extract(*, icg: _IcgRawDataFrame | DataFrame, heartbeats: _HeartbeatSegmentationDataFrame | DataFrame, c_points: _CPointDataFrame | DataFrame, sampling_rate_hz: float)

Extract B-points from given ICG derivative signal.

This algorithm extracts B-points based on the maximum distance of the dZ/dt curve and a straight line fitted between the C-Point and the Point on the dZ/dt curve 150 ms before the C-Point.

The results are saved in the points_ attribute of the super class.

Parameters:

icgDataFrame

ICG derivative signal

heartbeatsDataFrame

Segmented heartbeats. Each row contains start, end, and R-peak location (in samples from beginning of signal) of that heartbeat, index functions as id of heartbeat

c_pointsDataFrame

Extracted C-points. Each row contains the C-point location (in samples from beginning of signal) for each heartbeat, index functions as id of heartbeat. C-point locations can be NaN if no C-points were detected for certain heartbeats

sampling_rate_hzint

sampling rate of ICG derivative signal in hz

Returns:

self

Raises:

EventExtractionError

If the event extraction fails and handle_missing is set to “raise”

clone() → Self

Create a new instance of the class with all parameters copied over.

This will create a new instance of the class itself and all nested objects

get_params(deep: bool = True) → dict[str, Any]

Get parameters for this algorithm.

Parameters:

deep

Only relevant if object contains nested algorithm objects. If this is the case and deep is True, the params of these nested objects are included in the output using a prefix like nested_object_name__ (Note the two “_” at the end)

Returns:

params

Parameter names mapped to their values.

set_params(**params: Any) → Self

Set the parameters of this Algorithm.

To set parameters of nested objects use nested_object_name__para_name=.