fslrem: Modulus Remainder of 2 Images using FSL

View source: R/fslrem.R

fsl_remR Documentation

Modulus Remainder of 2 Images using FSL

Description

This function calls fslmaths -rem. The R functions wraps fslmaths

Usage

fsl_rem(..., outfile = tempfile(fileext = ".nii.gz"), retimg = FALSE)

fslrem(
  file,
  file2,
  outfile = NULL,
  retimg = TRUE,
  reorient = FALSE,
  intern = FALSE,
  opts = "",
  ...
)

Arguments

...

additional arguments passed to readnii.

outfile

(character) resultant image name (optional)

retimg

(logical) return image of class nifti

file

(character) input image

file2

(character) image to divide the current image by and take remainder

reorient

(logical) If retimg, should file be reoriented when read in? Passed to readnii.

intern

(logical) to be passed to system

opts

(character) operations to be passed to fslmaths

Value

If retimg then object of class nifti. Otherwise, Result from system command, depends if intern is TRUE or FALSE.

Note

Functions with underscores have different defaults and will return an output filename, so to be used for piping


muschellij2/fslr documentation built on Aug. 31, 2022, 8:47 p.m.