iDataFilePET.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 IDATAFILEPET_HH
#define IDATAFILEPET_HH 1

#include "gVariables.hh"
#include "vDataFile.hh"

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

  // -------------------------------------------------------------------
  // Public member functions
  public:
    int ReadSpecificInfoInHeader(bool a_affectQuantificationFlag);
    int WriteHeader();
    int ComputeSizeEvent();
    int PrepareDataFile();
    int WriteEvent(vEvent* ap_Event, int a_th);
    vEvent* GetEventSpecific(char* ap_buffer, int a_th);
    void DescribeSpecific();

  // -------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline bool GetTOFInfoFlag()
           {return m_TOFInfoFlag;}
    inline void SetTOFInfoFlag()
           {m_TOFInfoFlag = true;}
    inline bool GetIgnoreTOFFlag()
           {return m_ignoreTOFFlag;}
    inline void SetTOFResolutionInPs(FLTNB a_TOFResolutionInPs)
           {m_TOFResolutionInPs = a_TOFResolutionInPs;}
    inline FLTNB GetTOFResolutionInPs()
           {return m_TOFResolutionInPs;}
    inline int GetNbTOFBins()
           {return m_nbTOFBins;}
    inline FLTNB GetTOFBinSizeInPs()
           {return m_TOFBinSizeInPs;}
    inline FLTNB GetTOFQuantizationBinSizeInPs()
           {return m_TOFQuantizationBinSizeInPs;}
    inline void SetTOFMeasurementRangeInPs(FLTNB a_TOFMeasurementRangeInPs)
           {m_TOFMeasurementRangeInPs = a_TOFMeasurementRangeInPs;}
    inline FLTNB GetTOFMeasurementRangeInPs()
           {return m_TOFMeasurementRangeInPs;}
    inline FLTNB GetMaxAxialDiffmm()
           {return m_maxAxialDiffmm;}
    inline void SetMaxNumberOfLinesPerEvent(uint16_t a_value)
           {m_maxNumberOfLinesPerEvent = a_value;}
    inline uint16_t GetMaxNumberOfLinesPerEvent()
           {return m_maxNumberOfLinesPerEvent;}
    inline void SetIsotope(string a_value)
           {m_isotope = a_value;}
    inline string GetIsotope()
           {return m_isotope;}
    inline void SetIgnoreTOFFlag(bool a_ignoreTOFFlag)
           {m_ignoreTOFFlag = a_ignoreTOFFlag;}
    inline void SetEventKindFlagOn()
           {m_eventKindFlag = true;} 
    inline void SetAtnCorrectionFlagOn()
           {m_atnCorrectionFlag = true;} 
    inline void SetNormCorrectionFlagOn()
           {m_normCorrectionFlag = true;} 
    inline void SetScatterCorrectionFlagOn()
           {m_scatCorrectionFlag = true;} 
    inline void SetRandomCorrectionFlagOn()
           {m_randCorrectionFlag = true;} 
    inline bool GetNormCorrectionFlag()
           {return m_normCorrectionFlag;}
    inline bool GetAtnCorrectionFlag()
           {return m_atnCorrectionFlag;}
    inline bool GetEventKindFlag()
           {return m_eventKindFlag;}
    inline bool GetScatCorrectionFlag()
           {return m_scatCorrectionFlag;}
    inline bool GetRandCorrectionFlag()
           {return m_randCorrectionFlag;}

  // -------------------------------------------------------------------
  // Public functions dedicated to the projection script
  public:
    int PROJ_InitFile();
    int PROJ_GetScannerSpecificParameters();

  // -------------------------------------------------------------------
  // Private member functions
  private:
    int SetSpecificParametersFrom(vDataFile* ap_DataFile);
    int CheckSpecificParameters();
    int WriteListEvent(iEventListPET* ap_Event, int a_th=0);
    int WriteHistoEvent(iEventHistoPET* ap_Event, int a_th);
    int CheckFileSizeConsistency();
    int CheckSpecificConsistencyWithAnotherDataFile(vDataFile* ap_DataFile);

  // -------------------------------------------------------------------
  // Data members
  private:
    uint16_t m_maxNumberOfLinesPerEvent; 
    FLTNB  m_maxAxialDiffmm;             
    string m_isotope;                    
    bool m_eventKindFlag;                
    bool m_atnCorrectionFlag;            
    bool m_ignoreAttnCorrectionFlag;     
    bool m_normCorrectionFlag;           
    bool m_ignoreNormCorrectionFlag;     
    bool m_scatCorrectionFlag;           
    bool m_ignoreScatCorrectionFlag;     
    bool m_randCorrectionFlag;           
    bool m_ignoreRandCorrectionFlag;     
    bool m_TOFInfoFlag;                  
    bool m_ignoreTOFFlag;                
    FLTNB m_TOFResolutionInPs;           
    int m_nbTOFBins;                     
    FLTNB m_TOFBinSizeInPs;              
    FLTNB m_TOFQuantizationBinSizeInPs;  
    FLTNB m_TOFMeasurementRangeInPs;     
};

#endif