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_Result >	GetFitAllPermutation ()
	Return the results of fitting all permutations of the internal event. More...

const Top_Fit &	GetTopFit () const
	Return a constant reference to the underlying Top_Fit object. More...

std::vector< Lepjets_Event >	GetUnfittedEvent ()
	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

AElectron	The typename of the electron physics object class to be translated into HitFit's Lepjets_Event_Lep.
AMuon	The typename of the muon physics object class to be translated into HitFit's Lepjets_Event_Lep.
AJet	The typename of the jet physics object class to be translated into HitFit's Lepjets_Event_Jet.
AMet	The typename of the missing transverse energy physics object class be translated into HitFit's Fourvec.

Definition at line 153 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

el	The function object to translate from AElectron to Lepjets_Event_Lep.
mu	The function object to translate from AMuon to Lepjets_Event_Lep.
jet	The function object to translate from AJet to Lepjets_Event_Jet.
met	The function object to translate from AMet to Fourvec.
default_file	The path of ASCII text files which contains the parameter settings for this instance of RunHitFit.
lepw_mass	The mass to which the leptonic boson should be constrained to. A value of zero means this constraint will be removed.
hadw_mass	The mass to which the hadronic boson should be constrained to. A value of zero means this constraint will be removed.
top_mass	The mass to which the top quark should be constrained to. A value of zero means this constraint will be removed.

Definition at line 252 of file RunHitFit.h.

         : _ElectronTranslator(el),
           _MuonTranslator(mu),
           _JetTranslator(jet),
           _METTranslator(met),
           _event(0, 0),
           _jetObjRes(false),
           _Top_Fit(Top_Fit_Args(Defaults_Text(default_file)), lepw_mass, hadw_mass, top_mass) {}

template<class AElectron , class AMuon , class AJet , class AMet >

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

inline

Destructor.

Definition at line 271 of file RunHitFit.h.

271 {}

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

jet	The jet to be added into the internal event.
useObjRes	Boolean 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 332 of file RunHitFit.h.

References hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::MAX_HITFIT_JET.

Referenced by TtSemiLepHitFitProducer< LeptonCollection >::produce().

                                                          {
       // Only set flag when adding the first jet
       // the additional jets then WILL be treated in the
       // same way like the first jet.
       if (_jets.empty()) {
         _jetObjRes = useObjRes;
       }
 
       if (_jets.size() < MAX_HITFIT_JET) {
         _jets.push_back(jet);
       }
       return;
     }

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

electron	The electron to be added into the internal event.
useObjRes	Boolean 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 293 of file RunHitFit.h.

References hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_ElectronTranslator, hitfit::Lepjets_Event::add_lep(), and hitfit::electron_label.

Referenced by TtSemiLepHitFitProducer< LeptonCollection >::produce().

                                                                       {
       _event.add_lep(_ElectronTranslator(electron, electron_label, useObjRes));
       return;
     }

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

muon	The muon to be added into the internal event.
useObjRes	Boolean 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 307 of file RunHitFit.h.

References hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_MuonTranslator, hitfit::Lepjets_Event::add_lep(), and hitfit::muon_label.

                                                               {
       _event.add_lep(_MuonTranslator(muon, muon_label, useObjRes));
       return;
     }

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 276 of file RunHitFit.h.

Referenced by TtSemiLepHitFitProducer< LeptonCollection >::produce().

                  {
       _event = Lepjets_Event(0, 0);
       _jets.clear();
       _jetObjRes = false;
       _Unfitted_Events.clear();
       _Fit_Results.clear();
     }

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 385 of file RunHitFit.h.

References hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_event, hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_JetTranslator, hitfit::Lepjets_Event::add_jet(), hitfit::Top_Fit::args(), electrons_cff::bool, hitfit::Top_Fit_Args::do_higgs_flag(), hitfit::Top_Fit::fit_one_perm(), hitfit::hadb_label, hitfit::hadw1_label, hitfit::higgs_label, dqmiolumiharvest::j, hitfit::lepb_label, hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::MAX_HITFIT_JET, hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::MIN_HITFIT_JET, hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::MIN_HITFIT_TTH, TtSemiLepEvtBuilder_cfi::mt, hitfit::Lepjets_Event::set_jet_types(), TtSemiLepEvtBuilder_cfi::sigmt, and hitfit::unknown_label.

Referenced by TtSemiLepHitFitProducer< LeptonCollection >::produce().

                                                        {
       if (_jets.size() < MIN_HITFIT_JET) {
         // For ttbar lepton+jets, a minimum of MIN_HITFIT_JETS jets
         // is required
         return 0;
       }
 
       if (_jets.size() > MAX_HITFIT_JET) {
         // Restrict the maximum number of jets in the fit
         // to prevent loop overflow
         return 0;
       }
 
       _Unfitted_Events.clear();
       _Fit_Results.clear();
 
       // Prepare the array of jet types for permutation
       std::vector<int> jet_types(_jets.size(), unknown_label);
       jet_types[0] = lepb_label;
       jet_types[1] = hadb_label;
       jet_types[2] = hadw1_label;
       jet_types[3] = hadw1_label;
 
       if (_Top_Fit.args().do_higgs_flag() && _jets.size() >= MIN_HITFIT_TTH) {
         jet_types[4] = higgs_label;
         jet_types[5] = higgs_label;
       }
 
       std::stable_sort(jet_types.begin(), jet_types.end());
 
       do {
         // begin loop over all jet permutation
         for (int nusol = 0; nusol != 2; nusol++) {
           // loop over two neutrino solution
           bool nuz = bool(nusol);
 
           // Copy the event
           Lepjets_Event fev = _event;
 
           // Add jets into the event, with the assumed type
           // in accord with the permutation.
           // The translator _JetTranslator will correctly
           // return object of Lepjets_Event_Jet with
           // jet energy correction applied in accord with
           // the assumed jet type (b or light).
           for (size_t j = 0; j != _jets.size(); j++) {
             fev.add_jet(_JetTranslator(_jets[j], jet_types[j], _jetObjRes));
           }
 
           // Clone fev (intended to be fitted event)
           // to ufev (intended to be unfitted event)
           Lepjets_Event ufev = fev;
 
           // Set jet types.
           fev.set_jet_types(jet_types);
           ufev.set_jet_types(jet_types);
 
           // Store the unfitted event
           _Unfitted_Events.push_back(ufev);
 
           // Prepare the placeholder for various kinematic quantities
           double umwhad;
           double utmass;
           double mt;
           double sigmt;
           Column_Vector pullx;
           Column_Vector pully;
 
           // Do the fit
           double chisq = _Top_Fit.fit_one_perm(fev, nuz, umwhad, utmass, mt, sigmt, pullx, pully);
           // Store output of the fit
           _Fit_Results.push_back(Fit_Result(chisq, fev, pullx, pully, umwhad, utmass, mt, sigmt));
 
         }  // end loop over two neutrino solution
 
       } while (std::next_permutation(jet_types.begin(), jet_types.end()));
       // end loop over all jet permutations
 
       return _Fit_Results.size();
     }

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 475 of file RunHitFit.h.

References hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_Fit_Results.

Referenced by TtSemiLepHitFitProducer< LeptonCollection >::produce().

475 { return _Fit_Results; }

hitfit::RunHitFit::_Fit_Results

std::vector< Fit_Result > _Fit_Results

Definition: RunHitFit.h:222

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 379 of file RunHitFit.h.

References hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_Top_Fit.

379 { return _Top_Fit; }

hitfit::RunHitFit::_Top_Fit

Top_Fit _Top_Fit

Definition: RunHitFit.h:212

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 469 of file RunHitFit.h.

References hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_Unfitted_Events.

Referenced by TtSemiLepHitFitProducer< LeptonCollection >::produce().

469 { return _Unfitted_Events; }

hitfit::RunHitFit::_Unfitted_Events

std::vector< Lepjets_Event > _Unfitted_Events

Definition: RunHitFit.h:217

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

res	The resolution.

Definition at line 360 of file RunHitFit.h.

References hitfit::Lepjets_Event::kt_res().

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::SetMETResolution().

                                                 {
       _event.kt_res() = res;
       return;
     }

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 349 of file RunHitFit.h.

References hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::_METTranslator, hitfit::Lepjets_Event::kt_res(), hitfit::METTranslatorBase< AMet >::KtResolution(), and hitfit::Lepjets_Event::met().

Referenced by TtSemiLepHitFitProducer< LeptonCollection >::produce().

                                                          {
       _event.met() = _METTranslator(met, useObjRes);
       _event.kt_res() = _METTranslator.KtResolution(met, useObjRes);
       return;
     }

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

res	The $E_{T}\!\!\!\!/$ resolution, same as $k_{T}$ resolution.

Definition at line 371 of file RunHitFit.h.

References hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::SetKtResolution().

                                                  {
       SetKtResolution(res);
       return;
     }

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 158 of file RunHitFit.h.

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::AddLepton().

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 180 of file RunHitFit.h.

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::FitAllPermutation().

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 222 of file RunHitFit.h.

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::GetFitAllPermutation().

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 207 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 196 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 168 of file RunHitFit.h.

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::FitAllPermutation().

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 173 of file RunHitFit.h.

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::SetMet().

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 163 of file RunHitFit.h.

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::AddLepton().

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 212 of file RunHitFit.h.

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::GetTopFit().

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 217 of file RunHitFit.h.

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::GetUnfittedEvent().

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 495 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 490 of file RunHitFit.h.

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::AddJet(), and hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::FitAllPermutation().

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 500 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 480 of file RunHitFit.h.

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::FitAllPermutation().

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 485 of file RunHitFit.h.

Referenced by hitfit::RunHitFit< AElectron, AMuon, AJet, AMet >::FitAllPermutation().

Public Member Functions

Static Public Attributes

Private Attributes

Detailed Description

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

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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