KLFitter  v1.3.2
Documentation of the KLFitter library -- The Kinematic Likelihood Fitter
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
KLFitter::DetectorBase Class Referenceabstract

A base class for describing detectors. More...

#include <DetectorBase.h>

Inheritance diagram for KLFitter::DetectorBase:
KLFitter::DetectorAtlas_7TeV KLFitter::DetectorAtlas_8TeV KLFitter::DetectorAtlas_CrystalBall KLFitter::DetectorSnowmass

Public Member Functions

 DetectorBase (std::string folder="")
 The default constructor. More...
 
virtual ~DetectorBase ()
 The (defaulted) destructor.
 
Member functions (Get)
virtual ResolutionBaseResEnergyLightJet (double)=0
 Return the energy resolution of light jets. More...
 
virtual ResolutionBaseResEnergyBJet (double)=0
 Return the energy resolution of b jets. More...
 
virtual ResolutionBaseResEnergyGluonJet (double)=0
 Return the energy resolution of gluon jets. More...
 
virtual ResolutionBaseResEnergyElectron (double)=0
 Return the energy resolution of electrons. More...
 
virtual ResolutionBaseResEnergyMuon (double)=0
 Return the energy resolution of muons. More...
 
virtual ResolutionBaseResEnergyPhoton (double)=0
 Return the energy resolution of photons. More...
 
virtual ResolutionBaseResMissingET ()=0
 Return the missing ET resolution. More...
 
virtual ResolutionBaseResEtaLightJet (double)=0
 Return the eta resolution of light jets. More...
 
virtual ResolutionBaseResEtaBJet (double)=0
 Return the eta resolution of b jets. More...
 
virtual ResolutionBaseResPhiLightJet (double)=0
 Return the phi resolution of light jets. More...
 
virtual ResolutionBaseResPhiBJet (double)=0
 Return the phi resolution of b jets. More...
 
Member functions (misc)
int Status ()
 
void RequestResolutionType (const ResolutionType &type)
 Request a resolution type from the detector. More...
 

Protected Member Functions

ResolutionBaseResolutionUndefined (const std::string &type)
 Handle the call to a resolution object that is not defined, and throw an exception. More...
 
void ResolutionParametersUnavailable (const std::string &type)
 Handle cases where the parameters for a resolution type are not available. More...
 

Protected Attributes

std::set< ResolutionTyperes_type_requested
 Requested resolutions that the detector must provide.
 

Detailed Description

A base class for describing detectors.

This base class contains the energy resolution of different objects. More information (angular resolutions, acceptance, correections, etc.) can be added here.

Constructor & Destructor Documentation

KLFitter::DetectorBase::DetectorBase ( std::string  folder = "")
explicit

The default constructor.

Parameters
folderThe folder with transfer function parameters.

Member Function Documentation

void KLFitter::DetectorBase::RequestResolutionType ( const ResolutionType type)

Request a resolution type from the detector.

The likelihoods should define which resolution types are needed and make the appropriate requests to the detector class. Requested resolution types are then checked in the Status() function.

Parameters
typeThe ResolutionType object
virtual ResolutionBase* KLFitter::DetectorBase::ResEnergyBJet ( double  )
pure virtual

Return the energy resolution of b jets.

Parameters
etaThe eta of the particle.
Returns
A pointer to the energy resolution object.

Implemented in KLFitter::DetectorAtlas_8TeV, KLFitter::DetectorSnowmass, KLFitter::DetectorAtlas_CrystalBall, and KLFitter::DetectorAtlas_7TeV.

virtual ResolutionBase* KLFitter::DetectorBase::ResEnergyElectron ( double  )
pure virtual

Return the energy resolution of electrons.

Parameters
etaThe eta of the particle.
Returns
A pointer to the energy resolution object.

Implemented in KLFitter::DetectorAtlas_8TeV, KLFitter::DetectorAtlas_CrystalBall, KLFitter::DetectorAtlas_7TeV, and KLFitter::DetectorSnowmass.

virtual ResolutionBase* KLFitter::DetectorBase::ResEnergyGluonJet ( double  )
pure virtual

Return the energy resolution of gluon jets.

Parameters
etaThe eta of the particle.
Returns
A pointer to the energy resolution object.

Implemented in KLFitter::DetectorSnowmass, KLFitter::DetectorAtlas_8TeV, KLFitter::DetectorAtlas_CrystalBall, and KLFitter::DetectorAtlas_7TeV.

virtual ResolutionBase* KLFitter::DetectorBase::ResEnergyLightJet ( double  )
pure virtual

Return the energy resolution of light jets.

Parameters
etaThe eta of the particle.
Returns
A pointer to the energy resolution object.

Implemented in KLFitter::DetectorAtlas_8TeV, KLFitter::DetectorSnowmass, KLFitter::DetectorAtlas_CrystalBall, and KLFitter::DetectorAtlas_7TeV.

virtual ResolutionBase* KLFitter::DetectorBase::ResEnergyMuon ( double  )
pure virtual

Return the energy resolution of muons.

Parameters
etaThe eta of the particle.
Returns
A pointer to the energy resolution object.

Implemented in KLFitter::DetectorAtlas_8TeV, KLFitter::DetectorAtlas_CrystalBall, KLFitter::DetectorAtlas_7TeV, and KLFitter::DetectorSnowmass.

virtual ResolutionBase* KLFitter::DetectorBase::ResEnergyPhoton ( double  )
pure virtual

Return the energy resolution of photons.

Parameters
etaThe eta of the particle.
Returns
A pointer to the energy resolution object.

Implemented in KLFitter::DetectorAtlas_8TeV, KLFitter::DetectorSnowmass, KLFitter::DetectorAtlas_CrystalBall, and KLFitter::DetectorAtlas_7TeV.

virtual ResolutionBase* KLFitter::DetectorBase::ResEtaBJet ( double  )
pure virtual

Return the eta resolution of b jets.

Parameters
etaThe eta of the particle.
Returns
A pointer to the eta resolution object.

Implemented in KLFitter::DetectorAtlas_8TeV, KLFitter::DetectorAtlas_CrystalBall, KLFitter::DetectorAtlas_7TeV, and KLFitter::DetectorSnowmass.

virtual ResolutionBase* KLFitter::DetectorBase::ResEtaLightJet ( double  )
pure virtual

Return the eta resolution of light jets.

Parameters
etaThe eta of the particle.
Returns
A pointer to the eta resolution object.

Implemented in KLFitter::DetectorAtlas_8TeV, KLFitter::DetectorAtlas_CrystalBall, KLFitter::DetectorAtlas_7TeV, and KLFitter::DetectorSnowmass.

virtual ResolutionBase* KLFitter::DetectorBase::ResMissingET ( )
pure virtual

Return the missing ET resolution.

Returns
A pointer to the missing ET resolution.

Implemented in KLFitter::DetectorAtlas_8TeV, KLFitter::DetectorAtlas_CrystalBall, KLFitter::DetectorAtlas_7TeV, and KLFitter::DetectorSnowmass.

void KLFitter::DetectorBase::ResolutionParametersUnavailable ( const std::string &  type)
protected

Handle cases where the parameters for a resolution type are not available.

This prints an error message and throws an exception of type std::invalid_argument.

Parameters
typeThe name of the resolution function
ResolutionBase * KLFitter::DetectorBase::ResolutionUndefined ( const std::string &  type)
protected

Handle the call to a resolution object that is not defined, and throw an exception.

The derived detector classes are expected to reimplement all resolution functions and, if not supported by the detector, return this dummy object that throws the exception accordingly.

Parameters
typeThe type of resolution function
Returns
A nullptr, because an exception is thrown
virtual ResolutionBase* KLFitter::DetectorBase::ResPhiBJet ( double  )
pure virtual

Return the phi resolution of b jets.

Parameters
etaThe phi of the particle.
Returns
A pointer to the phi resolution object.

Implemented in KLFitter::DetectorAtlas_8TeV, KLFitter::DetectorAtlas_CrystalBall, KLFitter::DetectorAtlas_7TeV, and KLFitter::DetectorSnowmass.

virtual ResolutionBase* KLFitter::DetectorBase::ResPhiLightJet ( double  )
pure virtual

Return the phi resolution of light jets.

Parameters
etaThe phi of the particle.
Returns
A pointer to the phi resolution object.

Implemented in KLFitter::DetectorAtlas_8TeV, KLFitter::DetectorAtlas_CrystalBall, KLFitter::DetectorAtlas_7TeV, and KLFitter::DetectorSnowmass.


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