Belle II Software development
|
Abstract base class for constraints of kinematic fits. More...
#include <SoftGaussParticleConstraint.h>
Public Member Functions | |
SoftGaussParticleConstraint (double sigma_) | |
Creates an empty SoftGaussParticleConstraint object. | |
virtual | ~SoftGaussParticleConstraint () |
Virtual destructor. | |
virtual void | setFOList (std::vector< ParticleFitObject * > *fitobjects_) |
Adds several ParticleFitObject objects to the list. | |
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. | |
virtual void | getDerivatives (int idim, double der[]) const override=0 |
Get first order derivatives. | |
virtual void | add2ndDerivativesToMatrix (double *M, int idim) const override |
Adds second order derivatives to global covariance matrix M. | |
virtual void | addToGlobalChi2DerVector (double *y, int idim) const override |
Add derivatives of chi squared to global derivative matrix. | |
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. | |
double | num2ndDerivative (int ifo1, int ilocal1, double eps1, int ifo2, int ilocal2, double eps2) |
Evaluates numerically the 2nd derivative w.r.t. 2 parameters. | |
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 | |
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. | |
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. | |
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. | |
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
Definition at line 74 of file SoftGaussParticleConstraint.h.
|
protected |
Constant iterator through vector of pointers to ParticleFitObjects.
Definition at line 177 of file SoftGaussParticleConstraint.h.
|
protected |
Vector of pointers to ParticleFitObjects.
Definition at line 173 of file SoftGaussParticleConstraint.h.
|
protected |
Iterator through vector of pointers to ParticleFitObjects.
Definition at line 175 of file SoftGaussParticleConstraint.h.
|
protected |
Definition at line 189 of file SoftGaussParticleConstraint.h.
|
explicit |
Creates an empty SoftGaussParticleConstraint object.
sigma_ | The sigma value |
Definition at line 31 of file SoftGaussParticleConstraint.cc.
|
inlinevirtual |
|
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
Here, is a Matrix, where is the number of parameters of FitObject i; Correspondingly, is a matrix. Also, is a matrix for a given i and j, and is a 4-vector (though not a Lorentz-vector!).
First, treat the part
Second, treat the parts
and
Here, is a 4-vector, which we pass on to the FitObject
M | Covariance matrix, at least idim x idim |
idim | First dimension of the array |
Implements BaseSoftConstraint.
Definition at line 92 of file SoftGaussParticleConstraint.cc.
|
inlinevirtual |
Adds one ParticleFitObject objects to the list.
Definition at line 92 of file SoftGaussParticleConstraint.h.
|
overridevirtual |
Add derivatives of chi squared to global derivative matrix.
y | Vector of chi2 derivatives |
idim | Vector size |
Implements BaseSoftConstraint.
Definition at line 246 of file SoftGaussParticleConstraint.cc.
|
protectedpure virtual |
First derivatives with respect to the 4-vector of Fit objects i; result false if all derivatives are zero.
i | number of 1st FitObject |
derivatives | The result 4-vector |
Implemented in SoftGaussMassConstraint, and SoftGaussMomentumConstraint.
|
overridevirtual |
Returns the chi2.
Implements BaseSoftConstraint.
Definition at line 48 of file SoftGaussParticleConstraint.cc.
|
overridepure virtual |
Get first order derivatives.
Call this with a predefined array "der" with the necessary number of entries!
idim | First dimension of the array |
der | Array of derivatives, at least idim x idim |
Implements BaseConstraint.
Implemented in SoftGaussMassConstraint, and SoftGaussMomentumConstraint.
|
overridevirtual |
Returns the error on the value of the constraint.
Reimplemented from BaseConstraint.
Definition at line 54 of file SoftGaussParticleConstraint.cc.
|
virtualinherited |
Returns the name of the constraint.
Definition at line 56 of file BaseConstraint.cc.
|
virtual |
Returns the sigma.
Definition at line 37 of file SoftGaussParticleConstraint.cc.
|
overridepure virtual |
Returns the value of the constraint function.
Implements BaseConstraint.
Implemented in SoftGaussMassConstraint, and SoftGaussMomentumConstraint.
int getVarBasis | ( | ) | const |
Definition at line 368 of file SoftGaussParticleConstraint.cc.
|
inline |
Invalidates any cached values for the next event.
Definition at line 138 of file SoftGaussParticleConstraint.h.
double num1stDerivative | ( | int | ifo, |
int | ilocal, | ||
double | eps | ||
) |
Evaluates numerically the 1st derivative w.r.t. a parameter.
ifo | Number of FitObject |
ilocal | Local parameter number |
eps | variation of local parameter |
Definition at line 315 of file SoftGaussParticleConstraint.cc.
double num2ndDerivative | ( | int | ifo1, |
int | ilocal1, | ||
double | eps1, | ||
int | ifo2, | ||
int | ilocal2, | ||
double | eps2 | ||
) |
Evaluates numerically the 2nd derivative w.r.t. 2 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 329 of file SoftGaussParticleConstraint.cc.
|
virtualinherited |
print object to ostream
os | The output stream |
Definition at line 76 of file BaseConstraint.cc.
|
inlinevirtual |
Resests ParticleFitObject list.
Definition at line 99 of file SoftGaussParticleConstraint.h.
|
protectedpure virtual |
Second derivatives with respect to the 4-vectors of Fit objects i and j; result false if all derivatives are zero.
i | number of 1st FitObject |
j | number of 2nd FitObject |
derivatives | The result 4x4 matrix |
Implemented in SoftGaussMassConstraint, and SoftGaussMomentumConstraint.
|
inlinevirtual |
Adds several ParticleFitObject objects to the list.
fitobjects_ | A list of BaseFitObject objects |
Definition at line 83 of file SoftGaussParticleConstraint.h.
|
inherited |
Set object's name.
Definition at line 61 of file BaseConstraint.cc.
|
virtual |
Sets the sigma.
sigma_ | The new sigma value |
Definition at line 42 of file SoftGaussParticleConstraint.cc.
void test1stDerivatives | ( | ) |
Definition at line 260 of file SoftGaussParticleConstraint.cc.
void test2ndDerivatives | ( | ) |
Definition at line 280 of file SoftGaussParticleConstraint.cc.
|
related |
Prints out a BaseConstraint, using its print method.
os | The output stream |
bc | The object to print |
Definition at line 114 of file BaseConstraint.h.
|
protected |
The derivatives.
Definition at line 181 of file SoftGaussParticleConstraint.h.
|
protected |
The FitObjectContainer.
Definition at line 179 of file SoftGaussParticleConstraint.h.
|
protected |
The flags can be used to divide the FitObjectContainer into several subsets used for example to implement an equal mass constraint (see MassConstraint).
Definition at line 184 of file SoftGaussParticleConstraint.h.
|
protectedinherited |
Definition at line 108 of file BaseConstraint.h.
|
protected |
The sigma of the Gaussian.
Definition at line 187 of file SoftGaussParticleConstraint.h.