Belle II Software  release-08-01-10
UncertainSZLine Class Reference

A line in sz where s is the transverse travel distance as seen in the xy projection with uncertainties in the slope and intercept of the line. More...

#include <UncertainSZLine.h>

Collaboration diagram for UncertainSZLine:

Public Member Functions

 UncertainSZLine ()
 Default constructor for ROOT compatibility.
 
 UncertainSZLine (const double tanLambda, const double z0, const SZCovariance &szCovariance=SZUtil::identity(), const double chi2=0.0, const size_t ndf=0)
 Composes an uncertain sz line from the perigee parameters and a 2x2 covariance matrix. More...
 
 UncertainSZLine (const SZParameters szParameters, const SZCovariance &szCovariance=SZUtil::identity(), const double chi2=0.0, const size_t ndf=0)
 Composes an uncertain sz line from the perigee parameters and a 2x2 covariance matrix. More...
 
 UncertainSZLine (const SZLine &szLine, const SZCovariance &szCovariance=SZUtil::identity(), const double chi2=0.0, const size_t ndf=0)
 Augments a plain two dimensional line with a covariance matrix. More...
 
const SZLineoperator-> () const
 Access to the constant interface of the underlying parameter line Allows the user of this "super" class to use the getters and other methods to get inforamation about the line but disallows mutation of internal state. More...
 
 operator const SZLine & () const
 Downcast to the "super" class.
 
const SZLineszLine () const
 Getter for the underlying sz line.
 
SZParameters szParameters () const
 Getter for the sz parameters in the order defined by ESZParameter.h.
 
void setSZCovariance (const SZCovariance &szCovariance)
 Setter for the whole covariance matrix of the sz line parameters.
 
const SZCovarianceszCovariance () const
 Getter for the whole covariance matrix of the sz line parameters.
 
double covariance (const ESZParameter &iRow, const ESZParameter &iCol) const
 Getter for individual elements of the covariance matrix.
 
double variance (const ESZParameter &i) const
 Getter for individual diagonal elements of the covariance matrix.
 
double chi2 () const
 Getter for the chi square value of the line fit.
 
void setChi2 (const double chi2)
 Setter for the chi square value of the line fit.
 
std::size_t ndf () const
 Getter for the number of degrees of freediom used in the line fit.
 
void setNDF (std::size_t ndf)
 Setter for the number of degrees of freediom used in the line fit.
 
void invalidate ()
 Sets all line parameters to zero including the covariance matrix.
 
void reverse ()
 Reverses the direction of flight represented by this sz line.
 
UncertainSZLine reversed () const
 Returns a copy of the line corresponding to the reverse direction of travel.
 
void passiveMoveBy (const Vector2D &bySZ)
 Moves the coordinate system by the vector by and calculates the new sz line and its covariance matrix. More...
 
SZCovariance passiveMovedCovarianceBy (const Vector2D &bySZ) const
 Calculates the jacobian matrix that is needed for the translation of the parameter covariance for a passive move of the coordinate system.
 

Private Attributes

SZLine m_szLine
 Memory for the underlying line.
 
SZCovariance m_szCovariance = SZUtil::identity()
 Memory for the 2x2 covariance matrix of sz slope (aka tan lambda) and z0.
 
double m_chi2 = 0.0
 Memory for the chi square value of the fit of this line.
 
size_t m_ndf = 0
 Memory for the number of degrees of freedim of the fit of this line.
 

Detailed Description

A line in sz where s is the transverse travel distance as seen in the xy projection with uncertainties in the slope and intercept of the line.

Definition at line 28 of file UncertainSZLine.h.

Constructor & Destructor Documentation

◆ UncertainSZLine() [1/3]

UncertainSZLine ( const double  tanLambda,
const double  z0,
const SZCovariance szCovariance = SZUtil::identity(),
const double  chi2 = 0.0,
const size_t  ndf = 0 
)
inline

Composes an uncertain sz line from the perigee parameters and a 2x2 covariance matrix.

Covariance matrix defaults to a zero matrix.

Definition at line 38 of file UncertainSZLine.h.

43  : m_szLine(tanLambda, z0)
45  , m_chi2(chi2)
46  , m_ndf(ndf)
47  {
48  }
SZCovariance m_szCovariance
Memory for the 2x2 covariance matrix of sz slope (aka tan lambda) and z0.
double m_chi2
Memory for the chi square value of the fit of this line.
double chi2() const
Getter for the chi square value of the line fit.
size_t m_ndf
Memory for the number of degrees of freedim of the fit of this line.
SZLine m_szLine
Memory for the underlying line.
std::size_t ndf() const
Getter for the number of degrees of freediom used in the line fit.
const SZCovariance & szCovariance() const
Getter for the whole covariance matrix of the sz line parameters.

◆ UncertainSZLine() [2/3]

UncertainSZLine ( const SZParameters  szParameters,
const SZCovariance szCovariance = SZUtil::identity(),
const double  chi2 = 0.0,
const size_t  ndf = 0 
)
inlineexplicit

Composes an uncertain sz line from the perigee parameters and a 2x2 covariance matrix.

Covariance matrix defaults to a zero matrix.

Definition at line 52 of file UncertainSZLine.h.

◆ UncertainSZLine() [3/3]

UncertainSZLine ( const SZLine szLine,
const SZCovariance szCovariance = SZUtil::identity(),
const double  chi2 = 0.0,
const size_t  ndf = 0 
)
inlineexplicit

Augments a plain two dimensional line with a covariance matrix.

Covariance defaults to zero.

Definition at line 65 of file UncertainSZLine.h.

Member Function Documentation

◆ operator->()

const SZLine* operator-> ( ) const
inline

Access to the constant interface of the underlying parameter line Allows the user of this "super" class to use the getters and other methods to get inforamation about the line but disallows mutation of internal state.

This ensures that the parameters are not changed without proper adjustment to the covariance matrix in this class, which can be achieved by the more limited set of methods in this class accessable by normal . method calls

Definition at line 85 of file UncertainSZLine.h.

◆ passiveMoveBy()

void passiveMoveBy ( const Vector2D bySZ)
inline

Moves the coordinate system by the vector by and calculates the new sz line and its covariance matrix.

Change is inplace.

Definition at line 183 of file UncertainSZLine.h.


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