nireports.tools.timeseries module

Extracting signals from NIfTI and CIFTI2 files.

nireports.tools.timeseries.cifti_timeseries(dataset: str | Cifti2Image) → tuple[ndarray[tuple[Any, ...], dtype[float32]], dict[str, list[int]]]

Extract timeseries from CIFTI2 dataset.

nireports.tools.timeseries.get_tr(img: Nifti1Image | Cifti2Image) → float

Attempt to extract repetition time from NIfTI/CIFTI header.

Examples

>>> get_tr(nb.load(
...     test_data_package
...     / 'sub-ds205s03_task-functionallocalizer_run-01_bold_volreg.nii.gz'
... ))
2.2
>>> get_tr(nb.load(
...     test_data_package
...     / 'sub-01_task-mixedgamblestask_run-02_space-fsLR_den-91k_bold.dtseries.nii'
... ))
2.0

nireports.tools.timeseries.nifti_timeseries(dataset: str | Nifti1Image, segmentation: str | Nifti1Image | None = None, labels: Sequence[str] = ('Ctx GM', 'dGM', 'WM+CSF', 'Cb', 'Crown'), remap_rois: bool = False, lut: ndarray[tuple[Any, ...], dtype[uint8]] | None = None) → tuple[ndarray[tuple[Any, ...], dtype[float32]], dict[str, list[int]] | None]

Extract timeseries from NIfTI1/2 datasets.