KLFitter  v1.3.2
Documentation of the KLFitter library -- The Kinematic Likelihood Fitter
Public Member Functions | Static Public Member Functions | List of all members
KLFitter::ResSingleGaussBase Class Referenceabstract

This class offers a simple parameterization of a resolution. More...

#include <ResSingleGaussBase.h>

Inheritance diagram for KLFitter::ResSingleGaussBase:
KLFitter::ResolutionBase KLFitter::ResSingleGaussE KLFitter::ResSingleGaussPt

Public Member Functions

 ResSingleGaussBase (const char *filename)
 The default constructor.
 
 ResSingleGaussBase (std::vector< double > const &parameters)
 A constructor that takes parameters directly, unlike the default constructor that takes a path to the file with TFs. More...
 
virtual ~ResSingleGaussBase ()
 The (defaulted) destructor.
 
virtual double GetMean (double x)=0
 Calculate the mean of the Gaussian from the TF parameters and the value of x. More...
 
virtual double GetSigma (double x) override=0
 Calculate the width of the Gaussian from the TF parameters and the value of x. More...
 
double logp (double x, double xmeas, bool *good, double=0) override
 Return the probability of the true value of x given the measured value, xmeas. 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...
 

Static Public Member Functions

static bool CheckSingleGaussianSanity (double *sigma)
 Sanity check for single gaussian parameter sigma. 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

This class offers a simple parameterization of a resolution.

The parameterization is a single Gaussian with energy dependent parameters.

Constructor & Destructor Documentation

KLFitter::ResSingleGaussBase::ResSingleGaussBase ( std::vector< double > const &  parameters)
explicit

A constructor that takes parameters directly, unlike the default constructor that takes a path to the file with TFs.

Parameters
parametersThe parameters of the parameterization.

Member Function Documentation

static bool KLFitter::ResSingleGaussBase::CheckSingleGaussianSanity ( double *  sigma)
inlinestatic

Sanity check for single gaussian parameter sigma.

Parameters
sigma.
Returns
False if problem with TF.
virtual double KLFitter::ResSingleGaussBase::GetMean ( double  x)
pure virtual

Calculate the mean of the Gaussian from the TF parameters and the value of x.

Parameters
xThe value of x.
Returns
The mean.

Implemented in KLFitter::ResSingleGaussE, and KLFitter::ResSingleGaussPt.

virtual double KLFitter::ResSingleGaussBase::GetSigma ( double  x)
overridepure virtual

Calculate the width of the Gaussian from the TF parameters and the value of x.

Parameters
xThe value of x.
Returns
The width.

Implements KLFitter::ResolutionBase.

Implemented in KLFitter::ResSingleGaussE, and KLFitter::ResSingleGaussPt.

double KLFitter::ResSingleGaussBase::logp ( double  x,
double  xmeas,
bool *  good,
double  = 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.


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