/*! get all 3D datasets in directory where afni resides */
THD_string_array * THD_get_all_afni_dsets(void )
{
THD_string_array *outar=NULL, *elist=NULL;
char *af=NULL, *etr=NULL;
int N_af, N_afni=strlen("afni"), iaf=0, ii=0, smode, *isrt=NULL;
char scomm[256]={""};
ENTRY("THD_get_all_afni_dsets");
if (!(elist = get_elist()) ||
!(af = THD_abindir(1))) {
ERROR_message("Could not find afni, we're doomed daddy!");
RETURN(outar);
}
N_af = strlen(af);
elist = THD_get_all_files(af,'\0');
/* Now get all dsets under af */
INIT_SARR( outar );
for (ii=0, iaf=0; ii<elist->num ; ii++ ){
smode = storage_mode_from_filename(elist->ar[ii]);
etr = THD_trailname( elist->ar[ii] , 0 ) ;
if (
!THD_is_directory(elist->ar[ii]) &&
!strncmp(af, elist->ar[ii], N_af) &&
(smode > STORAGE_UNDEFINED && smode <= LAST_STORAGE_MODE) &&
(smode != STORAGE_BY_BRICK || /* don't want the .BRICK, just .HEAD */
STRING_HAS_SUFFIX(elist->ar[ii], ".HEAD")) &&
(smode != STORAGE_BY_NIFTI || /* don't want the .img */
!STRING_HAS_SUFFIX(elist->ar[ii], ".img")) &&
strcmp(etr,"AFNI_atlas_spaces.niml")
) {
ADDTO_SARR( outar , elist->ar[ii] ) ; ++iaf;
/*fprintf(stderr," %d- %s smode %d[%d]%d\n", iaf, etr,
STORAGE_UNDEFINED, smode, LAST_STORAGE_MODE); */
} else {
/*fprintf(stderr," skip %s (%s) smode %d[%d]%d\n",
elist->ar[ii], af, STORAGE_UNDEFINED, smode, LAST_STORAGE_MODE); */
}
}
qsort(outar->ar, outar->num, sizeof(char*),
(int(*) (const void *, const void *))compare_string);
if( SARR_NUM(outar) == 0 ) DESTROY_SARR(outar) ;
if (af) free(af); af = NULL;
RETURN( outar );
}
int main( int argc , char *argv[] )
{
MRI_shindss *shd ;
int ids , nopt , kk ;
char *prefix = "EIC" ;
char *fname=NULL , *buf ;
MRI_vectim *mv ; THD_3dim_dataset *dset ;
/*--- official AFNI startup stuff ---*/
mainENTRY("3dExtractGroupInCorr"); machdep();
AFNI_logger("3dExtractGroupInCorr",argc,argv);
PRINT_VERSION("3dExtractGroupInCorr"); AUTHOR("RW Cox");
/*-- process options --*/
nopt = 1 ;
while( nopt < argc && argv[nopt][0] == '-' ){
if( strcasecmp(argv[nopt],"-prefix") == 0 ){
nopt++ ;
if( strcasecmp(argv[nopt],"NULL") == 0 ) prefix = NULL ;
else prefix = strdup(argv[nopt]) ;
nopt++ ; continue ;
}
ERROR_message("Unknown option: '%s'",argv[nopt]) ;
suggest_best_prog_option(argv[0], argv[nopt]);
exit(1);
}
if( argc < 2 ){ usage_3dExtractGroupInCorr(2) ; exit(0) ; }
/* check for errors */
if( nopt >= argc ) ERROR_exit("No input filename on command line?!") ;
/*-- read input file --*/
fname = strdup(argv[nopt]) ;
if( STRING_HAS_SUFFIX(fname,".data") ){
strcpy(fname+strlen(fname)-5,".niml") ;
WARNING_message("EIC: Replaced '.data' with '.niml' in filename") ;
} else if( STRING_HAS_SUFFIX(fname,".grpincorr") ){
fname = (char *)realloc(fname,strlen(fname)+16) ;
strcat(fname,".niml") ;
INFO_message("EIC: Added '.niml' to end of filename") ;
} else if( STRING_HAS_SUFFIX(fname,".grpincorr.") ){
fname = (char *)realloc(fname,strlen(fname)+16) ;
strcat(fname,"niml") ;
INFO_message("EIC: Added 'niml' to end of filename") ;
}
shd = GRINCOR_read_input( fname ) ;
if( shd == NULL ) ERROR_exit("EIC: Cannot continue after input error") ;
INFO_message("EIC: file opened, contains %d datasets, %d time series, %s bytes",
shd->ndset , shd->nvec , commaized_integer_string(shd->nbytes) ) ;
/*-- process input file --*/
fprintf(stderr,"++ %d datasets: ",shd->ndset) ;
for( ids=0 ; ids < shd->ndset ; ids++ ){
fprintf(stderr,"%d",ids+1) ;
dset = GRINCOR_extract_dataset( shd, ids, prefix ) ; fprintf(stderr,".") ;
DSET_write(dset) ;
DSET_delete(dset) ;
}
fprintf(stderr,"\n") ; exit(0) ;
}
int main( int argc , char * argv[] )
{
float mrad=0.0f , fwhm=0.0f ;
int nrep=1 ;
char *prefix = "Polyfit" ;
char *resid = NULL ;
char *cfnam = NULL ;
int iarg , verb=0 , do_automask=0 , nord=3 , meth=2 , do_mclip=0 ;
THD_3dim_dataset *inset ;
MRI_IMAGE *imout , *imin ;
byte *mask=NULL ; int nvmask=0 , nmask=0 , do_mone=0 , do_byslice=0 ;
MRI_IMARR *exar=NULL ;
floatvec *fvit=NULL ; /* 26 Feb 2019 */
if( argc < 2 || strcasecmp(argv[1],"-help") == 0 ){
printf("\n"
"Usage: 3dPolyfit [options] dataset ~1~\n"
"\n"
"* Fits a polynomial in space to the input dataset and outputs that fitted dataset.\n"
"\n"
"* You can also add your own basis datasets to the fitting mix, using the\n"
" '-base' option.\n"
"\n"
"* You can get the fit coefficients using the '-1Dcoef' option.\n"
"\n"
"--------\n"
"Options: ~1~\n"
"--------\n"
"\n"
" -nord n = Maximum polynomial order (0..9) [default order=3]\n"
" [n=0 is the constant 1]\n"
" [n=-1 means only use volumes from '-base']\n"
"\n"
" -blur f = Gaussian blur input dataset (inside mask) with FWHM='f' (mm)\n"
"\n"
" -mrad r = Radius (voxels) of preliminary median filter of input\n"
" [default is no blurring of either type; you can]\n"
" [do both types (Gaussian and median), but why??]\n"
" [N.B.: median blur is slower than Gaussian]\n"
"\n"
" -prefix pp = Use 'pp' for prefix of output dataset (the fit).\n"
" [default prefix is 'Polyfit'; use NULL to skip this output]\n"
"\n"
" -resid rr = Use 'rr' for the prefix of the residual dataset.\n"
" [default is not to output residuals]\n"
"\n"
" -1Dcoef cc = Save coefficients of fit into text file cc.1D.\n"
" [default is not to save these coefficients]\n"
"\n"
" -automask = Create a mask (a la 3dAutomask)\n"
" -mask mset = Create a mask from nonzero voxels in 'mset'.\n"
" [default is not to use a mask, which is probably a bad idea]\n"
"\n"
" -mone = Scale the mean value of the fit (inside the mask) to 1.\n"
" [probably this option is not useful for anything]\n"
"\n"
" -mclip = Clip fit values outside the rectilinear box containing the\n"
" mask to the edge of that box, to avoid weird artifacts.\n"
"\n"
" -meth mm = Set 'mm' to 2 for least squares fit;\n"
" set it to 1 for L1 fit [default method=2]\n"
" [Note that L1 fitting is slower than L2 fitting!]\n"
"\n"
" -base bb = In addition to the polynomial fit, also use\n"
" the volumes in dataset 'bb' as extra basis functions.\n"
" [If you use a base dataset, then you can set nord]\n"
" [to -1, to skip using any spatial polynomial fit.]\n"
"\n"
" -verb = Print fun and useful progress reports :-)\n"
"\n"
"------\n"
"Notes: ~1~\n"
"------\n"
"* Output dataset is always stored in float format.\n"
"\n"
"* If the input dataset has more than 1 sub-brick, only sub-brick #0\n"
" is processed. To fit more than one volume, you'll have to use a script\n"
" to loop over the input sub-bricks, and then glue (3dTcat) the results\n"
" together to get a final result. A simple example:\n"
" #!/bin/tcsh\n"
" set base = model.nii\n"
" set dset = errts.nii\n"
" set nval = `3dnvals $dset`\n"
" @ vtop = $nval - 1\n"
" foreach vv ( `count 0 $vtop` )\n"
" 3dPolyfit -base \"$base\" -nord 0 -mask \"$base\" -1Dcoef QQ.$vv -prefix QQ.$vv.nii $dset\"[$vv]\"\n"
" end\n"
" 3dTcat -prefix QQall.nii QQ.0*.nii\n"
" 1dcat QQ.0*.1D > QQall.1D\n"
" \rm QQ.0*\n"
" exit 0\n"
"\n"
"* If the '-base' dataset has multiple sub-bricks, all of them are used.\n"
"\n"
"* You can use the '-base' option more than once, if desired or needed.\n"
"\n"
"* The original motivation for this program was to fit a spatial model\n"
" to a field map MRI, but that didn't turn out to be useful. Nevertheless,\n"
" I make this program available to someone who might find it beguiling.\n"
"\n"
"* If you really want, I could allow you to put sign constraints on the\n"
" fit coefficients (e.g., say that the coefficient for a given base volume\n"
" should be non-negative). But you'll have to beg for this.\n"
"\n"
"-- Emitted by RWCox\n"
) ;
PRINT_COMPILE_DATE ; exit(0) ;
}
/*-- startup paperwork --*/
mainENTRY("3dPolyfit main"); machdep(); AFNI_logger("3dPolyfit",argc,argv);
PRINT_VERSION("3dPolyfit") ;
/*-- scan command line --*/
iarg = 1 ;
while( iarg < argc && argv[iarg][0] == '-' ){
if( strcasecmp(argv[iarg],"-base") == 0 ){
THD_3dim_dataset *bset ; int kk ; MRI_IMAGE *bim ;
if( ++iarg >= argc ) ERROR_exit("Need argument after '-base'") ;
bset = THD_open_dataset(argv[iarg]) ;
CHECK_OPEN_ERROR(bset,argv[iarg]) ;
DSET_load(bset) ; CHECK_LOAD_ERROR(bset) ;
if( exar == NULL ) INIT_IMARR(exar) ;
for( kk=0 ; kk < DSET_NVALS(bset) ; kk++ ){
bim = THD_extract_float_brick(kk,bset) ;
if( bim != NULL ) ADDTO_IMARR(exar,bim) ;
DSET_unload_one(bset,kk) ;
}
DSET_delete(bset) ;
iarg++ ; continue ;
}
if( strcasecmp(argv[iarg],"-verb") == 0 ){
verb++ ; iarg++ ; continue ;
}
if( strcasecmp(argv[iarg],"-hermite") == 0 ){ /* 25 Mar 2013 [New Year's Day] */
mri_polyfit_set_basis("hermite") ; /* HIDDEN */
iarg++ ; continue ;
}
if( strcasecmp(argv[iarg],"-byslice") == 0 ){ /* 25 Mar 2013 [New Year's Day] */
do_byslice++ ; iarg++ ; continue ; /* HIDDEN */
}
if( strcasecmp(argv[iarg],"-mask") == 0 ){
THD_3dim_dataset *mset ;
if( ++iarg >= argc ) ERROR_exit("Need argument after '-mask'") ;
if( mask != NULL || do_automask ) ERROR_exit("Can't have two mask inputs") ;
mset = THD_open_dataset(argv[iarg]) ;
CHECK_OPEN_ERROR(mset,argv[iarg]) ;
DSET_load(mset) ; CHECK_LOAD_ERROR(mset) ;
nvmask = DSET_NVOX(mset) ;
mask = THD_makemask( mset , 0 , 0.5f, 0.0f ) ; DSET_delete(mset) ;
if( mask == NULL ) ERROR_exit("Can't make mask from dataset '%s'",argv[iarg]) ;
nmask = THD_countmask( nvmask , mask ) ;
if( nmask < 99 ) ERROR_exit("Too few voxels in mask (%d)",nmask) ;
if( verb ) INFO_message("Number of voxels in mask = %d",nmask) ;
iarg++ ; continue ;
}
if( strcasecmp(argv[iarg],"-nord") == 0 ){
nord = (int)strtol( argv[++iarg], NULL , 10 ) ;
if( nord < -1 || nord > 9 )
ERROR_exit("Illegal value after -nord :(") ;
iarg++ ; continue ;
}
if( strcasecmp(argv[iarg],"-meth") == 0 ){
meth = (int)strtol( argv[++iarg], NULL , 10 ) ;
if( meth < 1 || meth > 2 )
ERROR_exit("Illegal value after -meth :(") ;
iarg++ ; continue ;
}
if( strncmp(argv[iarg],"-automask",5) == 0 ){
if( mask != NULL ) ERROR_exit("Can't use -mask and -automask together!") ;
do_automask++ ; iarg++ ; continue ;
}
if( strncmp(argv[iarg],"-mclip",5) == 0 ){
do_mclip++ ; iarg++ ; continue ;
}
if( strncmp(argv[iarg],"-mone",5) == 0 ){
do_mone++ ; iarg++ ; continue ;
}
if( strcasecmp(argv[iarg],"-mrad") == 0 ){
mrad = strtod( argv[++iarg] , NULL ) ; iarg++ ; continue ;
}
if( strcasecmp(argv[iarg],"-blur") == 0 ){
fwhm = strtod( argv[++iarg] , NULL ) ; iarg++ ; continue ;
}
if( strcasecmp(argv[iarg],"-prefix") == 0 ){
prefix = argv[++iarg] ;
if( !THD_filename_ok(prefix) )
ERROR_exit("Illegal value after -prefix :(");
if( strcasecmp(prefix,"NULL") == 0 ) prefix = NULL ;
iarg++ ; continue ;
}
if( strcasecmp(argv[iarg],"-resid") == 0 ){
resid = argv[++iarg] ;
if( !THD_filename_ok(resid) )
ERROR_exit("Illegal value after -resid :(");
if( strcasecmp(resid,"NULL") == 0 ) resid = NULL ;
iarg++ ; continue ;
}
if( strcasecmp(argv[iarg],"-1Dcoef") == 0 ){ /* 26 Feb 2019 */
cfnam = argv[++iarg] ;
if( !THD_filename_ok(cfnam) )
ERROR_exit("Illegal value after -1Dcoef :(");
if( strcasecmp(cfnam,"NULL") == 0 ) cfnam = NULL ;
iarg++ ; continue ;
}
ERROR_exit("Unknown option: %s\n",argv[iarg]);
}
/*--- check for blatant errors ---*/
if( iarg >= argc )
ERROR_exit("No input dataset name on command line?");
if( prefix == NULL && resid == NULL && cfnam == NULL )
ERROR_exit("-prefix and -resid and -1Dcoef are all NULL?!") ;
if( do_byslice && cfnam != NULL ){
WARNING_message("-byslice does not work with -1Dcoef option :(") ;
cfnam = NULL ;
}
if( nord < 0 && exar == NULL )
ERROR_exit("no polynomial fit AND no -base option ==> nothing to compute :(") ;
/*-- read input --*/
if( verb ) INFO_message("Load input dataset") ;
inset = THD_open_dataset( argv[iarg] ) ;
CHECK_OPEN_ERROR(inset,argv[iarg]) ;
DSET_load(inset) ; CHECK_LOAD_ERROR(inset) ;
if( DSET_NVALS(inset) > 1 )
WARNING_message( "Only processing sub-brick #0 (out of %d)" , DSET_NVALS(inset) );
/* check input mask or create automask */
if( mask != NULL ){
if( nvmask != DSET_NVOX(inset) )
ERROR_exit("-mask and input datasets don't match in voxel counts :-(") ;
} else if( do_automask ){
THD_automask_verbose( (verb > 1) ) ;
THD_automask_extclip( 1 ) ;
mask = THD_automask( inset ) ; nvmask = DSET_NVOX(inset) ;
nmask = THD_countmask( nvmask , mask ) ;
if( nmask < 99 ) ERROR_exit("Too few voxels in automask (%d)",nmask) ;
if( verb ) ININFO_message("Number of voxels in automask = %d",nmask) ;
} else {
WARNING_message("3dPolyfit is running without a mask") ;
}
#undef GOOD
#define GOOD(i) (mask == NULL || mask[i])
/* check -base input datasets */
if( exar != NULL ){
int ii,kk , nvbad=0 , nvox=DSET_NVOX(inset),nm ; float *ex , exb ;
for( kk=0 ; kk < IMARR_COUNT(exar) ; kk++ ){
if( nvox != IMARR_SUBIM(exar,kk)->nvox ){
if( IMARR_SUBIM(exar,kk)->nvox != nvbad ){
ERROR_message("-base volume (%d voxels) doesn't match input dataset grid size (%d voxels)",
IMARR_SUBIM(exar,kk)->nvox , nvox ) ;
nvbad = IMARR_SUBIM(exar,kk)->nvox ;
}
}
}
if( nvbad != 0 ) ERROR_exit("Cannot continue :-(") ;
/* subtract mean from each base input, if is a constant polynomial in the fit */
if( nord >= 0 ){
if( verb ) INFO_message("subtracting spatial mean from '-base'") ;
for( kk=0 ; kk < IMARR_COUNT(exar) ; kk++ ){
exb = 0.0f ; ex = MRI_FLOAT_PTR(IMARR_SUBIM(exar,kk)) ;
for( nm=ii=0 ; ii < nvox ; ii++ ){ if( GOOD(ii) ){ exb += ex[ii]; nm++; } }
exb /= nm ;
for( ii=0 ; ii < nvox ; ii++ ) ex[ii] -= exb ;
}
}
}
/* if blurring, edit mask a little */
if( mask != NULL && (fwhm > 0.0f || mrad > 0.0f) ){
int ii ;
ii = THD_mask_remove_isolas( DSET_NX(inset),DSET_NY(inset),DSET_NZ(inset),mask ) ;
if( ii > 0 ){
nmask = THD_countmask( nvmask , mask ) ;
if( verb )
ININFO_message("Removed %d isola%s from mask, leaving %d voxels" ,
ii,(ii==1)?"\0":"s" , nmask ) ;
if( nmask < 99 )
ERROR_exit("Too few voxels left in mask after isola removal :-(") ;
}
}
/* convert input to float, which is simpler to deal with */
imin = THD_extract_float_brick(0,inset) ;
if( imin == NULL ) ERROR_exit("Can't extract input dataset brick?! :-(") ;
DSET_unload(inset) ;
if( verb ) INFO_message("Start fitting process") ;
/* do the Gaussian blurring */
if( fwhm > 0.0f ){
if( verb ) ININFO_message("Gaussian blur: FWHM=%g mm",fwhm) ;
imin->dx = fabsf(DSET_DX(inset)) ;
imin->dy = fabsf(DSET_DY(inset)) ;
imin->dz = fabsf(DSET_DZ(inset)) ;
mri_blur3D_addfwhm( imin , mask , fwhm ) ;
}
/* do the fitting */
mri_polyfit_verb(verb) ;
if( do_byslice )
imout = mri_polyfit_byslice( imin , nord , exar , mask , mrad , meth ) ;
else
imout = mri_polyfit ( imin , nord , exar , mask , mrad , meth ) ;
/* WTF? */
if( imout == NULL )
ERROR_exit("Can't compute polynomial fit :-( !?") ;
if( resid == NULL ) mri_free(imin) ;
if( ! do_byslice )
fvit = mri_polyfit_get_fitvec() ; /* get coefficients of fit [26 Feb 2019] */
/* scale the fit dataset? */
if( do_mone ){
float sum=0.0f ; int nsum=0 , ii,nvox ; float *par=MRI_FLOAT_PTR(imout) ;
nvox = imout->nvox ;
for( ii=0 ; ii < nvox ; ii++ ){
if( mask != NULL && mask[ii] == 0 ) continue ;
sum += par[ii] ; nsum++ ;
}
if( nsum > 0 && sum != 0.0f ){
sum = nsum / sum ;
if( verb ) ININFO_message("-mone: scaling fit by %g",sum) ;
for( ii=0 ; ii < nvox ; ii++ ) par[ii] *= sum ;
}
}
/* if there's a mask, clip values outside of its box */
#undef PF
#define PF(i,j,k) par[(i)+(j)*nx+(k)*nxy]
if( mask != NULL && do_mclip ){
int xm,xp,ym,yp,zm,zp , ii,jj,kk , nx,ny,nz,nxy ; float *par ;
MRI_IMAGE *bim = mri_empty_conforming( imout , MRI_byte ) ;
mri_fix_data_pointer(mask,bim) ;
if( verb ) ININFO_message("-mclip: polynomial fit to autobox of mask") ;
MRI_autobbox( bim , &xm,&xp , &ym,&yp , &zm,&zp ) ;
mri_clear_data_pointer(bim) ; mri_free(bim) ;
nx = imout->nx ; ny = imout->ny ; nz = imout->nz ; nxy = nx*ny ;
par = MRI_FLOAT_PTR(imout) ;
for( ii=0 ; ii < xm ; ii++ )
for( kk=0 ; kk < nz ; kk++ )
for( jj=0 ; jj < ny ; jj++ ) PF(ii,jj,kk) = PF(xm,jj,kk) ;
for( ii=xp+1 ; ii < nx ; ii++ )
for( kk=0 ; kk < nz ; kk++ )
for( jj=0 ; jj < ny ; jj++ ) PF(ii,jj,kk) = PF(xp,jj,kk) ;
for( jj=0 ; jj < ym ; jj++ )
for( kk=0 ; kk < nz ; kk++ )
for( ii=0 ; ii < nx ; ii++ ) PF(ii,jj,kk) = PF(ii,ym,kk) ;
for( jj=yp+1 ; jj < ny ; jj++ )
for( kk=0 ; kk < nz ; kk++ )
for( ii=0 ; ii < nx ; ii++ ) PF(ii,jj,kk) = PF(ii,yp,kk) ;
for( kk=0 ; kk < zm ; kk++ )
for( jj=0 ; jj < ny ; jj++ )
for( ii=0 ; ii < nx ; ii++ ) PF(ii,jj,kk) = PF(ii,jj,zm) ;
for( kk=zp+1 ; kk < nz ; kk++ )
for( jj=0 ; jj < ny ; jj++ )
for( ii=0 ; ii < nx ; ii++ ) PF(ii,jj,kk) = PF(ii,jj,zp) ;
}
if( mask != NULL ) free(mask) ;
/* write outputs */
if( prefix != NULL ){
THD_3dim_dataset *outset = EDIT_empty_copy( inset ) ;
EDIT_dset_items( outset ,
ADN_prefix , prefix ,
ADN_nvals , 1 ,
ADN_ntt , 0 ,
ADN_none ) ;
EDIT_substitute_brick( outset , 0 , MRI_float , MRI_FLOAT_PTR(imout) ) ;
tross_Copy_History( inset , outset ) ;
tross_Make_History( "3dPolyfit" , argc,argv , outset ) ;
DSET_write(outset) ;
WROTE_DSET(outset) ;
}
if( resid != NULL ){
THD_3dim_dataset *outset = EDIT_empty_copy( inset ) ;
float *inar=MRI_FLOAT_PTR(imin) , *outar=MRI_FLOAT_PTR(imout) ;
int nx,ny,nz , nxyz , kk ;
nx = imout->nx ; ny = imout->ny ; nz = imout->nz ; nxyz = nx*ny*nz ;
for( kk=0 ; kk < nxyz ; kk++ ) outar[kk] = inar[kk] - outar[kk] ;
mri_free(imin) ;
EDIT_dset_items( outset ,
ADN_prefix , resid ,
ADN_nvals , 1 ,
ADN_ntt , 0 ,
ADN_none ) ;
EDIT_substitute_brick( outset , 0 , MRI_float , MRI_FLOAT_PTR(imout) ) ;
tross_Copy_History( inset , outset ) ;
tross_Make_History( "3dPolyfit" , argc,argv , outset ) ;
DSET_write(outset) ;
WROTE_DSET(outset) ;
}
if( cfnam != NULL && fvit != NULL ){ /* won't work with '-byslice' */
char *qn ;
qn = STRING_HAS_SUFFIX(cfnam,".1D") ? cfnam : modify_afni_prefix(cfnam,NULL,".1D") ;
mri_write_floatvec( qn , fvit ) ;
}
exit(0) ;
}
int main( int argc , char *argv[] )
{
THD_3dim_dataset *xset=NULL , *cset ;
int nopt=1, datum=MRI_float, nvals, ii;
MRI_IMAGE *ysim=NULL ;
char *prefix = "Tcorr1D", *smethod="pearson";
char *xnam=NULL , *ynam=NULL ;
byte *mask=NULL ; int mask_nx,mask_ny,mask_nz , nmask=0 ;
int do_atanh = 0 ; /* 12 Jan 2018 */
/*----*/
AFNI_SETUP_OMP(0) ; /* 24 Jun 2013 */
if( argc < 2 || strcmp(argv[1],"-help") == 0 ){
printf("Usage: 3dTcorr1D [options] xset y1D\n"
"Computes the correlation coefficient between each voxel time series\n"
"in the input 3D+time dataset 'xset' and each column in the 1D time\n"
"series file 'y1D', and stores the output values in a new dataset.\n"
"\n"
"OPTIONS:\n"
" -pearson = Correlation is the normal Pearson (product moment)\n"
" correlation coefficient [this is the default method].\n"
" -spearman = Correlation is the Spearman (rank) correlation\n"
" coefficient.\n"
" -quadrant = Correlation is the quadrant correlation coefficient.\n"
" -ktaub = Correlation is Kendall's tau_b coefficient.\n"
" ++ For 'continuous' or finely-discretized data, tau_b and\n"
" rank correlation are nearly equivalent (but not equal).\n"
" -dot = Doesn't actually compute a correlation coefficient; just\n"
" calculates the dot product between the y1D vector(s)\n"
" and the dataset time series.\n"
"\n"
" -Fisher = Apply the 'Fisher' (inverse hyperbolic tangent) transformation\n"
" to the results.\n"
" ++ It does not make sense to use this with '-ktaub', but if\n"
" you want to do it, the program will not stop you.\n"
" ++ Cannot be used with '-dot'!\n"
"\n"
" -prefix p = Save output into dataset with prefix 'p'\n"
" [default prefix is 'Tcorr1D'].\n"
"\n"
" -mask mmm = Only process voxels from 'xset' that are nonzero\n"
" in the 3D mask dataset 'mmm'.\n"
" ++ Other voxels in the output will be set to zero.\n"
"\n"
" -float = Save results in float format [the default format].\n"
" -short = Save results in scaled short format [to save disk space].\n"
" ++ Cannot be used with '-dot'!\n"
"\n"
"NOTES:\n"
"* The output dataset is functional bucket type, with one sub-brick\n"
" per column of the input y1D file.\n"
"* No detrending, blurring, or other pre-processing options are available;\n"
" if you want these things, see 3dDetrend or 3dTproject or 3dcalc.\n"
" [In other words, this program presumes you know what you are doing!]\n"
"* Also see 3dTcorrelate to do voxel-by-voxel correlation of TWO\n"
" 3D+time datasets' time series, with similar options.\n"
"* You can extract the time series from a single voxel with given\n"
" spatial indexes using 3dmaskave, and then run it with 3dTcorr1D:\n"
" 3dmaskave -quiet -ibox 40 30 20 epi_r1+orig > r1_40_30_20.1D\n"
" 3dTcorr1D -pearson -Fisher -prefix c_40_30_20 epi_r1+orig r1_40_30_20.1D\n"
"* http://en.wikipedia.org/wiki/Correlation\n"
"* http://en.wikipedia.org/wiki/Pearson_product-moment_correlation_coefficient\n"
"* http://en.wikipedia.org/wiki/Spearman%%27s_rank_correlation_coefficient\n"
"* http://en.wikipedia.org/wiki/Kendall_tau_rank_correlation_coefficient\n"
"\n"
"-- RWCox - Apr 2010\n"
" - Jun 2010: Multiple y1D columns; OpenMP; -short; -mask.\n"
) ;
PRINT_AFNI_OMP_USAGE("3dTcorr1D",NULL) ;
PRINT_COMPILE_DATE ; exit(0) ;
}
mainENTRY("3dTcorr1D main"); machdep(); AFNI_logger("3dTcorr1D",argc,argv);
PRINT_VERSION("3dTcorr1D") ; THD_check_AFNI_version("3dTcorr1D") ;
/*-- option processing --*/
while( nopt < argc && argv[nopt][0] == '-' ){
if( strcmp(argv[nopt],"-mask") == 0 ){ /* 28 Jun 2010 */
THD_3dim_dataset *mset ;
if( ++nopt >= argc ) ERROR_exit("Need argument after '-mask'") ;
if( mask != NULL ) ERROR_exit("Can't have two mask inputs") ;
mset = THD_open_dataset( argv[nopt] ) ;
CHECK_OPEN_ERROR(mset,argv[nopt]) ;
DSET_load(mset) ; CHECK_LOAD_ERROR(mset) ;
mask_nx = DSET_NX(mset); mask_ny = DSET_NY(mset); mask_nz = DSET_NZ(mset);
mask = THD_makemask( mset , 0 , 0.5f, 0.0f ) ; DSET_delete(mset) ;
if( mask == NULL ) ERROR_exit("Can't make mask from dataset '%s'",argv[nopt]) ;
nmask = THD_countmask( mask_nx*mask_ny*mask_nz , mask ) ;
INFO_message("Number of voxels in mask = %d",nmask) ;
if( nmask < 2 ) ERROR_exit("Mask is too small to process") ;
nopt++ ; continue ;
}
if( strcasecmp(argv[nopt],"-float") == 0 ){ /* 27 Jun 2010 */
datum = MRI_float ; nopt++ ; continue ;
}
if( strcasecmp(argv[nopt],"-short") == 0 ){
datum = MRI_short ; nopt++ ; continue ;
}
if( strcasecmp(argv[nopt],"-pearson") == 0 ){
smethod = "pearson" ; nopt++ ; continue ;
}
if( strcasecmp(argv[nopt],"-dot") == 0 ){
smethod = "dot" ; nopt++ ; continue ;
}
if( strcasecmp(argv[nopt],"-spearman") == 0 || strcasecmp(argv[nopt],"-rank") == 0 ){
smethod = "spearman" ; nopt++ ; continue ;
}
if( strcasecmp(argv[nopt],"-quadrant") == 0 ){
smethod = "quadrant" ; nopt++ ; continue ;
}
if( strcasecmp(argv[nopt],"-ktaub") == 0 || strcasecmp(argv[nopt],"-taub") == 0 ){
smethod = "ktaub" ; nopt++ ; continue ;
}
if( strcasecmp(argv[nopt],"-fisher") == 0 ){ /* 12 Jan 2018 */
do_atanh = 1 ; nopt++ ; continue ;
}
if( strcmp(argv[nopt],"-prefix") == 0 ){
prefix = argv[++nopt] ;
if( !THD_filename_ok(prefix) ) ERROR_exit("Illegal value after -prefix!") ;
nopt++ ; continue ;
}
ERROR_exit("Unknown option: %s",argv[nopt]) ;
}
/*------------ open datasets, check for legality ------------*/
if( nopt+1 >= argc )
ERROR_exit("Need 2 non-option arguments on command line!?") ;
/* despite what the help says, if the 1D file is first, that's OK */
if( STRING_HAS_SUFFIX(argv[nopt],"1D") ){
ININFO_message("reading 1D file %s",argv[nopt]) ;
ysim = mri_read_1D( argv[nopt] ) ; ynam = argv[nopt] ;
if( ysim == NULL ) ERROR_exit("Can't read 1D file %s",argv[nopt]) ;
} else {
ININFO_message("reading dataset file %s",argv[nopt]) ;
xset = THD_open_dataset( argv[nopt] ) ; xnam = argv[nopt] ;
if( xset == NULL ) ERROR_exit("Can't open dataset %s",argv[nopt]) ;
}
/* read whatever type of file (3D or 1D) we don't already have */
nopt++ ;
if( xset != NULL ){
ININFO_message("reading 1D file %s",argv[nopt]) ;
ysim = mri_read_1D( argv[nopt] ) ; ynam = argv[nopt] ;
if( ysim == NULL ) ERROR_exit("Can't read 1D file %s",argv[nopt]) ;
} else {
ININFO_message("reading dataset file %s",argv[nopt]) ;
xset = THD_open_dataset( argv[nopt] ) ; xnam = argv[nopt] ;
if( xset == NULL ) ERROR_exit("Can't open dataset %s",argv[nopt]) ;
}
nvals = DSET_NVALS(xset) ; /* number of time points */
ii = (strcmp(smethod,"dot")==0) ? 2 : 3 ;
if( nvals < ii )
ERROR_exit("Input dataset %s length is less than ii?!",xnam,ii) ;
if( ysim->nx < nvals )
ERROR_exit("1D file %s has %d time points, but dataset has %d values",
ynam,ysim->nx,nvals) ;
else if( ysim->nx > nvals )
WARNING_message("1D file %s has %d time points, dataset has %d",
ynam,ysim->nx,nvals) ;
if( mri_allzero(ysim) )
ERROR_exit("1D file %s is all zero!",ynam) ;
if( ysim->ny > 1 )
INFO_message("1D file %s has %d columns: correlating with ALL of them!",
ynam,ysim->ny) ;
if( strcmp(smethod,"dot") == 0 && do_atanh ){
WARNING_message("'-dot' turns off '-Fisher'") ; do_atanh = 0 ;
}
if( strcmp(smethod,"dot") == 0 && datum == MRI_short ){
WARNING_message("'-dot' turns off '-short'") ; datum = MRI_float ;
}
cset = THD_Tcorr1D( xset, mask, nmask, ysim, smethod,
prefix, (datum==MRI_short) , do_atanh );
tross_Make_History( "3dTcorr1D" , argc,argv , cset ) ;
DSET_unload(xset) ; /* no longer needful */
/* finito */
DSET_write(cset) ;
INFO_message("Wrote dataset: %s\n",DSET_BRIKNAME(cset)) ;
exit(0) ;
}
