Abstract base class for constraints of kinematic fits. More...

#include <SoftGaussParticleConstraint.h>

Inheritance diagram for SoftGaussParticleConstraint:

[legend]

Collaboration diagram for SoftGaussParticleConstraint:

[legend]

Public Member Functions
	SoftGaussParticleConstraint (double sigma_)
	Creates an empty SoftGaussParticleConstraint object. More...

virtual	~SoftGaussParticleConstraint ()
	Virtual destructor.

virtual void	setFOList (std::vector< ParticleFitObject * > *fitobjects_)
	Adds several ParticleFitObject objects to the list. More...

virtual void	addToFOList (ParticleFitObject &fitobject, int flag=1)
	Adds one ParticleFitObject objects to the list.

virtual void	resetFOList ()
	Resests ParticleFitObject list.

virtual double	getValue () const override=0
	Returns the value of the constraint function.

virtual double	getChi2 () const override
	Returns the chi2.

virtual double	getError () const override
	Returns the error on the value of the constraint.

virtual double	getSigma () const
	Returns the sigma.

virtual double	setSigma (double sigma_)
	Sets the sigma. More...

virtual void	getDerivatives (int idim, double der[]) const override=0
	Get first order derivatives. More...

virtual void	add2ndDerivativesToMatrix (double *M, int idim) const override
	Adds second order derivatives to global covariance matrix M. More...

virtual void	addToGlobalChi2DerVector (double *y, int idim) const override
	Add derivatives of chi squared to global derivative matrix. More...

void	invalidateCache () const
	Invalidates any cached values for the next event.

void	test1stDerivatives ()

void	test2ndDerivatives ()

double	num1stDerivative (int ifo, int ilocal, double eps)
	Evaluates numerically the 1st derivative w.r.t. a parameter. More...

double	num2ndDerivative (int ifo1, int ilocal1, double eps1, int ifo2, int ilocal2, double eps2)
	Evaluates numerically the 2nd derivative w.r.t. 2 parameters. More...

int	getVarBasis () const

virtual const char *	getName () const
	Returns the name of the constraint.

void	setName (const char *name_)
	Set object's name.

virtual std::ostream &	print (std::ostream &os) const
	print object to ostream More...

Protected Types
enum	{ VAR_BASIS = BaseDefs::VARBASIS_EPXYZ }

typedef std::vector< ParticleFitObject * >	FitObjectContainer
	Vector of pointers to ParticleFitObjects.

typedef FitObjectContainer::iterator	FitObjectIterator
	Iterator through vector of pointers to ParticleFitObjects.

typedef FitObjectContainer::const_iterator	ConstFitObjectIterator
	Constant iterator through vector of pointers to ParticleFitObjects.

Protected Member Functions
virtual bool	secondDerivatives (int i, int j, double *derivatives) const =0
	Second derivatives with respect to the 4-vectors of Fit objects i and j; result false if all derivatives are zero. More...

virtual bool	firstDerivatives (int i, double *derivatives) const =0
	First derivatives with respect to the 4-vector of Fit objects i; result false if all derivatives are zero. More...

Protected Attributes
FitObjectContainer	fitobjects
	The FitObjectContainer.

std::vector< double >	derivatives
	The derivatives.

std::vector< int >	flags
	The flags can be used to divide the FitObjectContainer into several subsets used for example to implement an equal mass constraint (see MassConstraint).

double	sigma
	The sigma of the Gaussian.

char *	name

Related Functions
(Note that these are not member functions.)
std::ostream &	operator<< (std::ostream &os, const BaseConstraint &bc)
	Prints out a BaseConstraint, using its print method. More...

Detailed Description

Abstract base class for constraints of kinematic fits.

This class defines the minimal functionality any constraint class must provide. First of all a constraint should know on with particles (or FitObject) it is applied. Where as for example a constraint on the total transvese momentum takes into account all particles in the event, an invariant mass constraint usually applies only to a subset of particles.

The particle list is implemented as a vector containing pointers to objects derived from ParticleFitObject and can be either set a whole (setFOList) or enlarged by adding a single ParticleFitObject (addToFOList).

From the four–momenta of all concerned fit objects the constraint has to be able to calculate its current value (getValue). Constraints should be formulated such that a value of zero corresponds to a perfectly fulfilled constraint.

In order to find a solution to the constrained minimisation problem, fit algorithms usually need the first order derivatives of the constraint with respect to the fit parameters. Since many constraints can be most easily expressed in terms of E, px, py, pz, the constraints supply their derivatives w.r.t. these parameters. If a FitObject uses a different parametrisation, it is its own task to provide the additional derivatives of E, px, py, pz w.r.t. the parameters of the FitObject. Thus it is easily possible to use FitObjects with different kinds of parametrisations under the same constraint. Some fit algorithms also need the second derivatives of the constraint, i.e. the NewtonFitter.

First and second order derivatives of each constraint can be added directly to the global covariance matrix containing the derivatives of all constraints w.r.t. to all parameters (add1stDerivativesToMatrix, add2ndDerivativesToMatrix). This requires the constraint to know its position in the overall list of constraints (globalNum).

Author: Jenny List, Benno List

Date: 2008/02/13 12:37:38

Author: blist

Definition at line 74 of file SoftGaussParticleConstraint.h.

Constructor & Destructor Documentation

◆ SoftGaussParticleConstraint()

SoftGaussParticleConstraint ( double sigma_ )

explicit

Creates an empty SoftGaussParticleConstraint object.

Parameters

sigma_ The sigma value

Definition at line 31 of file SoftGaussParticleConstraint.cc.

Member Function Documentation

◆ add2ndDerivativesToMatrix()

void add2ndDerivativesToMatrix	(	double *	M,
		int	idim
	)		const

overridevirtual

Adds second order derivatives to global covariance matrix M.

Calculates the second derivative of the constraint g w.r.t.

the various parameters and adds it to the global covariance matrix

We denote with P_i the 4-vector of the i-th ParticleFitObject, then $$ \frac{\partial ^2 g}{\partial a_k \partial a_l} = \sum_i \sum_j \frac{\partial ^2 g}{\partial P_i \partial P_j} \cdot \frac{\partial P_i}{\partial a_k} \cdot \frac{\partial P_j}{\partial a_l}

\sum_i \frac{\partial g}{\partial P_i} \cdot \frac{\partial^2 P_i}{\partial a_k \partial a_l} $$ Here, $\frac{\partial P_i}{\partial a_k}$ is a $4 \times n_i$ Matrix, where $n_i$ is the number of parameters of FitObject i; Correspondingly, $\frac{\partial^2 P_i}{\partial a_k \partial a_l}$ is a $4 \times n_i \times n_i$ matrix. Also, $\frac{\partial ^2 g}{\partial P_i \partial P_j}$ is a $4\times 4$ matrix for a given i and j, and $\frac{\partial g}{\partial P_i}$ is a 4-vector (though not a Lorentz-vector!).

First, treat the part $$ \frac{\partial ^2 g}{\partial P_i \partial P_j} \cdot \frac{\partial P_i}{\partial a_k} \cdot \frac{\partial P_j}{\partial a_l} $$

Second, treat the parts $$ \sum_i \frac{\partial g}{\partial P_i} \cdot \frac{\partial^2 P_i}{\partial a_k \partial a_l} $$ and $$ \frac{\partial^2 h}{\partial g^2} \sum_i \frac{\partial g}{\partial P_i} \cdot \frac{\partial P_i}{\partial a_k} \sum_j \frac{\partial g}{\partial P_j} \cdot \frac{\partial P_j}{\partial a_l} $$

Here, $\frac{\partial g}{\partial P_i}$ is a 4-vector, which we pass on to the FitObject

Parameters

M	Covariance matrix, at least idim x idim
idim	First dimension of the array

Implements BaseSoftConstraint.

Definition at line 91 of file SoftGaussParticleConstraint.cc.

◆ addToGlobalChi2DerVector()

void addToGlobalChi2DerVector	(	double *	y,
		int	idim
	)		const

overridevirtual

Add derivatives of chi squared to global derivative matrix.

Parameters

y	Vector of chi2 derivatives
idim	Vector size

Implements BaseSoftConstraint.

Definition at line 243 of file SoftGaussParticleConstraint.cc.

◆ firstDerivatives()

virtual bool firstDerivatives	(	int	i,
		double *	derivatives
	)		const

protectedpure virtual

First derivatives with respect to the 4-vector of Fit objects i; result false if all derivatives are zero.

Parameters

i	number of 1st FitObject
derivatives	The result 4-vector

Implemented in SoftGaussMomentumConstraint, and SoftGaussMassConstraint.

◆ getDerivatives()

virtual void getDerivatives	(	int	idim,
		double	der[]
	)		const

overridepure virtual

Get first order derivatives.

Call this with a predefined array "der" with the necessary number of entries!

Parameters

idim	First dimension of the array
der	Array of derivatives, at least idim x idim

Implements BaseConstraint.

Implemented in SoftGaussMomentumConstraint, and SoftGaussMassConstraint.

◆ num1stDerivative()

double num1stDerivative	(	int	ifo,
		int	ilocal,
		double	eps
	)

Evaluates numerically the 1st derivative w.r.t. a parameter.

Parameters

ifo	Number of FitObject
ilocal	Local parameter number
eps	variation of local parameter

Definition at line 312 of file SoftGaussParticleConstraint.cc.

◆ num2ndDerivative()

double num2ndDerivative	(	int	ifo1,
		int	ilocal1,
		double	eps1,
		int	ifo2,
		int	ilocal2,
		double	eps2
	)

Evaluates numerically the 2nd derivative w.r.t. 2 parameters.

Parameters

ifo1	Number of 1st FitObject
ilocal1	1st local parameter number
eps1	variation of 1st local parameter
ifo2	Number of 1st FitObject
ilocal2	1st local parameter number
eps2	variation of 2nd local parameter

Definition at line 326 of file SoftGaussParticleConstraint.cc.

◆ print()

std::ostream & print ( std::ostream & os ) const

virtualinherited

print object to ostream

Parameters

os	The output stream

Definition at line 76 of file BaseConstraint.cc.

◆ secondDerivatives()

virtual bool secondDerivatives	(	int	i,
		int	j,
		double *	derivatives
	)		const

protectedpure virtual

Second derivatives with respect to the 4-vectors of Fit objects i and j; result false if all derivatives are zero.

Parameters

i	number of 1st FitObject
j	number of 2nd FitObject
derivatives	The result 4x4 matrix

Implemented in SoftGaussMomentumConstraint, and SoftGaussMassConstraint.

◆ setFOList()

virtual void setFOList ( std::vector< ParticleFitObject * > * fitobjects_ )

inlinevirtual

Adds several ParticleFitObject objects to the list.

Parameters

fitobjects_ A list of BaseFitObject objects

Definition at line 83 of file SoftGaussParticleConstraint.h.

◆ setSigma()

double setSigma ( double sigma_ )

virtual

Sets the sigma.

Parameters

sigma_ The new sigma value

Definition at line 42 of file SoftGaussParticleConstraint.cc.

Friends And Related Function Documentation

◆ operator<<()

std::ostream & operator<<	(	std::ostream &	os,
		const BaseConstraint &	bc
	)

Parameters

os	The output stream
bc	The object to print

Definition at line 114 of file BaseConstraint.h.

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

analysis/OrcaKinFit/include/SoftGaussParticleConstraint.h
analysis/OrcaKinFit/src/SoftGaussParticleConstraint.cc

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Related Functions

Detailed Description

Constructor & Destructor Documentation

◆ SoftGaussParticleConstraint()

Member Function Documentation

◆ add2ndDerivativesToMatrix()

◆ addToGlobalChi2DerVector()

◆ firstDerivatives()

◆ getDerivatives()

◆ num1stDerivative()

◆ num2ndDerivative()

◆ print()

◆ secondDerivatives()

◆ setFOList()

◆ setSigma()

Friends And Related Function Documentation

◆ operator<<()