Loading [MathJax]/extensions/tex2jax.js
ATLAS Offline Software
All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Modules Pages
Public Types | Public Member Functions | Static Protected Attributes | Private Attributes | List of all members
MuonCalib::RtChebyshev Class Reference

#include <RtChebyshev.h>

Inheritance diagram for MuonCalib::RtChebyshev:
Collaboration diagram for MuonCalib::RtChebyshev:

Public Types

using ParVec = std::vector< double >
 

Public Member Functions

 RtChebyshev (const ParVec &vec)
 initialization constructor, More...
 
virtual std::string name () const override final
 get the class name More...
 
virtual double radius (double t) const override final
 get the drift velocity More...
 
virtual double driftVelocity (double t) const override final
 get the drift acceleration More...
 
virtual double driftAcceleration (double t) const override final
 Returns the acceleration of the r-t relation. More...
 
virtual double tLower () const override final
 < get the lower drift-time bound More...
 
virtual double tUpper () const override final
 Returns the upper time covered by the r-t. More...
 
virtual double tBinWidth () const override final
 Returns the step-size for the sampling. More...
 
virtual unsigned nDoF () const override final
 get the coefficients of the r(t) polynomial More...
 
std::vector< double > rtParameters () const
 
virtual std::string typeName () const override final
 
double GetTmaxDiff () const
 return the difference in total dirft time between the two multilayers (ML1 - ML2) More...
 
bool hasTmaxDiff () const
 
void SetTmaxDiff (const double d)
 set the difference in total drift time betwene the two multilayers (ML1 - ML2) More...
 
double getReducedTime (const double t) const
 map the in the interval [tLower;tUpper] onto the interval [-1. More...
 
double dReducedTimeDt () const
 
 CalibFunc (const ParVec &vec)
 
unsigned int nPar () const
 
const ParVecparameters () 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 Chebyshev 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 Chebyshev 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 RtChebyshev.h.

Member Typedef Documentation

◆ ParVec

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

Definition at line 35 of file CalibFunc.h.

Constructor & Destructor Documentation

◆ RtChebyshev()

RtChebyshev::RtChebyshev ( 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 Chebyshev polynomial

Definition at line 9 of file RtChebyshev.cxx.

9  :
10  IRtRelation(vec) {
11  // check for consistency //
12  if (nPar() < 3) {
13  THROW_EXCEPTION("RtChebyshev::_init() - Not enough parameters!");
14  }
15  if (tLower() >= tUpper()) {
16  THROW_EXCEPTION("Lower time boundary ("<<tLower()<<")>= upper time ("<<tUpper()<<") boundary!");
17  }
18 } // end RtChebyshev::_init

Member Function Documentation

◆ CalibFunc()

MuonCalib::CalibFunc::CalibFunc
inlineexplicitinherited

Definition at line 36 of file CalibFunc.h.

36  :
37  m_parameters{vec} {}

◆ dReducedTimeDt()

double MuonCalib::IRtRelation::dReducedTimeDt ( ) const
inlineinherited

Definition at line 53 of file IRtRelation.h.

53  {
54  return unitIntervalPrime(tLower(), tUpper());
55  }

◆ driftAcceleration()

double RtChebyshev::driftAcceleration ( double  t) const
finaloverridevirtual

Returns the acceleration of the r-t relation.

Implements MuonCalib::IRtRelation.

Definition at line 62 of file RtChebyshev.cxx.

62  {
63  double acc{0.};
64  // Argument of the Chebyshev polynomials
65  const double x = getReducedTime(t);
66  const double dx_dt = std::pow(dReducedTimeDt(), 2);
67  for (unsigned int k = 2; k < nDoF(); ++k) {
68  acc += par(k+2) * chebyshevPoly1st2Prime(k, x) * dx_dt;
69  }
70  return acc * t;
71 }

◆ driftVelocity()

double RtChebyshev::driftVelocity ( double  t) const
finaloverridevirtual

get the drift acceleration

Implements MuonCalib::IRtRelation.

Definition at line 47 of file RtChebyshev.cxx.

47  {
48  // Set derivative to 0 outside of the bounds
49  if (t < tLower() || t > tUpper()) return 0.0;
50 
51  // Argument of the Chebyshev polynomials
52  const double x = getReducedTime(t);
53  // Chain rule
54  const double dx_dt = dReducedTimeDt();
55  double drdt{0.};
56  for (unsigned int k = 1; k < nDoF(); ++k) {
57  // Calculate the contribution to dr/dt using k * U_{k-1}(x) * dx/dt
58  drdt += par(k+2) * chebyshevPoly1stPrime(k, x) * dx_dt;
59  }
60  return drdt;
61 }

◆ 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.

49  {
50  return mapToUnitInterval(t, tLower(), tUpper());
51  }

◆ 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.

40 { return m_tmax_diff.value_or(0.); }

◆ hasTmaxDiff()

bool MuonCalib::IRtRelation::hasTmaxDiff ( ) const
inlineinherited

Definition at line 42 of file IRtRelation.h.

42 { return m_tmax_diff.has_value(); }

◆ name()

std::string RtChebyshev::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 RtChebyshev.cxx.

20 { return "RtChebyshev"; }

◆ nDoF()

unsigned RtChebyshev::nDoF ( ) const
finaloverridevirtual

get the coefficients of the r(t) polynomial

Implements MuonCalib::IRtRelation.

Definition at line 74 of file RtChebyshev.cxx.

74 { return nPar() -2; }

◆ nPar()

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

Definition at line 39 of file CalibFunc.h.

39 { return m_parameters.size(); }

◆ par()

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

Definition at line 41 of file CalibFunc.h.

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

◆ parameters()

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

Definition at line 40 of file CalibFunc.h.

40 { return m_parameters; }

◆ radius()

double RtChebyshev::radius ( double  t) const
finaloverridevirtual

get the drift velocity

Implements MuonCalib::IRtRelation.

Definition at line 23 of file RtChebyshev.cxx.

23  {
25  // INITIAL TIME CHECK //
27  if (t < tLower()) return 0.0;
28  if (t > tUpper()) return 14.6;
29 
31  // VARIABLES //
33  // argument of the Chebyshev polynomials
34  double x = getReducedTime(t);
35  double rad{0.0}; // auxiliary radius
36 
38  // CALCULATE r(t) //
40  for (unsigned int k = 0; k < nDoF(); k++) {
41  rad += par(k+2) * chebyshevPoly1st(k, x);
42  }
43  return std::max(rad, 0.);
44 }

◆ rtParameters()

std::vector< double > RtChebyshev::rtParameters ( ) const

Definition at line 76 of file RtChebyshev.cxx.

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

◆ 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.

45 { m_tmax_diff = d; }

◆ tBinWidth()

double RtChebyshev::tBinWidth ( ) const
finaloverridevirtual

Returns the step-size for the sampling.

Implements MuonCalib::IRtRelation.

Definition at line 21 of file RtChebyshev.cxx.

21 { return s_tBinWidth; }

◆ tLower()

double RtChebyshev::tLower ( ) const
finaloverridevirtual

< get the lower drift-time bound

get the upper drift-time bound

Implements MuonCalib::IRtRelation.

Definition at line 72 of file RtChebyshev.cxx.

72 { return par(0); }

◆ tUpper()

double RtChebyshev::tUpper ( ) const
finaloverridevirtual

Returns the upper time covered by the r-t.

Implements MuonCalib::IRtRelation.

Definition at line 73 of file RtChebyshev.cxx.

73 { return par(1); }

◆ typeName()

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

Implements MuonCalib::CalibFunc.

Definition at line 23 of file IRtRelation.h.

23 { 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.

◆ s_tBinWidth

constexpr 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:
index
Definition: index.py:1
hist_file_dump.d
d
Definition: hist_file_dump.py:143
max
constexpr double max()
Definition: ap_fixedTest.cxx:33
vec
std::vector< size_t > vec
Definition: CombinationsGeneratorTest.cxx:9
read_hist_ntuple.t
t
Definition: read_hist_ntuple.py:5
x
#define x
MuonCalib::CalibFunc::par
double par(unsigned int index) const
Definition: CalibFunc.h:41
MuonCalib::chebyshevPoly1st2Prime
constexpr double chebyshevPoly1st2Prime(const unsigned int order, const double x)
Returns the second derivative of the n-th Chebycheb polynomial of the first kind.
Definition: ChebychevPoly.h:81
MuonCalib::RtChebyshev::tUpper
virtual double tUpper() const override final
Returns the upper time covered by the r-t.
Definition: RtChebyshev.cxx:73
MuonCalib::unitIntervalPrime
double unitIntervalPrime(const double lowerEdge, const double upperEdge)
Definition: UtilFunc.h:15
AthenaPoolTestRead.acc
acc
Definition: AthenaPoolTestRead.py:16
MuonCalib::IRtRelation::tUpper
virtual double tUpper() const =0
Returns the upper time covered by the r-t.
MuonCalib::chebyshevPoly1st
constexpr double chebyshevPoly1st(const unsigned int order, const double x)
Returns the n-th Chebyshev polynomial of first kind evaluated at x (c.f.
Definition: ChebychevPoly.h:13
MuonCalib::IRtRelation::s_tBinWidth
static constexpr double s_tBinWidth
Definition: IRtRelation.h:60
THROW_EXCEPTION
#define THROW_EXCEPTION(MESSAGE)
Definition: throwExcept.h:10
MuonCalib::IRtRelation::m_tmax_diff
std::optional< double > m_tmax_diff
Definition: IRtRelation.h:58
MuonCalib::IRtRelation::tLower
virtual double tLower() const =0
Returns the lower time covered by the r-t.
DeMoScan.index
string index
Definition: DeMoScan.py:364
MuonCalib::CalibFunc::parameters
const ParVec & parameters() const
Definition: CalibFunc.h:40
MuonCalib::RtChebyshev::nDoF
virtual unsigned nDoF() const override final
get the coefficients of the r(t) polynomial
Definition: RtChebyshev.cxx:74
MuonCalib::IRtRelation::dReducedTimeDt
double dReducedTimeDt() const
Definition: IRtRelation.h:53
MuonCalib::CalibFunc::m_parameters
ParVec m_parameters
Definition: CalibFunc.h:48
MuonCalib::CalibFunc::nPar
unsigned int nPar() const
Definition: CalibFunc.h:39
MuonCalib::mapToUnitInterval
double mapToUnitInterval(const double x, const double lowerEdge, const double upperEdge)
Maps the number x which is in [lowEdge;upperEdge] to the interval [-1;1].
Definition: UtilFunc.h:12
MuonCalib::IRtRelation::getReducedTime
double getReducedTime(const double t) const
map the in the interval [tLower;tUpper] onto the interval [-1.
Definition: IRtRelation.h:49
MuonCalib::chebyshevPoly1stPrime
constexpr double chebyshevPoly1stPrime(const unsigned int order, const double x)
Returns the first derivative of the n-th Chebycheb polynomial of the first kind.
Definition: ChebychevPoly.h:49
pow
constexpr int pow(int base, int exp) noexcept
Definition: ap_fixedTest.cxx:15
MuonCalib::IRtRelation
generic interface for a rt-relation
Definition: IRtRelation.h:19
python.SystemOfUnits.rad
int rad
Definition: SystemOfUnits.py:111
fitman.k
k
Definition: fitman.py:528
MuonCalib::RtChebyshev::tLower
virtual double tLower() const override final
< get the lower drift-time bound
Definition: RtChebyshev.cxx:72