neurocaps.typing.AALParcelApproach#

class AALParcelApproach[source]#

Bases: dict

Type Definition for the AAL Parcellation Approach.

A TypedDict representing the subkeys (second level keys for “AAL”) for the processed AAL parcellation produced by the TimeseriesExtractor or CAP classes. The structure is as follows:

{
    "maps": "path/to/parcellation.nii.gz",
    "nodes": ["Precentral_L", "Precentral_R", "Frontal_Sup", "Frontal_Sup_R"],
    "regions": ["Precentral", "Frontal"]
}

Added in version 0.23.6.

Parameters:

  • maps (str) – Path to the AAL parcellation.

  • nodes (list[str]) – List of nodes (ROIs) in the AAL parcellation. Ordered in ascending order of their label ID in the parcellation and must exclude “Background”.

  • regions (list[str]) – List of networks in the AAL parcellation. Important: For certain visualization methods, the in operator is used to determine which nodes belong to which network. Therefore, network names must be contained within the corresponding node names (e.g., ‘Frontal’ network should have nodes with ‘Frontal’ in their names).

See also

ParcelApproach

Type definition representing the structure of the Schaefer, AAL, and Custom parcellation approaches.

On this page