resample_gifti: Resample a GIFTI file (with its ROI)

Description

Performs spatial resampling of GIFTI data on the cortical surface.

Usage

resample_gifti(
  original_fname,
  target_fname,
  hemisphere = c("left", "right"),
  file_type = NULL,
  original_res = NULL,
  resamp_res,
  ROIcortex_original_fname = NULL,
  ROIcortex_target_fname = NULL,
  read_dir = NULL,
  write_dir = NULL,
  wb_path = NULL
)
resampleGIfTI(
  original_fname,
  target_fname,
  hemisphere,
  file_type = NULL,
  original_res = NULL,
  resamp_res,
  ROIcortex_original_fname = NULL,
  ROIcortex_target_fname = NULL,
  read_dir = NULL,
  write_dir = NULL,
  wb_path = NULL
)
resamplegii(
  original_fname,
  target_fname,
  hemisphere,
  file_type = NULL,
  original_res = NULL,
  resamp_res,
  ROIcortex_original_fname = NULL,
  ROIcortex_target_fname = NULL,
  read_dir = NULL,
  write_dir = NULL,
  wb_path = NULL
)

Arguments

original_fname

The GIFTI file to resample.

target_fname

Where to save the resampled file.

hemisphere

"left" (default) or "right". An error will occur if the hemisphere indicated in the GIFTI metadata does not match.

file_type

"metric", "label", "surf", or NULL (default) to infer from original_fname.

original_res

The resolution of the original file. If NULL (default), infer from the file.

resamp_res

Target resolution for resampling (number of cortical surface vertices per hemisphere).

ROIcortex_original_fname

The name of the ROI file corresponding to original_fname. Leave as NULL (default) if this doesn't exist or shouldn't be resampled.

ROIcortex_target_fname

The name of the resampled ROI file. Only applicable if ROIcortex_original_fname is provided.

read_dir

Directory to append to the path of every file name in original_fname and ROIcortex_original_fname. If NULL (default), do not append any directory to the path.

write_dir

Directory to append to the path of every file name in target_fname and ROIcortex_target_fname. If NULL (default), do not append any directory to the path.

wb_path

(Optional) Path to Connectome Workbench folder or executable. If not provided, should be set with ciftiTools.setOption("wb_path", "path/to/workbench").

Value

The resampled GIFTI file name, invisibly