CASToR  3.2
Tomographic Reconstruction (PET/SPECT/CT)
code/include/dynamic/iDynamicModelTemplate.hh
Go to the documentation of this file.
1 
8 #ifndef IDYNAMICMODELTEMPLATE_HH
9 #define IDYNAMICMODELTEMPLATE_HH 1
10 
11 // Mother class of dynamic model
12 #include "vDynamicModel.hh"
13 // Required to automatically add the class in the CASToR code
14 #include "sAddonManager.hh"
15 
22 {
23  // -----------------------------------------------------------------------------------------
24  // Constructor & Destructor
25  public:
36 
37 
38  // -----------------------------------------------------------------------------------------
39  // Public member functions related to the initialization of the model
40  public:
41  // Function for automatic insertion (put the class name as the parameters and do not add semi-colon at the end of the line)
62  int ReadAndCheckOptionsList(string a_listOptions);
69  int InitializeSpecific();
74  void ShowHelpModelSpecific();
75 
76 
77  // -----------------------------------------------------------------------------------------
78  // Public member functions called by the main iterative algorithm class
87  int EstimateModelParameters(oImageSpace* ap_Image, int a_ite, int a_sset);
96  int EstimateImageWithModel(oImageSpace* ap_Image, int a_ite, int a_sset);
103  //int SaveParametricImages(int a_iteration, int a_subset = -1);
104 
105 
106  // -----------------------------------------------------------------------------------------
107  // Data members
108  protected:
111 };
112 
113 // Class for automatic insertion (set here the visible dynamic model's name, put the class name as the parameters and do not add semi-colon at the end of the line)
115 
116 #endif
int InitializeSpecific()
This function is used to initialize the model parametric images and basis functions.
This is the mother class of dynamic model classes.
This class is a child of the vDynamicModel class implementing a template squeleton.
iDynamicModelTemplate()
Constructor of iDynamicModelTemplate. Simply set all data members to default values.
int ReadAndCheckConfigurationFileSpecific()
This function is used to read options from a configuration file.
int CheckSpecificParameters()
This function is used to check whether all member variables have been correctly initialized or not...
int EstimateModelParameters(oImageSpace *ap_Image, int a_ite, int a_sset)
#define FUNCTION_DYNAMICMODEL(CLASS)
int EstimateImageWithModel(oImageSpace *ap_Image, int a_ite, int a_sset)
#define CLASS_DYNAMICMODEL(NAME, CLASS)
This class holds all the matrices in the image domain that can be used in the algorithm: image...
Declaration of class vDynamicModel.
int ReadAndCheckOptionsList(string a_listOptions)
void ShowHelpModelSpecific()
This function is used to print out specific help about the dynamic model and its options. It is pure virtual so must be implemented by children.
~iDynamicModelTemplate()
Destructor of iDynamicModelTemplate.