Skip to content

← source_localization package

ROIActivations

Compute the activations of regions of interest (ROIs) in the given atlas from current source density.

This node accepts as input a signal that has brain activity estimates (current source density) for each source location in the headmodel, which can be obtained by using one of the source estimation nodes (e.g., sLORETA). This node will then estimate average activity in selected (or all) ROIs that are defined in a brain atlas. The result is a time series with one channel for each region, and otherwise the same data format as the input. The atlas is essentially a parcellation of brain source locations (e.g., cells in a 3d grid or vertices in a triangle mesh of the brain surface) into regions, and is stored in the head model file. Some head models may have multiple atlases (although not the current default model), and the desired atlas can be selected using the atlas parameter. More Info... Version 1.2.1

Ports/Properties

data

Data to process.

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

headmodel

Override 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, (which is most likely the case for this node) and then uses that head model. If a relative path is given, the file is searched in the resources/headmodels folder of the cpe.

  • verbose name: Head Model File
  • default value: None
  • port type: StringPort
  • value type: str (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)

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. Supports filename matching syntax (see fnmatch).

  • verbose name: Restrict To Roi Subsets
  • default value: []
  • port type: ListPort
  • value type: list (can be None)

fill_with_nan

ROIs not in restricted subset will remain in data but their activations will be filled with nan.

  • verbose name: Set Non-Subset Rois To Nan
  • 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)