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

A base class for describing resolutions. More...

#include <ResolutionBase.h>

Inheritance diagram for KLFitter::ResolutionBase:
KLFitter::ResCrystalBallBase KLFitter::ResDoubleGaussBase KLFitter::ResGauss KLFitter::ResGauss_MET KLFitter::ResGaussE KLFitter::ResGaussPt KLFitter::ResSingleGaussBase KLFitter::ResSingleGaussLinearBase

Public Member Functions

Constructors and destructors
 ResolutionBase (int npar)
 The default constructor. More...
 
 ResolutionBase (std::vector< double > parameters)
 A constructor. More...
 
virtual ~ResolutionBase ()
 The (defaulted) destructor.
 
Member functions (Get)
virtual double GetSigma (double par)=0
 Return the (approximate) width of the TF depending on the relevant parameter (mostly xmeas, but sumET in case of ResGauss_MET). More...
 
virtual double logp (double, double, bool *good, double=0)
 Return the probability of the true value of x given the measured value, xmeas. More...
 
int Par (int index, double *par)
 Return a parameter of the parameterization. More...
 
Member functions (Set)
int SetPar (int index, double value)
 Set a parameter value. More...
 
int SetPar (std::vector< double > parameters)
 Set all parameter values. More...
 
Member functions (misc)
int ReadParameters (const char *filename, std::size_t nparameters)
 Read parameter values from ASCII file. More...
 
int Status ()
 Return a status code. More...
 

Protected Attributes

int fNParameters
 The number of parameters.
 
std::vector< double > fParameters
 The parameter values.
 
int fStatus
 The status of this class (1: ok, 0: error).
 

Detailed Description

A base class for describing resolutions.

This base class can be used to decribe resolutions.

Constructor & Destructor Documentation

KLFitter::ResolutionBase::ResolutionBase ( int  npar)
explicit

The default constructor.

Parameters
nparThe number of parameters needed for the parameterization.
KLFitter::ResolutionBase::ResolutionBase ( std::vector< double >  parameters)
explicit

A constructor.

Parameters
parametersA vector with the parameters.

Member Function Documentation

virtual double KLFitter::ResolutionBase::GetSigma ( double  par)
pure virtual

Return the (approximate) width of the TF depending on the relevant parameter (mostly xmeas, but sumET in case of ResGauss_MET).

Use to adjust the range of the fit parameter that correspond to the TF.

Parameters
parParameter on which the width depends
Returns
The width.

Implemented in KLFitter::ResDoubleGaussBase, KLFitter::ResSingleGaussLinearBase, KLFitter::ResGaussE, KLFitter::ResGaussPt, KLFitter::ResSingleGaussMET, KLFitter::ResCrystalBallJets, KLFitter::ResGauss_MET, KLFitter::ResGauss, KLFitter::ResSingleGaussBase, KLFitter::ResSingleGaussE, and KLFitter::ResSingleGaussPt.

virtual double KLFitter::ResolutionBase::logp ( double  ,
double  ,
bool *  good,
double  = 0 
)
inlinevirtual

Return the probability of the true value of x given the measured value, xmeas.

Parameters
xThe true value of x.
xmeasThe measured value of x.
goodFalse if problem with TF.
parOptional additional parameter (SumET in case of MET TF).
Returns
Logarithm of the probability.

Reimplemented in KLFitter::ResDoubleGaussBase, KLFitter::ResSingleGaussLinearBase, KLFitter::ResGaussE, KLFitter::ResGaussPt, KLFitter::ResGauss_MET, KLFitter::ResCrystalBallBase, KLFitter::ResGauss, and KLFitter::ResSingleGaussBase.

int KLFitter::ResolutionBase::Par ( int  index,
double *  par 
)

Return a parameter of the parameterization.

Parameters
indexThe parameter index.
parThe parameter value.
Returns
An error flag.
int KLFitter::ResolutionBase::ReadParameters ( const char *  filename,
std::size_t  nparameters 
)

Read parameter values from ASCII file.

Parameters
filenameThe name of the file.
nparametersThe number of parameters.
Returns
An error code.
int KLFitter::ResolutionBase::SetPar ( int  index,
double  value 
)

Set a parameter value.

Parameters
indexThe parameter index.
valueThe parameter value.
Returns
An error code.
int KLFitter::ResolutionBase::SetPar ( std::vector< double >  parameters)

Set all parameter values.

Parameters
parametersA vector of parameters.
Returns
An error code.
int KLFitter::ResolutionBase::Status ( )
inline

Return a status code.

Returns
A status code (1: ok, 0: error).

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