ciftiTools (version 0.3.1)

smooth_gifti: Smooth a metric GIFTI

Description

Smooths metric GIFTI data on the cortical surface. This uses the -metric-smoothing command from Connectome Workbench.

Usage

smooth_gifti(
  original_fname,
  target_fname,
  surf_fname = NULL,
  surf_FWHM = 5,
  hemisphere = c("left", "right"),
  ROI_fname = NULL,
  zeroes_as_NA = FALSE
)
smoothGIfTI(
  original_fname,
  target_fname,
  surf_fname,
  surf_FWHM = 5,
  zeroes_as_NA = FALSE
)
smoothgii(
  original_fname,
  target_fname,
  surf_fname,
  surf_FWHM = 5,
  zeroes_as_NA = FALSE
)

Arguments

original_fname

The GIFTI file to smooth.

target_fname

Where to save the smoothed file.

surf_fname

Surface GIFTI files cortical surface along which to smooth. If not provided, the default very inflated surfaces will be used.

surf_FWHM

The full width at half maximum (FWHM) parameter for the gaussian surface smoothing kernel, in mm. Default: 5

hemisphere

The cortex hemisphere: "left" or "right". Only used if surf_fname is NULL.

ROI_fname

The ROI to limit smoothing to, as a metric file. This is used to exclude the medial wall from smoothing. If not provided (default) all the data is smoothed across the surface.

zeroes_as_NA

Should zero-values be treated as NA? Default: FALSE.

Value

The smoothed GIFTI file name, invisibly