TICLCandidateFromTrackstersProducer.cc

Go to the documentation of this file.

// user include files
#include <algorithm>
#include <vector>

#include "FWCore/Framework/interface/ESHandle.h"
#include "FWCore/Framework/interface/Event.h"
#include "FWCore/Framework/interface/Frameworkfwd.h"
#include "FWCore/Framework/interface/MakerMacros.h"
#include "FWCore/Framework/interface/stream/EDProducer.h"
#include "FWCore/Framework/interface/ConsumesCollector.h"
#include "FWCore/MessageLogger/interface/MessageLogger.h"
#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"

#include "FWCore/Utilities/interface/transform.h"

#include "DataFormats/HGCalReco/interface/TICLCandidate.h"
#include "DataFormats/HGCalReco/interface/Trackster.h"
#include "RecoHGCal/TICL/interface/TracksterMomentumPluginBase.h"
#include "RecoHGCal/TICL/interface/TracksterTrackPluginBase.h"

using namespace ticl;

class TICLCandidateFromTrackstersProducer : public edm::stream::EDProducer<> {
public:
  TICLCandidateFromTrackstersProducer(const edm::ParameterSet&);
  ~TICLCandidateFromTrackstersProducer() override {}
  static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);

  void produce(edm::Event&, const edm::EventSetup&) override;

private:
  std::vector<edm::EDGetTokenT<std::vector<Trackster>>> trackster_tokens_;
  std::unique_ptr<TracksterMomentumPluginBase> momentum_algo_;
  std::unique_ptr<TracksterTrackPluginBase> track_algo_;
  float min_particle_prob_;
};
DEFINE_FWK_MODULE(TICLCandidateFromTrackstersProducer);

namespace {
  int pdg_id_from_particle_type(ticl::Trackster::ParticleType type) {
    switch (type) {
      case ticl::Trackster::ParticleType::photon:
        return 22;
      case ticl::Trackster::ParticleType::electron:
        // Pick IDs with positive charge so they can be reset with charge * id downstream
        return -11;
      case ticl::Trackster::ParticleType::muon:
        return -13;
      case ticl::Trackster::ParticleType::neutral_pion:
        return 111;
      case ticl::Trackster::ParticleType::charged_hadron:
        return 211;
      case ticl::Trackster::ParticleType::neutral_hadron:
        return 130;
      default:
        return 0;
    }
    return 0;
  }
}  // namespace

TICLCandidateFromTrackstersProducer::TICLCandidateFromTrackstersProducer(const edm::ParameterSet& ps)
    : min_particle_prob_(ps.getParameter<double>("minParticleProbability")) {
  trackster_tokens_ =
      edm::vector_transform(ps.getParameter<std::vector<edm::InputTag>>("tracksterCollections"),
                            [this](edm::InputTag const& tag) { return consumes<std::vector<Trackster>>(tag); });
  produces<std::vector<TICLCandidate>>();
  auto pset_momentum = ps.getParameter<edm::ParameterSet>("momentumPlugin");
  momentum_algo_ = TracksterMomentumPluginFactory::get()->create(
      pset_momentum.getParameter<std::string>("plugin"), pset_momentum, consumesCollector());

  auto pset_track = ps.getParameter<edm::ParameterSet>("trackPlugin");
  track_algo_ = TracksterTrackPluginFactory::get()->create(
      pset_track.getParameter<std::string>("plugin"), pset_track, consumesCollector());
}

void TICLCandidateFromTrackstersProducer::fillDescriptions(edm::ConfigurationDescriptions& descriptions) {
  edm::ParameterSetDescription desc;

  std::vector<edm::InputTag> source_vector{edm::InputTag("trackstersTrk"),
                                           edm::InputTag("trackstersMIP"),
                                           edm::InputTag("trackstersEM"),
                                           edm::InputTag("trackstersHAD")};
  desc.add<std::vector<edm::InputTag>>("tracksterCollections", source_vector);
  desc.add<double>("minParticleProbability", 0.);

  edm::ParameterSetDescription desc_momentum;
  desc_momentum.add<std::string>("plugin", "TracksterP4FromEnergySum");
  desc_momentum.add<bool>("energyFromRegression", false);
  desc_momentum.add<edm::InputTag>("vertices", edm::InputTag("offlinePrimaryVertices"));
  desc_momentum.add<edm::InputTag>("layerClusters", edm::InputTag("hgcalLayerClusters"));
  desc_momentum.add<edm::InputTag>("tracks", edm::InputTag("generalTracks"));
  desc.add<edm::ParameterSetDescription>("momentumPlugin", desc_momentum);

  edm::ParameterSetDescription desc_track;
  desc_track.add<std::string>("plugin", "TracksterRecoTrackPlugin");
  desc.add<edm::ParameterSetDescription>("trackPlugin", desc_track);

  descriptions.add("ticlCandidateFromTrackstersProducer", desc);
}

void TICLCandidateFromTrackstersProducer::produce(edm::Event& evt, const edm::EventSetup& es) {
  auto result = std::make_unique<std::vector<TICLCandidate>>();

  std::vector<const Trackster*> trackster_ptrs;

  // adds one TICLCandidate for each trackster that has a minimum particle probability
  for (auto& trackster_token : trackster_tokens_) {
    edm::Handle<std::vector<Trackster>> trackster_h;
    evt.getByToken(trackster_token, trackster_h);
    for (size_t i_trackster = 0; i_trackster < trackster_h->size(); ++i_trackster) {
      auto const& trackster = trackster_h->at(i_trackster);
      auto id_prob_begin = std::begin(trackster.id_probabilities());
      auto max_id_prob_it = std::max_element(id_prob_begin, std::end(trackster.id_probabilities()));
      float max_id_prob = *max_id_prob_it;
      if (max_id_prob < min_particle_prob_)
        continue;

      trackster_ptrs.push_back(&trackster);
      auto& ticl_cand = result->emplace_back(edm::Ptr<ticl::Trackster>(trackster_h, i_trackster));
      auto max_index = std::distance(id_prob_begin, max_id_prob_it);
      auto pdg_id = pdg_id_from_particle_type(static_cast<ticl::Trackster::ParticleType>(max_index));
      ticl_cand.setPdgId(pdg_id);
    }
  }

  momentum_algo_->setP4(trackster_ptrs, *result, evt);
  track_algo_->setTrack(trackster_ptrs, *result, evt);

  // charge assignment
  for (size_t i = 0; i < result->size(); ++i) {
    auto& ticl_cand = result->at(i);
    auto pdg_id = ticl_cand.pdgId();
    if (pdg_id == -11 || pdg_id == -13 || pdg_id == 211) {
      if (ticl_cand.trackPtr().isNonnull()) {
        auto charge = ticl_cand.trackPtr()->charge();
        ticl_cand.setCharge(charge);
        ticl_cand.setPdgId(pdg_id * charge);
        // If this is a special 0 energy trackster that has been injected
        // starting from a seed that has not been linked to any shower,
        // re-assign the energy and momentum to be the ones of the track linked
        // to the original seeding region.
        if (ticl_cand.rawEnergy() == 0.) {
          auto const& three_mom = ticl_cand.trackPtr()->momentum();
          constexpr double mpion2 = 0.13957 * 0.13957;
          double energy = std::sqrt(three_mom.mag2() + mpion2);
          math::XYZTLorentzVector trk_p4(three_mom.x(), three_mom.y(), three_mom.z(), energy);
          ticl_cand.setP4(trk_p4);
          ticl_cand.setRawEnergy(energy);
        }
      } else {
        // Demote them to be neutral, since there's not track associated.
        ticl_cand.setCharge(0);
        if (pdg_id == -11) {
          ticl_cand.setPdgId(22);
        } else {
          ticl_cand.setPdgId(130);
        }
      }
    }
  }

  evt.put(std::move(result));
}