afni_3dClipLevel: AFNI 3dClipLevel function

Description Usage Arguments Value Note

View source: R/afni_3dClipLevel.R

Description

Estimates the value at which to clip the anatomical dataset using 3dClipLevel so that background regions are set to zero.

Usage

1
2
3
afni_3dClipLevel(file, mfrac = 0.5, opts = "")

ClipLevel(...)

Arguments

file

nifti object or NIfTI filename. If more than one is given, they are given names of the letters up to z.

mfrac

Multiplier of the median for clipping (see notes)

opts

Additional options passed to 3dClipLevel

...

not used

Value

Single character string of a nubmer (by default), unless opts = "-doall"

Note

From AFNI docs: Algorithm:

(a) Set some initial clip value using wizardry (AKA 'variance').

(b) Find the median of all positive values >= clip value.

(c) Set the clip value to mfrac of this median.

(d) Loop back to (b) until the clip value doesn't change.


neuroconductor/afnir documentation built on May 22, 2021, 9:54 a.m.