KLFitter  v1.3.2
Documentation of the KLFitter library -- The Kinematic Likelihood Fitter
List of all members
KLFitter::ResGaussPt Class Reference

A class describing a Gaussian resolution. More...

#include <ResGaussPt.h>

Inheritance diagram for KLFitter::ResGaussPt:
KLFitter::ResolutionBase

Public Member Functions

Constructors and destructors
 ResGaussPt (const char *filename)
 The default constructor.
 
 ResGaussPt (double sigma)
 A constructor. More...
 
 ResGaussPt (std::vector< double > const &parameters)
 A constructor. More...
 
 ~ResGaussPt ()
 The (defaulted) destructor.
 
Member functions (Get)
double GetSigma (double par) override
 Return the width of the TF depending on the value of energy x. More...
 
double logp (double x, double xmeas, bool *good, double par=0) override
 Return the probability of the true value of x given the measured value, xmeas. More...
 
Member functions (Set)
void SetSigma (double sigma)
 Set the width of the Gaussian. More...
 
- Public Member Functions inherited from KLFitter::ResolutionBase
 ResolutionBase (int npar)
 The default constructor. More...
 
 ResolutionBase (std::vector< double > parameters)
 A constructor. More...
 
virtual ~ResolutionBase ()
 The (defaulted) destructor.
 
int Par (int index, double *par)
 Return a parameter of the parameterization. More...
 
int SetPar (int index, double value)
 Set a parameter value. More...
 
int SetPar (std::vector< double > parameters)
 Set all parameter values. More...
 
int ReadParameters (const char *filename, std::size_t nparameters)
 Read parameter values from ASCII file. More...
 
int Status ()
 Return a status code. More...
 

Additional Inherited Members

- Protected Attributes inherited from KLFitter::ResolutionBase
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 class describing a Gaussian resolution.

This class offers a simple parameterization of a resolution. The parameterization is a Gaussian with a width parametrized as a function of the true parameter.

Constructor & Destructor Documentation

KLFitter::ResGaussPt::ResGaussPt ( double  sigma)
explicit

A constructor.

Parameters
sigmaThe width of the Gaussian.
KLFitter::ResGaussPt::ResGaussPt ( std::vector< double > const &  parameters)
explicit

A constructor.

Parameters
sigmaThe width of the Gaussian.

Member Function Documentation

double KLFitter::ResGaussPt::GetSigma ( double  par)
overridevirtual

Return the width of the TF depending on the value of energy x.

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

Parameters
partrue energy as parameter of the TF.
Returns
The width.

Implements KLFitter::ResolutionBase.

double KLFitter::ResGaussPt::logp ( double  x,
double  xmeas,
bool *  good,
double  par = 0 
)
overridevirtual

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 (not used here).
Returns
Logarithm of the probability.

Reimplemented from KLFitter::ResolutionBase.

void KLFitter::ResGaussPt::SetSigma ( double  sigma)
inline

Set the width of the Gaussian.

Parameters
sigmaThe width of the Gaussian.

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