Skip to content

← nirs package

BaselinePCA

Perform Baseline PCA artifact removal.

This node calculates a PCA decomposition on some given baseline data (e.g., resting state, or any data not affected by evoked responses and/or task-related activity). Using this decomposition, the task data (data input) are then broken down into components, and the top num_components components are removed from the data. In effect, this will find components with large- amplitude (likely artifactual) activity on the baseline periods, thus resulting in components that are unlikely to include any task-related activity, and these components are then removed from the on-task data. 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

baseline

Baseline data.

verbose name
Baseline
default value
None
port type
DataPort
value type
Packet (can be None)
data direction
IN

num_components

Number of principal components to remove.

verbose name
Num Components
default value
1
port type
IntPort
value type
int (can be None)

demean

Whether to zero-mean the data and baseline beforehand. The mean will be re-added to the data afterwards.

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

detrend

Whether to detrend the data and baseline beforehand.

verbose name
Detrend
default value
True
port type
BoolPort
value type
bool (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)