info_cifti: Get CIFTI metadata

In ciftiTools: Tools for Reading, Writing, Viewing and Manipulating CIFTI Files

Get CIFTI metadata

Description

Get CIFTI metadata from the NIFTI header and XML using the Connectome Workbench command -nifti-information. The information is formatted as the meta component in a "xifti" object (see template_xifti), and includes:

1. medial wall masks for the left and right cortex

2. the subcortical labels (ordered spatially)

3. the subcortical mask

4. other NIFTI intent-specific metadata

Usage

info_cifti(cifti_fname)

infoCIfTI(cifti_fname)

infocii(cifti_fname)

Arguments

cifti_fname

File path to a CIFTI file (ending in ".d*.nii").

Details

Additional metadata depends on the type of CIFTI file:

"dtseries"

time_start:

Start time

time_step:

The TR

time_unit:

Unit of time

"dscalar"

names:

Name of each data column

"dlabels"

names:

( Names of each data column.)

labels:

( List of L \times 5 data.frames. Row names are the label names. Column names are Key, Red, Green, Blue, and Alpha. List entry names are the names of each data column.)

Value

The metadata component of a "xifti" for the input CIFTI file

Connectome Workbench

This function interfaces with the "-nifti-information" Workbench command.

Label Levels

xifti$meta$subcort$labels is a factor with the following levels:

1. Cortex-L

2. Cortex-R

3. Accumbens-L

4. Accumbens-R

5. Amygdala-L

6. Amygdala-R

7. Brain Stem

8. Caudate-L

9. Caudate-R

10. Cerebellum-L

11. Cerebellum-R

12. Diencephalon-L

13. Diencephalon-R

14. Hippocampus-L

15. Hippocampus-R

16. Pallidum-L

17. Pallidum-R

18. Putamen-L

19. Putamen-R

20. Thalamus-L

21. Thalamus-R

These correspond to the same structures as given by ft_read_cifti in the cifti-matlab MATLAB toolbox. Note that the first two levels (left and right cortex) are not used.

See Also

Other reading: as.xifti(), load_parc(), load_surf(), read_cifti(), read_surf(), read_xifti2()

ciftiTools documentation built on Oct. 4, 2024, 1:12 a.m.