AnalysisDataFormats/TopObjects/interface/TopGenEvent.h - master - githubmirror/cmssw

AnalysisDataFormats/TopObjects/interface/TopGenEvent.h
116 строк5 KB
Shahzad Malik Muzaffar
[ANALYSIS] Changes suggested by new llvm18 clang-format
05 сен 2024, 17:04
05 сен 2024, 17:04a467cd9
#ifndef TopObjects_TopGenEvent_h
#define TopObjects_TopGenEvent_h

#include "DataFormats/Candidate/interface/Candidate.h"
#include "DataFormats/HepMCCandidate/interface/GenParticle.h"

namespace TopDecayID {
  /// identification of top decays; used for following
  /// the decay chain in TopDecaySubset
  static const int stable = 2;
  static const int unfrag = 3;
  static const int tID = 6;
  static const int bID = 5;
  static const int glueID = 21;
  static const int photID = 22;
  static const int ZID = 23;
  static const int WID = 24;
  static const int elecID = 11;
  static const int muonID = 13;
  static const int tauID = 15;
}  // namespace TopDecayID

namespace WDecay {
  /// classification of leptons in the decay channel
  /// of the W boson used in several places throughout
  /// the package
  enum LeptonType { kNone, kElec, kMuon, kTau };
}  // namespace WDecay

/**
   \class   TopGenEvent TopGenEvent.h "AnalysisDataFormats/TopObjects/interface/TopGenEvent.h"

   \brief   Base class to hold information for reduced top generator information

   The structure holds reference information to the generator particles 
   of the decay chains for each top quark and of the initial partons. It 
   provides access and administration.
*/

class TopGenEvent {
public:
  /// empty constructor
  TopGenEvent() {}
  /// default constructor
  TopGenEvent(reco::GenParticleRefProd& decaySubset, reco::GenParticleRefProd& iniSubset);
  /// default destructor
  virtual ~TopGenEvent() {}

  /// return particles of decay chain
  const reco::GenParticleCollection& particles() const { return *parts_; }
  /// return particles of initial partons
  const reco::GenParticleCollection& initialPartons() const { return *initPartons_; }
  /// return radiated gluons from particle with pdgId
  std::vector<const reco::GenParticle*> radiatedGluons(int pdgId) const;
  /// return all light quarks or all quarks including b's
  std::vector<const reco::GenParticle*> lightQuarks(bool includingBQuarks = false) const;
  /// return number of leptons in the decay chain
  int numberOfLeptons(bool fromWBoson = true) const;
  /// return number of leptons in the decay chain
  int numberOfLeptons(WDecay::LeptonType type, bool fromWBoson = true) const;
  /// return number of b quarks in the decay chain
  int numberOfBQuarks(bool fromTopQuark = true) const;
  /// return number of top anti-top sisters
  std::vector<const reco::GenParticle*> topSisters() const;
  /// return daughter quark of top quark (which can have flavor b, s or d)
  const reco::GenParticle* daughterQuarkOfTop(bool invertCharge = false) const;
  /// return daughter quark of anti-top quark (which can have flavor b, s or d)
  const reco::GenParticle* daughterQuarkOfTopBar() const { return daughterQuarkOfTop(true); };
  /// return quark daughter quark of W boson
  const reco::GenParticle* daughterQuarkOfWPlus(bool invertQuarkCharge = false, bool invertBosonCharge = false) const;
  /// return quark daughter of anti-W boson
  const reco::GenParticle* daughterQuarkOfWMinus() const { return daughterQuarkOfWPlus(false, true); };
  /// return anti-quark daughter of W boson
  const reco::GenParticle* daughterQuarkBarOfWPlus() const { return daughterQuarkOfWPlus(true, false); };
  /// return anti-quark daughter of anti-W boson
  const reco::GenParticle* daughterQuarkBarOfWMinus() const { return daughterQuarkOfWPlus(true, true); };

  /// get candidate with given pdg id if available; 0 else
  const reco::GenParticle* candidate(int id, unsigned int parentId = 0) const;
  /// return electron if available; 0 else
  const reco::GenParticle* eMinus() const { return candidate(TopDecayID::elecID, TopDecayID::WID); }
  /// return positron if available; 0 else
  const reco::GenParticle* ePlus() const { return candidate(-TopDecayID::elecID, TopDecayID::WID); }
  /// return muon if available; 0 else
  const reco::GenParticle* muMinus() const { return candidate(TopDecayID::muonID, TopDecayID::WID); }
  /// return anti-muon if available; 0 else
  const reco::GenParticle* muPlus() const { return candidate(-TopDecayID::muonID, TopDecayID::WID); }
  /// return tau if available; 0 else
  const reco::GenParticle* tauMinus() const { return candidate(TopDecayID::tauID, TopDecayID::WID); }
  /// return anti-tau if available; 0 else
  const reco::GenParticle* tauPlus() const { return candidate(-TopDecayID::tauID, TopDecayID::WID); }
  /// return W minus if available; 0 else
  const reco::GenParticle* wMinus() const { return candidate(-TopDecayID::WID, TopDecayID::tID); }
  /// return W plus if available; 0 else
  const reco::GenParticle* wPlus() const { return candidate(TopDecayID::WID, TopDecayID::tID); }
  /// return b quark if available; 0 else
  const reco::GenParticle* b() const { return candidate(TopDecayID::bID, TopDecayID::tID); }
  /// return anti-b quark if available; 0 else
  const reco::GenParticle* bBar() const { return candidate(-TopDecayID::bID, TopDecayID::tID); }
  /// return top if available; 0 else
  const reco::GenParticle* top() const { return candidate(TopDecayID::tID); }
  /// return anti-top if available; 0 else
  const reco::GenParticle* topBar() const { return candidate(-TopDecayID::tID); }

  /// print content of the top decay chain as formated
  /// LogInfo to the MessageLogger output for debugging
  void print() const;

protected:
  /// reference to the top decay chain (has to be kept in the event!)
  reco::GenParticleRefProd parts_;
  /// reference to the list of initial partons (has to be kept in the event!)
  reco::GenParticleRefProd initPartons_;
};

#endif