CbmRoot
Loading...
Searching...
No Matches
cbm::algo::kf::MeasurementU< DataT > Class Template Reference

The class describes a 1D - measurement U in XY coordinate system. More...

#include <KfMeasurementU.h>

Public Member Functions

 MeasurementU ()=default
 default constructor
 
 MeasurementU (DataT cosPhi, DataT sinPhi, DataT u, DataT du2, DataT ndf)
 
void SetCosPhi (DataT cosPhi)
 
void SetSinPhi (DataT sinPhi)
 
void SetU (DataT u)
 
void SetDu2 (DataT du2)
 
void SetNdf (DataT ndf)
 
DataT CosPhi () const
 
DataT SinPhi () const
 
DataT U () const
 
DataT Du2 () const
 
DataT Ndf () const
 
std::string ToString (int indentLevel=0) const
 
bool IsFinite () const
 Checks, if all fields are finite.
 
bool IsUndefined () const
 Checks, if some fields are undefined.
 
template<class Archive >
void serialize (Archive &ar, const unsigned int)
 

Private Attributes

DataT fCosPhi = defs::Undef<DataT>
 cos(phi)
 
DataT fSinPhi = defs::Undef<DataT>
 sin(phi)
 
DataT fU = defs::Undef<DataT>
 measurement, u = x * cos(phi) + y * sin(phi)
 
DataT fDu2 = defs::Undef<DataT>
 rms^2 of the measurement
 
DataT fNdf = defs::Undef<DataT>
 number of degrees of freedom (used for chi2 calculation) if ndf == 1, the measurement is used in the chi2 calculation if ndf == 0, the measurement is not used in the chi2 calculation
 

Friends

class boost::serialization::access
 Serialization function.
 

Detailed Description

template<typename DataT>
class cbm::algo::kf::MeasurementU< DataT >

The class describes a 1D - measurement U in XY coordinate system.

The measurement is defined as

u = x * cos(phi) + y * sin(phi)

where phi is the azimuthal angle of the measurement direction and x, y are the coordinates of the measurement The measurement may be scaled, i.e. cos^2 + sin^2 must not necessarily be equal to 1 The measurement has a finite resolution, i.e. the measurement is not a point, but a distribution with a certain rms. The measurement may be used in the chi2 calculation or not The measurement may be a SIMD vector of values, when DataT is fvec type

Definition at line 35 of file KfMeasurementU.h.

Constructor & Destructor Documentation

◆ MeasurementU() [1/2]

template<typename DataT >
cbm::algo::kf::MeasurementU< DataT >::MeasurementU ( )
default

default constructor

◆ MeasurementU() [2/2]

template<typename DataT >
cbm::algo::kf::MeasurementU< DataT >::MeasurementU ( DataT cosPhi,
DataT sinPhi,
DataT u,
DataT du2,
DataT ndf )
inline

constructor

Parameters
cosPhicos(phi)
sinPhisin(phi)
umeasurement, u = x * cos(phi) + y * sin(phi)
du2rms^2 of the measurement
ndfnumber of degrees of freedom (used for chi2 calculation) if ndf == 1, the measurement is used in the chi2 calculation if ndf == 0, the measurement is not used in the chi2 calculation

Definition at line 51 of file KfMeasurementU.h.

Member Function Documentation

◆ CosPhi()

template<typename DataT >
DataT cbm::algo::kf::MeasurementU< DataT >::CosPhi ( ) const
inline

Definition at line 69 of file KfMeasurementU.h.

◆ Du2()

template<typename DataT >
DataT cbm::algo::kf::MeasurementU< DataT >::Du2 ( ) const
inline

Definition at line 72 of file KfMeasurementU.h.

◆ IsFinite()

template<typename DataT >
bool cbm::algo::kf::MeasurementU< DataT >::IsFinite ( ) const
inline

Checks, if all fields are finite.

Definition at line 83 of file KfMeasurementU.h.

◆ IsUndefined()

template<typename DataT >
bool cbm::algo::kf::MeasurementU< DataT >::IsUndefined ( ) const
inline

Checks, if some fields are undefined.

Definition at line 90 of file KfMeasurementU.h.

◆ Ndf()

template<typename DataT >
DataT cbm::algo::kf::MeasurementU< DataT >::Ndf ( ) const
inline

Definition at line 73 of file KfMeasurementU.h.

◆ serialize()

template<typename DataT >
template<class Archive >
void cbm::algo::kf::MeasurementU< DataT >::serialize ( Archive & ar,
const unsigned int  )
inline

Definition at line 99 of file KfMeasurementU.h.

◆ SetCosPhi()

template<typename DataT >
void cbm::algo::kf::MeasurementU< DataT >::SetCosPhi ( DataT cosPhi)
inline

Setters and getters

Definition at line 63 of file KfMeasurementU.h.

Referenced by cbm::algo::kf::TrackKalmanFilter< DataT >::FilterXY().

◆ SetDu2()

template<typename DataT >
void cbm::algo::kf::MeasurementU< DataT >::SetDu2 ( DataT du2)
inline

Definition at line 66 of file KfMeasurementU.h.

◆ SetNdf()

template<typename DataT >
void cbm::algo::kf::MeasurementU< DataT >::SetNdf ( DataT ndf)
inline

Definition at line 67 of file KfMeasurementU.h.

◆ SetSinPhi()

template<typename DataT >
void cbm::algo::kf::MeasurementU< DataT >::SetSinPhi ( DataT sinPhi)
inline

◆ SetU()

template<typename DataT >
void cbm::algo::kf::MeasurementU< DataT >::SetU ( DataT u)
inline

◆ SinPhi()

template<typename DataT >
DataT cbm::algo::kf::MeasurementU< DataT >::SinPhi ( ) const
inline

Definition at line 70 of file KfMeasurementU.h.

◆ ToString()

template<typename DataT >
std::string cbm::algo::kf::MeasurementU< DataT >::ToString ( int indentLevel = 0) const

Methods for debugging String representation of class contents

Parameters
indentLevelnumber of indent characters in the output

Definition at line 19 of file KfMeasurementU.cxx.

◆ U()

template<typename DataT >
DataT cbm::algo::kf::MeasurementU< DataT >::U ( ) const
inline

Definition at line 71 of file KfMeasurementU.h.

Friends And Related Symbol Documentation

◆ boost::serialization::access

template<typename DataT >
boost::serialization::access
friend

Serialization function.

Definition at line 38 of file KfMeasurementU.h.

Member Data Documentation

◆ fCosPhi

template<typename DataT >
DataT cbm::algo::kf::MeasurementU< DataT >::fCosPhi = defs::Undef<DataT>
private

cos(phi)


Data members

Definition at line 112 of file KfMeasurementU.h.

◆ fDu2

template<typename DataT >
DataT cbm::algo::kf::MeasurementU< DataT >::fDu2 = defs::Undef<DataT>
private

rms^2 of the measurement

Definition at line 115 of file KfMeasurementU.h.

◆ fNdf

template<typename DataT >
DataT cbm::algo::kf::MeasurementU< DataT >::fNdf = defs::Undef<DataT>
private

number of degrees of freedom (used for chi2 calculation) if ndf == 1, the measurement is used in the chi2 calculation if ndf == 0, the measurement is not used in the chi2 calculation

Definition at line 120 of file KfMeasurementU.h.

◆ fSinPhi

template<typename DataT >
DataT cbm::algo::kf::MeasurementU< DataT >::fSinPhi = defs::Undef<DataT>
private

sin(phi)

Definition at line 113 of file KfMeasurementU.h.

◆ fU

template<typename DataT >
DataT cbm::algo::kf::MeasurementU< DataT >::fU = defs::Undef<DataT>
private

measurement, u = x * cos(phi) + y * sin(phi)

Definition at line 114 of file KfMeasurementU.h.


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