nispace.io.load_img

nispace.io.load_img(img, override_file_format=False)[source]

Load one or more nifti/gifti images, passing through already-loaded objects.

Parameters:

img (str, os.PathLike, nib.Nifti1Image, nib.GiftiImage, list, or tuple) – A single image (path or loaded object), or a list/tuple of up to 2 such elements (e.g. left/right hemisphere gifti paths). Also accepts .curv FreeSurfer morphometry files, wrapped into a nib.GiftiImage.
override_file_format ({False, '.nii', '.nii.gz', '.gii', '.gii.gz'}, default False) – If given, rename+reinterpret path inputs with an unrecognized extension as this format before loading, instead of raising.

Returns:

A single loaded image, or a tuple of loaded images if img had 2 elements.

Return type:

nib.Nifti1Image, nib.GiftiImage, or tuple

Raises:

ValueError – If override_file_format is invalid, an element’s type/extension is unsupported, or img is not a path/list/tuple/image object.