iEventNorm.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-2018 all CASToR contributors listed below:

    --> current contributors: Thibaut MERLIN, Simon STUTE, Didier BENOIT, Claude COMTAT, Marina FILIPOVIC, Mael MILLARDET
    --> past contributors: Valentin VIELZEUF

This is CASToR version 2.0.
*/

#ifndef IEVENTNORM_HH
#define IEVENTNORM_HH 1

#include "vEvent.hh"

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

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

  // -------------------------------------------------------------------
  // Public Get & Set functions
  public:
    inline void SetNormalizationFactor(FLTNBDATA a_value)
           {m_normalizationFactor = (FLTNB)a_value;}
    inline void SetAttenuationCorrectionFactor(FLTNBDATA a_value)
           {m_attenuationCorrectionFactor = (FLTNB)a_value;}
    inline FLTNB GetMultiplicativeCorrections()
           {return m_normalizationFactor * m_attenuationCorrectionFactor;}
    inline FLTNB GetNormalizationFactor()
           {return m_normalizationFactor;}
    inline FLTNB GetAttenuationCorrectionFactor()
           {return m_attenuationCorrectionFactor;}

  // -------------------------------------------------------------------
  // Public functions that should not be used, so they throw an error and crash
  public:
    FLTNB GetEventValue(int a_bin);
    FLTNB GetAdditiveCorrections(int a_bin);
    void SetEventValue(int a_bin, FLTNBDATA a_value);
    INTNB GetNbValueBins();
    void MultiplyAdditiveCorrections(FLTNB a_factor);

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

  // -------------------------------------------------------------------
  // Data members
  protected:
    FLTNB m_normalizationFactor;         
    FLTNB m_attenuationCorrectionFactor; 
};

#endif