8#include "tpcclibConfig.h"
27double *petmeas, *petsim;
32double wss_wo_penalty=0.0;
35double cm3Func(
int parNr,
double *p,
void*);
39static char *info[] = {
40 "Non-linear fitting of two-tissue compartment model to plasma input, blood,",
41 "and tissue time-activity curves (PTAC, BTAC, and TTAC) to estimate",
42 "parameters K1, k2, k3, and Vb. Sample times must be in minutes.",
44 " ______ ___________________ ",
46 " | | --> | -------> | ",
47 " | Ca | <-- | C1 <------- C2 | ",
49 " |______| |___________________| ",
51 "Usage: @P [Options] ptacfile btacfile ttacfile endtime resultfile",
55 " Specify the constraints for model parameters;",
56 " This file with default values can be created by giving this",
57 " option as the only command-line argument to this program.",
58 " Without filename the default values are printed on screen.",
60 " Standard deviations are calculated and saved in results (y),",
61 " or not calculated (N, default).",
62 " Program runs a lot faster if SD and CL are not calculated.",
64 " 95% Confidence limits are calculated and saved in results (y), or",
65 " not calculated (N, default).",
67 " Enter a fixed Vb; fitted by default.",
68 " -r=<Reference region id or filename>",
69 " Optional reference region is used to constrain K1/k2 in other regions;",
70 " Also k3 is fitted to reference region data, thus any large region",
71 " (for example cortex) can be used here.",
73 " Fitted regional TACs are written in DFT format.",
75 " Fitted and measured TACs are plotted in specified SVG file.",
78 "Example 1: estimate K1, K1/k2, k3 and Vb",
79 " @P ua919ap.bld ua919ab.bld ua919.tac 60 ua919k3.res",
81 "Example 2: estimate K1 and k3; Vb is constrained to 4.5% and K1/k2 is",
82 "constrained to K1/k2 estimated from region 'occip'",
83 " @P -Vb=4.5 -r=occip ua919ap.bld ua919ab.bld ua919.tac 60 ua919.res",
85 "See also: patlak, lhsol, p2t_v3c, tacweigh, taccbv, rescoll",
87 "Keywords: TAC, modelling, irreversible uptake, k3, Ki, 2TCM",
106int main(
int argc,
char **argv)
108 int ai, help=0, version=0, verbose=1;
109 int ri, fi, pi, m, n, ret;
111 int ref=-1, refAdded=0, inputtype;
112 char dfile[FILENAME_MAX], pfile[FILENAME_MAX], bfile[FILENAME_MAX],
113 rfile[FILENAME_MAX], ffile[FILENAME_MAX], limfile[FILENAME_MAX];
114 char svgfile[FILENAME_MAX];
115 char *cptr, refname[FILENAME_MAX], tmp[FILENAME_MAX];
116 double fitdur, wss, aic, K1, k2, k3;
119 int doBootstrap=0, doSD=0, doCL=0;
120 double *sd, *cl1, *cl2;
122 int tgoNr=0, neighNr=0, iterNr=0, fittedparNr=0;
126 def_pmin[0]=0.0; def_pmax[0]=5.0;
127 def_pmin[1]=0.00001; def_pmax[1]=10.0;
128 def_pmin[2]=0.0; def_pmax[2]=2.0;
129 def_pmin[3]=0.0; def_pmax[3]=0.08;
135 if(argc==1) {
tpcPrintUsage(argv[0], info, stderr);
return(1);}
136 dfile[0]=pfile[0]=bfile[0]=rfile[0]=ffile[0]=refname[0]=limfile[0]=(char)0;
141 for(ai=1; ai<argc; ai++)
if(*argv[ai]==
'-') {
142 cptr=argv[ai]+1;
if(*cptr==
'-') cptr++;
if(cptr==NULL)
continue;
144 if(strncasecmp(cptr,
"CL", 2)==0) {
145 if(strlen(cptr)==2) {doCL=1;
continue;}
146 cptr+=2;
if(*cptr==
'=') {
148 if(*cptr==
'Y' || *cptr==
'y') {doCL=1;
continue;}
149 if(*cptr==
'N' || *cptr==
'n') {doCL=0;
continue;}
151 }
else if(strncasecmp(cptr,
"SD", 2)==0) {
152 if(strlen(cptr)==2) {doSD=1;
continue;}
153 cptr+=2;
if(*cptr==
'=') {
155 if(*cptr==
'Y' || *cptr==
'y') {doSD=1;
continue;}
156 if(*cptr==
'N' || *cptr==
'n') {doSD=0;
continue;}
158 }
else if(strncasecmp(cptr,
"LIM=", 4)==0 && strlen(cptr)>4) {
159 strlcpy(limfile, cptr+4, FILENAME_MAX);
continue;
160 }
else if(strcasecmp(cptr,
"LIM")==0) {
161 strcpy(limfile,
"stdout");
continue;
162 }
else if(strcasecmp(cptr,
"LK3")==0) {
163 lambda_k3=1;
continue;
164 }
else if(strncasecmp(cptr,
"R=", 2)==0 && strlen(cptr)>2) {
165 strlcpy(refname, cptr+2, FILENAME_MAX);
continue;
166 }
else if(strncasecmp(cptr,
"Vb=", 3)==0 && strlen(cptr)>3) {
168 if(fVb>=0.0 && fVb<1.0) {
169 if(fVb<0.01) fprintf(stderr,
"Warning: Vb was set to %g%%\n", 100.*fVb);
170 def_pmin[3]=def_pmax[3]=fVb;
174 }
else if(strncasecmp(cptr,
"FIT=", 4)==0) {
175 strlcpy(ffile, cptr+4, FILENAME_MAX);
if(strlen(ffile)>0)
continue;
176 }
else if(strncasecmp(cptr,
"SVG=", 4)==0) {
177 strlcpy(svgfile, cptr+4, FILENAME_MAX);
if(strlen(svgfile)>0)
continue;
179 fprintf(stderr,
"Error: invalid option '%s'.\n", argv[ai]);
184 if(help==2) {
tpcHtmlUsage(argv[0], info,
"");
return(0);}
189 for(; ai<argc; ai++) {
191 strlcpy(pfile, argv[ai], FILENAME_MAX);
continue;
192 }
else if(!bfile[0]) {
193 strlcpy(bfile, argv[ai], FILENAME_MAX);
continue;
194 }
else if(!dfile[0]) {
195 strlcpy(dfile, argv[ai], FILENAME_MAX);
continue;
196 }
else if(fitdur<0) {
198 fprintf(stderr,
"Error: invalid fit time '%s'.\n", argv[ai]);
200 }
else if(!rfile[0]) {
201 strlcpy(rfile, argv[ai], FILENAME_MAX);
continue;
204 fprintf(stderr,
"Error: too many arguments: '%s'.\n", argv[ai]);
207 if(doSD || doCL) doBootstrap=1;
else doBootstrap=0;
211 printf(
"pfile := %s\n", pfile);
212 printf(
"dfile := %s\n", dfile);
213 printf(
"rfile := %s\n", rfile);
214 printf(
"ffile := %s\n", ffile);
215 printf(
"svgfile := %s\n", svgfile);
216 printf(
"limfile := %s\n", limfile);
217 printf(
"refname := %s\n", refname);
218 printf(
"lambda_k3 := %d\n", lambda_k3);
219 printf(
"fitdur := %g\n", fitdur);
220 printf(
"doBootstrap := %d\n", doBootstrap);
221 printf(
"doSD := %d\n", doSD);
222 printf(
"doCL := %d\n", doCL);
227 if(limfile[0] && !pfile[0]) {
229 if(strcasecmp(limfile,
"stdout")!=0 && access(limfile, 0) != -1) {
230 fprintf(stderr,
"Error: parameter constraint file %s exists.\n", limfile);
233 if(verbose>1 && strcasecmp(limfile,
"stdout")!=0)
234 printf(
"writing parameter constraints file\n");
246 fprintf(stderr,
"Error in writing '%s': %s\n", limfile, ift.
status);
249 if(strcasecmp(limfile,
"stdout")!=0)
250 fprintf(stdout,
"Parameter file %s with initial values written.\n", limfile);
255 if(fitdur==0) fitdur=1.0E+100;
256 else if(fitdur<0) {
tpcPrintUsage(argv[0], info, stderr);
return(1);}
258 fprintf(stderr,
"Error: missing command-line argument; use option --help\n");
268 if(verbose>1) printf(
"reading %s\n", limfile);
269 ret=
iftRead(&ift, limfile, 1, 0);
271 fprintf(stderr,
"Error in reading '%s': %s\n", limfile, ift.
status);
274 if(verbose>10)
iftWrite(&ift,
"stdout", 0);
289 if(n==0) {fprintf(stderr,
"Error: invalid parameter file.\n");
return(9);}
292 for(pi=n=0, ret=0; pi<parNr; pi++) {
293 if(def_pmin[pi]<0.0) ret++;
294 if(def_pmax[pi]<def_pmin[pi]) ret++;
295 if(def_pmax[pi]>def_pmin[pi]) n++;
298 fprintf(stderr,
"Error: invalid parameter constraints.\n");
302 fprintf(stderr,
"Error: no model parameters left free for fitting.\n");
307 if(fVb>=0.0) def_pmin[3]=def_pmax[3]=fVb;
308 if(def_pmin[3]==def_pmax[3]) fVb=def_pmin[3];
309 if(fVb==0.0) strcpy(bfile,
"");
311 printf(
"bfile := %s\n", bfile);
312 if(fVb>=0.0) printf(
"fVb := %g\n", fVb);
319 if(verbose>1) printf(
"reading tissue and input data\n");
321 &fitframeNr, &dft, &input, stdout, verbose-2, tmp);
323 fprintf(stderr,
"Error: %s\n", tmp);
326 if(fitframeNr<4 || input.
frameNr<4) {
327 fprintf(stderr,
"Error: too few samples in specified fit duration.\n");
332 if(verbose>2) printf(
"setting blood tac to zero\n");
335 fprintf(stderr,
"Error: cannot allocate more memory.\n");
340 for(fi=0; fi<input.
frameNr; fi++) input.
voi[1].
y[fi]=0.0;
347 fprintf(stdout,
"common_data_weights := %g", dft.
w[0]);
348 for(fi=1; fi<dft.
frameNr; fi++) fprintf(stdout,
", %g", dft.
w[fi]);
349 fprintf(stdout,
"\n");
358 if(verbose>1) printf(
"no reference region data\n");
361 if(verbose>1) printf(
"reading reference region data\n");
362 if((n=
dftReadReference(&dft, refname, &inputtype, &ref, tmp, verbose-3))<1) {
363 fprintf(stderr,
"Error in reading '%s': %s\n", refname, tmp);
364 if(verbose>2) printf(
"dftReadReference()=%d\n", n);
369 fprintf(stderr,
"Warning: %s selected of %d reference regions.\n",
372 fprintf(stdout,
"selected reference region := %s\n", dft.
voi[ref].
name);
375 refAdded=0; strcpy(refname,
"");
380 if(verbose>1) printf(
"Reference region: %s\n", dft.
voi[ref].
name );
386 fprintf(stderr,
"Error: cannot allocate more memory.\n");
398 if(verbose>1) printf(
"initializing result data\n");
400 fprintf(stderr,
"Error: cannot setup memory for results.\n");
409 if(refname[0]) strcpy(res.
reffile, refname);
413 if(fVb>=0.0) res.
Vb=100.0*fVb;
422 pi=0; strcpy(res.
parname[pi],
"K1"); strcpy(res.
parunit[pi],
"ml/(min*ml)");
423 pi++; strcpy(res.
parname[pi],
"K1/k2"); strcpy(res.
parunit[pi],
"");
424 pi++; strcpy(res.
parname[pi],
"k3"); strcpy(res.
parunit[pi],
"1/min");
425 pi++; strcpy(res.
parname[pi],
"Vb"); strcpy(res.
parunit[pi],
"%");
426 pi++; strcpy(res.
parname[pi],
"Ki"); strcpy(res.
parunit[pi],
"ml/(min*ml)");
427 pi++; strcpy(res.
parname[pi],
"k3*K1/k2"); strcpy(res.
parunit[pi],
"1/min");
428 pi++; strcpy(res.
parname[pi],
"k3/(k2+k3)"); strcpy(res.
parunit[pi],
"");
429 pi++; strcpy(res.
parname[pi],
"WSS"); strcpy(res.
parunit[pi],
"");
430 pi++; strcpy(res.
parname[pi],
"AIC"); strcpy(res.
parunit[pi],
"");
436 if(ref>=0)
for(ri=0; ri<dft.
voiNr; ri++)
if(dft.
voi[ri].
sw>0) {
438 fprintf(stdout,
"fitting %s as reference region\n", dft.
voi[ri].
name);
440 petmeas=dft.
voi[ri].
y; petsim=dft.
voi[ri].
y2;
442 pmin[0]=def_pmin[0]; pmax[0]=def_pmax[0];
443 pmin[1]=def_pmin[1]; pmax[1]=def_pmax[1];
444 pmin[2]=def_pmin[2]; pmax[2]=def_pmax[2];
445 pmin[3]=def_pmin[3]; pmax[3]=def_pmax[3];
446 for(pi=fittedparNr=0; pi<parNr; pi++)
if(pmax[pi]>pmin[pi]) fittedparNr++;
448 printf(
" ref_constraints :=");
449 for(pi=0; pi<parNr; pi++) printf(
" [%g,%g]", pmin[pi], pmax[pi]);
451 printf(
"fittedparNr := %d\n", fittedparNr);
457 tgoNr=50+25*fittedparNr;
458 neighNr=6*fittedparNr;
460 pmin, pmax, cm3Func, NULL, parNr, neighNr,
463 fprintf(stderr,
"Error in optimization (%d).\n", ret);
474 if(verbose>2) {fprintf(stdout,
" K1/k2 := %g\n", fk1k2);}
478 if(verbose>2) printf(
" bootstrapping\n");
481 if(doSD) sd=res.
voi[ri].
sd;
else sd=NULL;
482 if(doCL) {cl1=res.
voi[ri].
cl1; cl2=res.
voi[ri].
cl2;}
else cl1=cl2=NULL;
492 parNr, dft.
w, cm3Func, tmp, verbose-4
495 fprintf(stderr,
"Error in bootstrap: %s\n", tmp);
496 for(pi=0; pi<parNr; pi++) {
497 if(doSD) sd[pi]=nan(
"");
498 if(doCL) cl1[pi]=cl2[pi]=nan(
"");
503 for(pi=n=0; pi<parNr; pi++)
if(pmax[pi]>pmin[pi]) n++;
504 if(verbose>2) printf(
"nr_of_fitted_parameters := %d\n", n);
505 for(fi=m=0; fi<fitframeNr; fi++)
if(dft.
w[fi]>0.0) m++;
506 if(verbose>2) printf(
"nr_of_fitted_samples := %d\n", m);
507 aic=
aicSS(wss, m, n);
515 if(doSD) res.
voi[ri].
sd[3]*=100.;
516 if(doCL) {res.
voi[ri].
cl1[3]*=100.; res.
voi[ri].
cl2[3]*=100.;}
534 if(verbose>0) {fprintf(stdout,
"fitting regional TACs: "); fflush(stdout);}
535 if(verbose>1) printf(
"\n");
536 for(ri=0; ri<dft.
voiNr; ri++)
if(dft.
voi[ri].
sw==0) {
537 if(verbose>2) printf(
"\n %d %s:\n", ri, dft.
voi[ri].
name);
540 petmeas=dft.
voi[ri].
y; petsim=dft.
voi[ri].
y2;
543 pmin[0]=def_pmin[0]; pmax[0]=def_pmax[0];
544 pmin[1]=def_pmin[1]; pmax[1]=def_pmax[1];
546 pmin[1]=pmax[1]=fk1k2;
548 pmin[2]=def_pmin[2]; pmax[2]=def_pmax[2];
549 pmin[3]=def_pmin[3]; pmax[3]=def_pmax[3];
550 for(pi=fittedparNr=0; pi<parNr; pi++)
if(pmax[pi]>pmin[pi]) fittedparNr++;
552 printf(
" constraints :=");
553 for(pi=0; pi<parNr; pi++) printf(
" [%g,%g]", pmin[pi], pmax[pi]);
555 printf(
"fittedparNr := %d\n", fittedparNr);
562 tgoNr=50+25*fittedparNr;
563 neighNr=6*fittedparNr;
566 pmin, pmax, cm3Func, NULL, parNr, 5,
569 fprintf(stderr,
"\nError in optimization (%d).\n", ret);
579 if(verbose>2) printf(
" bootstrapping\n");
582 if(doSD) sd=res.
voi[ri].
sd;
else sd=NULL;
583 if(doCL) {cl1=res.
voi[ri].
cl1; cl2=res.
voi[ri].
cl2;}
else cl1=cl2=NULL;
593 parNr, dft.
w, cm3Func, tmp, verbose-4
596 fprintf(stderr,
"Error in bootstrap: %s\n", tmp);
597 for(pi=0; pi<parNr; pi++) {
598 if(doSD) sd[pi]=nan(
"");
599 if(doCL) cl1[pi]=cl2[pi]=nan(
"");
605 for(pi=n=0; pi<parNr; pi++)
if(pmax[pi]>pmin[pi]) n++;
606 if(verbose>2) printf(
"nr_of_fitted_parameters := %d\n", n);
607 for(fi=m=0; fi<fitframeNr; fi++)
if(dft.
w[fi]>0.0) m++;
608 if(verbose>2) printf(
"nr_of_fitted_samples := %d\n", m);
609 aic=
aicSS(wss, m, n);
617 if(doSD) res.
voi[ri].
sd[3]*=100.;
618 if(doCL) {res.
voi[ri].
cl1[3]*=100.; res.
voi[ri].
cl2[3]*=100.;}
631 if(dft.
voiNr>2 && verbose==1) {fprintf(stdout,
"."); fflush(stdout);}
634 if(verbose>0) {fprintf(stdout,
"\n"); fflush(stdout);}
640 if(verbose>0) {
resPrint(&res); fprintf(stdout,
"\n");}
646 if(verbose>1) printf(
"saving results\n");
647 ret=
resWrite(&res, rfile, verbose-3);
649 fprintf(stderr,
"Error in writing '%s': %s\n", rfile,
reserrmsg);
653 if(verbose>0) fprintf(stdout,
"Model parameters written in %s\n", rfile);
658 if(svgfile[0] || ffile[0]) {
665 fprintf(stderr,
"Error: cannot save fitted curves.\n");
669 for(ri=0; ri<dft.
voiNr; ri++)
for(fi=0; fi<fitframeNr; fi++)
675 if(verbose>1) printf(
"saving SVG plot\n");
676 sprintf(tmp,
"K1-k3 fit: ");
679 0.0, nan(
""), svgfile, verbose-8);
681 fprintf(stderr,
"Error (%d) in writing '%s'.\n", ret, svgfile);
685 if(verbose>0) printf(
"Plots written in %s\n", svgfile);
690 for(ri=dft2.
voiNr-1; ri>=0; ri--)
if(dft2.
voi[ri].
sw!=0)
696 if(verbose>1) printf(
"saving fitted curves\n");
698 sprintf(dft2.
comments,
"# program := %s\n", tmp);
700 fprintf(stderr,
"Error in writing '%s': %s\n", ffile,
dfterrmsg);
704 if(verbose>0) printf(
"Fitted TACs written in %s\n", ffile);
720double cm3Func(
int parNr,
double *p,
void *fdata)
723 double Vb, k2, k3, d, wss=0.0;
731 k2=pa[0]/pa[1]; k3=pa[2];
if(fVb>=0.0) Vb=fVb;
else Vb=pa[3];
736 pa[0], k2, k3, 0.0, 0.0, 0.0, 0.0, Vb, 1.0,
737 input.
voi[0].
y2, NULL, NULL, NULL, NULL, NULL);
739 printf(
"error %d in simulation\n", ret);
747 dft.
x1, dft.
x2, petsim, NULL, NULL, fitframeNr);
751 dft.
x, petsim, NULL, NULL, fitframeNr);
753 printf(
"error %d in interpolation\n", ret);
758 for(fi=0, wss=0.0; fi<fitframeNr; fi++)
if(dft.
w[fi]>0.0) {
759 d=petmeas[fi]-petsim[fi];
764 if(0) printf(
"K1=%g k2=%g k3=%g Vb=%g => %g\n",
765 pa[0], k2, pa[2], Vb, wss);
double aicSS(double ss, const int n, const int k)
int bootstrap(int iterNr, double *cLim1, double *cLim2, double *SD, double *parameter, double *lowlim, double *uplim, int frameNr, double *origTac, double *fitTac, double *bsTac, int parNr, double *weight, double(*objf)(int, double *, void *), char *status, int verbose)
int modelCheckParameters(int par_nr, double *lower_p, double *upper_p, double *test_p, double *accept_p, double *penalty)
int atof_with_check(char *double_as_string, double *result_value)
double atof_dpi(char *str)
int dftdup(DFT *dft1, DFT *dft2)
int dftAddmem(DFT *dft, int voiNr)
int dftDelete(DFT *dft, int voi)
int dftWrite(DFT *data, char *filename)
int res_allocate_with_dft(RES *res, DFT *dft)
int iftPutDouble(IFT *ift, char *key, double value, char *cmt_type, int verbose)
int iftRead(IFT *ift, char *filename, int is_key_required, int verbose)
int iftWrite(IFT *ift, char *filename, int verbose)
int iftGetDoubleValue(IFT *ift, int si, const char *key, double *value, int verbose)
int interpolate(double *x, double *y, int nr, double *newx, double *newy, double *newyi, double *newyii, int newnr)
Linear interpolation and integration.
int interpolate4pet(double *x, double *y, int nr, double *newx1, double *newx2, double *newy, double *newyi, double *newyii, int newnr)
Interpolate and integrate TAC to PET frames.
Header file for libtpccurveio.
int resWrite(RES *res, char *filename, int verbose)
#define DFT_TIME_STARTEND
Header file for libtpcmisc.
int tpcProcessStdOptions(const char *s, int *print_usage, int *print_version, int *verbose_level)
size_t strlcpy(char *dst, const char *src, size_t dstsize)
void tpcProgramName(const char *program, int version, int copyright, char *prname, int n)
int tpcHtmlUsage(const char *program, char *text[], const char *path)
void tpcPrintBuild(const char *program, FILE *fp)
void tpcPrintUsage(const char *program, char *text[], FILE *fp)
Header file for libtpcmodel.
int simC3vs(double *t, double *ca, double *cb, int nr, double k1, double k2, double k3, double k4, double k5, double k6, double f, double vb, double fa, double *cpet, double *cta, double *ctb, double *ctc, double *ctab, double *ctvb)
int tgo(double *lowlim, double *uplim, double(*objf)(int, double *, void *), void *objfData, int dim, int neighNr, double *fmin, double *gmin, int samNr, int tgoNr, int verbose)
Header file for libtpcmodext.
int plot_fitrange_svg(DFT *dft1, DFT *dft2, char *main_title, double x1, double x2, double y1, double y2, char *fname, int verbose)
Header file for libtpcsvg.
char studynr[MAX_STUDYNR_LEN+1]
char comments[_DFT_COMMENT_LEN+1]
char parname[MAX_RESPARAMS][MAX_RESPARNAME_LEN+1]
char plasmafile[FILENAME_MAX]
char datafile[FILENAME_MAX]
char reffile[FILENAME_MAX]
char parunit[MAX_RESPARAMS][MAX_RESPARNAME_LEN+1]
char bloodfile[FILENAME_MAX]
double parameter[MAX_RESPARAMS]
double cl2[MAX_RESPARAMS]
double cl1[MAX_RESPARAMS]
char voiname[MAX_REGIONSUBNAME_LEN+1]
char name[MAX_REGIONNAME_LEN+1]