iEventSPECT.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 IEVENTSPECT_HH
#define IEVENTSPECT_HH 1

#include "vEvent.hh"

class iEventSPECT : public vEvent
{
  // -------------------------------------------------------------------
  // Constructor & Destructor
  public:
    iEventSPECT();
    virtual ~iEventSPECT();

  // -------------------------------------------------------------------
  // Public member functions
  public:
    virtual int AllocateSpecificData() = 0;
    virtual void Describe();

  // -------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline FLTNB GetNormFactor()
           {return m_eventNormFactor;}
    inline FLTNB GetEventScatRate()
           {return m_eventScatRate;}
    inline void SetNormalizationFactor(FLTNBDATA a_value)
           {m_eventNormFactor = (FLTNB)a_value;}
    inline void SetScatterRate(FLTNBDATA a_value)
           {m_eventScatRate = (FLTNB)a_value;}
    inline FLTNB GetAdditiveCorrections(int a_bin)
           {
             (void)a_bin; // avoid 'unused parameter' compil. warnings
             return m_eventScatRate;
           }
    inline FLTNB GetMultiplicativeCorrections()
           {return m_eventNormFactor;}
    virtual FLTNB GetEventValue(int a_bin) = 0;
    virtual void SetEventValue(int a_bin, FLTNBDATA a_value) = 0;
    virtual INTNB GetNbValueBins() = 0;
    inline void MultiplyAdditiveCorrections(FLTNB a_factor)
           {m_eventScatRate *= a_factor;}

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

  // -------------------------------------------------------------------
  // Data members
  protected:
    FLTNB m_eventScatRate;   
    FLTNB m_eventNormFactor; 
};

#endif