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

A basic jet class to store properties common to all jet types. More...

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

+ Inheritance diagram for ic::Jet:

Public Member Functions

 Jet ()
 
virtual ~Jet ()
 
virtual void Print () const
 
 ClassDef (Jet, 3)
 
Properties
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...
 
Setters
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 basic jet class to store properties common to all jet types.

Useful links:

Definition at line 17 of file Jet.hh.

Constructor & Destructor Documentation

ic::Jet::Jet ( )

Definition at line 11 of file Jet.cc.

ic::Jet::~Jet ( )
virtual

Definition at line 17 of file Jet.cc.

Member Function Documentation

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

Reimplemented from ic::Candidate.

Reimplemented in ic::CaloJet, ic::JPTJet, and ic::PFJet.

Definition at line 19 of file Jet.cc.

std::map<std::size_t, float> const& ic::Jet::jec_factors ( ) const
inline

A map containing the jet energy corrections, where the key is stored as a hash of the identifying string.

Important: see the details below for the definition of the correction factors.

In CMS jet energy corrections are applied sequentially, and scale the entire four-momentum. See this link for further information. This implies that the correction factor at a given level depends on the jet four-momentum already being corrected to the previous level.

Definition at line 40 of file Jet.hh.

std::map<std::size_t, float> const& ic::Jet::b_discriminators ( ) const
inline

A map containing the b-tagging discriminators, where the key is stored as a hash of the identifying string.

Definition at line 46 of file Jet.hh.

std::vector<std::size_t> const& ic::Jet::gen_particles ( ) const
inline

A vector to refer to ic::GenParticle::id() values.

Deprecated:
This property is no longer filled in the ICJetProducer. It is advised to save generator-level particles or jets that may be needed for matching.

Definition at line 56 of file Jet.hh.

std::vector<std::size_t> const& ic::Jet::secondary_vertices ( ) const
inline

A map containing the b-tagging discriminators, where the key is stored as a hash of the identifying string.

Definition at line 62 of file Jet.hh.

double const& ic::Jet::uncorrected_energy ( ) const
inline

The raw value of the jet energy.

Definition at line 67 of file Jet.hh.

float const& ic::Jet::jet_area ( ) const
inline

The jet area as used in the L1FastJet correction.

Definition at line 72 of file Jet.hh.

int const& ic::Jet::parton_flavour ( ) const
inline

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.

Definition at line 77 of file Jet.hh.

int const& ic::Jet::hadron_flavour ( ) const
inline

Returns true flavour of jet as PDG code. The hadronic definition can only return 0, 4 or 5.

Definition at line 81 of file Jet.hh.

float ic::Jet::GetJecFactor ( std::string const &  name) const

Returns a specific correction factor if name is defined, otherwise returns zero.

Definition at line 33 of file Jet.cc.

float ic::Jet::GetBDiscriminator ( std::string const &  name) const

Returns a specific discriminator value if name is defined, otherwise returns zero.

Definition at line 48 of file Jet.cc.

void ic::Jet::set_jec_factors ( std::map< std::size_t, float > const &  jec_factors)
inline

A map containing the jet energy corrections, where the key is stored as a hash of the identifying string.

Definition at line 95 of file Jet.hh.

void ic::Jet::set_b_discriminators ( std::map< std::size_t, float > const &  b_discriminators)
inline

A map containing the b-tagging discriminators, where the key is stored as a hash of the identifying string.

Definition at line 100 of file Jet.hh.

void ic::Jet::set_gen_particles ( std::vector< std::size_t > const &  gen_particles)
inline

A vector to refer to ic::GenParticle::id() values.

Definition at line 106 of file Jet.hh.

void ic::Jet::set_secondary_vertices ( std::vector< std::size_t > const &  secondary_vertices)
inline

A map containing the b-tagging discriminators, where the key is stored as a hash of the identifying string.

Definition at line 111 of file Jet.hh.

void ic::Jet::set_uncorrected_energy ( double const &  uncorrected_energy)
inline

The raw value of the jet energy.

Examples:
plugins/ICJetProducer.hh.

Definition at line 117 of file Jet.hh.

void ic::Jet::set_jet_area ( float const &  jet_area)
inline

The jet area as used in the L1FastJet correction.

Definition at line 122 of file Jet.hh.

void ic::Jet::set_parton_flavour ( int const &  parton_flavour)
inline

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.

Definition at line 125 of file Jet.hh.

void ic::Jet::set_hadron_flavour ( int const &  hadron_flavour)
inline

Returns true flavour of jet as PDG code. The hadronic definition can only return 0, 4 or 5.

Definition at line 130 of file Jet.hh.

void ic::Jet::SetJecFactor ( std::string const &  name,
float const &  value 
)

Store a jet energy correction factor, overwriting any existing value with label name

Definition at line 29 of file Jet.cc.

void ic::Jet::SetBDiscriminator ( std::string const &  name,
float const &  value 
)

Store a b-tagging discriminator, overwriting any existing value with label name

Definition at line 44 of file Jet.cc.

ic::Jet::ClassDef ( Jet  ,
 
)

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