SchaeferParcelApproach#

class neurocaps.typing.SchaeferParcelApproach[source]#

Bases: ParcelApproachBase

Type Definition for the Schaefer Parcellation Approach.

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

{
    "maps": "path/to/parcellation.nii.gz",
    "nodes": ["LH_Vis1", "LH_SomSot1", "RH_Vis1", "RH_Somsot1"],
    "regions": ["Vis", "SomSot"]
}

Parameters:

maps (str) – Path to the Schaefer parcellation.
nodes (list[str]) – List of nodes (ROIs) in the Schaefer parcellation. Ordered in ascending order of their label ID in the parcellation and must exclude “Background”.
regions (list[str]) – List of networks in the Schaefer 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., “Vis” network should have nodes with “Vis” in their names).
metadata (dict[str, Any]) – Dictionary containing metadata information about the parcellation. This key is purely informational and can be removed, modified, or extended.