RecJetRoI.h

Go to the documentation of this file.

// Dear emacs, this is -*- c++ -*-
// Copyright (C) 2002-2025 CERN for the benefit of the ATLAS collaboration
/***************************************************************************
                         RecJetRoI.h  -  description
                            -------------------
   begin                : Mon Jan 22 2001
   email                : moyse@heppch.ph.qmw.ac.uk
***************************************************************************/
 
#ifndef TRIGT1INTERFACES_RECJETTROI_H
#define TRIGT1INTERFACES_RECJETTROI_H
 
// STL include(s):
#include <map>
 
// Gaudi/Athena include(s):
#include "AthContainers/DataVector.h"
 
// Local include(s):
#include "TrigT1Interfaces/CoordinateRange.h"
#include "TrigT1Interfaces/TrigT1CaloDefs.h"
#include "TrigT1Interfaces/iRecCoordRoI.h"
 
// Forward declaration(s):
namespace TrigConf {
   class TriggerThreshold;
   class L1Menu;
}
 
namespace LVL1 {
 
   class JEPRoIDecoder;

   class RecJetRoI: public iRecCoordRoI {
 
   public:
      // constructor
      RecJetRoI() {}
      // constructor using Run 1+2 configuration
      RecJetRoI( unsigned int RoIWord,
                 const std::vector< TrigConf::TriggerThreshold* >* caloThresholds );
      RecJetRoI( unsigned int RoIWord,
                 const TrigConf::L1Menu * const l1menu );
 
      //copy constructor
      RecJetRoI( const RecJetRoI &obj );
 
      //assignment operator
      RecJetRoI& operator=(RecJetRoI const &obj);
 
      // destructor
      ~RecJetRoI();

      virtual unsigned int roiWord() const;

      virtual double phi() const;

      virtual double eta() const;
      
      virtual unsigned int crate() const;
      
      virtual unsigned int module() const;
      
      virtual unsigned int frame() const;
      
      virtual unsigned int localcoord() const;

      virtual unsigned int etLarge() const;

      virtual unsigned int etSmall() const;

      bool passedThreshold( unsigned int thresholdNumber ) const;

      bool passedFwdThreshold( unsigned int thresholdNumber ) const;

      const CoordinateRange& coord() const;

      std::vector<unsigned int> thresholdsPassed() const;

      unsigned int triggerThreshold( unsigned int thresh ) const;

      unsigned int windowSize( unsigned int thresh ) const;
      
      unsigned int thresholdPattern() const;

      bool isValidThreshold( unsigned int thresh ) const;

      bool isForwardJet() const;
 
   private:
      unsigned long int m_roiWord { 0 };
      
      JEPRoIDecoder* m_decoder { 0 };

      int m_version { 0 };

      CoordinateRange m_coordRange;
 
      unsigned long int m_thresholdMask { 0 };
 
      std::map< unsigned int, unsigned int > m_triggerThresholdValue; //< {threshold number, threshold value}
      std::map< unsigned int, unsigned int > m_windowSize; //< {threshold number, window size}
      
   private:
      // Constructor for Run 1 RoI format
      void constructRun1( const std::vector< TrigConf::TriggerThreshold* >* caloThresholds );
 
      // Constructor for Run 2 RoI format
      void constructRun2( const std::vector< TrigConf::TriggerThreshold* >* caloThresholds );
 
      // Constructor for Run 3 Legacy RoI format from new config
      void constructRun3(const TrigConf::L1Menu * const l1menu);
 
   }; // class RecJetRoI
 
} // namespace LVL1
 
#include "AthenaKernel/CLASS_DEF.h"
CLASS_DEF( DataVector< LVL1::RecJetRoI >, 6258, 1 )
CLASS_DEF( LVL1::RecJetRoI, 6259, 1 )
 
#endif // TRIGT1INTERFACES_RECJETTROI_H