iEventListPET.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 IEVENTLISTPET_HH
#define IEVENTLISTPET_HH 1

#include "iEventPET.hh"

#define KIND_UNKNOWN 0

#define KIND_TRUE 1

#define KIND_SCAT 2

#define KIND_MSCAT 3

#define KIND_RDM 4

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

  // -------------------------------------------------------------------
  // Public member functions
  public:
    inline int AllocateSpecificData() {return 0;}
    void Describe();

  // -------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline uint8_t GetKind()
           {return m_kind;}
    inline FLTNB GetEventScatRate(int a_bin)
           {
             (void)a_bin; // avoid 'unused parameter' compil. warnings
             return m_eventScatRate;
           }
    inline FLTNB GetTOFMeasurementInPs()
           {return m_TOFMeasurementInPs;}
    inline FLTNB* GetPOI1()
           {return mp_POI1;}
    inline FLTNB* GetPOI2()
           {return mp_POI2;}
    inline FLTNB GetPOI1(uint8_t axis)
           {return mp_POI1[axis];}
    inline FLTNB GetPOI2(uint8_t axis)
           {return mp_POI2[axis];}
    inline FLTNB GetEventValue(int a_bin)
           {
             (void)a_bin; // avoid 'unused parameter' compil. warnings
             return 1.;
           }
    inline void SetKind(uint8_t a_value)
           {m_kind = a_value;}
    inline void SetScatterRate(int a_bin, FLTNBDATA a_value)
           {
             (void)a_bin; // avoid 'unused parameter' compil. warnings
             m_eventScatRate = (FLTNB)a_value;
           }
    inline void SetTOFMeasurementInPs(FLTNB a_value)
           {m_TOFMeasurementInPs = a_value;}
    inline void SetTOFMeasurementRangeInPs(FLTNB a_value)
           {m_TOFMeasurementRangeInPs = a_value;}
    inline void SetPOI1(int a_axis, FLTNBDATA a_value)
           {mp_POI1[a_axis] = (FLTNB)a_value;}
    inline void SetPOI2(int a_axis, FLTNBDATA a_value)
           {mp_POI2[a_axis] = (FLTNB)a_value;}
    void SetEventValue(int a_bin, FLTNBDATA a_value); 
    FLTNB GetAdditiveCorrections(int a_bin);
    inline INTNB GetNbValueBins()
           {return 1;}
    void SetHasTOFInfo(bool a_hasTOFInfo)
           {m_hasTOFInfo = a_hasTOFInfo;}
    inline void MultiplyAdditiveCorrections(FLTNB a_factor)
           {m_eventRdmRate *= a_factor; m_eventScatRate *= a_factor;}

  // -------------------------------------------------------------------
  // Private member functions
  private:

  // -------------------------------------------------------------------
  // Data members
  private:
    uint8_t m_kind;                  
    FLTNB m_eventScatRate;           
    FLTNB m_TOFMeasurementInPs;      
    FLTNB mp_POI1[3];                
    FLTNB mp_POI2[3];                
    FLTNB m_TOFMeasurementRangeInPs; 
    bool m_hasTOFInfo;               
};

#endif