fslthresh: Threshold an image

In neuroconductor-devel/fslr: Wrapper Functions for 'FSL' ('FMRIB' Software Library) from Functional MRI of the Brain ('FMRIB')

Threshold an image

Description

This function calls fslmaths -thr -uthr to threshold an image and either saves the image or returns an object of class nifti

Usage

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

fslthresh(
  file,
  outfile = NULL,
  thresh = 0,
  uthresh = NULL,
  retimg = TRUE,
  reorient = FALSE,
  intern = FALSE,
  opts = "",
  verbose = TRUE,
  ...
)

Arguments

...	additional arguments passed to readnii.
outfile	(character) name of resultant thresholded file
retimg	(logical) return image of class nifti
file	(character) filename of image to be thresholded
thresh	(numeric) threshold (anything below set to 0)
uthresh	(numeric) upper threshold (anything above set to 0)
reorient	(logical) If retimg, should file be reoriented when read in? Passed to readnii.
intern	(logical) pass to system
opts	(character) additional options to be passed to fslmaths
verbose	(logical) print out command before running

Value

character or logical depending on intern

Note

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

Examples

if (have.fsl()){
system.time({
x = array(rnorm(1e6), dim = c(100, 100, 100))
img = nifti(x, dim= c(100, 100, 100), 
datatype = convert.datatype()$FLOAT32, cal.min = min(x), 
cal.max = max(x), pixdim = rep(1, 4))
thresh = fslthresh(img, thresh=0, uthresh = 2, retimg=TRUE)
})
} 

neuroconductor-devel/fslr documentation built on July 3, 2025, 11 p.m.