class to manage the order of constraints and their filtering More...

#include <Constraint.h>

Inheritance diagram for Constraint:

Collaboration diagram for Constraint:

[legend]

Public Types
enum	Type { unknown = 0 , beamenergy , beamspot , beam , origin , lifetime , resonance , composite , track , photon , klong , conversion , kinematic , geometric , mass , massEnergy , merged , ntypes , helix }
	type of constraints the order of these constraints is important: it is the order in which they are applied. More...

Public Member Functions
bool	operator< (const Constraint &rhs) const
	operator used to sort the constraints

bool	operator== (const Constraint &rhs) const
	operator

Type	type () const
	get type of constraint

unsigned int	dim () const
	get dimension of constraint

bool	isLinear () const
	is this a linear constraint

unsigned int	nIter () const
	get maximum number of iterations for non in constraint

	Constraint ()
	constructor

	Constraint (const ParticleBase *node, Type type, int depth, unsigned int dim, int maxniter=1)
	constructor

virtual	~Constraint ()
	destructor

virtual ErrCode	project (const FitParams &fitpar, Projection &p) const
	call the constraints projection function

virtual ErrCode	filter (FitParams &fitpar)
	filter this constraint

virtual ErrCode	filterWithReference (FitParams &fitpar, const FitParams &oldState)
	filter this constraint

std::string	name () const
	get name of constraint

void	setWeight (int w)
	used to be able to weight the constraints

Protected Member Functions
	Constraint (Constraint::Type type)
	constructor

void	setDim (unsigned int d)
	set dimension of constraint

void	setNIter (unsigned int d)
	set max number of iterations for non lin constraint

Private Attributes
const ParticleBase *	m_node
	particle behind the constraint

int	m_depth
	chi2 coming from the constraint

Type	m_type
	type of constraint

unsigned int	m_dim
	dimension of constraint

int	m_weight
	weight of this constraint currently we set them all to unity

int	m_maxNIter
	maximum number of iterations for non-linear constraints

Detailed Description

class to manage the order of constraints and their filtering

Definition at line 20 of file Constraint.h.

Member Enumeration Documentation

◆ Type

enum Type

type of constraints the order of these constraints is important: it is the order in which they are applied.

Definition at line 27 of file Constraint.h.

              { unknown = 0,
                beamenergy,
                beamspot,
                beam,
                origin,
                lifetime,
                resonance,
                composite,
                track,
                photon,
                klong,
                conversion,
                kinematic,
                geometric,
                mass,
                massEnergy,
                merged,
                ntypes,
                helix
              };

Constructor & Destructor Documentation

◆ Constraint() [1/3]

Constraint ( )

inline

constructor

Definition at line 70 of file Constraint.h.

                 :
      m_node(0),
      m_depth(0),
      m_type(unknown),
      m_dim(0),
      m_weight(0),
      m_maxNIter(0) {}

◆ Constraint() [2/3]

Constraint	(	const ParticleBase *	node,
		Type	type,
		int	depth,
		unsigned int	dim,
		int	maxniter = `1`
	)

inline

constructor

Definition at line 79 of file Constraint.h.

                                 :
      m_node(node),
      m_depth(depth),
      m_type(type),
      m_dim(dim),
      m_weight(1),
      m_maxNIter(maxniter) {}

◆ ~Constraint()

virtual ~Constraint ( )

inlinevirtual

destructor

Definition at line 92 of file Constraint.h.

92{}

◆ Constraint() [3/3]

Constraint ( Constraint::Type type )

inlineexplicitprotected

constructor

Definition at line 114 of file Constraint.h.

                                             :
      m_node(0),
      m_depth(0),
      m_type(type),
      m_dim(0),
      m_weight(0),
      m_maxNIter(0) {}

Member Function Documentation

◆ dim()

unsigned int dim ( ) const

inline

get dimension of constraint

Definition at line 61 of file Constraint.h.

61{ return m_dim; }

◆ filter()

ErrCode filter ( FitParams & fitpar )

virtual

filter this constraint

We don't have reference state yet so we use the k-1 last state to linearize non-linear constraints

Definition at line 28 of file Constraint.cc.

  {
    ErrCode status;
    Projection p(fitpar.getDimensionOfState(), m_dim);
    KalmanCalculator kalman(m_dim, fitpar.getDimensionOfState());
 
    double chisq(0);
    int iter(0);
    bool finished(false) ;
 
    double accumulated_chi2 = 0;
    while (!finished && !status.failure()) {
 
      p.resetProjection();
      status |= project(fitpar, p);
 
      if (!status.failure()) {
 
        status |= kalman.calculateGainMatrix(
                    p.getResiduals(),
                    p.getH(),
                    fitpar,
                    &p.getV(),
                    1
                  );
 
        if (!status.failure()) {
          kalman.updateState(fitpar);
 
          // r R^-1 r
          double newchisq = kalman.getChiSquare();
 
          double dchisqconverged = 0.001 ;
 
          double dchisq = newchisq - chisq;
          bool diverging = iter > 0 && dchisq > 0;
          bool converged = std::abs(dchisq) < dchisqconverged;
          finished  = ++iter >= m_maxNIter || diverging || converged;
          chisq = newchisq;
          accumulated_chi2 += newchisq;
        }
      }
    }
 
    const unsigned int number_of_constraints = kalman.getConstraintDim();
    fitpar.addChiSquare(accumulated_chi2, number_of_constraints);
 
    kalman.updateCovariance(fitpar);
    return status;
  }

◆ filterWithReference()

ErrCode filterWithReference	(	FitParams &	fitpar,
		const FitParams &	oldState
	)

virtual

filter this constraint

We now linearise around the last iteration $\alpha$ (const FitParams& oldState) In this implementation we can no longer linearize non-linear constraints but we ensured by the linearisation around the last state that the step size is small enough so we just use them as if they were linear

here we project the old state and use only the change with respect to the new state instead of the new state in the update . the advantage is more stable fit Downside: non-linear constraints can't be filtered multiple times anymore.

Definition at line 83 of file Constraint.cc.

  {
    ErrCode status;
    Projection p(fitpar.getDimensionOfState(), m_dim);
    KalmanCalculator kalman(m_dim, fitpar.getDimensionOfState());
 
    p.resetProjection();
    status |= project(oldState, p);
 
    p.getResiduals() += p.getH() * (fitpar.getStateVector() - oldState.getStateVector());
    if (!status.failure()) {
      status |= kalman.calculateGainMatrix(
                  p.getResiduals(),
                  p.getH(),
                  fitpar,
                  &p.getV(),
                  1
                );
 
      if (!status.failure()) {
        kalman.updateState(fitpar);
      }
    }
 
    const unsigned int number_of_constraints = kalman.getConstraintDim();
    fitpar.addChiSquare(kalman.getChiSquare(), number_of_constraints);
 
    kalman.updateCovariance(fitpar);
    return status;
  }

◆ isLinear()

bool isLinear ( ) const

inline

is this a linear constraint

Definition at line 64 of file Constraint.h.

64{ return m_maxNIter <= 1; }

◆ name()

std::string name ( ) const

get name of constraint

Definition at line 124 of file Constraint.cc.

  {
    std::string rc = "unknown constraint!";
    switch (m_type) {
      case beamspot:     rc = "beamspot";   break;
      case beamenergy:   rc = "beamenergy"; break;
      case beam:         rc = "beam"; break;
      case origin:       rc = "origin"; break;
      case composite:    rc = "composite";  break;
      case resonance:    rc = "resonance";  break;
      case track:        rc = "track";      break;
      case photon:       rc = "photon";     break;
      case klong:        rc = "klong";     break;
      case kinematic:    rc = "kinematic";  break;
      case geometric:    rc = "geometric";  break;
      case mass:         rc = "mass";       break;
      case massEnergy:   rc = "massEnergy"; break;
      case lifetime:     rc = "lifetime";   break;
      case merged:       rc = "merged";     break;
      case conversion:   rc = "conversion"; break;
      case helix:        rc = "helix";      break;
      case ntypes:
      case unknown:
        break;
    }
    return rc;
  }

◆ nIter()

unsigned int nIter ( ) const

inline

get maximum number of iterations for non in constraint

Definition at line 67 of file Constraint.h.

67{ return m_maxNIter; }

◆ operator<()

bool operator< ( const Constraint & rhs ) const

operator used to sort the constraints

Definition at line 17 of file Constraint.cc.

  {
    return m_depth < rhs.m_depth  ||
           (m_depth == rhs.m_depth && m_type < rhs.m_type);
  }

◆ operator==()

bool operator== ( const Constraint & rhs ) const

inline

operator

Definition at line 52 of file Constraint.h.

    {
      return m_type == rhs.m_type;
    }

◆ project()

ErrCode project	(	const FitParams &	fitpar,
		Projection &	p
	)		const

virtual

call the constraints projection function

Reimplemented in MergedConstraint.

Definition at line 23 of file Constraint.cc.

  {
    return m_node->projectConstraint(m_type, fitpar, p);
  }

◆ setDim()

void setDim ( unsigned int d )

inlineprotected

set dimension of constraint

Definition at line 123 of file Constraint.h.

123{ m_dim = d; }

◆ setNIter()

void setNIter ( unsigned int d )

inlineprotected

set max number of iterations for non lin constraint

Definition at line 126 of file Constraint.h.

126{ m_maxNIter = d; }

◆ setWeight()

void setWeight ( int w )

inline

used to be able to weight the constraints

Definition at line 109 of file Constraint.h.

109{ m_weight = w < 0 ? -1 : 1; }

◆ type()

Type type ( ) const

inline

get type of constraint

Definition at line 58 of file Constraint.h.

58{ return m_type; }

Member Data Documentation

◆ m_depth

int m_depth

private

chi2 coming from the constraint

depth of the constraint in the tree (determines for example the order of the track constraints)

Definition at line 137 of file Constraint.h.

◆ m_dim

unsigned int m_dim

private

dimension of constraint

Definition at line 143 of file Constraint.h.

◆ m_maxNIter

int m_maxNIter

private

maximum number of iterations for non-linear constraints

Definition at line 149 of file Constraint.h.

◆ m_node

const ParticleBase* m_node

private

particle behind the constraint

Definition at line 131 of file Constraint.h.

◆ m_type

Type m_type

private

type of constraint

Definition at line 140 of file Constraint.h.

◆ m_weight

int m_weight

private

weight of this constraint currently we set them all to unity

Definition at line 146 of file Constraint.h.

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

analysis/VertexFitting/TreeFitter/include/Constraint.h
analysis/VertexFitting/TreeFitter/src/Constraint.cc

Public Types

Public Member Functions

Protected Member Functions

Private Attributes

Detailed Description

Member Enumeration Documentation

◆ Type

Constructor & Destructor Documentation

◆ Constraint() [1/3]

◆ Constraint() [2/3]

◆ ~Constraint()

◆ Constraint() [3/3]

Member Function Documentation

◆ dim()

◆ filter()

◆ filterWithReference()

◆ isLinear()

◆ name()

◆ nIter()

◆ operator<()

◆ operator==()

◆ project()

◆ setDim()

◆ setNIter()

◆ setWeight()

◆ type()

Member Data Documentation

◆ m_depth

◆ m_dim

◆ m_maxNIter

◆ m_node

◆ m_type

◆ m_weight