Mēnsūra
Public Types | Public Member Functions | List of all members
pec::Jet Class Reference

Represents a reconstructed jet. More...

#include <Jet.hpp>

Inheritance diagram for pec::Jet:
pec::CandidateWithID pec::Candidate

Public Types

enum  BTagAlgo : unsigned { CSV = 0, CMVA = 1 }
 Supported b-tagging algorithms.
 
enum  CTagAlgo : unsigned { CvsB = 0, CvsL = 1 }
 Supported c-tagging algorithms.
 

Public Member Functions

 Jet () noexcept
 Constructor with no parameters.
 
virtual void Reset ()
 Resets the object to a state right after the default initialisation.
 
void SetCorrFactor (float jecFactor)
 Sets full jet energy correction factor.
 
void SetJECUncertainty (float jecUncertainty)
 Sets relative uncertainty of the JEC factor.
 
void SetJERUncertainty (float jecUncertainty)
 Sets relative uncertainty of the JER smearing factor.
 
void SetBTag (BTagAlgo algo, float value)
 Sets value of the given b-tagging discriminator.
 
void SetCTag (CTagAlgo algo, float value)
 Sets value of the given c-tagging discriminator.
 
void SetSecVertexMass (float mass)
 Sets mass of the secondary vertex associated with the jet.
 
void SetPileUpID (float pileUpMVA)
 Sets value of the pile-up discriminator.
 
void SetArea (float area)
 Sets jet area.
 
void SetCharge (float charge)
 Sets electric charge of the jet. More...
 
void SetPullAngle (float angle)
 Sets the pull angle. More...
 
void SetFlavour (int flavour)
 Sets jet flavour. More...
 
float CorrFactor () const
 Returns full jet energy correction factor. More...
 
float JECUncertainty () const
 Returns relative uncertainty of the JEC factor. More...
 
float JERUncertainty () const
 Returns relative uncertainty of the JER smearing factor. More...
 
float BTag (BTagAlgo algo) const
 Returns value of the requested b-tagging discriminator.
 
float CTag (CTagAlgo algo) const
 Returns value of the requested c-tagging discriminator.
 
float PileUpID () const
 Returns value of the pile-up discriminator.
 
float SecVertexMass () const
 Returns mass of the secondary vertex associated with the jet. More...
 
float Area () const
 Returns jet area.
 
float Charge () const
 Returns electric charge of the jet. More...
 
float PullAngle () const
 Returns jet pull angle. More...
 
int Flavour () const
 Returns jet flavour. More...
 
- Public Member Functions inherited from pec::CandidateWithID
 CandidateWithID () noexcept
 Constructor with no parameters.
 
void SetBit (unsigned index, bool value=true)
 Sets or unsets an ID bit. More...
 
bool TestBit (unsigned index) const
 Tests an ID bit. More...
 
- Public Member Functions inherited from pec::Candidate
 Candidate () noexcept
 Constructor with no parameters. More...
 
 Candidate (Candidate &&)=default
 Default move constructor.
 
 Candidate (Candidate const &)=default
 Default copy constructor.
 
Candidateoperator= (Candidate const &)=default
 Default assignment operator.
 
virtual ~Candidate ()=default
 Default virtual destructor.
 
void SetPt (float pt)
 Sets transverse momentum (GeV/c)
 
void SetEta (float eta)
 Sets pseudorapidity.
 
void SetPhi (float phi)
 Sets azimuthal angle. More...
 
void SetM (float mass)
 Sets mass (GeV/c^2)
 
float Pt () const
 Returns transverse momentum (GeV/c)
 
float Eta () const
 Returns pseudorapidity.
 
float Phi () const
 Returns azimuthal angle. More...
 
float M () const
 Returns mass (GeV/c^2)
 

Detailed Description

Represents a reconstructed jet.

Stored four-momentum (via the Candidate base class) is uncorrected. Some properties of a jet (especially of a soft one) might be left uninitialized if they are not expected to be used in an analysis. Properties that make sence for simulations only (like flavours) are not expected to be set in case of real data.

Member Function Documentation

float Jet::Charge ( ) const

Returns electric charge of the jet.

Several definitions of jet charge are used [1]. This method is expected to return the value given by pat::Jet::jetCharge, which is calculated as a sum of electric charges of jet constituents weighted with their pt, as documented in [2]. [1] http://arxiv.org/abs/1209.2421 [2] https://hypernews.cern.ch/HyperNews/CMS/get/JetMET/1425.html

float Jet::CorrFactor ( ) const

Returns full jet energy correction factor.

The raw momentum should be rescaled using this factor in order to apply full JEC and JER. The returned value might be zero if only raw momentum is saved and the correction must be applied by the user.

int Jet::Flavour ( ) const

Returns jet flavour.

Expected to return zero for real data. If the flavour of a jet in a simulated event is undefined, a zero is returned.

float Jet::JECUncertainty ( ) const

Returns relative uncertainty of the JEC factor.

Jet four-momentum corresponding to the up/down variation in the JEC systematics can be obtained as P4() * CorrFactor() * (1 +/- JECUncertainty()). If only raw momentum has been stored and the correction is to be applied by the user, the method returns zero.

float Jet::JERUncertainty ( ) const

Returns relative uncertainty of the JER smearing factor.

Jet four-momentum corresponding to the up/down variation in the JER systematics can be obtained as P4() * CorrFactor() * (1 +/- JERUncertainty()). If only raw momentum has been stored and the correction is to be applied by the user, the method returns zero.

float Jet::PullAngle ( ) const

Returns jet pull angle.

The pull vector is defined in [1], Eq. (3.7). The pull angle is an angle between this vector and the rapidity axis. The range is [-pi, pi). [1] http://arxiv.org/abs/1010.3698

float Jet::SecVertexMass ( ) const

Returns mass of the secondary vertex associated with the jet.

When there is no secondary vertex associated with the jet, the method returns 0.

void Jet::SetCharge ( float  charge)

Sets electric charge of the jet.

See documentation for the method Charge for a description of this quantity.

void Jet::SetFlavour ( int  flavour)

Sets jet flavour.

This method must be used for simulation only. It is assumed that the flavour is determined with the clustering of ghost hadrons as described in [1]. [1] https://twiki.cern.ch/twiki/bin/view/CMSPublic/SWGuideBTagMCTools

void Jet::SetPullAngle ( float  angle)

Sets the pull angle.

See documentation of the method PullAngle for a description of this quantity.


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