Skip to content

← cardiac package

RespRate

Calculate the respiratory rate from R peaks detected from ECG or PPG data.

This node should usually be preceded by the RDetection node (or another node that outputs data in the same format, that is: the incoming packet must have a stream with the ECG or PPG time series, and a marker stream with a name ending in '-peaks' and having the detected R peaks as events). This node calculates the respiration rate (breaths per minute) over a sliding window of the defined length. The output of this node is a stream with a feature axis having a single element named RR and a time axis with the heart beat timestamps (irregular rate). The output stream name will be the same as the input stream, replacing -peaks with -resp-rate. More Info... Version 1.0.0

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
60
port type
FloatPort
value type
float (can be None)

wait_full_buffer

Wait for the full window buffer as specified above before outputting Respiration Rate values

verbose name
Wait For Full Buffer
default value
False
port type
BoolPort
value type
bool (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 an overlap between two consecutive processing windows. If the 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
1
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)

minimum_respiration_rate

The assumed minimum respiration rate (breaths per minute).

verbose name
Minimum Respiration Rate
default value
10
port type
FloatPort
value type
float (can be None)

maximum_respiration_rate

The assumed maximum respiration rate (breaths per minute).

verbose name
Maximum Respiration Rate (Respiration Per Minute)
default value
28
port type
FloatPort
value type
float (can be None)

smooth_it

Smooth the calculated respiration rate output with an exponential decay. If False, the output will may have significant variability and is best followed by a MovingAverage node.

verbose name
Smooth Rate
default value
True
port type
BoolPort
value type
bool (can be None)

override_axes

Replace the incoming instance axis with a time axis, add a feature axis with a single element named RR. 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 element in the feature axis.

verbose name
Field Name
default value
RR
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)