Skip to content

← diagnostics package

NirsIntensityQualityMetrics

Compute various quality metrics from NIRS "raw" Intensity signal data.

The quality metric values themselves are stored in a Feature axis along with a corresponding _mask feature that contains a 1 or a 0 depnding on where the channel passed that criteria (is "good") or not. For example, a Feature axis might contain 'snr', 'snr_mask' where the former has the snr values for each channel, and the latter a 1 or 0 for each channel depending on whether it was below the threshold. The time axis is dropped on the output. This node expects a chunk with space and time axes, the Metadata.quantity property set to 'intensity' and the Origin.modality set to 'NIRS'. Version 0.6.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

zscore_threshold

Max acceptable z-score of the raw intensity. Channels having an absolute z-score below this are marked "good".

verbose name
Zscore Threshold
default value
4
port type
FloatPort
value type
float (can be None)

snr_threshold

The robust intensity raw signal-to-noise (SNR) threshold, calculated in dB, above which a channel is marked "good".

verbose name
Snr Threshold
default value
30
port type
FloatPort
value type
float (can be None)

cv_threshold

The coefficient of variation (CV) threshold, expressed as a percentage, below which a channel is marked as "good".

verbose name
Cv Threshold
default value
7.5
port type
FloatPort
value type
float (can be None)

abs_threshold

Max acceptable range for the raw intensity, specified as a 2-value list of the lower and upper bounds. Channels having a trimmed mean intensity (0.1) outside of this range are marked as bad.

verbose name
Abs Threshold
default value
[]
port type
ListPort
value type
list (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)