VirtualJetProducer.h

Go to the documentation of this file.

#ifndef RecoJets_JetProducers_plugins_VirtualJetProducer_h
#define RecoJets_JetProducers_plugins_VirtualJetProducer_h

#include "RecoJets/JetProducers/interface/JetSpecific.h"

#include "FWCore/Framework/interface/stream/EDProducer.h"
#include "FWCore/ParameterSet/interface/ParameterSet.h"
#include "FWCore/ParameterSet/interface/ConfigurationDescriptions.h"
#include "FWCore/ParameterSet/interface/ParameterSetDescription.h"
#include "DataFormats/Candidate/interface/Candidate.h"
#include "DataFormats/Candidate/interface/CandidateFwd.h"
#include "DataFormats/JetReco/interface/Jet.h"
#include "DataFormats/JetReco/interface/CaloJet.h"
#include "DataFormats/JetReco/interface/PFJet.h"
#include "DataFormats/JetReco/interface/BasicJet.h"
#include "DataFormats/JetReco/interface/GenJet.h"
#include "DataFormats/PatCandidates/interface/PackedCandidate.h"
#include "DataFormats/PatCandidates/interface/PackedGenParticle.h"

#include "DataFormats/JetReco/interface/BasicJetCollection.h"

#include "RecoJets/JetProducers/interface/PileUpSubtractor.h"
#include "RecoJets/JetProducers/interface/AnomalousTower.h"

#include "fastjet/JetDefinition.hh"
#include "fastjet/ClusterSequence.hh"
#include "fastjet/ClusterSequenceArea.hh"
#include "fastjet/PseudoJet.hh"
#include "fastjet/GhostedAreaSpec.hh"
#include "fastjet/Selector.hh"

#include <memory>
#include <vector>

class CaloGeometryRecord;
class HcalRecNumberingRecord;

class dso_hidden VirtualJetProducer : public edm::stream::EDProducer<> {
protected:
  //
  // typedefs & structs
  //
  struct JetType {
    enum Type {
      BasicJet,
      GenJet,
      CaloJet,
      PFJet,
      TrackJet,
      PFClusterJet,
      LastJetType  // no real type, technical
    };
    static const char* const names[];
    static Type byName(const std::string& name);
  };

  JetType::Type jetTypeE;

  inline bool makeCaloJet(const JetType::Type& fTag) { return fTag == JetType::CaloJet; }
  inline bool makePFJet(const JetType::Type& fTag) { return fTag == JetType::PFJet; }
  inline bool makeGenJet(const JetType::Type& fTag) { return fTag == JetType::GenJet; }
  inline bool makeTrackJet(const JetType::Type& fTag) { return fTag == JetType::TrackJet; }
  inline bool makePFClusterJet(const JetType::Type& fTag) { return fTag == JetType::PFClusterJet; }
  inline bool makeBasicJet(const JetType::Type& fTag) { return fTag == JetType::BasicJet; }

  //
  // construction/destruction
  //
public:
  explicit VirtualJetProducer(const edm::ParameterSet& iConfig);
  ~VirtualJetProducer() override;
  static void fillDescriptions(edm::ConfigurationDescriptions& descriptions);
  static void fillDescriptionsFromVirtualJetProducer(edm::ParameterSetDescription& desc);

  // typedefs
  typedef std::shared_ptr<fastjet::ClusterSequence> ClusterSequencePtr;
  typedef std::shared_ptr<fastjet::JetDefinition::Plugin> PluginPtr;
  typedef std::shared_ptr<fastjet::JetDefinition> JetDefPtr;
  typedef std::shared_ptr<fastjet::GhostedAreaSpec> ActiveAreaSpecPtr;
  typedef std::shared_ptr<fastjet::AreaDefinition> AreaDefinitionPtr;
  typedef std::shared_ptr<fastjet::Selector> SelectorPtr;

  //
  // member functions
  //
public:
  void produce(edm::Event& iEvent, const edm::EventSetup& iSetup) override;
  std::string jetType() const { return jetType_; }

protected:
  //
  // Internal methods for jet production.
  // The user can either use the defaults, or override all of these methods.
  //

  // This method creates the "produces" statement in the constructor.
  // The default is to produce a single jet collection as per the user's request
  // (Calo,PF,Basic, or Gen).
  virtual void makeProduces(std::string s, std::string tag = "");

  // This method inputs the constituents from "inputs" and modifies
  // fjInputs.
  virtual void inputTowers();

  // This checks if the tower is anomalous (if a calo tower).
  virtual bool isAnomalousTower(reco::CandidatePtr input);

  // This will copy the fastjet constituents to the jet itself.
  virtual void copyConstituents(const std::vector<fastjet::PseudoJet>& fjConstituents, reco::Jet* jet);

  // This will run the actual algorithm. This method is pure virtual and
  // has no default.
  virtual void runAlgorithm(edm::Event& iEvent, const edm::EventSetup& iSetup) = 0;

  // This will allow making the HTTTopJetTagInfoCollection
  virtual void addHTTTopJetTagInfoCollection(edm::Event& iEvent,
                                             const edm::EventSetup& iSetup,
                                             edm::OrphanHandle<reco::BasicJetCollection>& oh){};

  // Do the offset correction.
  // Only runs if "doPUOffsetCorrection_" is true.
  void offsetCorrectJets(std::vector<fastjet::PseudoJet>& orphanInput);

  // This will write the jets to the event.
  // The default is to write out the single jet collection in the default "produces"
  // statement.
  // This is a function template that can be called for the six types
  // CaloJet, PFJet, GenJet, TrackJet, PFClusterJet, BasicJet.
  // This is not suitable for compound jets.
  // Note: The "output" method is virtual and can be overriden.
  // The default behavior is to call the function template "writeJets".
  virtual void output(edm::Event& iEvent, edm::EventSetup const& iSetup);
  template <typename T>
  void writeJets(edm::Event& iEvent, edm::EventSetup const& iSetup);

  template <typename T>
  void writeCompoundJets(edm::Event& iEvent, edm::EventSetup const& iSetup);

  template <typename T>
  void writeJetsWithConstituents(edm::Event& iEvent, edm::EventSetup const& iSetup);

  // This method copies the constituents from the fjConstituents method
  // to an output of CandidatePtr's.
  virtual std::vector<reco::CandidatePtr> getConstituents(const std::vector<fastjet::PseudoJet>& fjConstituents);

  //These are only valid if we are dealing with CaloJets
  CaloGeometry const& getGeometry(edm::EventSetup const&) const;
  HcalTopology const& getTopology(edm::EventSetup const&) const;

  //
  // member data
  //
protected:
  std::string moduleLabel_;   // label for this module
  edm::InputTag src_;         // input constituent source
  edm::InputTag srcPVs_;      // primary vertex source
  std::string jetType_;       // type of jet (Calo,PF,Basic,Gen)
  std::string jetAlgorithm_;  // the jet algorithm to use
  double rParam_;             // the R parameter to use
  double inputEtMin_;         // minimum et of input constituents
  double inputEMin_;          // minimum e of input constituents
  double jetPtMin_;           // minimum jet pt
  bool doPVCorrection_;       // correct to primary vertex?

  // for restricting inputs due to processing time
  bool restrictInputs_;     // restrict inputs to first "maxInputs" inputs.
  unsigned int maxInputs_;  // maximum number of inputs.

  // for fastjet jet area calculation
  bool doAreaFastjet_;      // calculate area w/ fastjet?
  bool useExplicitGhosts_;  // use explicit ghosts in fastjet clustering sequence
  bool doAreaDiskApprox_;   // calculate area w/ disk approximation (only makes sense for anti-KT)?
  // for fastjet rho calculation
  bool doRhoFastjet_;         // calculate rho w/ fastjet?
  bool doFastJetNonUniform_;  // choice of eta-dependent PU calculation
  double
      voronoiRfact_;  // negative to calculate rho using active area (ghosts); otherwise calculates Voronoi area with this effective scale factor

  double
      rhoEtaMax_;  // Eta range of jets to be considered for Rho calculation; Should be at most (jet acceptance - jet radius)
  double ghostEtaMax_;     // default Ghost_EtaMax should be 5
  int activeAreaRepeats_;  // default Active_Area_Repeats 1
  double ghostArea_;       // default GhostArea 0.01

  // for pileup offset correction
  bool doPUOffsetCorr_;  // add the pileup calculation from offset correction?
  std::string puSubtractorName_;

  std::vector<edm::Ptr<reco::Candidate>>
      inputs_;                                // input candidates [View, PtrVector and CandCollection have limitations]
  reco::Particle::Point vertex_;              // Primary vertex
  ClusterSequencePtr fjClusterSeq_;           // fastjet cluster sequence
  JetDefPtr fjJetDefinition_;                 // fastjet jet definition
  PluginPtr fjPlugin_;                        // fastjet plugin
  ActiveAreaSpecPtr fjActiveArea_;            // fastjet active area definition
  AreaDefinitionPtr fjAreaDefinition_;        // fastjet area definition
  SelectorPtr fjSelector_;                    // selector for range definition
  std::vector<fastjet::PseudoJet> fjInputs_;  // fastjet inputs
  std::vector<fastjet::PseudoJet> fjJets_;    // fastjet jets

  // Parameters of the eta-dependent rho calculation
  std::vector<double> puCenters_;
  double puWidth_;
  unsigned int nExclude_;

  std::string jetCollInstanceName_;  // instance name for output jet collection
  bool writeCompound_;               // write compound jets (i.e. jets of jets)
  bool writeJetsWithConst_;          // write jets with constituents
  std::shared_ptr<PileUpSubtractor> subtractor_;

  bool useDeterministicSeed_;  // If desired, use a deterministic seed to fastjet
  unsigned int minSeed_;       // minimum seed to use, useful for MC generation

  int verbosity_;                       // flag to enable/disable debug output
  bool fromHTTTopJetProducer_ = false;  // for running the v2.0 HEPTopTagger
  bool applyWeight_;              // Apply weights stored in a value map or inside PackedCandidate (e.g. from PUPPI)
  edm::ValueMap<float> weights_;  // weights per particle (e.g. from PUPPI)

private:
  //These are only initialized if we are dealing with CaloJets
  edm::ESGetToken<CaloGeometry, CaloGeometryRecord> geometry_token_;
  edm::ESGetToken<HcalTopology, HcalRecNumberingRecord> topology_token_;

  std::unique_ptr<AnomalousTower> anomalousTowerDef_;  // anomalous tower definition

  // tokens for the data access
  edm::EDGetTokenT<reco::CandidateView> input_candidateview_token_;
  edm::EDGetTokenT<std::vector<edm::FwdPtr<reco::PFCandidate>>> input_candidatefwdptr_token_;
  edm::EDGetTokenT<std::vector<edm::FwdPtr<pat::PackedCandidate>>> input_packedcandidatefwdptr_token_;
  edm::EDGetTokenT<std::vector<edm::FwdPtr<reco::GenParticle>>> input_gencandidatefwdptr_token_;
  edm::EDGetTokenT<std::vector<edm::FwdPtr<pat::PackedGenParticle>>> input_packedgencandidatefwdptr_token_;

protected:
  edm::EDGetTokenT<reco::VertexCollection> input_vertex_token_;
  edm::EDGetTokenT<edm::ValueMap<float>> input_weights_token_;
};

#endif