FitParams Class Reference

Class to store and manage fitparams (statevector) More...

#include <FitParams.h>

Collaboration diagram for FitParams:

Public Types
typedef std::vector< std::pair< const ParticleBase *, int > >	indexmap
	index map

Public Member Functions
	FitParams (const int dim)
	Constructor.
	~FitParams ()
	Destructor.
	FitParams (const FitParams &toCopy)
	copy constructor
FitParams &	operator= (const FitParams &other)
	Assignment operator.
Eigen::Matrix< double, -1, -1, 0, MAX_MATRIX_SIZE, MAX_MATRIX_SIZE > &	getCovariance ()
	getter for the states covariance
const Eigen::Matrix< double, -1, -1, 0, MAX_MATRIX_SIZE, MAX_MATRIX_SIZE > &	getCovariance () const
	const getter for the states covariance
Eigen::Matrix< double, -1, 1, 0, MAX_MATRIX_SIZE, 1 > &	getStateVector ()
	getter for the fit parameters/statevector
const Eigen::Matrix< double, -1, 1, 0, MAX_MATRIX_SIZE, 1 > &	getStateVector () const
	const getter for the fit parameters/statevector
void	resetStateVector ()
	reset the statevector
void	resetCovariance ()
	reset the statevector
int	getDimensionOfState () const
	get the states dimension
bool	testCovariance () const
	test if the covariance makes sense
double	chiSquare () const
	get chi2 of statevector
int	nDof () const
	get number of degrees of freedom
void	addChiSquare (double chisq, int nconstraints)
	increment global chi2
void	resetChiSquare ()
	reset chi2

Protected Member Functions
	FitParams ()
	constructor

Private Attributes
int	m_dim
	dimension of statevector
double	m_chiSquare
	chi2
int	m_nConstraints
	number of constraints
int	m_dimensionReduction
	reduce the ndf used in the chi2 by this count
std::vector< int >	m_nConstraintsVec
	vector with the number of constraints per parameter
Eigen::Matrix< double, -1, 1, 0, MAX_MATRIX_SIZE, 1 >	m_globalState
	vector holding all parameters of this fit
Eigen::Matrix< double, -1, -1, 0, MAX_MATRIX_SIZE, MAX_MATRIX_SIZE >	m_globalCovariance
	covariance of the global state

Detailed Description

Class to store and manage fitparams (statevector)

Definition at line 20 of file FitParams.h.

Member Typedef Documentation

indexmap

typedef std::vector< std::pair<const ParticleBase*, int> > indexmap

index map

Definition at line 106 of file FitParams.h.

Constructor & Destructor Documentation

FitParams() [1/3]

FitParams ( const int  dim )

explicit

Constructor.

Definition at line 17 of file FitParams.cc.

    :
    m_dim(dim),
    m_chiSquare(1e10),
    m_nConstraints(0),
    m_dimensionReduction(0),
    m_nConstraintsVec(dim, 0),
    m_globalState(dim),
    m_globalCovariance(dim, dim)
  {
    resetStateVector();
    resetCovariance();
  }

~FitParams()

~FitParams ( )

inline

Destructor.

Definition at line 28 of file FitParams.h.

{};

FitParams() [2/3]

FitParams ( const FitParams &  toCopy )

inline

copy constructor

Definition at line 31 of file FitParams.h.

      : m_dim(toCopy.m_dim),
        m_chiSquare(toCopy.m_chiSquare),
        m_nConstraints(toCopy.m_nConstraints),
        m_dimensionReduction(toCopy.m_dimensionReduction),
        m_globalState(Eigen::Matrix < double, -1, 1, 0, MAX_MATRIX_SIZE, 1 > (toCopy.m_globalState)),
        m_globalCovariance(Eigen::Matrix < double, -1, -1, 0, MAX_MATRIX_SIZE, MAX_MATRIX_SIZE > (toCopy.m_globalCovariance))
    { }

FitParams() [3/3]

FitParams ( )

inlineprotected

constructor

Definition at line 111 of file FitParams.h.

{}

Member Function Documentation

addChiSquare()

void addChiSquare ( double  chisq, int  nconstraints  )

inline

increment global chi2

Definition at line 92 of file FitParams.h.

    {
      m_chiSquare += chisq;
      m_nConstraints += nconstraints;
    }

chiSquare()

double chiSquare ( ) const

inline

get chi2 of statevector

Definition at line 86 of file FitParams.h.

{return m_chiSquare;};

getCovariance() [1/2]

Eigen::Matrix< double, -1, -1, 0, MAX_MATRIX_SIZE, MAX_MATRIX_SIZE > & getCovariance ( )

inline

getter for the states covariance

Definition at line 53 of file FitParams.h.

    {
      return m_globalCovariance;
    }

getCovariance() [2/2]

const Eigen::Matrix< double, -1, -1, 0, MAX_MATRIX_SIZE, MAX_MATRIX_SIZE > & getCovariance ( ) const

inline

const getter for the states covariance

Definition at line 59 of file FitParams.h.

    {
      return m_globalCovariance;
    }

getDimensionOfState()

int getDimensionOfState ( ) const

inline

get the states dimension

Definition at line 80 of file FitParams.h.

{return m_dim;};

getStateVector() [1/2]

Eigen::Matrix< double, -1, 1, 0, MAX_MATRIX_SIZE, 1 > & getStateVector ( )

inline

getter for the fit parameters/statevector

Definition at line 65 of file FitParams.h.

{return m_globalState;}

getStateVector() [2/2]

const Eigen::Matrix< double, -1, 1, 0, MAX_MATRIX_SIZE, 1 > & getStateVector ( ) const

inline

const getter for the fit parameters/statevector

Definition at line 68 of file FitParams.h.

    {
      return m_globalState;
    }

nDof()

int nDof

(

)

const

get number of degrees of freedom

Definition at line 56 of file FitParams.cc.

  {
    const int ndf = m_nConstraints - m_dim;
    if (ndf < 1) {
      const std::string error_string =
        "Not enough constraints for this fit. Try adding a mass or beam constraint. constraints: " + std::to_string(
          m_nConstraints) + " parameters to extract: " + std::to_string(m_dim) + " ndf: " + std::to_string(ndf);
      throw FitParameterDimensionException(error_string);
    }
    return ndf;
  }

operator=()

FitParams & operator= ( const FitParams &  other )

inline

Assignment operator.

Definition at line 41 of file FitParams.h.

    {
      m_dim = other.m_dim;
      m_chiSquare = other.m_chiSquare;
      m_nConstraints = other.m_nConstraints;
      m_dimensionReduction = other.m_dimensionReduction;
      m_globalState = other.m_globalState;
      m_globalCovariance = other.m_globalCovariance;
      return *this;
    }

resetChiSquare()

void resetChiSquare ( )

inline

reset chi2

Definition at line 99 of file FitParams.h.

    {
      m_chiSquare = 0;
      m_nConstraints = 0;
    }

resetCovariance()

void resetCovariance

(

)

reset the statevector

Definition at line 36 of file FitParams.cc.

  {
    m_globalCovariance =
      Eigen::Matrix < double, -1, -1, 0, MAX_MATRIX_SIZE, MAX_MATRIX_SIZE >::Zero(m_dim, m_dim);
 
    std::fill(m_nConstraintsVec.begin(), m_nConstraintsVec.end(), 0);
    m_chiSquare = 0;
    m_nConstraints = 0;
  }

resetStateVector()

void resetStateVector

(

)

reset the statevector

Definition at line 31 of file FitParams.cc.

  {
    m_globalState = Eigen::Matrix<double, Eigen::Dynamic, 1>::Zero(m_dim);
  }

testCovariance()

bool testCovariance

(

)

const

test if the covariance makes sense

Definition at line 46 of file FitParams.cc.

  {
    bool ok = true;
    for (int row = 0; row < m_dim; ++row) {
      ok = (m_globalCovariance(row, row) > 0);
      if (!ok) break;
    }
    return ok;
  }

Member Data Documentation

m_chiSquare

double m_chiSquare

private

chi2

Definition at line 119 of file FitParams.h.

m_dim

int m_dim

private

dimension of statevector

Definition at line 116 of file FitParams.h.

m_dimensionReduction

int m_dimensionReduction

private

reduce the ndf used in the chi2 by this count

Definition at line 125 of file FitParams.h.

m_globalCovariance

Eigen::Matrix< double, -1, -1, 0, MAX_MATRIX_SIZE, MAX_MATRIX_SIZE > m_globalCovariance

private

covariance of the global state

Definition at line 134 of file FitParams.h.

m_globalState

Eigen::Matrix< double, -1, 1, 0, MAX_MATRIX_SIZE, 1 > m_globalState

private

vector holding all parameters of this fit

Definition at line 131 of file FitParams.h.

m_nConstraints

int m_nConstraints

private

number of constraints

Definition at line 122 of file FitParams.h.

m_nConstraintsVec

std::vector<int> m_nConstraintsVec

private

vector with the number of constraints per parameter

Definition at line 128 of file FitParams.h.

---

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

• analysis/VertexFitting/TreeFitter/include/FitParams.h
• analysis/VertexFitting/TreeFitter/src/FitParams.cc