ECLDigit.h

/**************************************************************************
 * basf2 (Belle II Analysis Software Framework)                           *
 * Author: The Belle II Collaboration                                     *
 *                                                                        *
 * See git log for contributors and copyright holders.                    *
 * This file is licensed under LGPL-3.0, see LICENSE.md.                  *
 **************************************************************************/
 
#pragma once
 
#include <framework/datastore/RelationsObject.h>
#include <ecl/utility/ECLRawDataHadron.h>
 
namespace Belle2 {

 
  class ECLDigit : public RelationsObject {
  public:
    ECLDigit()
    {
      m_CellId = 0;    
      m_Amp = 0;       
      m_TimeFit = 0;   
      m_Quality = 0;   
      m_Chi = 0;       
    }
 
    /*                              Setters                                   */

    void setCellId(int CellId) { m_CellId = CellId; }

    void setAmp(int Amp) { m_Amp = Amp; }
 

    void setTimeFit(int TimeFit) { m_TimeFit = TimeFit; }
 

    void setQuality(unsigned int NewQuality)
    {
      //                             4    0
      //                             v    v
      const unsigned int mask = 0b0000'0011;
      // Set quality in bits 1..0, keep other bits unchanged
      m_Quality = (NewQuality & mask) | (m_Quality & ~mask);
    }

    void setChi(int Chi) { m_Chi = Chi; }

    void setPackedHadronFraction(unsigned int packed_fraction)
    {
      //                             8    4    0
      //                             v    v    v
      const unsigned int mask = 0b0011'1110'0000;
      // Set packed hadron fraction in bits 9..5, keep other bits unchanged
      m_Quality = ((packed_fraction << 5) & mask) | (m_Quality & ~mask);
    }

    void setDataFormat(unsigned int format)
    {
      //                             4    0
      //                             v    v
      const unsigned int mask = 0b0001'1100;
      // Set data availability flag in bits 4..2, keep other bits unchanged
      m_Quality = ((format << 2) & mask) | (m_Quality & ~mask);
    }
 
    /*                              Getters                                   */

    int getCellId() const { return m_CellId; }

    int getAmp() const { return m_Amp; }

    int getTimeFit() const { return m_TimeFit; }

    int getQuality() const
    {
      //                             4    0
      //                             v    v
      const unsigned int mask = 0b0000'0011;
      // Get quality from bits 1..0
      return m_Quality & mask;
    }

    int getChi() const { return m_Chi; }

    unsigned int getPackedHadronFraction() const
    {
      //                             8    4    0
      //                             v    v    v
      const unsigned int mask = 0b0011'1110'0000;
      // Get packed hadron fraction from bits 9..5
      return (m_Quality & mask) >> 5;
    }

    double getHadronFraction() const
    {
      using namespace Belle2::ECL::RawDataHadron;
      unsigned int packed_fraction = getPackedHadronFraction();
      // Unpack from [0..31] to a floating point value. See unpackHadronFraction for details
      return unpackHadronFraction(packed_fraction);
    }

    unsigned int getDataFormat()
    {
      //                             4    0
      //                             v    v
      const unsigned int mask = 0b0001'1100;
      return (m_Quality & mask) >> 2;
    }

    static ECLDigit* getByCellID(int cid);
 
  private:
 
    int m_CellId;            
    int m_Amp;               
    int m_TimeFit;           
    int m_Quality;
    int m_Chi;               
 
    // 2: r25301, data member changed to ints
    ClassDef(ECLDigit, 2);
 
  };

} // end namespace Belle2