ATLAS Offline Software
Loading...
Searching...
No Matches
MuonCalib::TrLegendre Class Reference

#include <TrLegendre.h>

Inheritance diagram for MuonCalib::TrLegendre:
Collaboration diagram for MuonCalib::TrLegendre:

Public Types

using ParVec = std::vector<double>

Public Member Functions

 TrLegendre (const ParVec &vec)
virtual std::string name () const override final
virtual std::optional< double > driftTime (const double r) const override final
 Interface method for fetching the drift-time from the radius Returns a nullopt if the time is out of the boundaries.
virtual std::optional< double > driftTimePrime (const double r) const override final
virtual std::optional< double > driftTime2Prime (const double r) const override final
virtual double minRadius () const override final
 Returns the minimum drift-radius.
virtual double maxRadius () const override final
 Returns the maximum drift-radius.
virtual unsigned nDoF () const override final
 Returns the number of degrees of freedom of the tr relation.
virtual std::string typeName () const override final
double getReducedR (const double r) const
 Maps the radius interval [minRadius;maxRadius] to [-1;1] where the minimal radius is on the lower end.
double getReducedRPrime () const
 Returns the derivative of the reduced radisu w.r.t r.
unsigned int nPar () const
const ParVecparameters () const
double par (unsigned int index) const

Private Attributes

ParVec m_parameters {}

Detailed Description

Definition at line 11 of file TrLegendre.h.

Member Typedef Documentation

◆ ParVec

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

Definition at line 35 of file CalibFunc.h.

Constructor & Destructor Documentation

◆ TrLegendre()

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

Definition at line 10 of file TrLegendre.cxx.

10 : ITrRelation{vec} {
11 if (minRadius() >= maxRadius()) {
12 THROW_EXCEPTION("Minimum radius greater than maximum radius!");
13 }
14 }
std::vector< size_t > vec
ITrRelation(const ParVec &parameters)
Constructor taking the input r-t relation & the vector of parameters.
Definition ITrRelation.h:20
virtual double maxRadius() const override final
Returns the maximum drift-radius.
virtual double minRadius() const override final
Returns the minimum drift-radius.
#define THROW_EXCEPTION(MESSAGE)
Definition throwExcept.h:10

Member Function Documentation

◆ driftTime()

std::optional< double > MuonCalib::TrLegendre::driftTime ( const double r) const
finaloverridevirtual

Interface method for fetching the drift-time from the radius Returns a nullopt if the time is out of the boundaries.

Implements MuonCalib::ITrRelation.

Definition at line 17 of file TrLegendre.cxx.

17 {
18 if (r < minRadius() || r > maxRadius()) return std::nullopt;
19 const double reducedR = getReducedR(r);
20 double time{0.};
21 for (unsigned int k = 0; k < nDoF(); ++k) {
22 time += par(k+2) * legendrePoly(k, reducedR);
23 }
24 return std::make_optional(time);
25
26
27 }
double par(unsigned int index) const
Definition CalibFunc.h:41
double getReducedR(const double r) const
Maps the radius interval [minRadius;maxRadius] to [-1;1] where the minimal radius is on the lower end...
Definition ITrRelation.h:42
virtual unsigned nDoF() const override final
Returns the number of degrees of freedom of the tr relation.
int r
Definition globals.cxx:22
time(flags, cells_name, *args, **kw)
constexpr double legendrePoly(const unsigned l, const double x)
Calculates the legendre polynomial of rank l at x.

◆ driftTime2Prime()

std::optional< double > MuonCalib::TrLegendre::driftTime2Prime ( const double r) const
finaloverridevirtual

Implements MuonCalib::ITrRelation.

Definition at line 39 of file TrLegendre.cxx.

39 {
40 if (r < minRadius() || r > maxRadius()) return std::nullopt;
41 const double reducedR = getReducedR(r);
42 const double dt_dr = std::pow(getReducedRPrime(), 2);
43 double d2tdr2{0.};
44 for (unsigned int k = 2; k < nDoF(); ++k) {
45 d2tdr2 += par(k+2) * legendreDeriv(k, 2, reducedR) * dt_dr;
46 }
47 return std::make_optional(d2tdr2);
48 }
double getReducedRPrime() const
Returns the derivative of the reduced radisu w.r.t r.
Definition ITrRelation.h:46
constexpr double legendreDeriv(const unsigned l, const unsigned d, const double x)
Evaluates the n-th derivative of the l-th Legendre polynomial.

◆ driftTimePrime()

std::optional< double > MuonCalib::TrLegendre::driftTimePrime ( const double r) const
finaloverridevirtual

Implements MuonCalib::ITrRelation.

Definition at line 28 of file TrLegendre.cxx.

28 {
29 if (r < minRadius() || r > maxRadius()) return std::nullopt;
30 const double reducedR = getReducedR(r);
31 const double dt_dr = getReducedRPrime();
32 double dtdr{0.};
33 for (unsigned int k = 1; k < nDoF(); ++k) {
34 dtdr += par(k+2) * legendreDeriv(k, 1, reducedR) * dt_dr;
35 }
36 return std::make_optional(dtdr);
37
38 }

◆ getReducedR()

double MuonCalib::ITrRelation::getReducedR ( const double r) const
inlineinherited

Maps the radius interval [minRadius;maxRadius] to [-1;1] where the minimal radius is on the lower end.

Definition at line 42 of file ITrRelation.h.

42 {
44 }
virtual double maxRadius() const =0
Returns the maximum drift-radius.
virtual double minRadius() const =0
Returns the minimum drift-radius.
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

◆ getReducedRPrime()

double MuonCalib::ITrRelation::getReducedRPrime ( ) const
inlineinherited

Returns the derivative of the reduced radisu w.r.t r.

Definition at line 46 of file ITrRelation.h.

46 {
48 }
double unitIntervalPrime(const double lowerEdge, const double upperEdge)
Definition UtilFunc.h:15

◆ maxRadius()

double MuonCalib::TrLegendre::maxRadius ( ) const
finaloverridevirtual

Returns the maximum drift-radius.

Implements MuonCalib::ITrRelation.

Definition at line 50 of file TrLegendre.cxx.

50{ return par(1); }

◆ minRadius()

double MuonCalib::TrLegendre::minRadius ( ) const
finaloverridevirtual

Returns the minimum drift-radius.

Implements MuonCalib::ITrRelation.

Definition at line 49 of file TrLegendre.cxx.

49{ return par(0); }

◆ name()

std::string MuonCalib::TrLegendre::name ( ) const
finaloverridevirtual

Implements MuonCalib::CalibFunc.

Definition at line 15 of file TrLegendre.cxx.

15{ return "TrLegendre"; }

◆ nDoF()

unsigned MuonCalib::TrLegendre::nDoF ( ) const
finaloverridevirtual

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

Implements MuonCalib::ITrRelation.

Definition at line 51 of file TrLegendre.cxx.

51{ return nPar() -2; }
unsigned int nPar() const
Definition CalibFunc.h:39

◆ 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 }
str index
Definition DeMoScan.py:362

◆ parameters()

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

Definition at line 40 of file CalibFunc.h.

40{ return m_parameters; }

◆ typeName()

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

Implements MuonCalib::CalibFunc.

Definition at line 24 of file ITrRelation.h.

24{ return "ITrRelation"; }

Member Data Documentation

◆ m_parameters

ParVec MuonCalib::CalibFunc::m_parameters {}
privateinherited

Definition at line 48 of file CalibFunc.h.

48{};

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