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

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

#include <ResSingleGaussE.h>

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

Public Member Functions

 ResSingleGaussE (const char *filename)
 The default constructor.
 
 ResSingleGaussE (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...
 
 ~ResSingleGaussE ()
 The (defaulted) destructor.
 
double GetMean (double x) override
 Calculate the mean of the Gaussian from the TF parameters and the value of x. More...
 
double GetSigma (double x) override
 Calculate the width of the first Gaussian from the TF parameters and the value of x. More...
 
- Public Member Functions inherited from KLFitter::ResSingleGaussBase
 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.
 
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...
 

Additional Inherited Members

- Static Public Member Functions inherited from KLFitter::ResSingleGaussBase
static bool CheckSingleGaussianSanity (double *sigma)
 Sanity check for single gaussian parameter sigma. More...
 
- 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 double Gaussian with energy dependent parameters.

Constructor & Destructor Documentation

KLFitter::ResSingleGaussE::ResSingleGaussE ( 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

double KLFitter::ResSingleGaussE::GetMean ( double  x)
overridevirtual

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

Parameters
xThe value of x.
Returns
The mean.

Implements KLFitter::ResSingleGaussBase.

double KLFitter::ResSingleGaussE::GetSigma ( double  x)
overridevirtual

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

Parameters
xThe value of x.
Returns
The width.

Implements KLFitter::ResSingleGaussBase.


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