MuonCalib::RtLegendre Class Reference

This class contains the implementation of an r(t) relationship parametrized by a linear combination of Legendre polyonomials. More...

#include <RtLegendre.h>

Inheritance diagram for MuonCalib::RtLegendre:

Collaboration diagram for MuonCalib::RtLegendre:

Public Types
using	ParVec = std::vector<double>

Public Member Functions
	RtLegendre (const ParVec &vec)
	initialization constructor,
virtual std::string	name () const override final
	get the class name
virtual double	radius (double t) const override final
	get the drift velocity
virtual double	driftVelocity (double t) const override final
	get the drift acceleration
virtual double	driftAcceleration (double t) const override final
	Returns the acceleration of the r-t relation.
virtual double	tLower () const override final
	< get the lower drift-time bound
virtual double	tUpper () const override final
	Returns the upper time covered by the r-t.
virtual double	tBinWidth () const override final
	get the number of parameters used to describe the r(t) relationship
unsigned int	numberOfRtParameters () const
	get the coefficients of the r(t) polynomial
std::vector< double >	rtParameters () const
virtual unsigned	nDoF () const override final
	Returns the number of degrees of freedom of the relation function.
virtual std::string	typeName () const override final
double	GetTmaxDiff () const
	return the difference in total dirft time between the two multilayers (ML1 - ML2)
bool	hasTmaxDiff () const
void	SetTmaxDiff (const double d)
	set the difference in total drift time betwene the two multilayers (ML1 - ML2)
double	getReducedTime (const double t) const
	map the in the interval [tLower;tUpper] onto the interval [-1.;1.
double	dReducedTimeDt () const
	CalibFunc (const ParVec &vec)
unsigned int	nPar () const
const ParVec &	parameters () const
double	par (unsigned int index) const

Static Protected Attributes
static constexpr double	s_tBinWidth = 1.e-3

Private Attributes
std::optional< double >	m_tmax_diff {std::nullopt}
ParVec	m_parameters {}

Detailed Description

This class contains the implementation of an r(t) relationship parametrized by a linear combination of Legendre polyonomials.

Convention:

\[ r(t) = \sum_{k=0}^{K} p_k*T_k(2*(t-0.5*(tupper+tlower))/(tupper-tlower) \]

where T_k is the Legendre polynomial of k-th order, tupper and tlower are upper and lower drift-time bounds.

Units: [t] = ns, [r] = mm, [v] = mm/ns.

Definition at line 29 of file RtLegendre.h.

Member Typedef Documentation

ParVec

using MuonCalib::CalibFunc::ParVec = std::vector<double>

inherited

Definition at line 35 of file CalibFunc.h.

Constructor & Destructor Documentation

RtLegendre()

RtLegendre::RtLegendre ( const ParVec & vec )

explicit

initialization constructor,

size of ParVec - 2 = order of the r(t) polynomial,

ParVec[0] = t_low (smallest allowed drift time), ParVec[1] = t_up (largest allowed drift time). ParVec[2...] = parameters of the Legendre polynomial

Definition at line 9 of file RtLegendre.cxx.

                                        : 
    IRtRelation(vec) { 
    // check for consistency //
    if (nPar() < 3) {
        THROW_EXCEPTION("RtLegendre::_init() - Not enough parameters!");
    }
    if (tLower() >= tUpper()) {
        THROW_EXCEPTION("Lower time boundary >= upper time boundary!");
    }
}  // end RtLegendre::_init

Member Function Documentation

CalibFunc()

MuonCalib::CalibFunc::CalibFunc ( const ParVec & vec )

inlineexplicitinherited

Definition at line 36 of file CalibFunc.h.

                                                  : 
                    m_parameters{vec} {}

dReducedTimeDt()

double MuonCalib::IRtRelation::dReducedTimeDt ( ) const

inlineinherited

Definition at line 53 of file IRtRelation.h.

                                      {
            return unitIntervalPrime(tLower(), tUpper());
        }

driftAcceleration()

double RtLegendre::driftAcceleration ( double t ) const

finaloverridevirtual

Returns the acceleration of the r-t relation.

Implements MuonCalib::IRtRelation.

Definition at line 62 of file RtLegendre.cxx.

                                                   {
    double acc{0.};
    // Argument of the Legendre polynomials
    const double x = getReducedTime(t);
    const double dx_dt = std::pow(dReducedTimeDt(), 2);
    for (unsigned int k = 0; k < nDoF(); ++k) {
        acc += par(k+2) * Acts::detail::legendrePoly(x,k, 2) * dx_dt;
    }
    return acc * t;
}

driftVelocity()

double RtLegendre::driftVelocity ( double t ) const

finaloverridevirtual

get the drift acceleration

Implements MuonCalib::IRtRelation.

Definition at line 47 of file RtLegendre.cxx.

                                               { 
    return (radius(t + 1.0) - radius(t));
    // Set derivative to 0 outside of the bounds
    if (t < tLower() || t > tUpper()) return 0.0;
 
    // Argument of the Legendre polynomials
    const double x = getReducedTime(t);
    // Chain rule
    const double dx_dt = dReducedTimeDt();
    double drdt{0.};
    for (unsigned int k = 0; k < nDoF(); ++k) {
        drdt += par(k+2) *  Acts::detail::legendrePoly(x,k, 1) * dx_dt;
    }
    return drdt; 
}

getReducedTime()

double MuonCalib::IRtRelation::getReducedTime ( const double t ) const

inlineinherited

map the in the interval [tLower;tUpper] onto the interval [-1.;1.

] where tLower is mapped to -1. & tUpper to 1.;

Definition at line 49 of file IRtRelation.h.

                                                     {
           return mapToUnitInterval(t, tLower(), tUpper());
        }

GetTmaxDiff()

double MuonCalib::IRtRelation::GetTmaxDiff ( ) const

inlineinherited

return the difference in total dirft time between the two multilayers (ML1 - ML2)

Definition at line 40 of file IRtRelation.h.

{ return m_tmax_diff.value_or(0.); }

hasTmaxDiff()

bool MuonCalib::IRtRelation::hasTmaxDiff ( ) const

inlineinherited

Definition at line 42 of file IRtRelation.h.

{ return m_tmax_diff.has_value(); }

name()

std::string RtLegendre::name ( ) const

finaloverridevirtual

get the class name

get the radius corresponding to the drift time t; if t is not within [t_low, t_up] an unphysical radius of 99999 is returned

Implements MuonCalib::CalibFunc.

Definition at line 20 of file RtLegendre.cxx.

{ return "RtLegendre"; }

nDoF()

unsigned int RtLegendre::nDoF ( ) const

finaloverridevirtual

Returns the number of degrees of freedom of the relation function.

Implements MuonCalib::IRtRelation.

Definition at line 74 of file RtLegendre.cxx.

{ return nPar() -2; }

nPar()

unsigned int MuonCalib::CalibFunc::nPar ( ) const

inlineinherited

Definition at line 39 of file CalibFunc.h.

{ return m_parameters.size(); }

numberOfRtParameters()

unsigned int MuonCalib::RtLegendre::numberOfRtParameters

(

)

const

get the coefficients of the r(t) polynomial

par()

double MuonCalib::CalibFunc::par ( unsigned int index ) const

inlineinherited

Definition at line 41 of file CalibFunc.h.

                                                 {
                return index < nPar() ? m_parameters[index] : 0.;
            }

parameters()

const ParVec & MuonCalib::CalibFunc::parameters ( ) const

inlineinherited

Definition at line 40 of file CalibFunc.h.

{ return m_parameters; }

radius()

double RtLegendre::radius ( double t ) const

finaloverridevirtual

get the drift velocity

Implements MuonCalib::IRtRelation.

Definition at line 23 of file RtLegendre.cxx.

                                        {
    // INITIAL TIME CHECK //
    if (t < tLower()) return 0.0;
    if (t > tUpper()) return 14.6;
 
    // VARIABLES //
    // argument of the Legendre polynomials
    double x = getReducedTime(t);
    double rad{0.0};  // auxiliary radius

    // CALCULATE r(t) //
    for (unsigned int k = 0; k < nDoF(); k++) { 
        rad += par(k+2) * Acts::detail::legendrePoly(x,k); 
    }
    return std::max(rad, 0.);
}

rtParameters()

std::vector< double > RtLegendre::rtParameters

(

)

const

Definition at line 76 of file RtLegendre.cxx.

                                                 {
    return std::vector<double>{parameters().begin() +2, parameters().end()};
}

SetTmaxDiff()

void MuonCalib::IRtRelation::SetTmaxDiff ( const double d )

inlineinherited

set the difference in total drift time betwene the two multilayers (ML1 - ML2)

Definition at line 45 of file IRtRelation.h.

{ m_tmax_diff = d; }

tBinWidth()

double RtLegendre::tBinWidth ( ) const

finaloverridevirtual

get the number of parameters used to describe the r(t) relationship

Implements MuonCalib::IRtRelation.

Definition at line 21 of file RtLegendre.cxx.

{ return s_tBinWidth; }

tLower()

double RtLegendre::tLower ( ) const

finaloverridevirtual

< get the lower drift-time bound

get the upper drift-time bound

Implements MuonCalib::IRtRelation.

Definition at line 72 of file RtLegendre.cxx.

{ return par(0); }

tUpper()

double RtLegendre::tUpper ( ) const

finaloverridevirtual

Returns the upper time covered by the r-t.

Implements MuonCalib::IRtRelation.

Definition at line 73 of file RtLegendre.cxx.

{ return par(1); }

typeName()

virtual std::string MuonCalib::IRtRelation::typeName ( ) const

inlinefinaloverridevirtualinherited

Implements MuonCalib::CalibFunc.

Definition at line 23 of file IRtRelation.h.

{ return "IRtRelation"; }

Member Data Documentation

m_parameters

ParVec MuonCalib::CalibFunc::m_parameters {}

privateinherited

Definition at line 48 of file CalibFunc.h.

{};

m_tmax_diff

std::optional<double> MuonCalib::IRtRelation::m_tmax_diff {std::nullopt}

privateinherited

Definition at line 58 of file IRtRelation.h.

{std::nullopt};

s_tBinWidth

double MuonCalib::IRtRelation::s_tBinWidth = 1.e-3

staticconstexprprotectedinherited

Definition at line 60 of file IRtRelation.h.

---

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

• RtLegendre.h
• RtLegendre.cxx