MarlinKinfit  0.4.0
Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Related Functions | List of all members
BaseFitObject Class Referenceabstract

Abstract base class for particle objects of kinematic fits. More...

#include <BaseFitObject.h>

Inheritance diagram for BaseFitObject:
ParticleFitObject VertexFitObject ISRPhotonFitObject JetFitObject LeptonFitObject NeutrinoFitObject SimplePhotonFitObject TrackParticleFitObject ZinvisibleFitObject

Public Member Functions

 BaseFitObject ()
 Default constructor.
 
 BaseFitObject (const BaseFitObject &rhs)
 Copy constructor. More...
 
BaseFitObject & operator= (const BaseFitObject &rhs)
 Assignment. More...
 
virtual ~BaseFitObject ()
 Virtual destructor.
 
virtual BaseFitObject * copy () const =0
 Return a new copy of itself.
 
virtual BaseFitObject & assign (const BaseFitObject &source)
 Assign from anther object, if of same type. More...
 
virtual bool setParam (int ilocal, double par_, bool measured_, bool fixed_=false)
 Set value and measured flag of parameter i; return: significant change. More...
 
virtual bool setParam (int ilocal, double par_)
 Set value of parameter ilocal; return: significant change. More...
 
virtual bool updateParams (double p[], int idim)
 Read values from global vector, readjust vector; return: significant change. More...
 
virtual bool setMParam (int ilocal, double mpar_)
 Set measured value of parameter ilocal; return: success. More...
 
virtual bool setError (int ilocal, double err_)
 Set error of parameter ilocal; return: success. More...
 
virtual bool setCov (int ilocal, int jlocal, double cov_)
 Set covariance of parameters ilocal and jlocal; return: success. More...
 
virtual bool setGlobalParNum (int ilocal, int iglobal)
 Set number of parameter ilocal in global list return true signals OK. More...
 
virtual bool fixParam (int ilocal, bool fix=true)
 Fix a parameter (fix=true), or release it (fix=false) More...
 
virtual bool releaseParam (int ilocal)
 Release a parameter. More...
 
virtual bool isParamFixed (int ilocal) const
 Returns whether parameter is fixed. More...
 
virtual double getParam (int ilocal) const
 Get current value of parameter ilocal. More...
 
virtual const char * getParamName (int ilocal) const
 Get name of parameter ilocal. More...
 
virtual const char * getName () const
 Get object's name.
 
virtual void setName (const char *name_)
 Set object's name.
 
virtual double getMParam (int ilocal) const
 Get measured value of parameter ilocal. More...
 
virtual double getError (int ilocal) const
 Get error of parameter ilocal. More...
 
virtual double getCov (int ilocal, int jlocal) const
 Get covariance between parameters ilocal and jlocal. More...
 
virtual double getRho (int ilocal, int jlocal) const
 Get correlation coefficient between parameters ilocal and jlocal. More...
 
virtual bool isParamMeasured (int ilocal) const
 Get measured flag for parameter ilocal. More...
 
virtual int getGlobalParNum (int ilocal) const
 Get global parameter number of parameter ilocal. More...
 
virtual int getNPar () const =0
 Get total number of parameters of this FitObject.
 
virtual int getNMeasured () const
 Get number of measured parameters of this FitObject.
 
virtual int getNUnmeasured () const
 Get number of unmeasured parameters of this FitObject.
 
virtual int getNFree () const
 Get number of free parameters of this FitObject.
 
virtual int getNFixed () const
 Get number of fixed parameters of this FitObject.
 
virtual double getChi2 () const
 Get chi squared from measured and fitted parameters.
 
virtual double getDChi2DParam (int ilocal) const
 Get derivative of chi squared w.r.t. parameter ilocal. More...
 
virtual double getD2Chi2DParam2 (int ilocal, int jlocal) const
 Get second derivative of chi squared w.r.t. parameters ilocal1 and ilocal2. More...
 
virtual std::ostream & printParams (std::ostream &os) const
 print the parameters and errors More...
 
virtual std::ostream & printRhoValues (std::ostream &os) const
 print the correlation coefficients More...
 
virtual std::ostream & print1stDerivatives (std::ostream &os) const
 print the 1st derivatives wrt metaSet 0 (E, px, py, pz) More...
 
virtual std::ostream & print2ndDerivatives (std::ostream &os) const
 print the 2nd derivatives wrt metaSet 0 (E, px, py, pz) More...
 
virtual std::ostream & print (std::ostream &os) const =0
 print object to ostream More...
 
virtual void invalidateCache () const
 invalidate any cached quantities
 
virtual void updateCache () const =0
 
virtual void addToGlobCov (double *glcov, int idim) const
 Add covariance matrix elements to global covariance matrix of size idim x idim. More...
 
virtual void addToGlobalChi2DerVector (double *y, int idim) const
 Add derivatives of chi squared to global derivative vector. More...
 
virtual void addToGlobalChi2DerMatrix (double *M, int idim) const
 Add 2nd derivatives of chi squared to global derivative matrix. More...
 
virtual void addToGlobalChi2DerVector (double *y, int idim, double lambda, double der[], int metaSet) const
 Add derivatives of momentum vector to global derivative vector. More...
 
virtual void addTo1stDerivatives (double M[], int idim, double der[], int kglobal, int metaSet) const
 
virtual void addTo2ndDerivatives (double der2[], int idim, double factor[], int metaSet) const
 
virtual void addTo2ndDerivatives (double M[], int idim, double lambda, double der[], int metaSet) const
 
virtual double getFirstDerivative_Meta_Local (int iMeta, int ilocal, int metaSet) const =0
 
virtual double getSecondDerivative_Meta_Local (int iMeta, int ilocal, int jlocal, int metaSet) const =0
 
virtual void initCov ()
 
virtual double getError2 (double der[], int metaset) const
 
virtual void getDerivatives (double der[], int idim) const =0
 

Protected Member Functions

virtual bool calculateCovInv () const
 Calculate the inverse of the covariance matrix.
 

Protected Attributes

char * name
 
double par [BaseDefs::MAXPAR]
 fit parameters
 
double mpar [BaseDefs::MAXPAR]
 measured parameters
 
bool measured [BaseDefs::MAXPAR]
 measured flag
 
bool fixed [BaseDefs::MAXPAR]
 fixed flag
 
int globalParNum [BaseDefs::MAXPAR]
 global paramter number for each parameter
 
double cov [BaseDefs::MAXPAR][BaseDefs::MAXPAR]
 local covariance matrix
 
double covinv [BaseDefs::MAXPAR][BaseDefs::MAXPAR]
 inverse pf local covariance matrix
 
bool covinvvalid
 flag for valid inverse covariance matrix
 
bool cachevalid
 flag for valid cache
 

Static Protected Attributes

static const double eps2 = 0.0001
 

Related Functions

(Note that these are not member functions.)

std::ostream & operator<< (std::ostream &os, const BaseFitObject &bfo)
 Prints out a BaseFitObject, using its print method. More...
 

Detailed Description

Abstract base class for particle objects of kinematic fits.

This class defines the minimal functionality any fit object must provide. The main task of a fit object is to keep parameters (and errors) that define the four-momentum of a particle and encapsulate the actually chosen parametrisation from the rest of the fitting machinery.

Since for the fit a parametrisation distributed like a gaussian is most favorable, different kinds of particles (implying different kinds of measurements!) might require different parametrisations. For each desired parametrisation a concrete class should be derived from this abstract base class. It needs to be able to convert its parameters to E, px, py, pz and to provide the derivatives of E, px, py, pz with respect to the internal parameters.

Depending on the type of particle, some or all parameters might be unmeasured (neutrinos!), meaning that they come with a very large and/or unknown error. They are treated differently by the fit algorithm and are thus flagged accordingly.

In order to insert its derivatives into the global covariance matrix of all FitObjects in the event, each FitObjects needs to know the position of its parameters in the overall parameter list.

THIS iS JUNK!!!! It is done like this in JetFitObject.C, but using measured[i] which is the bool giving the measured/unmeasured status and NOT a bool containing the START VALUES!!!!! From its stored initial parameters and the current fit parameters the FitObject calculates its contribution to the $^2$ of the fit.

In its current state, a BaseFitObject has a set of parameters, some of them measured (i.e., they contribute to the $\chi^2$). These parameters have a local numbering, running from 0 to n-1. Global numbers can be assigned by the BaseFitter using setGlobalParNum.

The class WWFitter needs the following routines from BaseFitObject:

Author: Benno List, Jenny Böhme

Date:
2011/03/03 15:03:02
Author:
blist

Changelog:

Constructor & Destructor Documentation

BaseFitObject::BaseFitObject ( const BaseFitObject &  rhs)

Copy constructor.

Parameters
rhsright hand side

References assign().

Member Function Documentation

void BaseFitObject::addToGlobalChi2DerMatrix ( double *  M,
int  idim 
) const
virtual

Add 2nd derivatives of chi squared to global derivative matrix.

Parameters
MGlobal derivative matrix
idimFirst dimension of global derivative matrix

References calculateCovInv(), covinvvalid, getD2Chi2DParam2(), getGlobalParNum(), getNPar(), isParamFixed(), and isParamMeasured().

void BaseFitObject::addToGlobalChi2DerVector ( double *  y,
int  idim 
) const
virtual

Add derivatives of chi squared to global derivative vector.

Parameters
yVector of chi2 derivatives
idimVector size

References calculateCovInv(), covinvvalid, getDChi2DParam(), getGlobalParNum(), getNPar(), isParamFixed(), and isParamMeasured().

Referenced by SoftGaussParticleConstraint::add2ndDerivativesToMatrix(), BaseHardConstraint::addToGlobalChi2DerVector(), and SoftGaussParticleConstraint::addToGlobalChi2DerVector().

void BaseFitObject::addToGlobalChi2DerVector ( double *  y,
int  idim,
double  lambda,
double  der[],
int  metaSet 
) const
virtual

Add derivatives of momentum vector to global derivative vector.

Parameters
yVector of chi2 derivatives
idimVector size
lambdaThe lambda value
derderivatives of constraint wrt intermediate variables (e.g. 4-vector with dg/dE, dg/dpx, dg/dpy, dg/dpz)
metaSetwhich set of intermediate variables

References cachevalid, getNPar(), and globalParNum.

void BaseFitObject::addToGlobCov ( double *  glcov,
int  idim 
) const
virtual

Add covariance matrix elements to global covariance matrix of size idim x idim.

Parameters
glcovGlobal covariance matrix
idimFirst dimension of global derivative matrix

References getCov(), getGlobalParNum(), getNPar(), isParamFixed(), and isParamMeasured().

BaseFitObject & BaseFitObject::assign ( const BaseFitObject &  source)
virtual

Assign from anther object, if of same type.

Parameters
sourceThe source object

Reimplemented in ParticleFitObject, VertexFitObject, JetFitObject, ISRPhotonFitObject, LeptonFitObject, SimplePhotonFitObject, NeutrinoFitObject, TrackParticleFitObject, and ZinvisibleFitObject.

References cachevalid, cov, covinvvalid, fixed, globalParNum, measured, mpar, par, and setName().

Referenced by VertexFitObject::assign(), ParticleFitObject::assign(), BaseFitObject(), and operator=().

bool BaseFitObject::fixParam ( int  ilocal,
bool  fix = true 
)
virtual

Fix a parameter (fix=true), or release it (fix=false)

Parameters
ilocalLocal parameter number
fixfix if true, release if false

References fixed, and getNPar().

Referenced by VertexFitObject::addConstraints(), TrackParticleFitObject::fixVertexParam(), and releaseParam().

double BaseFitObject::getCov ( int  ilocal,
int  jlocal 
) const
virtual

Get covariance between parameters ilocal and jlocal.

Parameters
ilocalLocal parameter number i
jlocalLocal parameter number j

Reimplemented in JetFitObject.

References cov, and getNPar().

Referenced by addToGlobCov().

double BaseFitObject::getD2Chi2DParam2 ( int  ilocal,
int  jlocal 
) const
virtual

Get second derivative of chi squared w.r.t. parameters ilocal1 and ilocal2.

Parameters
ilocalLocal parameter number i
jlocalLocal parameter number j

References calculateCovInv(), covinv, covinvvalid, getNPar(), isParamFixed(), and isParamMeasured().

Referenced by addToGlobalChi2DerMatrix().

double BaseFitObject::getDChi2DParam ( int  ilocal) const
virtual

Get derivative of chi squared w.r.t. parameter ilocal.

Parameters
ilocalLocal parameter number

References calculateCovInv(), covinv, covinvvalid, getNPar(), isParamFixed(), isParamMeasured(), mpar, and par.

Referenced by addToGlobalChi2DerVector().

double BaseFitObject::getError ( int  ilocal) const
virtual

Get error of parameter ilocal.

Parameters
ilocalLocal parameter number

Reimplemented in JetFitObject.

References cov, and getNPar().

Referenced by NewtonFitterGSL::fit(), and printParams().

int BaseFitObject::getGlobalParNum ( int  ilocal) const
virtual

Get global parameter number of parameter ilocal.

Parameters
ilocalLocal parameter number

References getNPar(), and globalParNum.

Referenced by BaseHardConstraint::add2ndDerivativesToMatrix(), SoftGaussParticleConstraint::add2ndDerivativesToMatrix(), addToGlobalChi2DerMatrix(), ParticleFitObject::addToGlobalChi2DerMatrixNum(), addToGlobalChi2DerVector(), ParticleFitObject::addToGlobalChi2DerVectorNum(), addToGlobCov(), NewtonFitterGSL::fit(), VertexConstraint::getDerivatives(), ZinvisibleFitObject::updateParams(), TrackParticleFitObject::updateParams(), NeutrinoFitObject::updateParams(), SimplePhotonFitObject::updateParams(), LeptonFitObject::updateParams(), ISRPhotonFitObject::updateParams(), JetFitObject::updateParams(), and updateParams().

double BaseFitObject::getMParam ( int  ilocal) const
virtual

Get measured value of parameter ilocal.

Parameters
ilocalLocal parameter number

References getNPar(), and mpar.

Referenced by NewtonFitterGSL::fit().

double BaseFitObject::getParam ( int  ilocal) const
virtual

Get current value of parameter ilocal.

Parameters
ilocalLocal parameter number

References getNPar(), and par.

Referenced by NewtonFitterGSL::fit(), SoftGaussParticleConstraint::num1stDerivative(), BaseHardConstraint::num1stDerivative(), ParticleFitObject::num1stDerivative(), SoftGaussParticleConstraint::num2ndDerivative(), BaseHardConstraint::num2ndDerivative(), ParticleFitObject::num2ndDerivative(), printParams(), and updateParams().

virtual const char* BaseFitObject::getParamName ( int  ilocal) const
inlinevirtual

Get name of parameter ilocal.

Parameters
ilocalLocal parameter number

Reimplemented in VertexFitObject, JetFitObject, ISRPhotonFitObject, LeptonFitObject, SimplePhotonFitObject, NeutrinoFitObject, TrackParticleFitObject, and ZinvisibleFitObject.

Referenced by NewtonFitterGSL::fit().

double BaseFitObject::getRho ( int  ilocal,
int  jlocal 
) const
virtual

Get correlation coefficient between parameters ilocal and jlocal.

Parameters
ilocalLocal parameter number i
jlocalLocal parameter number j

References cov, and getNPar().

Referenced by printRhoValues().

bool BaseFitObject::isParamFixed ( int  ilocal) const
virtual

Returns whether parameter is fixed.

Parameters
ilocalLocal parameter number

References fixed, and getNPar().

Referenced by addToGlobalChi2DerMatrix(), addToGlobalChi2DerVector(), addToGlobCov(), NewtonFitterGSL::fit(), ParticleFitObject::getChi2(), getChi2(), getD2Chi2DParam2(), getDChi2DParam(), VertexConstraint::getDerivatives(), getNFixed(), getNFree(), getNMeasured(), getNUnmeasured(), printParams(), and updateParams().

bool BaseFitObject::isParamMeasured ( int  ilocal) const
virtual

Get measured flag for parameter ilocal.

Parameters
ilocalLocal parameter number

References getNPar(), and measured.

Referenced by addToGlobalChi2DerMatrix(), addToGlobalChi2DerVector(), addToGlobCov(), calculateCovInv(), NewtonFitterGSL::fit(), ParticleFitObject::getChi2(), getChi2(), getD2Chi2DParam2(), getDChi2DParam(), getNMeasured(), and getNUnmeasured().

BaseFitObject & BaseFitObject::operator= ( const BaseFitObject &  rhs)

Assignment.

Parameters
rhsright hand side

References assign().

virtual std::ostream& BaseFitObject::print ( std::ostream &  os) const
pure virtual

print object to ostream

Parameters
osThe output stream

Implemented in VertexFitObject, and ParticleFitObject.

Referenced by operator<<().

std::ostream & BaseFitObject::print1stDerivatives ( std::ostream &  os) const
virtual

print the 1st derivatives wrt metaSet 0 (E, px, py, pz)

Parameters
osThe output stream

References getNPar().

std::ostream & BaseFitObject::print2ndDerivatives ( std::ostream &  os) const
virtual

print the 2nd derivatives wrt metaSet 0 (E, px, py, pz)

Parameters
osThe output stream

References getNPar().

std::ostream & BaseFitObject::printParams ( std::ostream &  os) const
virtual

print the parameters and errors

Parameters
osThe output stream

References getError(), getNPar(), getParam(), and isParamFixed().

Referenced by ParticleFitObject::print(), and VertexFitObject::print().

std::ostream & BaseFitObject::printRhoValues ( std::ostream &  os) const
virtual

print the correlation coefficients

Parameters
osThe output stream

References getNPar(), and getRho().

virtual bool BaseFitObject::releaseParam ( int  ilocal)
inlinevirtual

Release a parameter.

Parameters
ilocalLocal parameter number

References fixParam().

bool BaseFitObject::setCov ( int  ilocal,
int  jlocal,
double  cov_ 
)
virtual

Set covariance of parameters ilocal and jlocal; return: success.

Parameters
ilocalLocal parameter number
jlocalLocal parameter number
cov_New error value

References cov, covinvvalid, getNPar(), and invalidateCache().

Referenced by LeptonFitObject::LeptonFitObject().

bool BaseFitObject::setError ( int  ilocal,
double  err_ 
)
virtual

Set error of parameter ilocal; return: success.

Parameters
ilocalLocal parameter number
err_New error value

References cov, covinvvalid, getNPar(), and invalidateCache().

Referenced by ISRPhotonFitObject::ISRPhotonFitObject(), LeptonFitObject::LeptonFitObject(), and SimplePhotonFitObject::SimplePhotonFitObject().

bool BaseFitObject::setGlobalParNum ( int  ilocal,
int  iglobal 
)
virtual

Set number of parameter ilocal in global list return true signals OK.

Parameters
ilocalLocal parameter number
iglobalNew global parameter number

References getNPar(), and globalParNum.

bool BaseFitObject::setMParam ( int  ilocal,
double  mpar_ 
)
virtual

Set measured value of parameter ilocal; return: success.

Parameters
ilocalLocal parameter number
mpar_New measured parameter value

References getNPar(), invalidateCache(), and mpar.

Referenced by ISRPhotonFitObject::ISRPhotonFitObject(), LeptonFitObject::LeptonFitObject(), SimplePhotonFitObject::SimplePhotonFitObject(), and VertexFitObject::VertexFitObject().

bool BaseFitObject::setParam ( int  ilocal,
double  par_,
bool  measured_,
bool  fixed_ = false 
)
virtual

Set value and measured flag of parameter i; return: significant change.

Parameters
ilocalLocal parameter number
par_New parameter value
measured_New "measured" flag
fixed_New "fixed" flag

References fixed, getNPar(), invalidateCache(), and measured.

Referenced by ISRPhotonFitObject::ISRPhotonFitObject(), LeptonFitObject::LeptonFitObject(), SoftGaussParticleConstraint::num1stDerivative(), BaseHardConstraint::num1stDerivative(), ParticleFitObject::num1stDerivative(), SoftGaussParticleConstraint::num2ndDerivative(), BaseHardConstraint::num2ndDerivative(), ParticleFitObject::num2ndDerivative(), SimplePhotonFitObject::SimplePhotonFitObject(), updateParams(), and VertexFitObject::VertexFitObject().

bool BaseFitObject::setParam ( int  ilocal,
double  par_ 
)
virtual

Set value of parameter ilocal; return: significant change.

Parameters
ilocalLocal parameter number
par_New parameter value

References cov, getNPar(), invalidateCache(), and par.

bool BaseFitObject::updateParams ( double  p[],
int  idim 
)
virtual

Read values from global vector, readjust vector; return: significant change.

Parameters
pThe parameter vector
idimLength of the vector

Reimplemented in JetFitObject, ISRPhotonFitObject, LeptonFitObject, SimplePhotonFitObject, NeutrinoFitObject, TrackParticleFitObject, and ZinvisibleFitObject.

References getGlobalParNum(), getNPar(), getParam(), invalidateCache(), isParamFixed(), and setParam().

Friends And Related Function Documentation

std::ostream & operator<< ( std::ostream &  os,
const BaseFitObject &  bfo 
)
related

Prints out a BaseFitObject, using its print method.

Parameters
osThe output stream
bfoThe object to print

References print().

The documentation for this class was generated from the following files:
Generated on Fri Dec 2 2016 12:34:44 for MarlinKinfit by   doxygen 1.8.6