`ComputeRegions`¶

A meta-node that performs source localization for given regions of interest using sLoreta, and optionally groups them based on a given mapping.

Uses the following nodes: SLORETA, Magnitude, ROIActivations, CombineChannels. Version 1.0.0

Ports/Properties¶

`data`¶

Data to process. Outputs source localised data per ROI without magnitude.

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

`data_magnitude`¶

Output only. Data per ROI with magnitude performed.

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

`data_vertex`¶

Output only. Source localisation per vertex, without ROI averaging.

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

`headmodel`¶

Head model file to use (*.h m). If omitted, the node checks if the data has a current head model associated with it, e.g., because a previous node has annotated it, and then uses that head model. If a relative path is given, the file is searched in the resources/headmodels folder.

verbose name: Headmodel
default value: Colin-339ch-4495v-scalar-4shell-1.1.hm
port type: StringPort
value type: str (can be None)

`regularization_strength`¶

Regularization strength. Larger values yield smoother solutions. In theory this is proportional to the sensor noise level. Ad-hoc choices work fairly well for visualization and basic source localization.

verbose name: Regularization Strength
default value: 0.05
port type: FloatPort
value type: float (can be None)

`interpolate`¶

Rely on channel locations rather than labels. If this is enabled, the head model will be matched to the data using the channel locations rather than channel labels. This is only useful if the labels are unrecognized (e.g., non-standard labels), and if there are high-quality measured channel locations available. These locations must be in the same coordinate system as NeuroPype's default 10-5 locations (see node documentation for more details).

verbose name: Interpolate
default value: False
port type: BoolPort
value type: bool (can be None)

`atlas`¶

Optionally the name of the atlas to use. If the head model file contains multiple atlases in it, this allows to select the one to use.

verbose name: Atlas
default value: None
port type: StringPort
value type: str (can be None)

`roi_subset`¶

Subset of ROIs for which to calculate activations, optional. Setting this to non-empty will restrict the set of regions for which activations are calculated, for a modest performance gain.

verbose name: Roi Subset
default value: ['rostralanteriorcingulate L.1', 'rostralanteriorcingulate L.2', 'rostralanteriorcingulate R.1', 'rostralanteriorcingulate R.2', 'rostralanteriorcingulate R.3', 'caudalanteriorcingulate L.1', 'caudalanteriorcingulate L.2', 'caudalanteriorcingulate R.1', 'caudalanteriorcingulate R.2', 'rostralmiddlefrontal L.1', 'rostralmiddlefrontal L.2', 'rostralmiddlefrontal L.3', 'rostralmiddlefrontal L.4', 'rostralmiddlefrontal L.5', 'rostralmiddlefrontal L.6', 'rostralmiddlefrontal L.7', 'rostralmiddlefrontal L.8', 'rostralmiddlefrontal L.9', 'rostralmiddlefrontal L.10', 'rostralmiddlefrontal L.11', 'rostralmiddlefrontal L.12', 'rostralmiddlefrontal L.13', 'rostralmiddlefrontal L.14', 'rostralmiddlefrontal L.15', 'rostralmiddlefrontal L.16', 'rostralmiddlefrontal R.1', 'rostralmiddlefrontal R.2', 'rostralmiddlefrontal R.3', 'rostralmiddlefrontal R.4', 'rostralmiddlefrontal R.5', 'rostralmiddlefrontal R.6', 'rostralmiddlefrontal R.7', 'rostralmiddlefrontal R.8', 'rostralmiddlefrontal R.9', 'rostralmiddlefrontal R.10', 'rostralmiddlefrontal R.11', 'rostralmiddlefrontal R.12', 'rostralmiddlefrontal R.13', 'rostralmiddlefrontal R.14', 'rostralmiddlefrontal R.15', 'lateralorbitofrontal L.1', 'lateralorbitofrontal L.2', 'lateralorbitofrontal L.3', 'lateralorbitofrontal L.4', 'lateralorbitofrontal L.5', 'lateralorbitofrontal L.6', 'lateralorbitofrontal L.7', 'lateralorbitofrontal R.1', 'lateralorbitofrontal R.2', 'lateralorbitofrontal R.3', 'lateralorbitofrontal R.4', 'lateralorbitofrontal R.5', 'lateralorbitofrontal R.6', 'lateralorbitofrontal R.7', 'medialorbitofrontal L.1', 'medialorbitofrontal L.2', 'medialorbitofrontal L.3', 'medialorbitofrontal L.4', 'medialorbitofrontal L.5', 'medialorbitofrontal R.1', 'medialorbitofrontal R.2', 'medialorbitofrontal R.3', 'medialorbitofrontal R.4', 'medialorbitofrontal R.5', 'lateraloccipital L.1', 'lateraloccipital L.2', 'lateraloccipital L.3', 'lateraloccipital L.4', 'lateraloccipital L.5', 'lateraloccipital L.6', 'lateraloccipital L.7', 'lateraloccipital L.8', 'lateraloccipital L.9', 'lateraloccipital L.10', 'lateraloccipital L.11', 'lateraloccipital L.12', 'lateraloccipital L.13', 'lateraloccipital R.1', 'lateraloccipital R.2', 'lateraloccipital R.3', 'lateraloccipital R.4', 'lateraloccipital R.5', 'lateraloccipital R.6', 'lateraloccipital R.7', 'lateraloccipital R.8', 'lateraloccipital R.9', 'lateraloccipital R.10', 'precentral L.1', 'precentral L.2', 'precentral L.3', 'precentral L.4', 'precentral L.5', 'precentral L.6', 'precentral L.7', 'precentral L.8', 'precentral L.9', 'precentral L.10', 'precentral L.11', 'precentral L.12', 'precentral R.1', 'precentral R.2', 'precentral R.3', 'precentral R.4', 'precentral R.5', 'precentral R.6', 'precentral R.7', 'precentral R.8', 'precentral R.9', 'precentral R.10', 'precentral R.11', 'precentral R.12', 'inferiorparietal L.1', 'inferiorparietal L.2', 'inferiorparietal L.3', 'inferiorparietal L.4', 'inferiorparietal L.5', 'inferiorparietal L.6', 'inferiorparietal L.7', 'inferiorparietal L.9', 'inferiorparietal L.10', 'inferiorparietal L.11', 'inferiorparietal L.12', 'inferiorparietal L.13', 'inferiorparietal L.14', 'inferiorparietal R.1', 'inferiorparietal R.2', 'inferiorparietal R.3', 'inferiorparietal R.4', 'inferiorparietal R.5', 'inferiorparietal R.6', 'inferiorparietal R.7', 'inferiorparietal R.8', 'inferiorparietal R.9', 'inferiorparietal R.10', 'inferiorparietal R.11', 'inferiorparietal R.12', 'inferiorparietal R.13', 'inferiorparietal R.14', 'inferiorparietal R.15']
port type: ListPort
value type: list (can be None)

`roi_mapping`¶

Grouping of old channels into new channels. The syntax is {'new_channel1': [index0, index1, ...], 'new_channel2': [index3, index4, index5, ...], ...} where 'new_channelX' are examples of two new channel names being defined, and the indexX terms stand for where you list the old channels from which each new channel would be formed, given as numeric indices (counting from 0). Example: {'mychan': [0,1,2], 'myotherchan': [3,4,5,10]}.

verbose name: Channel Grouping
default value: {'ORB_PF_L': ['lateralorbitofrontal L.1', 'lateralorbitofrontal L.2', 'lateralorbitofrontal L.3', 'lateralorbitofrontal L.4', 'lateralorbitofrontal L.5', 'lateralorbitofrontal L.6', 'lateralorbitofrontal L.7', 'medialorbitofrontal L.1', 'medialorbitofrontal L.2', 'medialorbitofrontal L.3', 'medialorbitofrontal L.4', 'medialorbitofrontal L.5'], 'PRE_CENT_L': ['precentral L.1', 'precentral L.2', 'precentral L.3', 'precentral L.4', 'precentral L.5', 'precentral L.6', 'precentral L.7', 'precentral L.8', 'precentral L.9', 'precentral L.10', 'precentral L.11', 'precentral L.12'], 'ANT_CIN_R': ['rostralanteriorcingulate R.1', 'rostralanteriorcingulate R.2', 'rostralanteriorcingulate R.3', 'caudalanteriorcingulate R.1', 'caudalanteriorcingulate R.2'], 'DORLAT_PF_L': ['rostralmiddlefrontal L.1', 'rostralmiddlefrontal L.2', 'rostralmiddlefrontal L.3', 'rostralmiddlefrontal L.4', 'rostralmiddlefrontal L.5', 'rostralmiddlefrontal L.6', 'rostralmiddlefrontal L.7', 'rostralmiddlefrontal L.8', 'rostralmiddlefrontal L.9', 'rostralmiddlefrontal L.10', 'rostralmiddlefrontal L.11', 'rostralmiddlefrontal L.12', 'rostralmiddlefrontal L.13', 'rostralmiddlefrontal L.14', 'rostralmiddlefrontal L.15', 'rostralmiddlefrontal L.16'], 'INF_PAR_R': ['inferiorparietal R.1', 'inferiorparietal R.2', 'inferiorparietal R.3', 'inferiorparietal R.4', 'inferiorparietal R.5', 'inferiorparietal R.6', 'inferiorparietal R.7', 'inferiorparietal R.8', 'inferiorparietal R.9', 'inferiorparietal R.10', 'inferiorparietal R.11', 'inferiorparietal R.12', 'inferiorparietal R.13', 'inferiorparietal R.14', 'inferiorparietal R.15'], 'DORLAT_PF_R': ['rostralmiddlefrontal R.1', 'rostralmiddlefrontal R.2', 'rostralmiddlefrontal R.3', 'rostralmiddlefrontal R.4', 'rostralmiddlefrontal R.5', 'rostralmiddlefrontal R.6', 'rostralmiddlefrontal R.7', 'rostralmiddlefrontal R.8', 'rostralmiddlefrontal R.9', 'rostralmiddlefrontal R.10', 'rostralmiddlefrontal R.11', 'rostralmiddlefrontal R.12', 'rostralmiddlefrontal R.13', 'rostralmiddlefrontal R.14', 'rostralmiddlefrontal R.15'], 'ORB_PF_R': ['lateralorbitofrontal R.1', 'lateralorbitofrontal R.2', 'lateralorbitofrontal R.3', 'lateralorbitofrontal R.4', 'lateralorbitofrontal R.5', 'lateralorbitofrontal R.6', 'lateralorbitofrontal R.7', 'medialorbitofrontal R.1', 'medialorbitofrontal R.2', 'medialorbitofrontal R.3', 'medialorbitofrontal R.4', 'medialorbitofrontal R.5'], 'LAT_OCP_R': ['lateraloccipital R.1', 'lateraloccipital R.2', 'lateraloccipital R.3', 'lateraloccipital R.4', 'lateraloccipital R.5', 'lateraloccipital R.6', 'lateraloccipital R.7', 'lateraloccipital R.8', 'lateraloccipital R.9', 'lateraloccipital R.10'], 'ANT_CIN_L': ['rostralanteriorcingulate L.1', 'rostralanteriorcingulate L.2', 'caudalanteriorcingulate L.1', 'caudalanteriorcingulate L.2'], 'INF_PAR_L': ['inferiorparietal L.1', 'inferiorparietal L.2', 'inferiorparietal L.3', 'inferiorparietal L.4', 'inferiorparietal L.5', 'inferiorparietal L.6', 'inferiorparietal L.7', 'inferiorparietal L.9', 'inferiorparietal L.10', 'inferiorparietal L.11', 'inferiorparietal L.12', 'inferiorparietal L.13', 'inferiorparietal L.14'], 'PRE_CENT_R': ['precentral R.1', 'precentral R.2', 'precentral R.3', 'precentral R.4', 'precentral R.5', 'precentral R.6', 'precentral R.7', 'precentral R.8', 'precentral R.9', 'precentral R.10', 'precentral R.11', 'precentral R.12'], 'LAT_OCP_L': ['lateraloccipital L.1', 'lateraloccipital L.2', 'lateraloccipital L.3', 'lateraloccipital L.4', 'lateraloccipital L.5', 'lateraloccipital L.6', 'lateraloccipital L.7', 'lateraloccipital L.8', 'lateraloccipital L.9', 'lateraloccipital L.10', 'lateraloccipital L.11', 'lateraloccipital L.12', 'lateraloccipital L.13']}
port type: Port
value type: object (can be None)

`write_back_mode`¶

Define how new channels get written back into the list of channels. Replace-selected means that the selected old channels will be replaced by the new channels, replace-all means that only the new channels will be in the output, and append means that the new channels will be appended at the end.

verbose name: Write Back Mode
default value: replace-selected
port type: EnumPort
value type: str (can be None)

`ignore_nans`¶

If activated the channels containing nan values are ignored.

verbose name: Ignore Nans
default value: False
port type: BoolPort
value type: bool (can be None)

`magnitude`¶

Perform a Magnitude operation (abs value) after sLoreta.

verbose name: Magnitude
default value: False
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)

ComputeRegions¶

Ports/Properties¶

data¶

data_magnitude¶

data_vertex¶

headmodel¶

regularization_strength¶

interpolate¶

atlas¶

roi_subset¶

roi_mapping¶

write_back_mode¶

ignore_nans¶

magnitude¶

set_breakpoint¶

metadata¶