oDynamicDataManager.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 ODYNAMICDATAMANAGER_HH
#define ODYNAMICDATAMANAGER_HH 1

#define DYNAMIC_SWITCH_NOTHING 0
#define DYNAMIC_SWITCH_CONTINUE 1
#define DYNAMIC_SWITCH_DEFORMATION 2
#define DYNAMIC_SWITCH_END_LOOP 3

#include "gVariables.hh"
#include "gOptions.hh"
#include "sOutputManager.hh"

class oImageDimensionsAndQuantification;
class vDataFile;

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

  // -------------------------------------------------------------------
  // Public member functions
  public:
    int InitDynamicData( int a_nbRespGates, int a_nbCardGates, const string& a_pathTo4DDataSplittingFile,
                         int a_rmMCorrFlag, int a_cMmCorrFlag, int a_pMotionCorrFlag );
    int SetDynamicSpecificQuantificationFactors(FLTNB** a2p_quantificationFactors);
    int CheckParameters(int64_t a_nbEvents);
    void ResetCurrentDynamicIndices();
    int DynamicSwitch(int64_t a_index, uint32_t a_time, int a_bed, int a_th);
    
  // -------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline void SetVerbose(int a_verboseLevel)
           {m_verbose = a_verboseLevel;};
    inline void SetImageDimensionsAndQuantification(oImageDimensionsAndQuantification* ap_ImageDimensionsAndQuantification)
           {mp_ID = ap_ImageDimensionsAndQuantification;};
    inline void SetRespMotionFlagOn()
           {m_rMotionCorrFlag = true;}
    inline void SetCardMotionFlagOn()
           {m_cMotionCorrFlag = true;} 
    inline void SetPMotionFlagOn()
           {m_pMotionCorrFlag = true;} 
    inline bool IsRespMotionEnabled()
           {return m_rMotionCorrFlag;}
    inline bool IsCardMotionEnabled()
           {return m_cMotionCorrFlag;}
    inline bool IsPMotionEnabled()
           {return m_pMotionCorrFlag;}
    inline int GetCurrentPMotionIndex(int a_th)
           {return mp_currentPMotionIndex[a_th] ;}
    inline int GetCurrentTimeFrame(int a_th)
           {return mp_currentFrameIndex[a_th];}
    inline int GetCurrentRespGate(int a_th)
           {return mp_currentRespGateIndex[a_th];}
    inline int GetCurrentRespImage(int a_th)
           {return m_rMotionCorrFlag ? 0 : mp_currentRespGateIndex[a_th];}
    inline int GetCurrentCardGate(int a_th)
           {return mp_currentCardGateIndex[a_th];}
    inline int GetCurrentCardImage(int a_th)
           {return m_cMotionCorrFlag ? 0 : mp_currentCardGateIndex[a_th];}
    inline int GetNb2ndMotImgsForLMS()
           {return m_nbCardGates;}
    inline int GetPMotionFirstIndexForFrame(int a_fr)
           {return m_pMotionCorrFlag ? mp_framePMotionFirstIndex[a_fr] : 0 ;}

    inline int GetPMotionLastIndexForFrame(int a_fr)
           {return m_pMotionCorrFlag ? mp_framePMotionLastIndex[a_fr] : 0 ;}
           
    inline int GetNb1stMotImgsForLMS(int a_fr)
           {return m_pMotionCorrFlag ? mp_frameNbPMotionTriggers[a_fr] : m_nbRespGates ;}


    inline int GetNbPMotionTriggers(int a_fr)
           {return mp_frameNbPMotionTriggers[a_fr];}
           
    inline FLTNB GetListPMotionWeightInFrameForLMS(int a_fr, int a_pmsset)
           {return m2p_listPMotionWeightInFrame[a_fr][a_pmsset] ;}
           
           
    inline int GetNbIPatMotionSubsets()
           {return m_nbPMotionTriggers+1;}

    inline bool GateDurationProvided()
            {return m_gateDurationProvidedFlag;}
  // -------------------------------------------------------------------
  // Private member functions  
  private:
    int InitDynamicDataGating(const string& a_pathToGateFile);
    int InitDynamicDataPatientMotion(const string& a_pathToFile);

  // -------------------------------------------------------------------
  // Data members
  private:
    oImageDimensionsAndQuantification*  mp_ID; 
    int m_verbose;                             
    // Framing
    int* mp_currentFrameIndex;                 
    int m_nbTimeFrames;                        
    // Respiratory gating
    bool m_respGatingFlag;                     
    bool m_rMotionCorrFlag;                    
    int m_nbRespGates;                         
    int64_t** m2p_nbEventsPerRespGate;         
    int64_t** m2p_indexLastEventRespGate;      
    int* mp_currentRespGateIndex;              
    // Cardiac gating
    bool m_cardGatingFlag;                     
    bool m_cMotionCorrFlag;                    
    int m_nbCardGates;                         
    int64_t** m2p_nbEventsPerCardGate;         
    int64_t** m2p_indexLastEventCardGate;      
    int* mp_currentCardGateIndex;              
    // Common gating
    HPFLTNB** m2p_durationPerGate;             
    bool m_gateDurationProvidedFlag;           
    // Involuntary motion
    bool m_pMotionCorrFlag;                    
    int m_nbPMotionTriggers;                   
    uint16_t* mp_framePMotionFirstIndex;       
    uint16_t* mp_framePMotionLastIndex;        
    uint16_t* mp_frameNbPMotionTriggers;       
    uint32_t* mp_listPMotionTriggers;          
    HPFLTNB** m2p_listPMotionWeightInFrame;    
    int* mp_currentPMotionIndex;               
};
#endif