RecoTauBuilderPlugins.h

Go to the documentation of this file.

#ifndef RecoTauTag_RecoTau_RecoTauBuilderPlugin_h
#define RecoTauTag_RecoTau_RecoTauBuilderPlugin_h

/*
 * RecoTauBuilderPlugins
 *
 * Author: Evan K. Friis (UC Davis)
 *
 * Classes for building new and modifying existing PFTaus from PFJets and
 * reconstructed PiZeros.
 *
 * RecoTauBuilderPlugin is the base class for any algorithm that constructs
 * taus.  Algorithms should override the abstract function
 *
 * std::vector<PFTau> operator()(const PFJet&, const
 * std::vector<RecoTauPiZero>&) const;
 *
 * implementing it such that a list of taus a produced for a given jet and its
 * associated collection of PiZeros.
 *
 * RecoTauModifierPlugin takes an input tau and modifies it.
 *
 * Both plugins inherit from RecoTauEventHolderPlugin, which provides the
 * methods
 *
 *    const edm::Event* evt() const; const edm::EventSetup* evtSetup()
 *
 * to retrieve the current event if necessary.
 *
 *
 */

#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/Framework/interface/ConsumesCollector.h"

#include "DataFormats/VertexReco/interface/VertexFwd.h"
#include "DataFormats/JetReco/interface/JetCollection.h"
#include "DataFormats/TauReco/interface/PFTau.h"
#include "DataFormats/TauReco/interface/PFRecoTauChargedHadron.h"
#include "DataFormats/TauReco/interface/RecoTauPiZero.h"
#include "RecoTauTag/RecoTau/interface/RecoTauPluginsCommon.h"
#include "RecoTauTag/RecoTau/interface/RecoTauVertexAssociator.h"

#include "DataFormats/Provenance/interface/EventID.h"
#include "DataFormats/Common/interface/Handle.h"

#include <vector>

namespace reco {
  namespace tau {

    /* Class that constructs PFTau(s) from a Jet and its associated PiZeros */
    class RecoTauBuilderPlugin : public RecoTauEventHolderPlugin {
    public:
      typedef std::vector<std::unique_ptr<reco::PFTau>> output_type;
      typedef output_type return_type;

      explicit RecoTauBuilderPlugin(const edm::ParameterSet& pset, edm::ConsumesCollector&& iC)
          : RecoTauEventHolderPlugin(pset),
            // The vertex association configuration is specified with the quality cuts.
            vertexAssociator_(pset.getParameter<edm::ParameterSet>("qualityCuts"), std::move(iC)) {
        pfCandSrc_ = pset.getParameter<edm::InputTag>("pfCandSrc");
        pfCand_token = iC.consumes<edm::View<reco::Candidate>>(pfCandSrc_);
      };

      ~RecoTauBuilderPlugin() override {}

      virtual return_type operator()(const reco::JetBaseRef&,
                                     const std::vector<reco::PFRecoTauChargedHadron>&,
                                     const std::vector<reco::RecoTauPiZero>&,
                                     const std::vector<CandidatePtr>&) const = 0;

      const edm::Handle<edm::View<reco::Candidate>>& getPFCands() const { return pfCands_; };

      reco::VertexRef primaryVertex(const reco::JetBaseRef& jet) const {
        return vertexAssociator_.associatedVertex(*jet);
      }
      reco::VertexRef primaryVertex(const reco::PFTau& tau, bool useJet = false) const {
        return vertexAssociator_.associatedVertex(tau, useJet);
      }

      // Hook called by base class at the beginning of each event. Used to update
      // handle to PFCandidates
      void beginEvent() override;

    private:
      edm::InputTag pfCandSrc_;
      // Handle to PFCandidates needed to build Refs
      edm::Handle<edm::View<reco::Candidate>> pfCands_;
      reco::tau::RecoTauVertexAssociator vertexAssociator_;
      edm::EDGetTokenT<edm::View<reco::Candidate>> pfCand_token;
    };

    /* Class that updates a PFTau's members (i.e. electron variables) */
    class RecoTauModifierPlugin : public RecoTauEventHolderPlugin {
    public:
      explicit RecoTauModifierPlugin(const edm::ParameterSet& pset, edm::ConsumesCollector&& iC)
          : RecoTauEventHolderPlugin(pset) {}
      ~RecoTauModifierPlugin() override {}
      // Modify an existing PFTau (i.e. add electron rejection, etc)
      virtual void operator()(PFTau&) const = 0;
      void beginEvent() override {}
      virtual void endEvent() {}
    };

    /* Class that returns a double value indicating the quality of a given tau */
    class RecoTauCleanerPlugin : public RecoTauEventHolderPlugin {
    public:
      explicit RecoTauCleanerPlugin(const edm::ParameterSet& pset, edm::ConsumesCollector&& iC)
          : RecoTauEventHolderPlugin(pset) {}
      ~RecoTauCleanerPlugin() override {}
      // Modify an existing PFTau (i.e. add electron rejection, etc)
      virtual double operator()(const PFTauRef&) const = 0;
      void beginEvent() override {}
    };
  }  // namespace tau
}  // namespace reco

#include "FWCore/PluginManager/interface/PluginFactory.h"

typedef edmplugin::PluginFactory<reco::tau::RecoTauBuilderPlugin*(const edm::ParameterSet&, edm::ConsumesCollector&& iC)>
    RecoTauBuilderPluginFactory;
typedef edmplugin::PluginFactory<reco::tau::RecoTauModifierPlugin*(const edm::ParameterSet&,
                                                                   edm::ConsumesCollector&& iC)>
    RecoTauModifierPluginFactory;
typedef edmplugin::PluginFactory<reco::tau::RecoTauCleanerPlugin*(const edm::ParameterSet&, edm::ConsumesCollector&& iC)>
    RecoTauCleanerPluginFactory;

#endif