Skip to content

← nirs package

OptodeAttribution

Attribute channel measures to optodes.

This node accepts channel NIRS data, and factorizes it into per-optode measures. This can be used to work out overall light transmission through an optode, or optode contact fidelity, for instance. Version 0.1.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

combiner

Method for to combine multiple readings for an optode into a single value.

verbose name
Combiner
default value
mean
port type
EnumPort
value type
str (can be None)

transform

How to transform the data prior to factorization. These are mainly useful to attribute measures where there is no obviously right relationship between channels and optodes, such as different quality or noise scores.

verbose name
Transform
default value
None
port type
EnumPort
value type
str (can be None)

beta

Bias for very small signal values.

verbose name
Beta
default value
0.0
port type
FloatPort
value type
float (can be None)

length_falloff_exponent

Exponent for the falloff function. This is used to correct for differences in channel length.

verbose name
Length Falloff Exponent
default value
2
port type
FloatPort
value type
float (can be None)

factorization

Optional data factorization. None will simply consider all channels associated with an optode. The other two can be used in combination with num_components to keep only the dominant latent between-optode factors in the data, while cutting off noise on individual channels.

verbose name
Factorization
default value
None
port type
EnumPort
value type
str (can be None)

num_components

Number of components to consider, if factorization is used.

verbose name
Num Components
default value
1
port type
IntPort
value type
int (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)