iLinearModel.hh

Go to the documentation of this file.

/*
This file is part of CASToR.

    CASToR is free software: you can redistribute it and/or modify it under the
    terms of the GNU General Public License as published by the Free Software
    Foundation, either version 3 of the License, or (at your option) any later
    version.

    CASToR is distributed in the hope that it will be useful, but WITHOUT ANY
    WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
    FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
    details.

    You should have received a copy of the GNU General Public License along with
    CASToR (in file GNU_GPL.TXT). If not, see <http://www.gnu.org/licenses/>.

Copyright 2017-2019 all CASToR contributors listed below:

    --> Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Thibaut MERLIN, Mael MILLARDET, Simon STUTE, Valentin VIELZEUF

This is CASToR version 3.0.
*/

#ifndef ILINEARMODEL_HH
#define ILINEARMODEL_HH 1

#define OPTIMISATION_METHOD_DR 0

#define OPTIMISATION_METHOD_NESTEM 1

#define OPTIMISATION_METHOD_NNLS 2

#define OPTIMISATION_METHOD_LS 3

#include "vDynamicModel.hh"
#include "sAddonManager.hh"

class iLinearModel : public vDynamicModel
{
  // -----------------------------------------------------------------------------------------
  // Constructor & Destructor
  public:
    iLinearModel();
    ~iLinearModel();


  // -----------------------------------------------------------------------------------------
  // Public member functions related to the initialization of the model
  public:
    // Function for automatic insertion (put the class name as the parameters and do not add semi-colon at the end of the line)
    FUNCTION_DYNAMICMODEL(iLinearModel)
    int CheckSpecificParameters();
    int CheckSpecificParametersForAllLinearModels();
    virtual int ReadAndCheckConfigurationFileSpecific();
    int ReadAndCheckOptionsList(string a_listOptions);
    int ReadAndCheckConfigurationFileSpecificToAllLinearModels();
    int InitializeSpecific();

    int InitializeSpecificToAllLinearModels();
    void ShowBasisFunctions();

    void ShowHelp();


  // -----------------------------------------------------------------------------------------
  // Public member functions called by the main iterative algorithm class
    int EstimateModelParameters(oImageSpace* ap_Image, int a_ite, int a_sset);
    int EstimateImageWithModel(oImageSpace* ap_Image, int a_ite, int a_sset);
    int NestedEM(oImageSpace* ap_ImageS, int a_ite);
    int EstimateParametersWithNNLS(oImageSpace* ap_ImageS, int a_ite);
    int Patlak_LS(oImageSpace* ap_ImageS, int a_ite) ;


  // -----------------------------------------------------------------------------------------
  // Data members
  protected:

    int m_OptimisationMethod;   
    int m_nbRgateBF;                
    int m_nbCgateBF;                
    //int m_nbRGModelParam;           /*!< Number of model parameters applied to respiratory gates */
    //int m_nbCGModelParam;           /*!< Number of model parameters applied to cardiac gates */

    FLTNB** m2p_respBasisFunctions;  
    FLTNB** m2p_cardBasisFunctions;  
    FLTNB*   mp_corrBasisCoeffs;      
    FLTNB* mp_corrBasisFunctions;     
    uint32_t m_nbLinearModelCycles;   
    int m_basisFunctionsUpdStartIte;  
    int m_basisFunctionsUpdRatio;     
    int m_basisFunctionsUpdIdx;       
};

// 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)
CLASS_DYNAMICMODEL(LinearModel,iLinearModel)

#endif