KLMDigit.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
 
/* KLM headers. */
#include <klm/dataobjects/bklm/BKLMElementNumbers.h>
#include <klm/dataobjects/KLMElementNumbers.h>
#include <klm/dataobjects/KLMScintillatorFirmwareFitResult.h>
#include <klm/dataobjects/KLMSimHit.h>
 
/* Basf2 headers. */
#include <framework/dataobjects/DigitBase.h>
 
namespace Belle2 {

  class KLMDigit : public DigitBase {
 
  public:

    KLMDigit();

    explicit KLMDigit(const KLMSimHit* simHit);

    KLMDigit(const KLMSimHit* simHit, int strip);

    ~KLMDigit()
    {
    }

    unsigned int getUniqueChannelID() const override;

    EAppendStatus addBGDigit(const DigitBase* bg) override;

    int getSubdetector() const
    {
      return m_Subdetector;
    }

    void setSubdetector(int subdetector)
    {
      m_Subdetector = subdetector;
    }

    int getSection() const
    {
      return m_Section;
    }

    void setSection(int section)
    {
      m_Section = section;
    }

    int getSector() const
    {
      return m_Sector;
    }

    void setSector(int sector)
    {
      m_Sector = sector;
    }

    int getLayer() const
    {
      return m_Layer;
    }

    void setLayer(int layer)
    {
      m_Layer = layer;
    }

    int getPlane() const
    {
      return m_Plane;
    }

    void setPlane(int plane)
    {
      m_Plane = plane;
    }

    int getStrip() const
    {
      return m_Strip;
    }

    void setStrip(int strip)
    {
      m_Strip = strip;
    }

    int getLastStrip() const
    {
      return m_LastStrip;
    }

    void setLastStrip(int lastStrip)
    {
      m_LastStrip = lastStrip;
    }

    bool isMultiStrip() const
    {
      return (m_LastStrip != 0);
    }

    bool inRPC() const
    {
      return (m_Subdetector == KLMElementNumbers::c_BKLM &&
              m_Layer >= BKLMElementNumbers::c_FirstRPCLayer);
    }

    bool isPhiReadout() const;

    uint16_t getCharge() const
    {
      return m_Charge;
    }

    void setCharge(uint16_t charge)
    {
      m_Charge = charge;
    }

    uint16_t getCTime() const
    {
      return m_CTime;
    }

    void setCTime(uint16_t ctime)
    {
      m_CTime = ctime;
    }

    uint16_t getTDC() const
    {
      return m_TDC;
    }

    void setTDC(uint16_t tdc)
    {
      m_TDC = tdc;
    }

    float getTime() const
    {
      return m_Time;
    }

    void setTime(float time)
    {
      m_Time = time;
    }

    int getRevo9DCArrivalTime() const
    {
      return m_NGeneratedPhotoelectrons;
    }

    void setRevo9DCArrivalTime(int revo9DCArrivalTime)
    {
      m_NGeneratedPhotoelectrons = revo9DCArrivalTime;
    }

    int getRPCHitIndex() const
    {
      return static_cast<int>(m_MCTime);
    }

    void setRPCHitIndex(int rpcHitIndex)
    {
      m_MCTime = static_cast<float>(rpcHitIndex);
    }

    float getEnergyDeposit() const
    {
      return m_EnergyDeposit;
    }

    void setEnergyDeposit(float eDep)
    {
      m_EnergyDeposit = eDep;
    }

    float getNPhotoelectrons() const
    {
      return m_NPhotoelectrons;
    }

    void setNPhotoelectrons(float nPhotoelectrons)
    {
      m_NPhotoelectrons = nPhotoelectrons;
    }

    int getNGeneratedPhotoelectrons() const
    {
      return m_NGeneratedPhotoelectrons;
    }

    void setNGeneratedPhotoelectrons(int nPhotoelectrons)
    {
      m_NGeneratedPhotoelectrons = nPhotoelectrons;
    }

    bool isGood() const
    {
      return m_FitStatus == KLM::c_ScintillatorFirmwareSuccessfulFit;
    }

    int getFitStatus() const
    {
      return m_FitStatus;
    }

    void setFitStatus(int s)
    {
      m_FitStatus = s;
    }

    float getMCTime() const
    {
      return m_MCTime;
    }

    void setMCTime(float time)
    {
      m_MCTime = time;
    }

    float getSiPMMCTime() const
    {
      return m_SiPMMCTime;
    }

    void setSiPMMCTime(float time)
    {
      m_SiPMMCTime = time;
    }
 
  protected:

    const KLMElementNumbers* m_ElementNumbers; 

    int m_Subdetector;

    int m_Section;

    int m_Sector;

    int m_Layer;

    int m_Plane;

    int m_Strip;

    int m_LastStrip;

    uint16_t m_Charge;

    uint16_t m_CTime;

    uint16_t m_TDC;

    float m_Time;

    float m_EnergyDeposit;

    float m_NPhotoelectrons;

    int m_NGeneratedPhotoelectrons;

    int m_FitStatus;

    float m_MCTime;

    float m_SiPMMCTime;

    ClassDefOverride(Belle2::KLMDigit, 1);
 
  };

}