i1TCModel.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-2020 all CASToR contributors listed below:

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

This is CASToR version 3.1.
*/

#ifndef I1TCMODEL_HH
#define I1TCMODEL_HH 1


#define METHOD_1CPT_NNLS 0

#define METHOD_1CPT_LS 1

#define METHOD_1CPT_BF 2

#define METHOD_INT_WPO 0

#define METHOD_INT_TRAP 1

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


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


  // -----------------------------------------------------------------------------------------
  // 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(i1TCModel)
    int CheckSpecificParameters();
    int ReadAndCheckConfigurationFileSpecific();
    int ReadAndCheckOptionsList(string a_listOptions);
    int InitializeSpecific();
    void ShowHelpModelSpecific();


  // -------------------------------------------------------------------
  // 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);


  // -------------------------------------------------------------------
  // Private member functions 
  private:
    int EstimateModelParametersWithLS(oImageSpace* ap_ImageS);
    
    int EstimateModelParametersWithNNLS(oImageSpace* ap_ImageS);

    int EstimateModelParametersWithBF(oImageSpace* ap_ImageS);
    
    int RRLS(uint16_t  a_nP,
             uint16_t  a_nT,
               FLTNB **a2p_model,
               FLTNB  *ap_data,
               FLTNB  *ap_w,
               FLTNB  *ap_result
            );
                    
    int LS(uint16_t  a_nP,
           uint16_t  a_nT,
             FLTNB **a2p_model,
             FLTNB  *ap_data,
             FLTNB  *ap_w,
             FLTNB  *ap_result
          );
                        

    FLTNB WPOinc(uint32_t a_time, FLTNB tac, FLTNB b_tac, FLTNB bb_tac, FLTNB n_tac);
    
    int IntegrateTAC(FLTNB* ap_tac, FLTNB* ap_citac, int a_th);
    
    int WPO(FLTNB* ap_tac, FLTNB* ap_citac, int a_th);
    int Trapz(FLTNB* ap_tac, FLTNB* ap_citac);
    
    
    
  // -----------------------------------------------------------------------------------------
  // Data members
  protected:
    bool        m_savePImgFlag;           
    int         m_OptimisationMethodFlag; 
    FLTNB**     m2p_ct;                   
    FLTNB**     m2p_cti;                  
    FLTNB*      mp_w;                     
    FLTNB***    m3p_nnlsA;                
    FLTNB**     m2p_nnlsB;                
    FLTNB**     m2p_nnlsMat;              
    uint16_t    m_nnlsN=3;                
    FLTNB*      mp_parUpperBounds;        
    FLTNB*      mp_parLowerBounds;        
    FLTNB       m_RRcst;                  
    bool        m_ridgeRegressionFlag;    
    FLTNB*      mp_DT2;                   
    // WPO
    FLTNB*      mp_wpoQ;
    FLTNB*      mp_wpoA;
    FLTNB**     m2p_wpoP;
    FLTNB**     m2p_wpoFD;
    FLTNB**     m2p_wpoBD;
    bool        m_intMethodFlag;          
    // Least-Square matrices for LS estimation
    oMatrix**   mp_Y;       
    oMatrix**   mp_X;       
    oMatrix**   mp_Xt;      
    oMatrix**   mp_XtX;     
    oMatrix**   mp_LSnum;   
    oMatrix**   mp_LSden;   
    oMatrix**   mp_Theta;   
    // Least-Square with Ridge Regression variables
    oMatrix*    mp_RRm;     
    oMatrix*    mp_RRw;     
    oMatrix**   mp_RRnum;   
    FLTNB*      mp_VaImage; 
};




// 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(_1TCM,i1TCModel)

#endif