resample_cifti_components: Resample a series of GIFTIs related to a CIFTI file

Description

Performs spatial resampling of various CIFTI file components on the cortical surface. (The subcortical data is not resampled here.) GIFTI surface geometry files can additionally be included: see surfL_original_fname and surfR_original_fname.

Usage

resample_cifti_components(
  original_res,
  resamp_res,
  cortexL_original_fname = NULL,
  cortexR_original_fname = NULL,
  cortexL_target_fname = NULL,
  cortexR_target_fname = NULL,
  ROIcortexL_original_fname = NULL,
  ROIcortexR_original_fname = NULL,
  ROIcortexL_target_fname = NULL,
  ROIcortexR_target_fname = NULL,
  surfL_original_fname = NULL,
  surfR_original_fname = NULL,
  surfL_target_fname = NULL,
  surfR_target_fname = NULL,
  read_dir = NULL,
  write_dir = NULL,
  wb_path = NULL
)

Arguments

original_res

The original resolution of the CIFTI cortical surface(s).

resamp_res

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

cortexL_original_fname, cortexR_original_fname

(Optional) File path of GIFTI data for [left/right] cortex to resample.

cortexL_target_fname, cortexR_target_fname

(Optional) File path to save the resampled GIFTI data for [left/right] cortex as. If NULL (default) and cortex[L/R]_original_fname was provided, it will be named by cifti_component_suffix.

ROIcortexL_original_fname, ROIcortexR_original_fname

(Optional) File path of GIFTI ROI corresponding to cortex[L/R]_original_fname to resample.

ROIcortexL_target_fname, ROIcortexR_target_fname

(Optional) File path of to save the resampled GIFTI ROI corresponding to cortex[L/R]_target_fname as. If NULL (default) and cortex[L/R]_original_fname was provided, it will be named by cifti_component_suffix.

surfL_original_fname

(Optional) File path of GIFTI surface geometry file representing the left cortex.

surfR_original_fname

(Optional) File path of GIFTI surface geometry file representing the right cortex.

surfL_target_fname

(Optional) File path to save the resampled GIFTI surface geometry file representing the left cortex at.

surfR_target_fname

(Optional) File path to save the resampled GIFTI surface geometry file representing the right cortex at.

read_dir

Directory to append to the path of every file being read, e.g. cortexL_original_fname. If NULL (default), do not append any directory to the path.

read_dir must already exist, or an error will be raised.

write_dir

Where should the separated files be placed? NULL (default) will write them to the current working directory.

write_dir must already exist, or an error will occur.

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

A named character vector of file paths to each resampled file

Details

Step 1: Generate spheres in the original and target resolutions Step 2: Use -metric-resample to resample surface/cortex files Step 3: Use -surface-resample to resample gifti files