CASToR  2.0
Tomographic Reconstruction (PET/SPECT/CT)
 All Classes Files Functions Variables Typedefs Enumerations Enumerator Macros Groups Pages
iDynamicModelTemplate.hh
Go to the documentation of this file.
1 /*
2 This file is part of CASToR.
3 
4  CASToR is free software: you can redistribute it and/or modify it under the
5  terms of the GNU General Public License as published by the Free Software
6  Foundation, either version 3 of the License, or (at your option) any later
7  version.
8 
9  CASToR is distributed in the hope that it will be useful, but WITHOUT ANY
10  WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
11  FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
12  details.
13 
14  You should have received a copy of the GNU General Public License along with
15  CASToR (in file GNU_GPL.TXT). If not, see <http://www.gnu.org/licenses/>.
16 
17 Copyright 2017-2018 all CASToR contributors listed below:
18 
19  --> current contributors: Thibaut MERLIN, Simon STUTE, Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Mael MILLARDET
20  --> past contributors: Valentin VIELZEUF
21 
22 This is CASToR version 2.0.
23 */
24 
31 #ifndef IPATLAKMODEL_HH
32 #define IPATLAKMODEL_HH 1
33 
34 // Mother class of dynamic model
35 #include "vDynamicModel.hh"
36 // Required to automatically add the class in the CASToR code
37 #include "sAddonManager.hh"
38 
45 {
46  // -----------------------------------------------------------------------------------------
47  // Constructor & Destructor
48  public:
59 
60 
61  // -----------------------------------------------------------------------------------------
62  // Public member functions related to the initialization of the model
63  public:
64  // Function for automatic insertion (put the class name as the parameters and do not add semi-colon at the end of the line)
79  int ReadAndCheckConfigurationFile(string a_fileOptions);
86  int ReadAndCheckOptionsList(string a_listOptions);
93  int Initialize();
98  void ShowHelp();
99 
100 
101  // -----------------------------------------------------------------------------------------
102  // Public member functions called by the main iterative algorithm class
111  int EstimateModelParameters(oImageSpace* ap_Image, int a_ite, int a_sset);
120  int EstimateImageWithModel(oImageSpace* ap_Image, int a_ite, int a_sset);
127  int SaveParametricImages(int a_iteration);
128 
129 
130  // -----------------------------------------------------------------------------------------
131  // Data members
132  protected:
135 };
136 
137 // 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)
139 
140 #endif
int Initialize()
This function is used to initialize the model parametric images and basis functions.
#define FLTNB
Definition: gVariables.hh:81
This is the mother class of dynamic model classes.
This class is a child of the vDynamicModel class implementing a template squeleton.
int SaveParametricImages(int a_iteration)
Write parametric images on disk.
iDynamicModelTemplate()
Constructor of iDynamicModelTemplate. Simply set all data members to default values.
#define FUNCTION_DYNAMICMODEL(CLASS)
int ReadAndCheckConfigurationFile(string a_fileOptions)
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)
Estimate the model parametric images.
void ShowHelp()
This function is used to print out specific help about the deformation model and its options...
int EstimateImageWithModel(oImageSpace *ap_Image, int a_ite, int a_sset)
Estimate image using model parametric images and basis functions.
#define CLASS_DYNAMICMODEL(NAME, CLASS)
This class holds all the matrices in the image domain that can be used in the algorithm: image...
Definition: oImageSpace.hh:61
int ReadAndCheckOptionsList(string a_listOptions)
This function is used to read parameters from a string.
Declaration of class vDynamicModel.
~iDynamicModelTemplate()
Destructor of iDynamicModelTemplate.
Declaration of class sAddonManager.