HGCalMulticluster.h

Go to the documentation of this file.

#ifndef DataFormats_L1Trigger_HGCalMulticluster_h
#define DataFormats_L1Trigger_HGCalMulticluster_h

#include "DataFormats/Common/interface/Ptr.h"
#include "DataFormats/L1Trigger/interface/BXVector.h"
#include "DataFormats/L1THGCal/interface/HGCalClusterT.h"
#include "DataFormats/L1THGCal/interface/HGCalCluster.h"
#include <boost/iterator/transform_iterator.hpp>
#include <functional>

namespace l1t {

  class HGCalMulticluster : public HGCalClusterT<l1t::HGCalCluster> {
  public:
    HGCalMulticluster() : hOverEValid_(false) {}
    HGCalMulticluster(const LorentzVector p4, int pt = 0, int eta = 0, int phi = 0);

    HGCalMulticluster(const edm::Ptr<l1t::HGCalCluster>& tc, float fraction = 1);

    ~HGCalMulticluster() override;

    float hOverE() const {
      // --- this below would be faster when reading old objects, as HoE will only be computed once,
      // --- but it may not be allowed by CMS rules because of the const_cast
      // --- and could potentially cause a data race
      // if (!hOverEValid_) (const_cast<HGCalMulticluster*>(this))->saveHOverE();
      // --- this below is safe in any case
      return hOverEValid_ ? hOverE_ : l1t::HGCalClusterT<l1t::HGCalCluster>::hOverE();
    }

    void saveHOverE() {
      hOverE_ = l1t::HGCalClusterT<l1t::HGCalCluster>::hOverE();
      hOverEValid_ = true;
    }

    enum EnergyInterpretation { EM = 0 };

    void saveEnergyInterpretation(const HGCalMulticluster::EnergyInterpretation eInt, double energy);

    double iEnergy(const HGCalMulticluster::EnergyInterpretation eInt) const {
      return energy() * interpretationFraction(eInt);
    }

    double iPt(const HGCalMulticluster::EnergyInterpretation eInt) const { return pt() * interpretationFraction(eInt); }

    math::XYZTLorentzVector iP4(const HGCalMulticluster::EnergyInterpretation eInt) const {
      return p4() * interpretationFraction(eInt);
    }

    math::PtEtaPhiMLorentzVector iPolarP4(const HGCalMulticluster::EnergyInterpretation eInt) const {
      return math::PtEtaPhiMLorentzVector(pt() * interpretationFraction(eInt), eta(), phi(), 0.);
    }

  private:
    template <typename Iter>
    struct KeyGetter : std::unary_function<typename Iter::value_type, typename Iter::value_type::first_type> {
      const typename Iter::value_type::first_type& operator()(const typename Iter::value_type& p) const {
        return p.first;
      }
    };

    template <typename Iter>
    boost::transform_iterator<KeyGetter<Iter>, Iter> key_iterator(Iter itr) const {
      return boost::make_transform_iterator<KeyGetter<Iter>, Iter>(itr, KeyGetter<Iter>());
    }

  public:
    typedef boost::transform_iterator<KeyGetter<std::map<EnergyInterpretation, double>::const_iterator>,
                                      std::map<EnergyInterpretation, double>::const_iterator>
        EnergyInterpretation_const_iterator;

    std::pair<EnergyInterpretation_const_iterator, EnergyInterpretation_const_iterator> energyInterpretations() const {
      return std::make_pair(key_iterator(energyInterpretationFractions_.cbegin()),
                            key_iterator(energyInterpretationFractions_.cend()));
    }

    EnergyInterpretation_const_iterator interpretations_begin() const {
      return key_iterator(energyInterpretationFractions_.cbegin());
    }

    EnergyInterpretation_const_iterator interpretations_end() const {
      return key_iterator(energyInterpretationFractions_.cend());
    }

    size_type interpretations_size() const { return energyInterpretationFractions_.size(); }

  private:
    double interpretationFraction(const HGCalMulticluster::EnergyInterpretation eInt) const;

    float hOverE_;
    bool hOverEValid_;
    std::map<EnergyInterpretation, double> energyInterpretationFractions_;
  };

  typedef BXVector<HGCalMulticluster> HGCalMulticlusterBxCollection;

}  // namespace l1t

#endif