Header file for libtpcmodels. More...

#include "tpcclibConfig.h"
#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <math.h>
#include "tpcextensions.h"

Enumerations
enum	mf { MF_UNKNOWN =0 , MF_LEVEL =100 , MF_LINE =101 , MF_POL2 , MF_POL3 , MF_POL4 , MF_POL5 , MF_POL6 , MF_POL7 , MF_POL8 , MF_POL9 , MF_RATF11 =211 , MF_RATF21 =221 , MF_RATF22 =222 , MF_RATF32 =232 , MF_RATF33 =233 , MF_EXP1 =301 , MF_EXP2 =302 , MF_EXP3 , MF_EXP4 , MF_EXP5 , MF_LUNDQVIST =321 , MF_LUNDQVIST2 , MF_LUNDQVIST3 , MF_EXPBOLUSINF =331 , MF_EXPBOLUSINF_RW =332 , MF_EXPBOLUSINF_AZ =334 , MF_PK11195 =351 , MF_HILL =841 , MF_1MHILL =842 , MF_1MHILL_ADE =843 , MF_HILL_B =844 , MF_AMHILL =845 , MF_EHILL_PAR =846 , MF_EHILL_MET =847 , MF_MAMEDE =851 , MF_1MMAMEDE , MF_MAYER_PAR =861 , MF_MAYER_MET , MF_EMAYER_PAR , MF_EMAYER_MET , MF_HILL3M_PAR =871 , MF_HILL3M_M1 , MF_HILL3M_M2 , MF_HILL3M_M3 , MF_PF3M_PAR =881 , MF_PF3M_M1 , MF_PF3M_M2 , MF_PF3M_M3 , MF_STEP =1010 , MF_RATF33D =1232 , MF_FENGM2S =1312 , MF_FENGM2 =1313 , MF_FENGM2E =1314 , MF_GAMMAV =1401 , MF_GAMMAVB =1402 , MF_WEIBULLCDF_D =1421 , MF_WEIBULLCDF_DD =1423 , MF_SURGE =1431 , MF_SURGE_TRAD =1432 , MF_SURGE_RECIRC =1433 , MF_P2B_SRC =1434 , MF_SURGE_FDG =1435 , MF_HILL_D =1801 , MF_HILL_DD =1811 , MF_HILL_SDD =1821 , MF_IMGPROFILE =2111 , MF_P2B_RF =2233 , MF_P2B_FM2 =2313 , MF_P2B_HILL =2841 , MF_GRAHAM_INP =9501 , MF_GRAHAM_EINP , MF_GRAHAM_INPM , MF_HUANG_MET =9601 , MF_CARSON_EMET , MF_NEW_MET , MF_MLMCM =9701 , MF_LAST }
	Deprecated identification codes of mathematical functions fitted to PET data. More...
enum	optimality_criterion { OPTCRIT_UNKNOWN , OPTCRIT_OLS , OPTCRIT_LMS , OPTCRIT_LAD , OPTCRIT_MAD , OPTCRIT_ODR , OPTCRIT_LAST }
	Optimality Criterion for statistical optimizations. More...

Functions
double	aicSS (double ss, const unsigned int n, const unsigned int k)
	Calculate corrected AIC.
unsigned int	parFreeNr (const unsigned int n, double pLower, double pUpper)
	Calculate the number of free parameters.
unsigned int	modelNr ()
char *	modelCode (const unsigned int i)
unsigned int	modelOldId (const unsigned int i)
unsigned int	modelOld2New (const unsigned int i)
char *	modelDesc (const unsigned int i)
unsigned int	modelCodeIndex (const char *s)
unsigned int	modelParNr (const unsigned int code)
unsigned int	optcritNr ()
char *	optcritCode (optimality_criterion id)
char *	optcritDesc (optimality_criterion id)
optimality_criterion	optcritId (const char *s)

Detailed Description

Header file for libtpcmodels.

Header file for model description library.

Author: Vesa Oikonen

Copyright: (c) Turku PET Centre

Definition in file tpcmodels.h.

Enumeration Type Documentation

◆ mf

enum mf

Deprecated identification codes of mathematical functions fitted to PET data.

Note: Do not change the existing id codes, because these are used in some data files to specify the applied function.

Definition at line 27 of file tpcmodels.h.

               {
  MF_UNKNOWN=0,
  MF_LEVEL=100,
  MF_LINE=101, 
  MF_POL2, MF_POL3, MF_POL4, MF_POL5, MF_POL6, MF_POL7, MF_POL8, MF_POL9,
  MF_RATF11=211, MF_RATF21=221, MF_RATF22=222, MF_RATF32=232, MF_RATF33=233,
  MF_EXP1=301, MF_EXP2=302, MF_EXP3, MF_EXP4, MF_EXP5,
  MF_LUNDQVIST=321, MF_LUNDQVIST2, MF_LUNDQVIST3,
  MF_EXPBOLUSINF=331,
  MF_EXPBOLUSINF_RW=332,
  MF_EXPBOLUSINF_AZ=334,
  MF_PK11195=351,
  MF_HILL=841, MF_1MHILL=842, MF_1MHILL_ADE=843,
  MF_HILL_B=844, MF_AMHILL=845,
  MF_EHILL_PAR=846, MF_EHILL_MET=847,
  MF_MAMEDE=851, MF_1MMAMEDE,
  MF_MAYER_PAR=861, MF_MAYER_MET, MF_EMAYER_PAR, MF_EMAYER_MET,
  MF_HILL3M_PAR=871, MF_HILL3M_M1, MF_HILL3M_M2, MF_HILL3M_M3,
  MF_PF3M_PAR=881, MF_PF3M_M1, MF_PF3M_M2, MF_PF3M_M3,
  MF_STEP=1010,
  MF_RATF33D=1232,
  MF_FENGM2S=1312, MF_FENGM2=1313, MF_FENGM2E=1314,
  MF_GAMMAV=1401, MF_GAMMAVB=1402,
  MF_WEIBULLCDF_D=1421, MF_WEIBULLCDF_DD=1423,
  MF_SURGE=1431, MF_SURGE_TRAD=1432, MF_SURGE_RECIRC=1433, MF_P2B_SRC=1434, MF_SURGE_FDG=1435,
  MF_HILL_D=1801, MF_HILL_DD=1811, MF_HILL_SDD=1821,
  MF_IMGPROFILE=2111,
  MF_P2B_RF=2233, MF_P2B_FM2=2313, MF_P2B_HILL=2841,
  MF_GRAHAM_INP=9501, MF_GRAHAM_EINP, MF_GRAHAM_INPM,
  MF_HUANG_MET=9601,
  MF_CARSON_EMET,
  MF_NEW_MET,
  MF_MLMCM=9701,
  MF_LAST
} mf;

◆ optimality_criterion

enum optimality_criterion

Optimality Criterion for statistical optimizations.

Enumerator
OPTCRIT_UNKNOWN	Unknown optimality criterion.
OPTCRIT_OLS	Ordinary Least Squares (sum-of-squares, SS).
OPTCRIT_LMS	Least Median of Squares.
OPTCRIT_LAD	Least Absolute Deviations (sum of absolute deviations, LAE, LAV, LAR).
OPTCRIT_MAD	Median Absolute Deviation.
OPTCRIT_ODR	Orthogonal Distance Regression (sum of perpendicular distances).
OPTCRIT_LAST	List end.

Definition at line 66 of file tpcmodels.h.

             {
  OPTCRIT_UNKNOWN, 
  OPTCRIT_OLS, 
  OPTCRIT_LMS, 
  OPTCRIT_LAD, 
  OPTCRIT_MAD, 
  OPTCRIT_ODR, 
  OPTCRIT_LAST 
} optimality_criterion;

Function Documentation

◆ aicSS()

double aicSS	(	double	ss,
		const unsigned int	n,
		const unsigned int	k )

extern

Calculate corrected AIC.

Calculate AICc in the special case of sum-of-squares optimization from the SS, number of fitted samples, and number of fitted parameters.

If variance is different between the data points, weighted SS must be given.

See also: parFreeNr, tacWSampleNr

Returns: Returns the AIC value, or NaN in case of invalid input values.

Parameters

ss	Sum-of-Squares of the fit (weighted, if necessary).
n	Sample size, i.e. number of fitted samples; do not include samples with zero weight.
k	Number of fitted model parameters; do not include fixed parameters; AICc calculation is valid only when (n-k)>1.

Definition at line 29 of file aic.c.

  {
  if(!(ss>=0.0) || n<1 || (n-k)<2) return(nan(""));
 
  int dr=n-k-1; 
  int dv=2*k*(k+1);
  double aic=0.0, bias_adj=0.0, css;
  if(dr>0) bias_adj=((double)dv)/((double)dr); else bias_adj=0.0;
  if(ss<1.0e-50) css=1.0e-50; else css=ss; /* Because log(0) is an error */
  aic= n*log(css/(double)n) + 2.0*(double)k + bias_adj;
  return(aic);
}

◆ modelCode()

char * modelCode ( const unsigned int i )

extern

Get string representation of a model code.

Returns: pointer to string representation of the code, or NULL if not identified.

Author: Vesa Oikonen

See also: modelDesc, modelCodeIndex, modelNr

Parameters

i	model list index.

Definition at line 175 of file modell.c.

  {
  if(i>=modelNr()) return((char*)NULL);
  return(tpc_model[i].code);
}

Referenced by mfCreateTAC(), parWriteCSV(), and parWriteXML().

◆ modelCodeIndex()

unsigned int modelCodeIndex ( const char * s )

extern

Get model index for the string representation of model code.

Returns: index number, 0, if unknown model code.

Author: Vesa Oikonen

See also: modelCode, modelDesc

Parameters

s	model code as a string; code is case-insensitive, but otherwise exact match is required.

Definition at line 236 of file modell.c.

  {
  if(s==NULL || *s=='\0') return(0);
  unsigned int i=0;
  while(tpc_model[i].code[0]!='\0') {
    if(!strcasecmp(tpc_model[i].code, s)) return(i);
    i++;
  }
  return(0);
}

Referenced by parExamplePerfectBolus(), parExampleRadiowaterBolus(), parExampleTTACs(), and parReadCSV().

◆ modelDesc()

char * modelDesc ( const unsigned int i )

extern

Get description of a model.

Returns: pointer to string, or NULL if not identified.

Author: Vesa Oikonen

See also: modelCode

Parameters

i	model list index.

Definition at line 221 of file modell.c.

  {
  if(i>=modelNr()) return((char*)NULL);
  return(tpc_model[i].desc);
}

◆ modelNr()

unsigned int modelNr ( )

extern

Number of listed models.

Returns: Nr of models.

Definition at line 161 of file modell.c.

{
  unsigned int i=0;
  while(tpc_model[i].code[0]!='\0') i++;
  return(i);
}

Referenced by modelCode(), modelDesc(), modelOld2New(), and modelParNr().

◆ modelOld2New()

unsigned int modelOld2New ( const unsigned int i )

extern

Convert the deprecated function id to the model list index.

Returns: model/function list index, or 0 if not identified.

Author: Vesa Oikonen

See also: modelOldId, modelCode, modelCodeIndex, modelNr

Parameters

i	Deprecated function id.

Definition at line 204 of file modell.c.

  {
  unsigned int n=modelNr();
  if(i==0) return(0);
  for(unsigned int j=1; j<n; j++) if(tpc_model[j].id==i) return(j);
  return(0);
}

Referenced by parReadFIT().

◆ modelOldId()

unsigned int modelOldId ( const unsigned int i )

extern

Get the deprecated function id for working with older file formats.

Returns: function id, or 0 if not identified.

Author: Vesa Oikonen

See also: modelOld2New, modelCode, modelCodeIndex, modelNr

Parameters

i	model list index.

Definition at line 190 of file modell.c.

  {
  return(tpc_model[i].id);
}

Referenced by parWriteFIT().

◆ modelParNr()

unsigned int modelParNr ( const unsigned int code )

extern

Get model parameter number.

Returns: parameter number, or 0 if invalid model code.

Author: Vesa Oikonen

Parameters

code	model code; can be retrieved using modelCodeIndex().

Definition at line 255 of file modell.c.

  {
  if(code<1 || code>=modelNr()) return(0);
  return(tpc_model[code].parNr);
}

Referenced by mfCreateTAC(), parExamplePerfectBolus(), parExampleRadiowaterBolus(), and parExampleTTACs().

◆ optcritCode()

char * optcritCode ( optimality_criterion id )

extern

Get string representation of an optimality criterion.

Returns: pointer to string representation of the code, or NULL if not identified.

See also: optcritDesc, optcritId, modelCode

Parameters

id	Optimality criterion.

Definition at line 60 of file optcrit.c.

  {
  for(unsigned int i=0; i<optcritNr(); i++) if(id==tpc_optcrit[i].id) return(tpc_optcrit[i].code);
  return((char*)NULL);
}

◆ optcritDesc()

char * optcritDesc ( optimality_criterion id )

extern

Get description of an optimality criterion.

Returns: pointer to string, or NULL if not identified.

See also: optcritCode, optcritId

Parameters

id	Optimality criterion.

Definition at line 74 of file optcrit.c.

  {
  for(unsigned int i=0; i<optcritNr(); i++) if(id==tpc_optcrit[i].id) return(tpc_optcrit[i].desc);
  return((char*)NULL);
}

◆ optcritId()

optimality_criterion optcritId ( const char * s )

extern

Get the Id for the string representation of optimality criterion code string.

Returns: Enumerated optimality criterion id, OPTCRIT_UNKNOWN, if unknown code.

See also: optcritCode, optcritDesc

Parameters

s	Optimality criterion code string; code is case-insensitive, but otherwise exact match is required.

Definition at line 88 of file optcrit.c.

  {
  if(s==NULL || *s=='\0') return(OPTCRIT_UNKNOWN);
  for(unsigned int i=0; i<optcritNr(); i++) 
    if(!strcasecmp(tpc_optcrit[i].code, s)) return(tpc_optcrit[i].id);
  /* Try also some alternative names */
  if(!strcasecmp("SS", s)) return(OPTCRIT_OLS);
  if(!strcasecmp("WSS", s)) return(OPTCRIT_OLS);
  if(!strcasecmp("SUMSQR", s)) return(OPTCRIT_OLS);
  if(!strcasecmp("LAE", s)) return(OPTCRIT_LAD);
  if(!strcasecmp("LAV", s)) return(OPTCRIT_LAD);
  if(!strcasecmp("LAR", s)) return(OPTCRIT_LAD);
  if(!strcasecmp("Deming", s)) return(OPTCRIT_ODR);
  return(OPTCRIT_UNKNOWN);
}

◆ optcritNr()

unsigned int optcritNr ( )

extern

Number of optimality criteria.

Returns: Nr of criteria.

Definition at line 47 of file optcrit.c.

{
  unsigned int i=0;
  while(tpc_optcrit[i].code[0]!='\0') i++;
  return(i);
}

Referenced by optcritCode(), optcritDesc(), and optcritId().

◆ parFreeNr()

unsigned int parFreeNr	(	const unsigned int	n,
		double *	pLower,
		double *	pUpper )

extern

Calculate the number of free parameters.

Model parameters can be fixed by setting lower and upper limit to equal values. This function simply checks the limits for each parameter.

Returns: Returns the number of free parameters.

Author: Vesa Oikonen

See also: aicSS, tacWSampleNr

Parameters

n	Nr of parameters
pLower	Lower limits (array of length n)
pUpper	Upper limits (array of length n)

Definition at line 60 of file aic.c.

  {
  if(n==0 || pLower==NULL || pUpper==NULL) return(0);
  unsigned int nf=0;
  for(unsigned int i=0; i<n; i++) {
    double range=pUpper[i]-pLower[i];
    if(range>1.0E-10) nf++;
  }
  return(nf);
}

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ mf

◆ optimality_criterion

Function Documentation

◆ aicSS()

◆ modelCode()

◆ modelCodeIndex()

◆ modelDesc()

◆ modelNr()

◆ modelOld2New()

◆ modelOldId()

◆ modelParNr()

◆ optcritCode()

◆ optcritDesc()

◆ optcritId()

◆ optcritNr()

◆ parFreeNr()