CMS 3D CMS Logo

 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Pages
List of all members | Public Member Functions | Static Public Attributes | Private Attributes
hitfit::RunHitFit< AElectron, AMuon, AJet, AMet > Class Template Reference

Template class of experiment-independent interface to HitFit. This class is intended to be used inside the programming environment of a specific experiment, where each type of physics objects has its own class/type. For using HitFit with generic four-vector classes, user can't use this class and have to use the Top_Fit class directly. The reason is: this class is designed assuming electron and muon are represented by different object type, a situation which is guaranteed to happen in any experiments. The class contains some static integer constants to limit the maximum amount of jets in an event before fitting. See the description of those constants for details. The numbers of permutations for $t\bar{t}$ and $t\bar{t}H$ as a function of the number of jets $N_{\mathrm{jet}}$ in the event for a few values of are. More...

#include <RunHitFit.h>

Public Member Functions

void AddJet (const AJet &jet, bool useObjRes=false)
 Add one jet into the internal event. This function will do nothing if the internal event has already contained the maximally allowed number of jets. More...
 
void AddLepton (const AElectron &electron, bool useObjRes=false)
 Add one electron into the internal event. More...
 
void AddLepton (const AMuon &muon, bool useObjRes=false)
 Add one muon into the internal event. More...
 
void clear ()
 Clear the internal event, fit results, and jets. More...
 
std::vector< Fit_Result >
::size_type 
FitAllPermutation ()
 Fit all permutations of the internal event. Returns the number of permutations. More...
 
std::vector< Fit_ResultGetFitAllPermutation ()
 Return the results of fitting all permutations of the internal event. More...
 
const Top_FitGetTopFit () const
 Return a constant reference to the underlying Top_Fit object. More...
 
std::vector< Lepjets_EventGetUnfittedEvent ()
 Return the unfitted events for all permutations. More...
 
 RunHitFit (const LeptonTranslatorBase< AElectron > &el, const LeptonTranslatorBase< AMuon > &mu, const JetTranslatorBase< AJet > &jet, const METTranslatorBase< AMet > &met, const std::string default_file, double lepw_mass, double hadw_mass, double top_mass)
 Constructor. More...
 
void SetKtResolution (const Resolution &res)
 Set the $k_{T}$ resolution of the internal event. More...
 
void SetMet (const AMet &met, bool useObjRes=false)
 Set the missing transverse energy of the internal event. More...
 
void SetMETResolution (const Resolution &res)
 Set the $E_{T}\!\!\!\!/$ resolution of the internal event. More...
 
 ~RunHitFit ()
 Destructor. More...
 

Static Public Attributes

static const unsigned int MAX_HITFIT = 1680
 
static const unsigned int MAX_HITFIT_JET = 8
 
static const unsigned int MAX_HITFIT_VAR = 32
 
static const unsigned int MIN_HITFIT_JET = 4
 
static const unsigned int MIN_HITFIT_TTH = 6
 

Private Attributes

LeptonTranslatorBase< AElectron > _ElectronTranslator
 
Lepjets_Event _event
 
std::vector< Fit_Result_Fit_Results
 
bool _jetObjRes
 
std::vector< AJet > _jets
 
JetTranslatorBase< AJet > _JetTranslator
 
METTranslatorBase< AMet > _METTranslator
 
LeptonTranslatorBase< AMuon > _MuonTranslator
 
Top_Fit _Top_Fit
 
std::vector< Lepjets_Event_Unfitted_Events
 

Detailed Description

template<class AElectron, class AMuon, class AJet, class AMet>
class hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >

Template class of experiment-independent interface to HitFit. This class is intended to be used inside the programming environment of a specific experiment, where each type of physics objects has its own class/type. For using HitFit with generic four-vector classes, user can't use this class and have to use the Top_Fit class directly. The reason is: this class is designed assuming electron and muon are represented by different object type, a situation which is guaranteed to happen in any experiments. The class contains some static integer constants to limit the maximum amount of jets in an event before fitting. See the description of those constants for details. The numbers of permutations for $t\bar{t}$ and $t\bar{t}H$ as a function of the number of jets $N_{\mathrm{jet}}$ in the event for a few values of are.

$N_{\mathrm{jet}}$ $N_{t\bar{t}}$

$N_{t\bar{t}H}$

4 24

N/A

5 120

N/A

6 360

360

7 840

2520

8 1680

20160

If adjusting the limits defined by the static constants is desired, then please the following formulas.

The number for possible permutations, $N_{t\bar{t}}$, as a function of number of jets, $n$, for $t\bar{t}$ event is given by:

\[ N_{t\bar{t}}(n) = \frac{n!}{(n-4)!};~ n \ge 4 \]

The number for possible permutations, $N_{t\bar{t}H}$, as a function of number of jets, $n$, for $t\bar{t}H$ is given by:

\[ N_{t\bar{t}}(n) = \frac{n!}{(n-6)!2!};~ n \ge 6 \]

Parameters
AElectronThe typename of the electron physics object class to be translated into HitFit's Lepjets_Event_Lep.
AMuonThe typename of the muon physics object class to be translated into HitFit's Lepjets_Event_Lep.
AJetThe typename of the jet physics object class to be translated into HitFit's Lepjets_Event_Jet.
AMetThe typename of the missing transverse energy physics object class be translated into HitFit's Fourvec.

Definition at line 156 of file RunHitFit.h.

Constructor & Destructor Documentation

template<class AElectron , class AMuon , class AJet , class AMet >
hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::RunHitFit ( const LeptonTranslatorBase< AElectron > &  el,
const LeptonTranslatorBase< AMuon > &  mu,
const JetTranslatorBase< AJet > &  jet,
const METTranslatorBase< AMet > &  met,
const std::string  default_file,
double  lepw_mass,
double  hadw_mass,
double  top_mass 
)
inline

Constructor.

Parameters
elThe function object to translate from AElectron to Lepjets_Event_Lep.
muThe function object to translate from AMuon to Lepjets_Event_Lep.
jetThe function object to translate from AJet to Lepjets_Event_Jet.
metThe function object to translate from AMet to Fourvec.
default_fileThe path of ASCII text files which contains the parameter settings for this instance of RunHitFit.
lepw_massThe mass to which the leptonic $ W- $ boson should be constrained to. A value of zero means this constraint will be removed.
hadw_massThe mass to which the hadronic $ W- $ boson should be constrained to. A value of zero means this constraint will be removed.
top_massThe mass to which the top quark should be constrained to. A value of zero means this constraint will be removed.

Definition at line 258 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::~RunHitFit ( )
inline

Destructor.

Definition at line 279 of file RunHitFit.h.

Member Function Documentation

template<class AElectron , class AMuon , class AJet , class AMet >
void hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::AddJet ( const AJet &  jet,
bool  useObjRes = false 
)
inline

Add one jet into the internal event. This function will do nothing if the internal event has already contained the maximally allowed number of jets.

Explanation about this function: This function does not directly add the jet into the internal event. Rather, this function store the jet in an internal array. The reason is: jet energy correction and resolution depends on the jet type in the permutation. Therefore RunHitFit will only add jet into the event after a specific jet permutation has been determined. This is done in the FitAllPermutation function().

Parameters
jetThe jet to be added into the internal event.
useObjResBoolean parameter to indicate if the user would like to use the resolution embedded in the object, and not the resolution read when instantiating the class.

Definition at line 351 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
void hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::AddLepton ( const AElectron &  electron,
bool  useObjRes = false 
)
inline

Add one electron into the internal event.

Parameters
electronThe electron to be added into the internal event.
useObjResBoolean parameter to indicate if the user would like to use the resolution embedded in the object, and not the resolution read when instantiating the class.

Definition at line 306 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
void hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::AddLepton ( const AMuon &  muon,
bool  useObjRes = false 
)
inline

Add one muon into the internal event.

Parameters
muonThe muon to be added into the internal event.
useObjResBoolean parameter to indicate if the user would like to use the resolution embedded in the object, and not the resolution read when instantiating the class.

Definition at line 323 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
void hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::clear ( void  )
inline

Clear the internal event, fit results, and jets.

Definition at line 287 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
std::vector<Fit_Result>::size_type hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::FitAllPermutation ( )
inline

Fit all permutations of the internal event. Returns the number of permutations.

Definition at line 418 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
std::vector<Fit_Result> hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::GetFitAllPermutation ( )
inline

Return the results of fitting all permutations of the internal event.

Definition at line 531 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
const Top_Fit& hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::GetTopFit ( ) const
inline

Return a constant reference to the underlying Top_Fit object.

Definition at line 408 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
std::vector<Lepjets_Event> hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::GetUnfittedEvent ( )
inline

Return the unfitted events for all permutations.

Definition at line 521 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
void hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::SetKtResolution ( const Resolution res)
inline

Set the $k_{T}$ resolution of the internal event.

Parameters
resThe resolution.

Definition at line 385 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
void hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::SetMet ( const AMet &  met,
bool  useObjRes = false 
)
inline

Set the missing transverse energy of the internal event.

Definition at line 371 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
void hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::SetMETResolution ( const Resolution res)
inline

Set the $E_{T}\!\!\!\!/$ resolution of the internal event.

Parameters
resThe $E_{T}\!\!\!\!/$ resolution, same as $k_{T}$ resolution.

Definition at line 398 of file RunHitFit.h.

Member Data Documentation

template<class AElectron , class AMuon , class AJet , class AMet >
LeptonTranslatorBase<AElectron> hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_ElectronTranslator
private

The translator from AElectron to Lepjets_Event_Lep.

Definition at line 163 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
Lepjets_Event hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_event
private

The internal event. The internal event only contains lepton and missing transverse energy.

Definition at line 185 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
std::vector<Fit_Result> hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_Fit_Results
private

The results of the kinematic fit.

Definition at line 227 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
bool hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_jetObjRes
private

Boolean flag which sets whether to use jet resolution read from file or jet resolution embedded in the physics objects.

This flag is only set when the FIRST jet is added into the event.

By default this flag is set to FALSE if user does not specify anything about which resolution to be used.

Definition at line 212 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
std::vector<AJet> hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_jets
private

The internal array of jets. Jets are kept in this array and not added into the internal event. The reason is: the jet energy correction applied to a jet is dependent on the assumed jet type (b or light) in the permutation. Therefore the decision is to store jets in their original format/data type.

Before a fit to a particular permutation is done, this class convert the jets in this array into Lepjets_Event_Jet format, taking into consideration the assumed jet type and applying the appropriate jet energy correction.

Definition at line 201 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
JetTranslatorBase<AJet> hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_JetTranslator
private

The translator from AJet to Lepjets_Event_Jet.

Definition at line 173 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
METTranslatorBase<AMet> hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_METTranslator
private

The translator from AMet to Fourvec.

Definition at line 178 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
LeptonTranslatorBase<AMuon> hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_MuonTranslator
private

The translator from AMuon to Lepjets_Event_Lep.

Definition at line 168 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
Top_Fit hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_Top_Fit
private

The interface between the event and the fitting algorithm.

Definition at line 217 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
std::vector<Lepjets_Event> hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_Unfitted_Events
private

The array of events with permutation information before fitting.

Definition at line 222 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
const unsigned int hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::MAX_HITFIT = 1680
static

Maximum number of HitFit permutation in each event.

Definition at line 554 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
const unsigned int hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::MAX_HITFIT_JET = 8
static

Maximum number of jet as input to HitFit in each event

Definition at line 549 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
const unsigned int hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::MAX_HITFIT_VAR = 32
static

Maximum number of fitted variables in HitFit in each event

Definition at line 559 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
const unsigned int hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::MIN_HITFIT_JET = 4
static

Minimum number of jet as input to HitFit in Tt event

Definition at line 539 of file RunHitFit.h.

template<class AElectron , class AMuon , class AJet , class AMet >
const unsigned int hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::MIN_HITFIT_TTH = 6
static

Minimum number of jet as input to HitFit in TtH event

Definition at line 544 of file RunHitFit.h.