MuonCalib::IMdtBFieldCorFunc Class Reference

generic interface for b-field correction functions More...

#include <IMdtBFieldCorFunc.h>

Inheritance diagram for MuonCalib::IMdtBFieldCorFunc:

Collaboration diagram for MuonCalib::IMdtBFieldCorFunc:

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

Public Member Functions
	IMdtBFieldCorFunc (const CalibFunc::ParVec &vec)
virtual	~IMdtBFieldCorFunc ()=default
virtual std::string	typeName () const
virtual double	correction (double t, double Bpar, double Bperp) const =0
	Return time correction (ns). More...
unsigned int	nPar () const
const ParVec &	parameters () const
double	par (unsigned int index) const
virtual std::string	name () const =0

Private Attributes
ParVec	m_parameters {}

Detailed Description

generic interface for b-field correction functions

Definition at line 14 of file IMdtBFieldCorFunc.h.

Member Typedef Documentation

ParVec

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

inherited

Definition at line 35 of file CalibFunc.h.

Constructor & Destructor Documentation

IMdtBFieldCorFunc()

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

inlineexplicit

Definition at line 16 of file IMdtBFieldCorFunc.h.

: CalibFunc(vec){};

~IMdtBFieldCorFunc()

virtual MuonCalib::IMdtBFieldCorFunc::~IMdtBFieldCorFunc ( )

virtualdefault

Member Function Documentation

correction()

virtual double MuonCalib::IMdtBFieldCorFunc::correction ( double  t, double  Bpar, double  Bperp  ) const

pure virtual

Return time correction (ns).

Input: t = drift-time (ns), Bpar = magnetic field parallel to wire (Tesla), Bperp = magnetic field perpendicular to wire and parallel to track.

Implemented in MuonCalib::BFieldCorFunc.

name()

virtual std::string MuonCalib::CalibFunc::name ( ) const

pure virtualinherited

Implemented in MuonCalib::RtSpline, MuonCalib::RtChebyshev, MuonCalib::RtLegendre, MuonCalib::RtRelationLookUp, MuonCalib::MdtSlewCorFuncHardcoded, MuonCalib::BFieldCorFunc, MuonCalib::RtResolutionChebyshev, MuonCalib::RtResolutionLookUp, and MuonCalibR4::RtResolutionSqrt.

nPar()

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

inlineinherited

Definition at line 39 of file CalibFunc.h.

{ return m_parameters.size(); }

par()

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

inlineinherited

Definition at line 41 of file CalibFunc.h.

                                                 {
                if (index < nPar())
                    return m_parameters[index];
                else
                    return 0.;
            }

parameters()

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

inlineinherited

Definition at line 40 of file CalibFunc.h.

{ return m_parameters; }

typeName()

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

inlinevirtual

Implements MuonCalib::CalibFunc.

Definition at line 18 of file IMdtBFieldCorFunc.h.

{ return "IMdtBFieldCorFunc"; }

Member Data Documentation

m_parameters

ParVec MuonCalib::CalibFunc::m_parameters {}

privateinherited

Definition at line 51 of file CalibFunc.h.

---

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

• IMdtBFieldCorFunc.h