Imperial Analysis
 All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
ic::PFJet Class Reference

A class deriving from ic::Jet that provides specific information for particle-flow jets. More...

#include "UserCode/ICHiggsTauTau/interface/PFJet.hh"

+ Inheritance diagram for ic::PFJet:

Public Member Functions

 PFJet ()
 
virtual ~PFJet ()
 
virtual void Print () const
 
 ClassDef (PFJet, 2)
 
Properties
int const & muon_multiplicity () const
 Number of PF muon constituents. More...
 
int const & charged_multiplicity () const
 Number of charged constituents. More...
 
int const & charged_had_multiplicity () const
 Number of charged hadron constituents. More...
 
int const & neutral_had_multiplicity () const
 Number of neutral hadron constituents. More...
 
int const & photon_multiplicity () const
 Number of PF photon constituents. More...
 
int const & electron_multiplicity () const
 Number of PF electron constituents. More...
 
int const & HF_had_multiplicity () const
 Number PF HF hadronic constituents. More...
 
int const & HF_em_multiplicity () const
 Number of PF HF electromagnetic constituents. More...
 
int const & neutral_multiplicity () const
 Number of neutral constituents. More...
 
float const & charged_em_energy () const
 Charged electromagnetic energy. More...
 
float charged_em_energy_frac () const
 Calculates the charged electromagnetic fraction of the raw jet energy. More...
 
float const & neutral_em_energy () const
 Neutral electromagnetic energy. More...
 
float neutral_em_energy_frac () const
 Calculates the neutral electromagnetic fraction of the raw jet energy. More...
 
float const & charged_had_energy () const
 Charged hadron energy. More...
 
float charged_had_energy_frac () const
 Calculates the charged hadron fraction of the raw jet energy. More...
 
float const & neutral_had_energy () const
 Neutral hadron energy. More...
 
float neutral_had_energy_frac () const
 Calculates the neutral hadron fraction of the raw jet energy. More...
 
float const & photon_energy () const
 Photon energy. More...
 
float photon_energy_frac () const
 Calculates the photon fraction of the raw jet energy. More...
 
float const & electron_energy () const
 Electron energy. More...
 
float electron_energy_frac () const
 Calculates the electron fraction of the raw jet energy. More...
 
float const & muon_energy () const
 Muon energy. More...
 
float muon_energy_frac () const
 Calculates the muon fraction of the raw jet energy. More...
 
float const & HF_had_energy () const
 HF hadronic energy. More...
 
float HF_had_energy_frac () const
 Calculates the HF hadronic fraction of the raw jet energy. More...
 
float const & HF_em_energy () const
 HF electromagnetic energy. More...
 
float HF_em_energy_frac () const
 Calculates the HF electromagnetic fraction of the raw jet energy. More...
 
float const & charged_mu_energy () const
 Muon energy. More...
 
float charged_mu_energy_frac () const
 Calculates the muon fraction of the raw jet energy. More...
 
float const & beta () const
 The fraction of the constituent track momentum associated to the primary vertex. More...
 
float const & beta_max () const
 The largest value of beta() obtained when it is evaluated for every vertex in the event. More...
 
float const & pu_id_mva_value () const
 The output of the pileup ID MVA. More...
 
bool pu_id_mva_loose () const
 Whether the loose working point of the MVA ID is passed. More...
 
std::vector< std::size_t > const & constituent_tracks () const
 A vector to refer to the constituent track ic::Track::id() values. More...
 
int const & charged_multiplicity_nopu () const
 The number of charged constituents associated to the PV. More...
 
float const & linear_radial_moment () const
 Used for quark-gluon discrimination. More...
 
Setters
void set_muon_multiplicity (int const &muon_multiplicity)
 Number of PF muon constituents. More...
 
void set_charged_multiplicity (int const &charged_multiplicity)
 Number of charged constituents. More...
 
void set_charged_had_multiplicity (int const &charged_had_multiplicity)
 Number of charged hadron constituents. More...
 
void set_neutral_had_multiplicity (int const &neutral_had_multiplicity)
 Number of neutral hadron constituents. More...
 
void set_photon_multiplicity (int const &photon_multiplicity)
 Number of PF photon constituents. More...
 
void set_electron_multiplicity (int const &electron_multiplicity)
 Number of PF electron constituents. More...
 
void set_HF_had_multiplicity (int const &HF_had_multiplicity)
 Number PF HF hadronic constituents. More...
 
void set_HF_em_multiplicity (int const &HF_em_multiplicity)
 Number of PF HF electromagnetic constituents. More...
 
void set_neutral_multiplicity (int const &neutral_multiplicity)
 Number of neutral constituents. More...
 
void set_charged_em_energy (float const &charged_em_energy)
 Charged electromagnetic energy. More...
 
void set_neutral_em_energy (float const &neutral_em_energy)
 Neutral electromagnetic energy. More...
 
void set_charged_had_energy (float const &charged_had_energy)
 Charged hadron energy. More...
 
void set_neutral_had_energy (float const &neutral_had_energy)
 Neutral hadron energy. More...
 
void set_photon_energy (float const &photon_energy)
 Photon energy. More...
 
void set_electron_energy (float const &electron_energy)
 Electron energy. More...
 
void set_muon_energy (float const &muon_energy)
 Muon energy. More...
 
void set_HF_had_energy (float const &HF_had_energy)
 HF hadronic energy. More...
 
void set_HF_em_energy (float const &HF_em_energy)
 HF electromagnetic energy. More...
 
void set_charged_mu_energy (float const &charged_mu_energy)
 Muon energy. More...
 
void set_beta (float const &beta)
 The fraction of the constituent track momentum associated to the primary vertex. More...
 
void set_beta_max (float const &beta_max)
 The largest value of beta() obtained when it is evaluated for every vertex in the event. More...
 
void set_pu_id_mva_value (float const &pu_id_mva_value)
 The output of the pileup ID MVA. More...
 
void set_constituent_tracks (std::vector< std::size_t > const &constituent_tracks)
 A vector to refer to the constituent track ic::Track::id() values. More...
 
void set_charged_multiplicity_nopu (int const &charged_multiplicity_nopu)
 The number of charged constituents associated to the PV. More...
 
void set_linear_radial_moment (float const &linear_radial_moment)
 Used for quark-gluon discrimination. More...
 
- Public Member Functions inherited from ic::Jet
 Jet ()
 
virtual ~Jet ()
 
 ClassDef (Jet, 3)
 
std::map< std::size_t, float >
const & 
jec_factors () const
 A map containing the jet energy corrections, where the key is stored as a hash of the identifying string. More...
 
std::map< std::size_t, float >
const & 
b_discriminators () const
 A map containing the b-tagging discriminators, where the key is stored as a hash of the identifying string. More...
 
std::vector< std::size_t > const & gen_particles () const
 A vector to refer to ic::GenParticle::id() values. More...
 
std::vector< std::size_t > const & secondary_vertices () const
 A map containing the b-tagging discriminators, where the key is stored as a hash of the identifying string. More...
 
double const & uncorrected_energy () const
 The raw value of the jet energy. More...
 
float const & jet_area () const
 The jet area as used in the L1FastJet correction. More...
 
int const & parton_flavour () const
 An algorithmic determination of the true flavour of the jet, e.g. gluon, light, c or b quark. This is defined only in simulation and returns a PDG code. More...
 
int const & hadron_flavour () const
 Returns true flavour of jet as PDG code. The hadronic definition can only return 0, 4 or 5. More...
 
float GetJecFactor (std::string const &name) const
 Returns a specific correction factor if name is defined, otherwise returns zero. More...
 
float GetBDiscriminator (std::string const &name) const
 Returns a specific discriminator value if name is defined, otherwise returns zero. More...
 
void set_jec_factors (std::map< std::size_t, float > const &jec_factors)
 A map containing the jet energy corrections, where the key is stored as a hash of the identifying string. More...
 
void set_b_discriminators (std::map< std::size_t, float > const &b_discriminators)
 A map containing the b-tagging discriminators, where the key is stored as a hash of the identifying string. More...
 
void set_gen_particles (std::vector< std::size_t > const &gen_particles)
 A vector to refer to ic::GenParticle::id() values. More...
 
void set_secondary_vertices (std::vector< std::size_t > const &secondary_vertices)
 A map containing the b-tagging discriminators, where the key is stored as a hash of the identifying string. More...
 
void set_uncorrected_energy (double const &uncorrected_energy)
 The raw value of the jet energy. More...
 
void set_jet_area (float const &jet_area)
 The jet area as used in the L1FastJet correction. More...
 
void set_parton_flavour (int const &parton_flavour)
 An algorithmic determination of the true flavour of the jet, e.g. gluon, light, c or b quark. This is defined only in simulation and returns a PDG code. More...
 
void set_hadron_flavour (int const &hadron_flavour)
 Returns true flavour of jet as PDG code. The hadronic definition can only return 0, 4 or 5. More...
 
void SetJecFactor (std::string const &name, float const &value)
 Store a jet energy correction factor, overwriting any existing value with label name More...
 
void SetBDiscriminator (std::string const &name, float const &value)
 Store a b-tagging discriminator, overwriting any existing value with label name More...
 
- Public Member Functions inherited from ic::Candidate
 Candidate ()
 
virtual ~Candidate ()
 
 ClassDef (Candidate, 2)
 
Vector const & vector () const
 Four-momentum. More...
 
std::size_t id () const
 Unique identifier. More...
 
double pt () const
 Direct access to the \( p_{\text{T}} \). More...
 
double eta () const
 Direct access to \( \eta \). More...
 
double phi () const
 Direct access to \( \phi \). More...
 
double energy () const
 Direct access to the energy. More...
 
int charge () const
 Electric charge. More...
 
double M () const
 Calculates the candidate mass. More...
 
void set_vector (Vector const &vector)
 Four-momentum. More...
 
void set_id (std::size_t const &id)
 Unique identifier. More...
 
void set_pt (double const &pt)
 Direct access to the \( p_{\text{T}} \). More...
 
void set_eta (double const &eta)
 Direct access to \( \eta \). More...
 
void set_phi (double const &phi)
 Direct access to \( \phi \). More...
 
void set_energy (double const &energy)
 Direct access to the energy. More...
 
void set_charge (int const &charge)
 Electric charge. More...
 

Detailed Description

A class deriving from ic::Jet that provides specific information for particle-flow jets.

Examples:
plugins/ICJetDestHelper.hh, and plugins/ICJetProducer.hh.

Definition at line 14 of file PFJet.hh.

Constructor & Destructor Documentation

ic::PFJet::PFJet ( )

Definition at line 5 of file PFJet.cc.

ic::PFJet::~PFJet ( )
virtual

Definition at line 32 of file PFJet.cc.

Member Function Documentation

void ic::PFJet::Print ( ) const
virtual

Reimplemented from ic::Jet.

Definition at line 34 of file PFJet.cc.

int const& ic::PFJet::muon_multiplicity ( ) const
inline

Number of PF muon constituents.

Definition at line 23 of file PFJet.hh.

int const& ic::PFJet::charged_multiplicity ( ) const
inline

Number of charged constituents.

Definition at line 26 of file PFJet.hh.

int const& ic::PFJet::charged_had_multiplicity ( ) const
inline

Number of charged hadron constituents.

Definition at line 31 of file PFJet.hh.

int const& ic::PFJet::neutral_had_multiplicity ( ) const
inline

Number of neutral hadron constituents.

Definition at line 36 of file PFJet.hh.

int const& ic::PFJet::photon_multiplicity ( ) const
inline

Number of PF photon constituents.

Definition at line 41 of file PFJet.hh.

int const& ic::PFJet::electron_multiplicity ( ) const
inline

Number of PF electron constituents.

Definition at line 44 of file PFJet.hh.

int const& ic::PFJet::HF_had_multiplicity ( ) const
inline

Number PF HF hadronic constituents.

Definition at line 49 of file PFJet.hh.

int const& ic::PFJet::HF_em_multiplicity ( ) const
inline

Number of PF HF electromagnetic constituents.

Definition at line 52 of file PFJet.hh.

int const& ic::PFJet::neutral_multiplicity ( ) const
inline

Number of neutral constituents.

Definition at line 55 of file PFJet.hh.

float const& ic::PFJet::charged_em_energy ( ) const
inline

Charged electromagnetic energy.

Definition at line 60 of file PFJet.hh.

float ic::PFJet::charged_em_energy_frac ( ) const
inline

Calculates the charged electromagnetic fraction of the raw jet energy.

Definition at line 63 of file PFJet.hh.

float const& ic::PFJet::neutral_em_energy ( ) const
inline

Neutral electromagnetic energy.

Definition at line 68 of file PFJet.hh.

float ic::PFJet::neutral_em_energy_frac ( ) const
inline

Calculates the neutral electromagnetic fraction of the raw jet energy.

Definition at line 71 of file PFJet.hh.

float const& ic::PFJet::charged_had_energy ( ) const
inline

Charged hadron energy.

Definition at line 76 of file PFJet.hh.

float ic::PFJet::charged_had_energy_frac ( ) const
inline

Calculates the charged hadron fraction of the raw jet energy.

Definition at line 79 of file PFJet.hh.

float const& ic::PFJet::neutral_had_energy ( ) const
inline

Neutral hadron energy.

Definition at line 84 of file PFJet.hh.

float ic::PFJet::neutral_had_energy_frac ( ) const
inline

Calculates the neutral hadron fraction of the raw jet energy.

Definition at line 87 of file PFJet.hh.

float const& ic::PFJet::photon_energy ( ) const
inline

Photon energy.

Definition at line 92 of file PFJet.hh.

float ic::PFJet::photon_energy_frac ( ) const
inline

Calculates the photon fraction of the raw jet energy.

Definition at line 95 of file PFJet.hh.

float const& ic::PFJet::electron_energy ( ) const
inline

Electron energy.

Definition at line 100 of file PFJet.hh.

float ic::PFJet::electron_energy_frac ( ) const
inline

Calculates the electron fraction of the raw jet energy.

Definition at line 103 of file PFJet.hh.

float const& ic::PFJet::muon_energy ( ) const
inline

Muon energy.

Definition at line 108 of file PFJet.hh.

float ic::PFJet::muon_energy_frac ( ) const
inline

Calculates the muon fraction of the raw jet energy.

Definition at line 111 of file PFJet.hh.

float const& ic::PFJet::HF_had_energy ( ) const
inline

HF hadronic energy.

Definition at line 116 of file PFJet.hh.

float ic::PFJet::HF_had_energy_frac ( ) const
inline

Calculates the HF hadronic fraction of the raw jet energy.

Definition at line 119 of file PFJet.hh.

float const& ic::PFJet::HF_em_energy ( ) const
inline

HF electromagnetic energy.

Definition at line 124 of file PFJet.hh.

float ic::PFJet::HF_em_energy_frac ( ) const
inline

Calculates the HF electromagnetic fraction of the raw jet energy.

Definition at line 127 of file PFJet.hh.

float const& ic::PFJet::charged_mu_energy ( ) const
inline

Muon energy.

Definition at line 132 of file PFJet.hh.

float ic::PFJet::charged_mu_energy_frac ( ) const
inline

Calculates the muon fraction of the raw jet energy.

Definition at line 135 of file PFJet.hh.

float const& ic::PFJet::beta ( ) const
inline

The fraction of the constituent track momentum associated to the primary vertex.

Defined as:

\[ \beta = \frac{\sum^{\mathrm{tracks}}_{\mathrm{PV}}p_{\mathrm{T}}^{\mathrm{trk}}} {\sum^{\mathrm{tracks}}p_{\mathrm{T}}^{\mathrm{trk}}}, \]

where the sums are over the tracks associated to the jet, and PV implies the subset of these tracks that were used in the leading primary vertex fit. In the case that a track was not used in any vertex fit in the event, it is considered associated to the primary vertex if the longitudinal distance between the track and vertex \(\Delta Z < 0.2\,\mathrm{cm}\).

Definition at line 155 of file PFJet.hh.

float const& ic::PFJet::beta_max ( ) const
inline

The largest value of beta() obtained when it is evaluated for every vertex in the event.

Definition at line 159 of file PFJet.hh.

float const& ic::PFJet::pu_id_mva_value ( ) const
inline

The output of the pileup ID MVA.

Definition at line 162 of file PFJet.hh.

bool ic::PFJet::pu_id_mva_loose ( ) const
inline

Whether the loose working point of the MVA ID is passed.

Deprecated:
The working point has changed with each new training of the MVA, and should instead be implemented in a free function

Definition at line 170 of file PFJet.hh.

std::vector<std::size_t> const& ic::PFJet::constituent_tracks ( ) const
inline

A vector to refer to the constituent track ic::Track::id() values.

Definition at line 206 of file PFJet.hh.

int const& ic::PFJet::charged_multiplicity_nopu ( ) const
inline

The number of charged constituents associated to the PV.

Definition at line 211 of file PFJet.hh.

float const& ic::PFJet::linear_radial_moment ( ) const
inline

Used for quark-gluon discrimination.

Defined as:

\[ \mathrm{LRM} = \frac{\sum^{\mathrm{tracks}}_{\mathrm{PV}}\left[p_{\mathrm{T}}^{\mathrm{trk}}\times\Delta R(\mathrm{jet},\mathrm{track})\right]}{p_{\mathrm{T}}^{\mathrm{jet}}}. \]

Definition at line 224 of file PFJet.hh.

void ic::PFJet::set_muon_multiplicity ( int const &  muon_multiplicity)
inline

Number of PF muon constituents.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 234 of file PFJet.hh.

void ic::PFJet::set_charged_multiplicity ( int const &  charged_multiplicity)
inline

Number of charged constituents.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 239 of file PFJet.hh.

void ic::PFJet::set_charged_had_multiplicity ( int const &  charged_had_multiplicity)
inline

Number of charged hadron constituents.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 244 of file PFJet.hh.

void ic::PFJet::set_neutral_had_multiplicity ( int const &  neutral_had_multiplicity)
inline

Number of neutral hadron constituents.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 250 of file PFJet.hh.

void ic::PFJet::set_photon_multiplicity ( int const &  photon_multiplicity)
inline

Number of PF photon constituents.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 256 of file PFJet.hh.

void ic::PFJet::set_electron_multiplicity ( int const &  electron_multiplicity)
inline

Number of PF electron constituents.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 261 of file PFJet.hh.

void ic::PFJet::set_HF_had_multiplicity ( int const &  HF_had_multiplicity)
inline

Number PF HF hadronic constituents.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 266 of file PFJet.hh.

void ic::PFJet::set_HF_em_multiplicity ( int const &  HF_em_multiplicity)
inline

Number of PF HF electromagnetic constituents.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 271 of file PFJet.hh.

void ic::PFJet::set_neutral_multiplicity ( int const &  neutral_multiplicity)
inline

Number of neutral constituents.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 276 of file PFJet.hh.

void ic::PFJet::set_charged_em_energy ( float const &  charged_em_energy)
inline

Charged electromagnetic energy.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 281 of file PFJet.hh.

void ic::PFJet::set_neutral_em_energy ( float const &  neutral_em_energy)
inline

Neutral electromagnetic energy.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 286 of file PFJet.hh.

void ic::PFJet::set_charged_had_energy ( float const &  charged_had_energy)
inline

Charged hadron energy.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 291 of file PFJet.hh.

void ic::PFJet::set_neutral_had_energy ( float const &  neutral_had_energy)
inline

Neutral hadron energy.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 296 of file PFJet.hh.

void ic::PFJet::set_photon_energy ( float const &  photon_energy)
inline

Photon energy.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 301 of file PFJet.hh.

void ic::PFJet::set_electron_energy ( float const &  electron_energy)
inline

Electron energy.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 306 of file PFJet.hh.

void ic::PFJet::set_muon_energy ( float const &  muon_energy)
inline

Muon energy.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 311 of file PFJet.hh.

void ic::PFJet::set_HF_had_energy ( float const &  HF_had_energy)
inline

HF hadronic energy.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 316 of file PFJet.hh.

void ic::PFJet::set_HF_em_energy ( float const &  HF_em_energy)
inline

HF electromagnetic energy.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 322 of file PFJet.hh.

void ic::PFJet::set_charged_mu_energy ( float const &  charged_mu_energy)
inline

Muon energy.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 327 of file PFJet.hh.

void ic::PFJet::set_beta ( float const &  beta)
inline

The fraction of the constituent track momentum associated to the primary vertex.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 332 of file PFJet.hh.

void ic::PFJet::set_beta_max ( float const &  beta_max)
inline

The largest value of beta() obtained when it is evaluated for every vertex in the event.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 335 of file PFJet.hh.

void ic::PFJet::set_pu_id_mva_value ( float const &  pu_id_mva_value)
inline

The output of the pileup ID MVA.

Examples:
plugins/ICJetProducer.hh.

Definition at line 338 of file PFJet.hh.

void ic::PFJet::set_constituent_tracks ( std::vector< std::size_t > const &  constituent_tracks)
inline

A vector to refer to the constituent track ic::Track::id() values.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 343 of file PFJet.hh.

void ic::PFJet::set_charged_multiplicity_nopu ( int const &  charged_multiplicity_nopu)
inline

The number of charged constituents associated to the PV.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 349 of file PFJet.hh.

void ic::PFJet::set_linear_radial_moment ( float const &  linear_radial_moment)
inline

Used for quark-gluon discrimination.

Examples:
plugins/ICJetDestHelper.hh.

Definition at line 355 of file PFJet.hh.

ic::PFJet::ClassDef ( PFJet  ,
 
)

The documentation for this class was generated from the following files: