L1GlobalCaloTrigger.h

Go to the documentation of this file.

#ifndef L1GLOBALCALOTRIGGER_H_
#define L1GLOBALCALOTRIGGER_H_

#include "DataFormats/L1CaloTrigger/interface/L1CaloRegion.h"
#include "DataFormats/L1CaloTrigger/interface/L1CaloEmCand.h"

#include "DataFormats/L1GlobalCaloTrigger/interface/L1GctCollections.h"

#include "L1Trigger/GlobalCaloTrigger/src/L1GctUnsignedInt.h"

#include "L1Trigger/GlobalCaloTrigger/interface/L1GctJetFinderBase.h"
#include "L1Trigger/GlobalCaloTrigger/interface/L1GctJetLeafCard.h"

#include <vector>

class L1GctJetLeafCard;
class L1GctJetFinderBase;
class L1GctEmLeafCard;
class L1GctElectronSorter;

class L1GctWheelJetFpga;
class L1GctWheelEnergyFpga;
class L1GctJetFinalStage;
class L1GctGlobalEnergyAlgos;
class L1GctGlobalHfSumAlgos;
class L1GctElectronFinalSort;
class L1GctJetFinderParams;
class L1GctJetEtCalibrationLut;
class L1GctChannelMask;
class L1CaloEtScale;


class L1GlobalCaloTrigger {
public:
  static const int N_JET_LEAF_CARDS;
  static const int N_EM_LEAF_CARDS;
  static const int N_WHEEL_CARDS;
  
  typedef L1GctUnsignedInt< L1GctEtTotal::kEtTotalNBits   > etTotalType;
  typedef L1GctUnsignedInt<   L1GctEtHad::kEtHadNBits     > etHadType;
  typedef L1GctUnsignedInt<  L1GctEtMiss::kEtMissNBits    > etMissType;
  typedef L1GctUnsignedInt<  L1GctEtMiss::kEtMissPhiNBits > etMissPhiType;

  typedef L1GctJetFinderBase::lutPtr       lutPtr;
  typedef L1GctJetFinderBase::lutPtrVector lutPtrVector;

  L1GlobalCaloTrigger(const L1GctJetLeafCard::jetFinderType jfType = L1GctJetLeafCard::hardwareJetFinder, unsigned jetLeafMask = 0);

  ~L1GlobalCaloTrigger();
  
  void reset();
  
  void process();

  void setJetFinderParams(const L1GctJetFinderParams* const jfpars);

  void setJetEtCalibrationLuts(const lutPtrVector& jfluts);

  void setupTauAlgo(const bool useImprovedAlgo, const bool ignoreVetoBitsForIsolation);

  void setHtMissScale(const L1CaloEtScale* const scale);

  void setupHfSumLuts(const L1CaloEtScale* const scale);

  void setChannelMask(const L1GctChannelMask* const mask); 

  void setBxRange(const int firstBx, const int lastBx);
  void setBxRangeSymmetric(const int numOfBx);
  void setBxRangeAutomatic();

  int getFirstBx() const { return m_bxStart; }
  int getLastBx()  const { return (m_bxStart + m_numOfBx - 1); }
  int getTotalBx() const { return m_numOfBx; }

  void fillRegions(const std::vector<L1CaloRegion>& rgn);

  void fillEmCands(const std::vector<L1CaloEmCand>& rgn);

  void setRegion(const L1CaloRegion& region);

  void setRegion(const unsigned et, const unsigned ieta, const unsigned iphi, 
                 const bool overFlow=false, const bool fineGrain=true);

  void setIsoEm(const L1CaloEmCand& em);

  void setNonIsoEm(const L1CaloEmCand& em);

  L1GctEmCandCollection getIsoElectrons() const;
  
  L1GctEmCandCollection getNonIsoElectrons() const;
  
  L1GctJetCandCollection getCentralJets() const;
  
  L1GctJetCandCollection getForwardJets() const;
  
  L1GctJetCandCollection getTauJets() const;
  
  L1GctInternJetDataCollection getInternalJets() const;

  L1GctEtTotalCollection getEtSumCollection() const;
  
  L1GctEtHadCollection   getEtHadCollection() const;

  L1GctEtMissCollection  getEtMissCollection() const;

  L1GctHtMissCollection  getHtMissCollection() const;

  L1GctInternEtSumCollection getInternalEtSums() const;
  L1GctInternHtMissCollection getInternalHtMiss() const;

  // Hf sums output to GT
  L1GctHFBitCountsCollection  getHFBitCountsCollection()  const;
  L1GctHFRingEtSumsCollection getHFRingEtSumsCollection() const;

  std::vector<L1GctJetLeafCard*> getJetLeafCards() const { return theJetLeafCards; }
  
  std::vector<L1GctEmLeafCard*> getEmLeafCards() const { return theEmLeafCards; }
  
  std::vector<L1GctWheelJetFpga*> getWheelJetFpgas() const { return theWheelJetFpgas; }
  
  std::vector<L1GctWheelEnergyFpga*> getWheelEnergyFpgas() const { return theWheelEnergyFpgas; }
  
  L1GctJetFinalStage* getJetFinalStage() const { return theJetFinalStage; }
  
  L1GctGlobalEnergyAlgos* getEnergyFinalStage() const { return theEnergyFinalStage; }

  L1GctGlobalHfSumAlgos* getHfSumProcessor() const;
  
  L1GctElectronFinalSort* getIsoEmFinalStage() const { return theIsoEmFinalStage; }
  L1GctElectronFinalSort* getNonIsoEmFinalStage() const { return theNonIsoEmFinalStage; }

  const L1GctJetFinderParams* getJetFinderParams() const { return m_jetFinderParams; }

  const lutPtrVector getJetEtCalibLuts() const { return m_jetEtCalLuts; }

  void print();
  
  void setVerbose();
  void setTerse();

 private:
  
  void sortInputData();
  void bxSetup();
  void bxReset(const int bx);
  void fillEmCands(std::vector<L1CaloEmCand>::iterator& emc, const int bx);
  void fillRegions(std::vector<L1CaloRegion>::iterator& rgn, const int bx);
  void bxProcess(const int bx);

  void build(L1GctJetLeafCard::jetFinderType jfType, unsigned jetLeafMask);

  bool setupOk() const;

  unsigned sorterNo(const L1CaloEmCand& em) const;

  template <class T>
  struct CompareBx {
    bool operator()(const T& i, const T& j) const {
      return i.bx() < j.bx();
    }
  };
  CompareBx<L1CaloEmCand> emcBxComparator;
  CompareBx<L1CaloRegion> rgnBxComparator;

 private:
  
  std::vector<L1GctJetLeafCard*> theJetLeafCards;
  
  std::vector<L1GctJetFinderBase*> theJetFinders;
  
  std::vector<L1GctEmLeafCard*> theEmLeafCards;
  
  std::vector<L1GctElectronSorter*> theIsoElectronSorters;
  std::vector<L1GctElectronSorter*> theNonIsoElectronSorters;
  
  std::vector<L1GctWheelJetFpga*> theWheelJetFpgas;     
  
  std::vector<L1GctWheelEnergyFpga*> theWheelEnergyFpgas;
  
  L1GctJetFinalStage* theJetFinalStage;         
  
  L1GctGlobalEnergyAlgos* theEnergyFinalStage;  
  
  L1GctElectronFinalSort* theIsoEmFinalStage;

  L1GctElectronFinalSort* theNonIsoEmFinalStage;

  const L1GctJetFinderParams* m_jetFinderParams;

  lutPtrVector m_jetEtCalLuts;

  const L1GctChannelMask* m_inputChannelMask;

  bool m_bxRangeAuto;
  int m_bxStart;
  int m_numOfBx;

  std::vector<L1CaloEmCand> m_allInputEmCands;
  std::vector<L1CaloRegion> m_allInputRegions;
};

#endif /*L1GLOBALCALOTRIGGER_H_*/