SZUtil Struct Reference

Utility struct for functions and types related to the sz plane parameters. More...

#include <SZParameters.h>

Inheritance diagram for SZUtil:

Public Types
using	EParamaters = ESZParameter
	Indices of the parameters.
using	ParameterVector = TrackFindingCDC::ParameterVector< c_N >
	The vector type representing the n related parameters.
using	CovarianceMatrix = TrackFindingCDC::CovarianceMatrix< c_N >
	The matrix type representing the covariance of the n related parameters.
using	PrecisionMatrix = TrackFindingCDC::PrecisionMatrix< c_N >
	The matrix type representing the precision of the n related parameters.
using	JacobianMatrix = TrackFindingCDC::JacobianMatrix< c_N >
	The matrix type used to translate covariances and precisions im auto mapping of the parameter space.

Static Public Member Functions
static ParameterVector	reversalSigns ()
	Getter for the signs which have to be applied to reverse the parameters.
static void	transport (const JacobianMatrix &jacobian, CovarianceMatrix &cov)
	Transport the covariance matrix inplace with the given jacobian matrix.
static CovarianceMatrix	transported (const JacobianMatrix &jacobian, const CovarianceMatrix &cov)
	Return a copy of the covariance matrix transported with the given jacobian matrix.
static JacobianMatrix	reversalJacobian ()
	Jacobian matrix needed in the reversal operation of the parameter vector.
static void	reverse (CovarianceMatrix &cov)
	Reverse the covariance matrix inplace.
static CovarianceMatrix	reversed (const CovarianceMatrix &cov)
	Return a copy of the reversed covariance matrix.
static CovarianceMatrix	identity ()
	Returns an identity matrix.
static CovarianceMatrix	covarianceFromPrecision (const PrecisionMatrix &prec)
	Convert the precision matrix to the corresponding covariance matrix.
static PrecisionMatrix	precisionFromCovariance (const CovarianceMatrix &cov)
	Convert the covariance matrix to the corresponding precision matrix.
static CovarianceMatrix	covarianceFromFullPrecision (const PrecisionMatrix &prec)
	Convert the precision matrix to the corresponding covariance matrix.
static PrecisionMatrix	precisionFromFullCovariance (const CovarianceMatrix &cov)
	Convert the covariance matrix to the corresponding precision matrix.
static AParameterVector	getSubParameterVector (const ParameterVector &par)
	Getter for a sub part of the covariance matrix.
static ACovarianceMatrix	getSubCovarianceMatrix (const CovarianceMatrix &cov)
	Getter for a sub part of the covariance matrix.

Static Public Attributes
static const size_t	c_N
	Number of elements.

Detailed Description

Utility struct for functions and types related to the sz plane parameters.

Definition at line 44 of file SZParameters.h.

Member Typedef Documentation

CovarianceMatrix

using CovarianceMatrix = TrackFindingCDC::CovarianceMatrix<c_N>

inherited

The matrix type representing the covariance of the n related parameters.

Definition at line 36 of file UncertainParameters.h.

EParamaters

using EParamaters = ESZParameter

inherited

Indices of the parameters.

Definition at line 27 of file UncertainParameters.h.

JacobianMatrix

using JacobianMatrix = TrackFindingCDC::JacobianMatrix<c_N>

inherited

The matrix type used to translate covariances and precisions im auto mapping of the parameter space.

Definition at line 42 of file UncertainParameters.h.

ParameterVector

using ParameterVector = TrackFindingCDC::ParameterVector<c_N>

inherited

The vector type representing the n related parameters.

Definition at line 33 of file UncertainParameters.h.

PrecisionMatrix

using PrecisionMatrix = TrackFindingCDC::PrecisionMatrix<c_N>

inherited

The matrix type representing the precision of the n related parameters.

Definition at line 39 of file UncertainParameters.h.

Member Function Documentation

covarianceFromFullPrecision()

auto covarianceFromFullPrecision ( const PrecisionMatrix &  prec )

staticinherited

Convert the precision matrix to the corresponding covariance matrix.

Faster version with foreknowledge that the precision is of full rank.

Definition at line 73 of file UncertainParameters.icc.h.

                        {
      return CovarianceMatrixUtil::fromFullPrecision(prec);
    }

covarianceFromPrecision()

auto covarianceFromPrecision ( const PrecisionMatrix &  prec )

staticinherited

Convert the precision matrix to the corresponding covariance matrix.

Definition at line 64 of file UncertainParameters.icc.h.

                        {
      return CovarianceMatrixUtil::fromPrecision(prec);
    }

getSubCovarianceMatrix()

ACovarianceMatrix getSubCovarianceMatrix ( const CovarianceMatrix &  cov )

staticinherited

Getter for a sub part of the covariance matrix.

Definition at line 87 of file UncertainParameters.icc.h.

    {
      return CovarianceMatrixUtil::getSub<ACovarianceMatrix, I>(cov);
    }

getSubParameterVector()

AParameterVector getSubParameterVector ( const ParameterVector &  par )

staticinherited

Getter for a sub part of the covariance matrix.

Definition at line 83 of file UncertainParameters.icc.h.

    {
      return ParameterVectorUtil::getSub<AParameterVector, I>(par);
    }

identity()

auto identity

staticinherited

Returns an identity matrix.

Definition at line 61 of file UncertainParameters.icc.h.

                                                                                {
      return CovarianceMatrixUtil::identity<c_N>();
    }

precisionFromCovariance()

auto precisionFromCovariance ( const CovarianceMatrix &  cov )

staticinherited

Convert the covariance matrix to the corresponding precision matrix.

Definition at line 67 of file UncertainParameters.icc.h.

                       {
      return CovarianceMatrixUtil::toPrecision(cov);
    }

precisionFromFullCovariance()

auto precisionFromFullCovariance ( const CovarianceMatrix &  cov )

staticinherited

Convert the covariance matrix to the corresponding precision matrix.

Faster version with foreknowledge that the precision is of full rank.

Definition at line 79 of file UncertainParameters.icc.h.

                       {
      return CovarianceMatrixUtil::fullToPrecision(cov);
    }

reversalJacobian()

auto reversalJacobian

staticinherited

Jacobian matrix needed in the reversal operation of the parameter vector.

Definition at line 52 of file UncertainParameters.icc.h.

                                                                                      {
      return JacobianMatrixUtil::scale(T::reversalSigns());
    }

reversalSigns()

static ParameterVector reversalSigns ( )

inlinestatic

Getter for the signs which have to be applied to reverse the parameters.

Definition at line 47 of file SZParameters.h.

      {
        return  ParameterVector({ -1.0, 1.0});
      }

reverse()

void reverse ( CovarianceMatrix &  cov )

staticinherited

Reverse the covariance matrix inplace.

Definition at line 55 of file UncertainParameters.icc.h.

    {
      return transport(reversalJacobian(), cov);
    }

reversed()

auto reversed ( const CovarianceMatrix &  cov )

staticinherited

Return a copy of the reversed covariance matrix.

Definition at line 58 of file UncertainParameters.icc.h.

                        {
      return transported(reversalJacobian(), cov);
    }

transport()

void transport ( const JacobianMatrix &  jacobian, CovarianceMatrix &  cov  )

staticinherited

Transport the covariance matrix inplace with the given jacobian matrix.

Definition at line 45 of file UncertainParameters.icc.h.

    {
      CovarianceMatrixUtil::transport(jacobian, cov);
    }

transported()

auto transported ( const JacobianMatrix &  jacobian, const CovarianceMatrix &  cov  )

staticinherited

Return a copy of the covariance matrix transported with the given jacobian matrix.

Definition at line 48 of file UncertainParameters.icc.h.

                        {
      return CovarianceMatrixUtil::transported(jacobian, cov);
    }

Member Data Documentation

c_N

const size_t c_N

staticinherited

Number of elements.

Definition at line 30 of file UncertainParameters.h.

---

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

• tracking/trackFindingCDC/geometry/include/SZParameters.h