AFNI program: 3dTcorr1D

Output of -help


Usage: 3dTcorr1D [options] xset y1D
Computes the correlation coefficient between each voxel time series
in the input 3D+time dataset 'xset' and each column in the 1D time
series file 'y1D', and stores the output values in a new dataset.

OPTIONS:
  -pearson  = Correlation is the normal Pearson (product moment)
                correlation coefficient [this is the default method].
  -spearman = Correlation is the Spearman (rank) correlation
                coefficient.
  -quadrant = Correlation is the quadrant correlation coefficient.
  -ktaub    = Correlation is Kendall's tau_b coefficient.
              ++ For 'continuous' or finely-discretized data, tau_b and
                 rank correlation are nearly equivalent (but not equal).

  -prefix p = Save output into dataset with prefix 'p'
               [default prefix is 'Tcorr1D'].

  -mask mmm = Only process voxels from 'xset' that are nonzero
                in the 3D mask dataset 'mmm'.
              ++ Other voxels in the output will be set to zero.

  -float    = Save results in float format [the default format].
  -short    = Save results in scaled short format [to save disk space].

NOTES:
* The output dataset is functional bucket type, with one sub-brick
   per column of the input y1D file.
* No detrending, blurring, or other pre-processing options are available;
   if you want these things, see 3dDetrend or 3dBandpass or 3dcalc.
   [In other words, this program presumes you know what you are doing!]
* Also see 3dTcorrelate to do voxel-by-voxel correlation of TWO
   3D+time datasets' time series, with similar options.
http://en.wikipedia.org/wiki/Correlation
http://en.wikipedia.org/wiki/Pearson_product-moment_correlation_coefficient
http://en.wikipedia.org/wiki/Spearman%27s_rank_correlation_coefficient
http://en.wikipedia.org/wiki/Kendall_tau_rank_correlation_coefficient

-- RWCox - Apr 2010
         - Jun 2010: Multiple y1D columns; OpenMP; -short; -mask.

 =========================================================================
* This binary version of 3dTcorr1D is NOT compiled using OpenMP, a
   semi-automatic parallelizer software toolkit, which splits the work
   across multiple CPUs/cores on the same shared memory computer.
* However, the source code is modified for OpenMP, and can be compiled
   with an OpenMP-capable compiler, such as gcc 4.2+, Intel's icc, and
   Sun Studio.
* If you wish to compile this program with OpenMP, see the man page for
   your C compiler, and (if needed) consult the AFNI message board, and
   http://afni.nimh.nih.gov/pub/dist/doc/misc/OpenMP.html

++ Compile date = May  2 2012


This page auto-generated on Thu May 3 04:28:33 EDT 2012