ciftiTools (version 0.9.0)

write_surf_gifti: Write a "surf" to a GIFTI surface file

Description

Write the data for the left or right surface to a surface GIFTI file.

Usage

write_surf_gifti(
  x,
  gifti_fname,
  hemisphere = c("left", "right"),
  encoding = NULL,
  endian = c("LittleEndian", "BigEndian")
)
write_surf(
  x,
  gifti_fname,
  hemisphere = c("left", "right"),
  encoding = NULL,
  endian = c("LittleEndian", "BigEndian")
)

Arguments

x

A "surf" object, an object from gifti::readgii, or a list with elements "pointset" and "triangle".

gifti_fname

Where to write the GIFTI file.

hemisphere

"left" (default) or "right". Ignored if data is already a "gifti" object, or if it is a "surf" object with the hemisphere metadata already specified.

encoding

A length-2 vector with elements chosen among "ASCII", "Base64Binary", and "GZipBase64Binary". If NULL (default), will use the metadata if data is a "gifti" object, or "GZipBase64Binary" for the "pointset" and "ASCII" for the "triangles" if data is not already a GIFTI.

endian

"LittleEndian" (default) or "BigEndian".

Value

Whether the GIFTI was successfully written

See Also

Other functions for writing CIFTI or GIFTI data: separate_cifti(), write_cifti(), write_metric_gifti(), write_subcort_nifti()

Other functions for working with GIFTI surface geometry data: is.surf(), read_surf(), resample_surf(), rotate_surf(), view_surf()