vol_to_fsaverage: Project or map values from MNI volume to fsaverage surface.
In dfsp-spirit/regfusionr: Registration Fusion in R

vol_to_fsaverage

R Documentation

Project or map values from MNI volume to fsaverage surface.

Description

Applies the Wu et al. regfusion method to obtain surface coords, then interpolates values.

Usage

vol_to_fsaverage(
  input_img,
  template_type,
  rf_type = "RF_ANTs",
  interp = "linear",
  out_type = "curv",
  out_dir = "."
)

Arguments

`input_img`	3D or 4D NIFTI or MGZ image instance of type `fs.volume`, or a character string that will be interpreted as a file system path to such a volume that should be loaded with `freesurferformats::read.fs.volume`. If 4D, the 4th dimension is considered the time/subject dimension.
`template_type`	character string, the source template or the space that your input image is in. One of 'MNI152_orig', 'Colin27_orig', 'MNI152_norm', 'Colin27_norm'.
`rf_type`	the regfusion type to use, one of 'RF_ANTs' or 'RF_M3Z'.
`interp`	interpolation method, currently only 'linear' is supported.
`out_type`	character string, the format of the output files. One of the following: 'curv' for FreeSurfer curv format, 'mgz' for FreeSurfer MGZ format, 'gii' for GIFTI format.
`out_dir`	character string, the path to a writable output directory. If `NULL`, the returned named list contains the projected data (instead of the path of the file it was written to) at the keys 'lh' and 'rh', and the parameter 'out_type' is ignored.

Value

named list of 2 character strings, the output files (for the 2 hemispheres) at keys 'lh' and 'rh'. See the documentation for parameter 'out_dir' if you want the data in R instead.