MuonShower.h

Go to the documentation of this file.

#ifndef DataFormats_L1Trigger_MuonShower_h
#define DataFormats_L1Trigger_MuonShower_h

/*
  This class is derived from the L1Candidate primarily to interface easily
  with the Global Muon Trigger. In the trigger system the MuonShower object
  carries only up to 4 bits of information, 2 for in-time showers,
  2 for out-of-time showers.
*/

#include "DataFormats/Common/interface/Ref.h"
#include "DataFormats/L1Trigger/interface/L1Candidate.h"
#include "DataFormats/L1Trigger/interface/BXVector.h"
#include "DataFormats/L1Trigger/interface/L1TObjComparison.h"

namespace l1t {

  class MuonShower;
  typedef BXVector<MuonShower> MuonShowerBxCollection;
  typedef edm::Ref<MuonShowerBxCollection> MuonShowerRef;
  typedef edm::RefVector<MuonShowerBxCollection> MuonShowerRefVector;
  typedef std::vector<MuonShowerRef> MuonShowerVectorRef;

  typedef ObjectRefBxCollection<MuonShower> MuonShowerRefBxCollection;
  typedef ObjectRefPair<MuonShower> MuonShowerRefPair;
  typedef ObjectRefPairBxCollection<MuonShower> MuonShowerRefPairBxCollection;

  class MuonShower : public L1Candidate {
  public:
    MuonShower(bool oneNominalInTime = false,
               bool oneNominalOutOfTime = false,
               bool twoLooseInTime = false,
               bool twoLooseOutOfTime = false,
               bool oneTightInTime = false,
               bool oneTightOutOfTime = false);

    ~MuonShower() override;

    /*
      In CMSSW we consider 3 valid cases:
      - 1 nominal shower (baseline trigger for physics at Run-3)
      - 1 tight shower (backup trigger)
      - 2 loose showers (to extend the physics reach)

      In the uGT and UTM library, the hadronic shower trigger data is split
      over 4 bits: 2 for in-time trigger data, 2 for out-of-time trigger data
      - mus0, mus1 for in-time
      - musOutOfTime0, musOutOfTime1 for out-of-time

      The mapping for Run-3 startup is as follows:
      - 1 nominal shower -> 0b01 (mus0)
      - 1 tight shower -> 0b10 (mus1)

      The 2 loose showers case would be mapped onto musOutOfTime0 and musOutOfTime1 later during Run-3
    */

    void setOneNominalInTime(const bool bit) { oneNominalInTime_ = bit; }
    void setOneTightInTime(const bool bit) { oneTightInTime_ = bit; }
    void setMus0(const bool bit) { oneNominalInTime_ = bit; }
    void setMus1(const bool bit) { oneTightInTime_ = bit; }
    void setMusOutOfTime0(const bool bit) { musOutOfTime0_ = bit; }
    void setMusOutOfTime1(const bool bit) { musOutOfTime1_ = bit; }

    bool mus0() const { return oneNominalInTime_; }
    bool mus1() const { return oneTightInTime_; }
    bool musOutOfTime0() const { return musOutOfTime0_; }
    bool musOutOfTime1() const { return musOutOfTime1_; }

    // at least one bit must be valid
    bool isValid() const;

    // useful members for trigger performance studies
    // needed at startup Run-3
    bool isOneNominalInTime() const { return oneNominalInTime_; }
    bool isOneTightInTime() const { return oneTightInTime_; }
    // to be developed during Run-3
    bool isTwoLooseInTime() const { return false; }
    // these options require more study
    bool isOneNominalOutOfTime() const { return false; }
    bool isTwoLooseOutOfTime() const { return false; }
    bool isOneTightOutOfTime() const { return false; }

    virtual bool operator==(const l1t::MuonShower& rhs) const;
    virtual inline bool operator!=(const l1t::MuonShower& rhs) const { return !(operator==(rhs)); };

  private:
    // Run-3 definitions as provided in DN-20-033
    // in time and out-of-time qualities. only 2 bits each.
    bool oneNominalInTime_;
    bool oneTightInTime_;
    bool musOutOfTime0_;
    bool musOutOfTime1_;
  };

}  // namespace l1t

#endif