neurocaps.typing.CustomParcelApproach

class CustomParcelApproach

Bases: dict

Type Definition for the Custom Parcellation Approach.

A TypedDict representing the subkeys (second level keys for “Custom”) for the user-defined Custom parcellation approach. The structure is as follows:

{
    "maps": "path/to/parcellation.nii.gz",
    "nodes": ["LH_Vis1", "LH_Vis2", "LH_Hippocampus", "RH_Vis1", "RH_Vis2", "RH_Hippocampus"],
    "regions": {
        "Visual": CustomRegionHemispheres
        "Hippocampus": CustomRegionHemispheres
    }
}

Added in version 0.23.6.

Parameters:

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

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

• regions (dict[str, CustomRegionHemispheres]) – Dictionary mapping the regions to their left and right hemispheres.

See also

CustomRegionHemispheres

Type definition of the Custom hemisphere dictionary for the “regions” subkeys.

ParcelApproach

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