ICandData_v1.h

Go to the documentation of this file.

 
/*
   Copyright (C) 2002-2026 CERN for the benefit of the ATLAS collaboration
*/
#ifndef XAODL0MUONCAND_VERSION_ICANDDATA_V1_H
#define XAODL0MUONCAND_VERSION_ICANDDATA_V1_H
 
#include <cstdint>
#include <cmath>
#include "AthContainers/AuxElement.h"
 
namespace xAOD
{

 
  class ICandData_v1 : public SG::AuxElement
  {
  public:
    ICandData_v1() = default;
    virtual ~ICandData_v1() = default;
 

    enum class BC_ID
    {
      BC_UNDEFINED = 0,
      BC_PREVIOUS,
      BC_CURRENT,
      BC_NEXT,
      BC_NEXTNEXT
    };
      // quality of the candidate
    enum class Quality : uint8_t
    {
      Q_UNDEFINED = 0,
      Q_BEST,
      Q_LOW
    };

    uint16_t subdetectorId() const;
    uint16_t sectorId() const;
    uint16_t bcTag() const;
    uint8_t threshold() const;
    uint8_t candCharge() const;
    uint8_t mdtFlag() const;
    uint8_t coinType() const;

    uint16_t eta() const;
    uint16_t phi() const;
    uint8_t pt() const;
    Quality candQuality() const;
 
  

    void setSubdetectorId(uint16_t subdetectorId);
    void setSectorId(uint16_t sectorId);
    void setBcTag(uint16_t bcTag);
    void setEta(float eta);
    void setPhi(float phi);
    void setPt(float pt);
    void setThreshold(uint8_t threshold);
    void setCandCharge(uint8_t candCharge);
    void setMdtFlag(uint8_t mdtFlag);
    void setCoinType(uint8_t coinType);
    void setCandQuality(Quality candQuality);


 
    void initialize(uint16_t subdetectorId, uint16_t sectorId, uint16_t bcTag);
 
    
    static constexpr float etaRange() { return s_etaRange; }
    static constexpr uint16_t etaBitRange() { return s_etaBitRange; }
    static constexpr float phiRange() { return s_phiRange; }
    static constexpr uint16_t phiBitRange() { return s_phiBitRange; }
    static constexpr float ptRange() { return s_ptRange; }
    static constexpr uint8_t ptBitRange() { return s_ptBitRange; }
    static constexpr uint8_t coinTypeBitMask() { return COINTYPE_BIT_MASK; }
 
  protected:
    static constexpr float s_etaRange = 2.7;
    static constexpr float s_phiRange = 2.0 * M_PI;
    static constexpr float s_ptRange = 1000.0;

    static constexpr uint16_t s_etaBitRange = 0x3fff;
    static constexpr uint16_t s_phiBitRange = 0x1ff;
    static constexpr uint8_t s_ptBitRange = 0xff;

    static constexpr uint8_t COINTYPE_BIT_MASK = 0x7;
  };
 
}  // namespace xAOD
 
#include "xAODCore/BaseInfo.h"
SG_BASE( xAOD::ICandData_v1, SG::AuxElement );
 
#endif  // XAODL0MUONCAND_VERSION_ICANDDATA_V1_H