Create a CIFTI-2 brain model entry for a surface.

A surface brain model entry describes a set of surface vertices that one matrix dimension of a CIFTI-2 file contains, e.g. one hemisphere. The vertex indices are 0-based and refer to the vertices of the surface mesh that the file is defined on. If they are NULL, the model covers all vertices of the surface, which is only allowed if their number matches the size of the index range (the reader validates this, and the writer computes the range from the index list).

Usage

cifti.brain.model.surface(
  structure,
  surface_number_of_vertices,
  vertices = NULL
)

Arguments

structure

character string, the brain structure, see cifti.structure.canonical for the accepted spellings.

surface_number_of_vertices

integer, the number of vertices of the complete surface (not the number of vertices in this model: a grayordinates file of the HCP leaves out the medial wall, so its models usually cover fewer vertices than the surface has).

vertices

integer vector or NULL, the 0-based vertex indices in this model.

Value

a named list, one brain model entry, to be passed to cifti.axis.brain.models.

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.volume(), cifti.dim.labels(), cifti.file.type.for.axes(), cifti.grayordinates(), cifti.header.from.axes(), cifti.label.table(), cifti.parcel(), 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

model <- cifti.brain.model.surface("lh", 10L, vertices = 0:4)
model$index_count
#> NULL