AFNI program: 3dTstat

Output of -help

++ 3dTstat: AFNI version=AFNI_24.3.06 (Oct 31 2024) [64-bit]
++ Authored by: KR Hammett & RW Cox
Usage: 3dTstat [options] dataset
Computes one or more voxel-wise statistics for a 3D+time dataset
and stores them in a bucket dataset.  If no statistic option is
given, computes just the mean of each voxel time series.
Multiple statistics options may be given, and will result in
a multi-volume dataset.

Statistics Options (note where detrending does/does not occur):

 -sum       = compute sum of input voxels
 -abssum    = compute absolute sum of input voxels
 -sos       = compute sum of squares
 -l2norm    = compute L2 norm (sqrt(sum squares))
 -mean      = compute mean of input voxels
 -slope     = compute the slope of input voxels vs. time

 -stdev     = compute standard deviation of input voxels
              NB: input is detrended by first removing mean+slope
 -stdevNOD  = like '-stdev', but no initial detrending
 -cvar      = compute coefficient of variation of input:
                 voxels = stdev/fabs(mean)
              NB: in stdev calc, input is detrended by removing mean+slope
 -cvarNOD   = like '-cvar', but no initial detrending in stdev calc
 -cvarinv   = 1.0/cvar = 'signal to noise ratio' [for Vinai]
              NB: in stdev calc, input is detrended by removing mean+slope
 -cvarinvNOD = like '-cvarinv', but no detrending in stdev calc

 -tsnr      = compute temporal signal to noise ratio
                fabs(mean)/stdev NOT DETRENDED (same as -cvarinvNOD)
 -MAD       = compute MAD (median absolute deviation) of
                input voxels = median(|voxel-median(voxel)|)
                [N.B.: the trend is NOT removed for this]
 -DW        = compute Durbin-Watson Statistic of input voxels
                [N.B.: the trend IS removed for this]
 -median    = compute median of input voxels  [undetrended]
 -nzmedian  = compute median of non-zero input voxels [undetrended]
 -nzstdev   = standard deviation of non-zero input voxel [undetrended]
 -bmv       = compute biweight midvariance of input voxels [undetrended]
                [actually is 0.989*sqrt(biweight midvariance), to make]
                [the value comparable to the standard deviation output]
 -MSSD      = Von Neumann's Mean of Successive Squared Differences
               = average of sum of squares of first time difference
 -MSSDsqrt  = Sqrt(MSSD)
 -MASDx     = Median of absolute values of first time differences
               times 1.4826 (to scale it like standard deviation)
               = a robust alternative to MSSDsqrt
 -min       = compute minimum of input voxels [undetrended]
 -max       = compute maximum of input voxels [undetrended]
 -absmax    = compute absolute maximum of input voxels [undetrended]
 -signed_absmax = (signed) value with absolute maximum [undetrended]
 -percentile P  = the P-th percentile point (0=min, 50=median, 100=max)
                  of the data in each voxel time series.
                  [this option can only be used once!]
 -argmin    = index of minimum of input voxels [undetrended]
 -argmin1   = index + 1 of minimum of input voxels [undetrended]
 -argmax    = index of maximum of input voxels [undetrended]
 -argmax1   = index + 1 of maximum of input voxels [undetrended]
 -argabsmax = index of absolute maximum of input voxels [undetrended]
 -argabsmax1= index +1 of absolute maximum of input voxels [undetrended]
 -duration  = compute number of points around max above a threshold
              Use basepercent option to set limits
 -onset     = beginning of duration around max where value
              exceeds basepercent
 -offset    = end of duration around max where value
              exceeds basepercent
 -centroid  = compute centroid of data time curves
              (sum(i*f(i)) / sum(f(i)))
 -centduration = compute duration using centroid's index as center
 -nzmean    = compute mean of non-zero voxels
 -zcount    = count number of zero values at each voxel
 -nzcount    = count number of non zero values at each voxel

 -autocorr n = compute autocorrelation function and return
               first n coefficients
 -autoreg n = compute autoregression coefficients and return
               first n coefficients
   [N.B.: -autocorr 0 and/or -autoreg 0 will return number
          coefficients equal to the length of the input data]

 -accumulate = accumulate time series values (partial sums)
               val[i] = sum old_val[t] over t = 0..i
               (output length = input length)

 -centromean = compute mean of middle 50% of voxel values [undetrended]

 -skewness = measure of asymmetry in distribution - based on Pearson's
             moment, coefficient of skewness.
 -kurtosis = measure of the 'tailedness' of the probability distribution
             - the fourth standardized moment.  Never negative.
 -firstvalue = first value in dataset - typically just placeholder

 ** If no statistic option is given, then '-mean' is assumed **

Other Options:
 -tdiff    = Means to take the first difference of each time
               series before further processing.
 -prefix p = Use string 'p' for the prefix of the
               output dataset [DEFAULT = 'stat']
 -datum d  = use data type 'd' for the type of storage
               of the output, where 'd' is one of
               'byte', 'short', or 'float' [DEFAULT=float]
 -nscale = Do not scale output values when datum is byte or short.
           Scaling is done by default.

 -basepercent nn = Percentage of maximum for duration calculation

 -mask mset   Means to use the dataset 'mset' as a mask:
                 Only voxels with nonzero values in 'mset'
                 will be printed from 'dataset'.  Note
                 that the mask dataset and the input dataset
                 must have the same number of voxels.

 -mrange a b  Means to further restrict the voxels from
                 'mset' so that only those mask values
                 between 'a' and 'b' (inclusive) will
                 be used.  If this option is not given,
                 all nonzero values from 'mset' are used.
                 Note that if a voxel is zero in 'mset', then
                 it won't be included, even if a < 0 < b.

 -cmask 'opts' Means to execute the options enclosed in single
                  quotes as a 3dcalc-like program, and produce
                  produce a mask from the resulting 3D brick.
       Examples:
        -cmask '-a fred+orig[7] -b zork+orig[3] -expr step(a-b)'
                  produces a mask that is nonzero only where
                  the 7th sub-brick of fred+orig is larger than
                  the 3rd sub-brick of zork+orig.
        -cmask '-a fred+orig -expr 1-bool(k-7)'
                  produces a mask that is nonzero only in the
                  7th slice (k=7); combined with -mask, you
                  could use this to extract just selected voxels
                  from particular slice(s).
       Notes: * You can use both -mask and -cmask in the same
                  run - in this case, only voxels present in
                  both masks will be dumped.
              * Only single sub-brick calculations can be
                  used in the 3dcalc-like calculations -
                  if you input a multi-brick dataset here,
                  without using a sub-brick index, then only
                  its 0th sub-brick will be used.
              * Do not use quotes inside the 'opts' string!


If you want statistics on a detrended dataset and the option
doesn't allow that, you can use program 3dDetrend first.

The output is a bucket dataset.  The input dataset may
use a sub-brick selection list, as in program 3dcalc.

*** If you are trying to compute the mean or std.dev. of multiple
datasets (not across time), use 3dMean or 3dmerge instead.

----------------- Processing 1D files with 3dTstat -----------------
To analyze a 1D file and get statistics on each of its columns,
you can do something like this:
  3dTstat -stdev -bmv -prefix stdout: file.1D\'
where the \' means to transpose the file on input, since 1D files
read into 3dXXX programs are interpreted as having the time direction
along the rows rather than down the columns.  In this example, the
output is written to the screen, which could be captured with '>'
redirection.  Note that if you don't give the '-prefix stdout:'
option, then the output will be written into a NIML-formatted 1D
dataset, which you might find slightly confusing (but still usable).

++ Compile date = Oct 31 2024 {AFNI_24.3.06:linux_ubuntu_24_64}
This page auto-generated on Thu Oct 31 09:42:45 PM EDT 2024