BaseFitter Class Reference

Abstract base class for fitting engines of kinematic fits. More...

#include <BaseFitter.h>

Inheritance diagram for BaseFitter:

Collaboration diagram for BaseFitter:

Public Member Functions
virtual void	addFitObject (BaseFitObject *fitobject_)
virtual void	addFitObject (BaseFitObject &fitobject_)
virtual void	addConstraint (BaseConstraint *constraint_)
virtual void	addConstraint (BaseConstraint &constraint_)
virtual void	addHardConstraint (BaseHardConstraint *constraint_)
virtual void	addHardConstraint (BaseHardConstraint &constraint_)
virtual void	addSoftConstraint (BaseSoftConstraint *constraint_)
virtual void	addSoftConstraint (BaseSoftConstraint &constraint_)
virtual std::vector< BaseFitObject * > *	getFitObjects ()
virtual std::vector< BaseHardConstraint * > *	getConstraints ()
virtual std::vector< BaseSoftConstraint * > *	getSoftConstraints ()
virtual double	fit ()=0
virtual int	getError () const =0
virtual double	getProbability () const =0
virtual double	getChi2 () const =0
virtual int	getDoF () const =0
virtual int	getIterations () const =0
virtual void	reset ()
virtual bool	initialize ()=0
virtual BaseTracer *	getTracer ()
virtual const BaseTracer *	getTracer () const
virtual void	setTracer (BaseTracer *newTracer)
virtual void	setTracer (BaseTracer &newTracer)
virtual const double *	getGlobalCovarianceMatrix (int &idim) const
virtual double *	getGlobalCovarianceMatrix (int &idim)

Public Attributes
std::map< std::string, double >	traceValues

Protected Types
typedef std::vector< BaseFitObject * >	FitObjectContainer
typedef std::vector< BaseHardConstraint * >	ConstraintContainer
typedef std::vector< BaseSoftConstraint * >	SoftConstraintContainer
typedef FitObjectContainer::iterator	FitObjectIterator
typedef ConstraintContainer::iterator	ConstraintIterator
typedef SoftConstraintContainer::iterator	SoftConstraintIterator

Protected Member Functions
	BaseFitter (const BaseFitter &rhs)
	Copy constructor disabled.
BaseFitter &	operator= (const BaseFitter &rhs)
	Assignment disabled.

Protected Attributes
FitObjectContainer	fitobjects
ConstraintContainer	constraints
SoftConstraintContainer	softconstraints
int	covDim
	dimension of global covariance matrix
double *	cov
	global covariance matrix of last fit problem
bool	covValid
	Flag whether global covariance is valid.
BaseTracer *	tracer

Detailed Description

Abstract base class for fitting engines of kinematic fits.

Author: Jenny List, Benno List Last update:

Date

2011/03/03 15:03:02

by:

Author

blist

Definition at line 47 of file BaseFitter.h.

Member Typedef Documentation

ConstraintContainer

typedef std::vector<BaseHardConstraint*> ConstraintContainer

protected

Definition at line 92 of file BaseFitter.h.

ConstraintIterator

typedef ConstraintContainer::iterator ConstraintIterator

protected

Definition at line 96 of file BaseFitter.h.

FitObjectContainer

typedef std::vector<BaseFitObject*> FitObjectContainer

protected

Definition at line 91 of file BaseFitter.h.

FitObjectIterator

typedef FitObjectContainer::iterator FitObjectIterator

protected

Definition at line 95 of file BaseFitter.h.

SoftConstraintContainer

typedef std::vector<BaseSoftConstraint*> SoftConstraintContainer

protected

Definition at line 93 of file BaseFitter.h.

SoftConstraintIterator

typedef SoftConstraintContainer::iterator SoftConstraintIterator

protected

Definition at line 97 of file BaseFitter.h.

Constructor & Destructor Documentation

BaseFitter()

BaseFitter

(

)

Definition at line 31 of file BaseFitter.cc.

      : fitobjects(FitObjectContainer()),
        constraints(ConstraintContainer()),
        softconstraints(SoftConstraintContainer()),
        covDim(0), cov(nullptr), covValid(false)
#ifndef FIT_TRACEOFF
      , tracer(nullptr),
        traceValues(std::map<std::string, double> ())
#endif
    {}

~BaseFitter()

~BaseFitter ( )

virtual

Definition at line 42 of file BaseFitter.cc.

    {
      delete[] cov;
      cov = nullptr;
    }

Member Function Documentation

addConstraint() [1/2]

void addConstraint ( BaseConstraint &  constraint_ )

virtual

Definition at line 74 of file BaseFitter.cc.

    {
      covValid = false;
      if (auto* hc = dynamic_cast<BaseHardConstraint*>(&constraint_))
        constraints.push_back(hc);
      else if (auto* sc = dynamic_cast<BaseSoftConstraint*>(&constraint_))
        softconstraints.push_back(sc);
    }

addConstraint() [2/2]

void addConstraint ( BaseConstraint *  constraint_ )

virtual

Definition at line 60 of file BaseFitter.cc.

    {
      covValid = false;
 
      if (auto* hc = dynamic_cast<BaseHardConstraint*>(constraint_))
        constraints.push_back(hc);
      else if (auto* sc = dynamic_cast<BaseSoftConstraint*>(constraint_))
        softconstraints.push_back(sc);
      else {
        // illegal constraint
        assert(0);
      }
    }

addFitObject() [1/2]

void addFitObject ( BaseFitObject &  fitobject_ )

virtual

Definition at line 54 of file BaseFitter.cc.

    {
      covValid = false;
      fitobjects.push_back(&fitobject_);
    }

addFitObject() [2/2]

void addFitObject ( BaseFitObject *  fitobject_ )

virtual

Definition at line 48 of file BaseFitter.cc.

    {
      covValid = false;
      fitobjects.push_back(fitobject_);
    }

addHardConstraint() [1/2]

void addHardConstraint ( BaseHardConstraint &  constraint_ )

virtual

Definition at line 89 of file BaseFitter.cc.

    {
      covValid = false;
      constraints.push_back(&constraint_);
    }

addHardConstraint() [2/2]

void addHardConstraint ( BaseHardConstraint *  constraint_ )

virtual

Definition at line 83 of file BaseFitter.cc.

    {
      covValid = false;
      constraints.push_back(constraint_);
    }

addSoftConstraint() [1/2]

void addSoftConstraint ( BaseSoftConstraint &  constraint_ )

virtual

Definition at line 101 of file BaseFitter.cc.

    {
      covValid = false;
      softconstraints.push_back(&constraint_);
    }

addSoftConstraint() [2/2]

void addSoftConstraint ( BaseSoftConstraint *  constraint_ )

virtual

Definition at line 95 of file BaseFitter.cc.

    {
      covValid = false;
      softconstraints.push_back(constraint_);
    }

fit()

virtual double fit ( )

pure virtual

Implemented in NewFitterGSL, NewtonFitterGSL, and OPALFitterGSL.

getChi2()

virtual double getChi2 ( ) const

pure virtual

Implemented in NewFitterGSL, NewtonFitterGSL, and OPALFitterGSL.

getConstraints()

std::vector< BaseHardConstraint * > * getConstraints ( )

virtual

Definition at line 112 of file BaseFitter.cc.

    {
      return &constraints;
    }

getDoF()

virtual int getDoF ( ) const

pure virtual

Implemented in NewFitterGSL, NewtonFitterGSL, and OPALFitterGSL.

getError()

virtual int getError ( ) const

pure virtual

Implemented in NewFitterGSL, NewtonFitterGSL, and OPALFitterGSL.

getFitObjects()

std::vector< BaseFitObject * > * getFitObjects ( )

virtual

Definition at line 107 of file BaseFitter.cc.

    {
      return &fitobjects;
    }

getGlobalCovarianceMatrix() [1/2]

double * getGlobalCovarianceMatrix ( int &  idim )

virtual

Parameters

idim	1st dimension of global covariance matrix

Definition at line 158 of file BaseFitter.cc.

    {
      if (covValid && cov) {
        idim = covDim;
        return cov;
      }
      idim = 0;
      return nullptr;
    }

getGlobalCovarianceMatrix() [2/2]

const double * getGlobalCovarianceMatrix ( int &  idim ) const

virtual

Parameters

idim	1st dimension of global covariance matrix

Definition at line 148 of file BaseFitter.cc.

    {
      if (covValid && cov) {
        idim = covDim;
        return cov;
      }
      idim = 0;
      return nullptr;
    }

getIterations()

virtual int getIterations ( ) const

pure virtual

Implemented in NewFitterGSL, NewtonFitterGSL, and OPALFitterGSL.

getProbability()

virtual double getProbability ( ) const

pure virtual

Implemented in NewFitterGSL, NewtonFitterGSL, and OPALFitterGSL.

getSoftConstraints()

std::vector< BaseSoftConstraint * > * getSoftConstraints ( )

virtual

Definition at line 117 of file BaseFitter.cc.

    {
      return &softconstraints;
    }

getTracer() [1/2]

BaseTracer * getTracer ( )

virtual

Definition at line 130 of file BaseFitter.cc.

    {
      return tracer;
    }

getTracer() [2/2]

const BaseTracer * getTracer ( ) const

virtual

Definition at line 134 of file BaseFitter.cc.

    {
      return tracer;
    }

initialize()

virtual bool initialize ( )

pure virtual

Implemented in NewFitterGSL, and NewtonFitterGSL.

reset()

void reset ( )

virtual

Definition at line 122 of file BaseFitter.cc.

    {
      fitobjects.resize(0);
      constraints.resize(0);
      softconstraints.resize(0);
      covValid = false;
    }

setTracer() [1/2]

void setTracer ( BaseTracer &  newTracer )

virtual

Definition at line 143 of file BaseFitter.cc.

    {
      tracer = &newTracer;
    }

setTracer() [2/2]

void setTracer ( BaseTracer *  newTracer )

virtual

Definition at line 138 of file BaseFitter.cc.

    {
      tracer = newTracer;
    }

Member Data Documentation

constraints

ConstraintContainer constraints

protected

Definition at line 100 of file BaseFitter.h.

cov

double* cov

protected

global covariance matrix of last fit problem

Definition at line 104 of file BaseFitter.h.

covDim

int covDim

protected

dimension of global covariance matrix

Definition at line 103 of file BaseFitter.h.

covValid

bool covValid

protected

Flag whether global covariance is valid.

Definition at line 105 of file BaseFitter.h.

fitobjects

FitObjectContainer fitobjects

protected

Definition at line 99 of file BaseFitter.h.

softconstraints

SoftConstraintContainer softconstraints

protected

Definition at line 101 of file BaseFitter.h.

tracer

BaseTracer* tracer

protected

Definition at line 108 of file BaseFitter.h.

traceValues

std::map<std::string, double> traceValues

Definition at line 112 of file BaseFitter.h.

---

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

• analysis/OrcaKinFit/include/BaseFitter.h
• analysis/OrcaKinFit/src/BaseFitter.cc