Skip to content

← cardiac package

HeartRate

Calculate the heart rate (BPM) from detected R peaks in QRS complexes.

The input to this node should be the output of the RDetection node, or a packet having a marker stream ending in -peaks with events corresponding to the R peaks and having an instance axis where the times array holds the timestamps of those peaks. The calculated BMP is based on the event markers contained within a sliding window of the defined length. The output of this node is a new stream with the same name as the input stream except peaks is replaced by hr (i.e., eeg-hr). This stream will contain a time axis with an irregular sampling rate, and a feature axis with a single element named HR. More Info... Version 1.0.1

Ports/Properties

data

Data to process.

verbose name
Data
default value
None
port type
DataPort
value type
Packet (can be None)
data direction
INOUT

window_length

Sliding window length (beats or seconds). If the length of data is more than this length, the data will be segmented into this processing window. If the length of data is less than this window, the data will be buffered to get more data.

verbose name
Processing Sliding Window Length
default value
10
port type
FloatPort
value type
float (can be None)

window_shift

Shift window length (beats or seconds). The processing window is shifted by this length. Therefore, it should be less than or equal to the processing window. If it is less than the processing window, there will be overlap between two consecutive processing windows. If shift window is the same as the processing window, then there will be no overlap between two consecutive processing windows.

verbose name
Shift Window Length
default value
3
port type
FloatPort
value type
float (can be None)

window_length_unit

Unit in which the window length is given.

verbose name
Window Length Unit
default value
seconds
port type
EnumPort
value type
str (can be None)

override_axes

Replace the incoming instance axis with a time axis, add a feature axis with a single element named HR. If False, a feature axis will not be added, and instead a field will be added to the incoming instance axis.

verbose name
Override Axes
default value
True
port type
BoolPort
value type
bool (can be None)

field_name

The name of the new instance axis field or FeatureAxis name if using override_axes.

verbose name
Field Name
default value
HR
port type
StringPort
value type
str (can be None)

set_breakpoint

Set a breakpoint on this node. If this is enabled, your debugger (if one is attached) will trigger a breakpoint.

verbose name
Set Breakpoint (Debug Only)
default value
False
port type
BoolPort
value type
bool (can be None)

metadata

User-definable meta-data associated with the node. Usually reserved for technical purposes.

verbose name
Metadata
default value
{}
port type
DictPort
value type
dict (can be None)