KLFitter::Fitter Class Reference

The fitter class. More...

#include <Fitter.h>

Public Member Functions
Constructors and destructors
	Fitter ()
	The default constructor.
	~Fitter ()
	The (defaulted) destructor.
Member functions (Get)
KLFitter::DetectorBase *	Detector ()
	Return the detector. More...
KLFitter::Particles *	Particles ()
	Return the measured particles. More...
KLFitter::Permutations *	Permutations ()
	Return the permutation object. More...
KLFitter::LikelihoodBase *	Likelihood ()
	Return the lieklihood . More...
int	MinuitStatus ()
	Return the Minuit status. More...
unsigned int	ConvergenceStatus ()
	Return the convergence status bit. More...
Member functions (Set)
int	SetDetector (KLFitter::DetectorBase *detector)
	Set the detector description. More...
int	SetParticles (KLFitter::Particles *particles, int nPartonsInPermutations=-1)
	Set the particles. More...
int	SetMyParticlesTruth (KLFitter::Particles *particles)
	Set truth particles. More...
int	SetET_miss_XY_SumET (double etx, double ety, double sumet)
	Set x and y component of the missing ET. More...
int	SetLikelihood (KLFitter::LikelihoodBase *likelihood)
	Set the likelihood for the actual fit. More...

Member functions (misc)
enum	ConvergenceErrors { MinuitDidNotConverge = 1, FitAbortedDueToNaN = 2, AtLeastOneFitParameterAtItsLimit = 3, InvalidTransferFunctionAtConvergence = 4 }
	Enumerator for convergence errors.
enum	kMinimizationMethod { kMinuit, kSimulatedAnnealing, kMarkovChainMC }
	Enumerator for the minimization methods.
static const unsigned int	MinuitDidNotConvergeMask = 0x1 << MinuitDidNotConverge
	Bit masks for convergence errors.
static const unsigned int	FitAbortedDueToNaNMask = 0x1 << FitAbortedDueToNaN
static const unsigned int	AtLeastOneFitParameterAtItsLimitMask = 0x1 << AtLeastOneFitParameterAtItsLimit
static const unsigned int	InvalidTransferFunctionAtConvergenceMask = 0x1 << InvalidTransferFunctionAtConvergence
int	Fit (int index)
	Perform the fit for a single permutation of jets and leptons. More...
int	Fit ()
	Perform the fit for all permutations of jets and leptons. More...
int	Status ()
	Check if detector, likelihood, etc. More...
void	TurnOffSA ()
	Turn of simulated annealing.
void	SetMinimizationMethod (kMinimizationMethod method)
	Set the minimization method. More...
int	SetFitStatusToCache (int iperm, int nperms)
	Write fCachedMinuitStatus and fCachedConvergenceStatus to fCachedMinuitStatusVector.at(iperm) and fCachedConvergenceStatusVector.at(iperm) More...
int	GetFitStatusFromCache (int iperm)
	Write parameters from fCachedMinuitStatusVector.at(iperm) and fCachedConvergenceStatusVector.at(iperm) to fCachedMinuitStatus and fCachedConvergenceStatus. More...

Detailed Description

The fitter class.

This class owns all particles, the detector description, the likelihood, etc. This is the class seen by the user.

Member Function Documentation

unsigned int KLFitter::Fitter::ConvergenceStatus ( )

inline

Return the convergence status bit.

Returns

The convergence status bit.

KLFitter::DetectorBase* KLFitter::Fitter::Detector ( )

inline

Return the detector.

Returns

A pointer to the detector.

int KLFitter::Fitter::Fit

(

int

index

)

Perform the fit for a single permutation of jets and leptons.

Parameters

index

The permutation index.

Returns

An error code.

int KLFitter::Fitter::Fit

(

)

Perform the fit for all permutations of jets and leptons.

Returns

An error code.

int KLFitter::Fitter::GetFitStatusFromCache

(

int

iperm

)

Write parameters from fCachedMinuitStatusVector.at(iperm) and fCachedConvergenceStatusVector.at(iperm) to fCachedMinuitStatus and fCachedConvergenceStatus.

Parameters

iperm

Current permutation

Returns

An error code.

KLFitter::LikelihoodBase* KLFitter::Fitter::Likelihood ( )

inline

Return the lieklihood .

Returns

A pointer to the likelihood object.

int KLFitter::Fitter::MinuitStatus ( )

inline

Return the Minuit status.

Returns

The Minuit stats

KLFitter::Particles* KLFitter::Fitter::Particles ( )

inline

Return the measured particles.

Returns

A pointer to the particles.

KLFitter::Permutations* KLFitter::Fitter::Permutations ( )

inline

Return the permutation object.

Returns

A pointer to the permutation object.

int KLFitter::Fitter::SetDetector

(

KLFitter::DetectorBase *

detector

)

Set the detector description.

Parameters

detector

A pointer to the detector.

Returns

An error code.

int KLFitter::Fitter::SetET_miss_XY_SumET	(	double	etx,
		double	ety,
		double	sumet
	)

Set x and y component of the missing ET.

Parameters

etx	component of the missing ET.
ety	component of the missing ET.
sumet	The measured scalar sum of transverse energy.

Returns

An error flag.

int KLFitter::Fitter::SetFitStatusToCache	(	int	iperm,
		int	nperms
	)

Write fCachedMinuitStatus and fCachedConvergenceStatus to fCachedMinuitStatusVector.at(iperm) and fCachedConvergenceStatusVector.at(iperm)

Parameters

iperm	Current permutation
nperms	The number of permutations

Returns

An error code.

int KLFitter::Fitter::SetLikelihood

(

KLFitter::LikelihoodBase *

likelihood

)

Set the likelihood for the actual fit.

Parameters

likelihood

A pointer to the likelihood.

Returns

An error code.

void KLFitter::Fitter::SetMinimizationMethod ( kMinimizationMethod  method )

inline

Set the minimization method.

Parameters

method

The minimization method.

int KLFitter::Fitter::SetMyParticlesTruth

(

KLFitter::Particles *

particles

)

Set truth particles.

Parameters

particles

A pointer to a set of particles.

Returns

An error flag.

int KLFitter::Fitter::SetParticles	(	KLFitter::Particles *	particles,
		int	nPartonsInPermutations = -1
	)

Set the particles.

Parameters

particles	A pointer to a set of particles.
nPartonsInPermutations	The number of partons per permutation (can be smaller than the number of added partons).

Returns

An error flag.

int KLFitter::Fitter::Status

(

)

Check if detector, likelihood, etc.

are all set.

Returns

A status code.

---

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

• include/KLFitter/Fitter.h
• src/Fitter.cxx