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

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

#include <ResCrystalBallJets.h>

Inheritance diagram for KLFitter::ResCrystalBallJets:
KLFitter::ResCrystalBallBase KLFitter::ResolutionBase

Public Member Functions

 ResCrystalBallJets (const char *filename)
 The default constructor.
 
 ResCrystalBallJets (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...
 
 ~ResCrystalBallJets ()
 The (defaulted) destructor.
 
double GetAlpha (double x) override
 Calculate the alpha from the TF parameters and the value of x. More...
 
double GetN (double x) override
 Calculate the n parameter from the TF parameters and the value of x. More...
 
double GetSigma (double x) override
 Calculate the sigma from the TF parameters and the value of x. More...
 
double GetMean (double x) override
 Calculate the mean from the TF parameters and the value of x. More...
 
- Public Member Functions inherited from KLFitter::ResCrystalBallBase
 ResCrystalBallBase (const char *filename)
 The default constructor.
 
 ResCrystalBallBase (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 ~ResCrystalBallBase ()
 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...
 
double LogCrystalBallFunction (double x, double alpha, double n, double sigma, double mean)
 A function that calculates CrystalBall See twiki: https://en.wikipedia.org/wiki/Crystal_Ball_function. More...
 
double ApproxError (double x)
 An approximation of the error function needed to calculate crystal ball normalization with precision < 1e-4. 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::ResCrystalBallBase
static bool CheckCrystalBallSanity (double *sigma, double *n)
 Sanity check for the crystal ball parameters sigma, and n (1st sigma, scale and 2nd 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 crystal ball with energy dependent parameters.

Constructor & Destructor Documentation

KLFitter::ResCrystalBallJets::ResCrystalBallJets ( 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::ResCrystalBallJets::GetAlpha ( double  x)
overridevirtual

Calculate the alpha from the TF parameters and the value of x.

Parameters
xThe value of x.
Returns
The alpha.

Implements KLFitter::ResCrystalBallBase.

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

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

Parameters
xThe value of x.
Returns
The mean.

Implements KLFitter::ResCrystalBallBase.

double KLFitter::ResCrystalBallJets::GetN ( double  x)
overridevirtual

Calculate the n parameter from the TF parameters and the value of x.

Parameters
xThe value of x.
Returns
The n parameter.

Implements KLFitter::ResCrystalBallBase.

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

Calculate the sigma from the TF parameters and the value of x.

Parameters
xThe value of x.
Returns
The sigma.

Implements KLFitter::ResolutionBase.


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