imco: Performs PCA-based Intermodal Coupling

In hufengling/pIMCo: Functionality to couple two or more MRI modalities using PCA

Performs PCA-based Intermodal Coupling

Description

Performs PCA-based Intermodal Coupling

Usage

imco(
  files,
  brain_mask,
  out_dir = NULL,
  out_name = NULL,
  fwhm = 3,
  verbose = TRUE,
  prop_miss = 0.9,
  use_ratio = FALSE,
  return_coupling = FALSE
)

Arguments

files	list of paths to niftis (string) or list of antsImages
brain_mask	path to mask nifti or antsImage mask to apply before coupling (optional)
out_dir	string path to output directory
out_name	string prefix for file name. Final name is "'out_name'_coupling.nii.gz"
fwhm	numerical value of full width at half maximum for calculating neighborhood size; default is 3
verbose	TRUE or FALSE; default TRUE
prop_miss	proportion of voxels in a neighborhood allowed to be missing; default is 0.9
use_ratio	default FALSE for (logit of 1st eigenvalue scaled to 0-1), TRUE for (1st eigenvalue/total variance)
return_coupling	default FALSE to write image to out_dir, TRUE to return coupling image without writing

Value

list of coupled antsImages and file paths

Examples

## Not run: 
mod1_filepath <- "/path/to/proj/dir/mod1_subj1.nii.gz"
mod2_filepath <- "/path/to/proj/dir/mod2_subj1.nii.gz"
mod3_filepath <- "/path/to/proj/dir/mod3_subj1.nii.gz"
imco(files = list(mod1_files, mod2_files, mod3_files),
    brain_mask = "/path/to/proj/dir/grey_matter_mask.nii.gz",
    out_dir = "/path/to/proj/dir/coupled_images",
    out_name = "subj-1",
    fwhm = 3)

## End(Not run)

hufengling/pIMCo documentation built on April 23, 2022, 9:23 p.m.