zoom.data_loader.load_parc

zoom.data_loader.load_parc(parcellation: PathLike | tuple | nibabel.gifti.gifti.GiftiImage, atlas: str, density: str, hemi: str) → numpy.ndarray[source]

Load parcellation image.

Parameters:

  • parcellation (path_like str, tuple, nib.gifti.gifti.GiftiImage) –

    Recognized parcellation image - If hemi in [‘L’,’lh’,’left’]:

    • path_like str: Filepaths to .gii or .annot

    • nib.gifti.gifti.GiftiImage

    • Otherwise, use both hemisphere:
      • tuple: must be organized as L/R pair

        • (str, str): Filepaths to .gii or .annot

        • (nib.gifti.gifti.GiftiImage, nib.gifti.gifti.GiftiImage)

  • atlas ({'fsaverage', 'fSLR', 'civet'} optional,) – Name of surface atlas on which parcellation is defined.

  • density (str, optional) – Density of surface mesh on which parcellation is defined. Must becompatible with specified atlas.

  • hemi ({'L','lh','left','both'} optional,) – Hemisphere used to perform downstream analyses.

Returns:

gii_data – Data extracted from given GIFTI image.

Return type:

np.ndarray