Stage1Layer2EtSumAlgorithmImp.h

Go to the documentation of this file.

//
// This header file contains the class definitions for all of the concrete
// implementations of the firmware interface. The Stage1Layer2FirmwareFactory
// selects the appropriate implementation based on the firmware version in the
// configuration.
//

#ifndef L1TCALOSTAGE1ETSUMSALGORITHMIMP_H
#define L1TCALOSTAGE1ETSUMSALGORITHMIMP_H

#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "L1Trigger/L1TCalorimeter/interface/Stage1Layer2EtSumAlgorithm.h"
#include "L1Trigger/L1TCalorimeter/interface/CaloParamsHelper.h"
#include "L1Trigger/L1TCalorimeter/interface/CordicXilinx.h"
#include <array>
#include <vector>


namespace l1t {

  class Stage1Layer2EtSumAlgorithmImpPP : public Stage1Layer2EtSumAlgorithm {
  public:
    Stage1Layer2EtSumAlgorithmImpPP(CaloParamsHelper const* params);
    ~Stage1Layer2EtSumAlgorithmImpPP() override = default;
    void processEvent(const std::vector<l1t::CaloRegion> & regions,
                  const std::vector<l1t::CaloEmCand> & EMCands,
                  const std::vector<l1t::Jet> * jets,
                  std::vector<l1t::EtSum> * sums) override;

  private:
    CaloParamsHelper const* const params_;

    int DiJetPhi(const std::vector<l1t::Jet> * jets) const;
    uint16_t MHToverHT(uint16_t,uint16_t) const;
    std::vector<double> sinPhi;
    std::vector<double> cosPhi;

  };

  class Stage1Layer2EtSumAlgorithmImpHW : public Stage1Layer2EtSumAlgorithm {
  public:
    Stage1Layer2EtSumAlgorithmImpHW(CaloParamsHelper const* params);
    ~Stage1Layer2EtSumAlgorithmImpHW() override = default;
    void processEvent(const std::vector<l1t::CaloRegion> & regions,
                  const std::vector<l1t::CaloEmCand> & EMCands,
                  const std::vector<l1t::Jet> * jets,
                  std::vector<l1t::EtSum> * sums) override;

  private:
    CaloParamsHelper const* const params_;

    int DiJetPhi(const std::vector<l1t::Jet> * jets) const;
    uint16_t MHToverHT(uint16_t,uint16_t) const;

    struct SimpleRegion {
      int ieta;
      int iphi;
      int et;
    };
    enum class ETSumType {
      kHadronicSum,
      kEmSum
    };
    std::tuple<int, int, int> doSumAndMET(const std::vector<SimpleRegion>& regionEt, ETSumType sumType);

    // Converts 3Q16 fixed-point phase from CORDIC
    // to 0-71 appropriately
    int cordicToMETPhi(int phase);
    // Array used in above function
    std::array<int, 73> cordicPhiValues;

    CordicXilinx cordic{24, 19};

    // for converting region et to x and y components
    std::array<long, 5> cosines;
    std::array<long, 5> sines;
  };

  class Stage1Layer2EtSumAlgorithmImpHI : public Stage1Layer2EtSumAlgorithm {
  public:
    Stage1Layer2EtSumAlgorithmImpHI(CaloParamsHelper const* params);
    ~Stage1Layer2EtSumAlgorithmImpHI() override = default;
    void processEvent(const std::vector<l1t::CaloRegion> & regions,
                  const std::vector<l1t::CaloEmCand> & EMCands,
                  const std::vector<l1t::Jet> * jets,
                  std::vector<l1t::EtSum> * sums) override;

  private:
    CaloParamsHelper const* const params_;

    int DiJetPhi(const std::vector<l1t::Jet> * jets) const;
    uint16_t MHToverHT(uint16_t,uint16_t) const;

    struct SimpleRegion {
      int ieta;
      int iphi;
      int et;
    };
    enum class ETSumType {
      kHadronicSum,
      kEmSum
    };
    std::tuple<int, int, int> doSumAndMET(const std::vector<SimpleRegion>& regionEt, ETSumType sumType);

    // Converts 3Q16 fixed-point phase from CORDIC
    // to 0-71 appropriately
    int cordicToMETPhi(int phase);
    // Array used in above function
    std::array<int, 73> cordicPhiValues;

    CordicXilinx cordic{24, 19};

    // for converting region et to x and y components
    std::array<long, 5> cosines;
    std::array<long, 5> sines;
  };


  /* class Stage1Layer2CentralityAlgorithm : public Stage1Layer2EtSumAlgorithm { */
  /* public: */
  /*   Stage1Layer2CentralityAlgorithm(CaloParamsHelper* params); */
  /*   virtual ~Stage1Layer2CentralityAlgorithm(); */
  /*   virtual void processEvent(const std::vector<l1t::CaloRegion> & regions, */
  /*                  const std::vector<l1t::CaloEmCand> & EMCands, */
  /*                  std::vector<l1t::EtSum> * sums); */
  /* private: */
  /*   CaloParamsHelper* const params_; */
  /* }; */
}

#endif