BKLMHit2d.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/bklm/BKLMHit1d.h>
#include <klm/dataobjects/bklm/BKLMStatus.h>
 
/* Belle 2 headers. */
#include <framework/datastore/RelationsObject.h>
 
/* ROOT headers. */
#include <TVector3.h>
 
/* CLHEP headers. */
#include <CLHEP/Vector/ThreeVector.h>
 
namespace Belle2 {
  class BKLMHit2d : public RelationsObject {
 
  public:
 
    BKLMHit2d();
 
    BKLMHit2d(const BKLMHit1d* hitPhi, const BKLMHit1d* hitZ, const CLHEP::Hep3Vector& globalPos, double time);
 
    BKLMHit2d(const BKLMHit2d&);
 
    BKLMHit2d& operator=(const BKLMHit2d&);
 
    ~BKLMHit2d()
    {
    }
 
    bool inRPC() const
    {
      return getLayer() >= BKLMElementNumbers::c_FirstRPCLayer;
    }
 
    int getSection() const
    {
      return BKLMElementNumbers::getSectionByModule(m_ModuleID);
    }
 
    int getSector() const
    {
      return BKLMElementNumbers::getSectorByModule(m_ModuleID);
    }
 
    int getLayer() const
    {
      return BKLMElementNumbers::getLayerByModule(m_ModuleID);
    }
 
    int getPhiStripMin() const
    {
      return BKLMElementNumbers::getStripByModule(m_ModuleID);
    }
 
    int getPhiStripMax() const
    {
      return BKLMStatus::getMaximalStrip(m_ModuleID);
    }
 
    double getPhiStripAve() const
    {
      return 0.5 * (getPhiStripMin() + getPhiStripMax());
    }
 
    int getZStripMin() const
    {
      return (((m_ZStrips & BKLM_ZSTRIP_MASK) >> BKLM_ZSTRIP_BIT) + 1);
    }
 
    int getZStripMax() const
    {
      return (((m_ZStrips & BKLM_ZMAXSTRIP_MASK) >> BKLM_ZMAXSTRIP_BIT) + 1);
    }
 
    double getZStripAve() const
    {
      return 0.5 * (getZStripMin() + getZStripMax());
    }
 
    int getModuleID() const
    {
      return m_ModuleID;
    }
 
    bool isOutOfTime()
    {
      return (m_ModuleID & BKLM_OUTOFTIME_MASK) != 0;
    }
 
    bool isOnTrack()
    {
      return (m_ModuleID & BKLM_ONTRACK_MASK) != 0;
    }
 
    bool isOnStaTrack()
    {
      return (m_ModuleID & BKLM_ONSTATRACK_MASK) != 0;
    }
 
    float getGlobalPositionX(void) const
    {
      return m_GlobalPosition[0];
    }
 
    float getGlobalPositionY(void) const
    {
      return m_GlobalPosition[1];
    }
 
    float getGlobalPositionZ(void) const
    {
      return m_GlobalPosition[2];
    }
 
    TVector3 getGlobalPosition(void) const
    {
      return TVector3(m_GlobalPosition[0], m_GlobalPosition[1], m_GlobalPosition[2]);
    }
 
    float getTime() const
    {
      return m_Time;
    }
 
    float getEnergyDeposit() const
    {
      return m_EnergyDeposit;
    }
 
    bool match(const BKLMHit2d* h) const
    {
      return BKLMElementNumbers::hitsFromSameModule(m_ModuleID, h->getModuleID());
    }
 
    void isOutOfTime(bool flag)
    {
      if (flag)
        m_ModuleID |= BKLM_OUTOFTIME_MASK;
      else
        m_ModuleID &= ~BKLM_OUTOFTIME_MASK;
    }
 
    void isOnTrack(bool flag)
    {
      if (flag)
        m_ModuleID |= BKLM_ONTRACK_MASK;
      else
        m_ModuleID &= ~BKLM_ONTRACK_MASK;
    }
 
    void isOnStaTrack(bool flag)
    {
      if (flag)
        m_ModuleID |= BKLM_ONSTATRACK_MASK;
      else
        m_ModuleID &= ~BKLM_ONSTATRACK_MASK;
    }
 
  private:
 
    static constexpr int BKLM_ZSTRIP_BIT = 0;
 
    static constexpr int BKLM_ZMAXSTRIP_BIT = 6;
 
    static constexpr int BKLM_ZSTRIP_MASK = (63 << BKLM_ZSTRIP_BIT);
 
    static constexpr int BKLM_ZMAXSTRIP_MASK = (63 << BKLM_ZMAXSTRIP_BIT);
 
    int m_ModuleID;
 
    int m_ZStrips;
 
    float m_GlobalPosition[3];
 
    float m_Time;
 
    float m_EnergyDeposit;
 
    ClassDef(BKLMHit2d, 6)
 
  };
 
} // end of namespace Belle2