cifti.parcel: Create a CIFTI-2 parcel.

View source: R/write_cifti_axes.R

cifti.parcelR Documentation

Create a CIFTI-2 parcel.

Description

Create one parcel, i.e. a named set of surface vertices (per structure) and volume voxels. The name is the only label a parcellated file has: the position in the list of parcels is the parcel index, and the reader returns the names.

Usage

cifti.parcel(name, vertices = NULL, voxel_indices_ijk = NULL)

Arguments

name

character string, the parcel name.

vertices

named list or NULL, the 0-based vertex indices per brain structure, e.g. list(CORTEX_LEFT = c(0, 1, 2), CORTEX_RIGHT = c(4, 5)). Structures without vertices are left out.

voxel_indices_ijk

n x 3 integer matrix or NULL, the 0-based voxel indices of the parcel, one voxel per row.

Value

a named list, one parcel, to be passed to cifti.axis.parcels.

See Also

Other cifti functions: cifti.axis.brain.models(), cifti.axis.from.template(), cifti.axis.labels(), cifti.axis.parcels(), cifti.axis.parcels.from.annot(), cifti.axis.scalars(), cifti.axis.series(), cifti.brain.model.surface(), cifti.brain.model.volume(), cifti.dim.labels(), cifti.file.type.for.axes(), cifti.grayordinates(), cifti.header.from.axes(), cifti.label.table(), cifti.parcels(), cifti.series.info(), cifti.structure.data(), cifti.structures(), cifti.volume(), print.fs.cifti(), print.fs.cifti.data(), print.fs.connectome(), read.cifti(), read.cifti.header(), read.cifti.rows(), read.fs.connectome.cifti(), write.cifti(), write.fs.connectome.cifti(), write.fs.morph.cifti(), write.fs.parcellated.cifti(), write.fs.parcellation.cifti(), write.fs.series.cifti()

Examples

parcel <- cifti.parcel("PARCEL_A", list(CORTEX_LEFT = 0:2, CORTEX_RIGHT = 4:5))
parcel$name


freesurferformats documentation built on Sept. 25, 2026, 1:07 a.m.