RecMuonRoI.h

Go to the documentation of this file.

// Copyright (C) 2002-2021 CERN for the benefit of the ATLAS collaboration
 
/***************************************************************************
 *                         RecMuonRoI.h  -  description
 *                            -------------------
 *   begin                : Tue Feb 25 2003
 *   email                : Thorsten Wengler
 ***************************************************************************/
 
#ifndef TRIGT1INTERFACES_RECMUONROI_H
#define TRIGT1INTERFACES_RECMUONROI_H
 
// STL include(s):
#include <string>
#include <vector>
 
// Gaudi/Athena include(s):
#include "AthContainers/DataVector.h"
 
// Local include(s):
#include "TrigT1Interfaces/iRecCoordRoI.h"
 
// Forward declaration(s):
namespace TrigConf {
   class TriggerThreshold;
   class L1Menu;
}
 
namespace LVL1 {
 
   // Forward declaration(s):
   class RecMuonRoiSvc;
   class ITrigT1MuonRecRoiTool;

   enum BitMask {
      FirsCandMask                 = 0x00400000,
      SectorAddressMask            = 0x003fc000,
      SysIDMask                    = 0x000000c0,
      SubSysIDMask                 = 0x00000001,
      SectNumBarrelMask            = 0x0000003e,
      SectNumEndcapMask            = 0x0000007e,
      SectNumForwardMask           = 0x0000003e,
      ThresNumMask                 = 0x00003800,
      RoIOvlMask                   = 0x000007fc,
      BarrelRoIMask                = 0x0000001f,
      BarrelOvlMask                = 0x00000180,
      EndcapRoIMask                = 0x000000ff,
      EndcapOvlMask                = 0x00000100,
      ForwardRoIMask               = 0x0000003f,
      PadOflMask                   = 0x00000002,
      SectOflMask                  = 0x00000001,
      TGCCandidateSignMask         = 0x08000000,
      CandidateVetoMask            = 0x10000000
   };

   class RecMuonRoI : public iRecCoordRoI {
 
   public:
      enum ChargeSign {
         NEGATIVE = 0, 
         POSITIVE = 1, 
         UNDEFINED = 100 
      }; // enum CandidateSign
 
      // constructor
      RecMuonRoI() {}
 
      // constructor using Run 1+2 configuration
      RecMuonRoI( unsigned int roIWord, const RecMuonRoiSvc* theRecRPCRoiSvc,
                  const RecMuonRoiSvc* theRecTGCRoiSvc,
                  const std::vector< TrigConf::TriggerThreshold* >* theMuonConfig );
 
      RecMuonRoI( unsigned int roIWord, const ITrigT1MuonRecRoiTool* theRecRPCRoiTool,
                  const ITrigT1MuonRecRoiTool* theRecTGCRoiTool,
                  const std::vector< TrigConf::TriggerThreshold* >* theMuonConfig );

      RecMuonRoI( unsigned int roIWord, const ITrigT1MuonRecRoiTool* theRecRPCRoiTool,
                  const ITrigT1MuonRecRoiTool* theRecTGCRoiTool,
                  const TrigConf::L1Menu * const l1menu );
 
      // does exactly like the constructor
      void construct( unsigned int roIWord, const RecMuonRoiSvc* theRecRPCRoiSvc,
                      const RecMuonRoiSvc* theRecTGCRoiSvc,
                      const std::vector< TrigConf::TriggerThreshold* >* theMuonConfig );
 
      void construct( unsigned int roIWord, const ITrigT1MuonRecRoiTool* theRecRPCRoiTool,
                      const ITrigT1MuonRecRoiTool* theRecTGCRoiTool,
                      const std::vector< TrigConf::TriggerThreshold* >* theMuonConfig );
 
      // using Run 3 menu
      void construct( unsigned int roIWord, const ITrigT1MuonRecRoiTool* theRecRPCRoiTool,
                      const ITrigT1MuonRecRoiTool* theRecTGCRoiTool,
                      const TrigConf::L1Menu* const l1menu );

      virtual unsigned int roiWord() const { return m_roiWord; }

      unsigned int sysID() const { return m_sysID; }

      unsigned int subsysID() const { return m_subSysID; }

      unsigned int sectorID() const { return m_sectorID; }

      virtual double phi() const { return m_phi; }

      virtual double eta() const { return m_eta; }

      unsigned int getThresholdNumber() const { return  m_thresholdNumber; }

      unsigned int getThresholdValue() const { return m_thresholdValue; }

      unsigned int getRoINumber() const { return m_roiNumber; }

      unsigned int getOverlap() const { return m_overlap; }

      bool firstCandidate() const { return m_firstCandidateFlag; }

      bool sectorOverflow() const { return m_sectorOflFlag; }

      bool padOverflow() const { return m_padOflFlag; }

      ChargeSign candidateCharge() const;

      bool candidateVetoed() const;
 
      std::string getDebugString();
 
   private:
      unsigned int getBitMaskValue( const unsigned int * uintValue, const unsigned int mask );

      unsigned int m_roiWord { 0 };

      bool m_firstCandidateFlag { false };

      bool m_sectorOflFlag { false };

      bool m_padOflFlag { false };

      unsigned int m_thresholdNumber { 0 };

      unsigned int m_thresholdValue { 0 };

      unsigned int m_roiNumber { 0 };

      unsigned int m_overlap { 0 };

      unsigned int m_sysID { 0 };

      unsigned int m_subSysID { 0 };

      unsigned int m_sectorID { 0 };

      double m_eta { 0 };

      double m_phi { 0 };
 
   }; // class RecMuonRoI
 
} // namespace LVL1
 
/* CLID for RecMuonRoI */
#include "AthenaKernel/CLASS_DEF.h"
CLASS_DEF( DataVector< LVL1::RecMuonRoI >, 247859471, 1 )
CLASS_DEF( LVL1::RecMuonRoI, 6080, 0 )
 
#endif // TRIGT1INTERFACES_RECMUONROI_H