#include <MdtCalibInput.h>

Collaboration diagram for MdtCalibInput:

Public Types
enum	BFieldComp { BFieldComp::alongWire = 0, BFieldComp::alongTrack = 1 }

Public Member Functions
	MdtCalibInput (const Identifier &id, const int16_t adc, const int16_t tdc, const MuonGMR4::MdtReadoutElement *reEle, const ActsGeometryContext &gctx)
	Minimal constructor in the PhaseII geomerty setup. More...

	MdtCalibInput (const Identifier &id, const int16_t adc, const int16_t tdc, const MuonGM::MdtReadoutElement *reEle)
	Minimal constructor in the legacy geomerty setup. More...

	MdtCalibInput (const MdtDigit &digit, const MuonGM::MuonDetectorManager &detMgr)
	Constructor taking the Mdt digit & the legacy II detector manager. More...

	MdtCalibInput (const MdtDigit &digit, const MuonGMR4::MuonDetectorManager &detMgr, const ActsGeometryContext &gctx)
	Constructor taking the Mdt digit & the Phase II detector manager. More...

	MdtCalibInput (const Muon::MdtPrepData &prd)
	Constructor taking the MdtPrepdata. More...

	MdtCalibInput (const xAOD::MdtDriftCircle &prd, const ActsGeometryContext &gctx)
	Constructor taking taking the xAOD::MdtDriftCircle. More...

	MdtCalibInput (MdtCalibInput &&other)=default

MdtCalibInput &	operator= (MdtCalibInput &&other)=default

	~MdtCalibInput ()

const Identifier &	identify () const
	Returns the Identifier of the hit. More...

int16_t	tdc () const
	Returns the tdc counts of the hit. More...

int16_t	adc () const
	Returns the amount of accumulated charge. More...

const MuonGM::MdtReadoutElement *	legacyDescriptor () const
	Returns the legacy readout element. More...

const MuonGMR4::MdtReadoutElement *	decriptor () const
	Returns the R4 readout element. More...

const Amg::Vector3D &	closestApproach () const
	Returns the point of closest approach to the wire. More...

void	setClosestApproach (const Amg::Vector3D &approach)
	Sets the closest approach. More...

const Amg::Vector3D &	trackDirection () const
	Returns the track direction (Can be zero) More...

void	setTrackDirection (const Amg::Vector3D &trackDir)
	Sets the track direction if it's given from an external seed. More...

double	timeOfFlight () const
	Returns the time of flight. More...

void	setTimeOfFlight (const double toF)
	Sets the time of flight (Usually globPos.mag() * inverseSpeed of light) More...

double	triggerTime () const
	Returns the trigger offset time. More...

void	setTriggerTime (const double trigTime)
	Sets the trigger offset time. More...

double	distanceToTrack () const
	Returns the distance to track (signed) More...

Amg::Vector2D	projectMagneticField (const Amg::Vector3D &fieldInGlob) const
	Splits the B-field into the components that point along the transverse track direction & along the tube wire. More...

double	signalPropagationDistance () const
	Calculates the distance that the signal has to travel along the wire. More...

const Trk::StraightLineSurface &	legacySurface () const
	Returns the assocaited ideal surface (Throw exception if no legacy RE is available) More...

const Amg::Vector3D &	surfaceCenter () const
	Returns the center of the associated surface. More...

double	tubeLength () const
	Returns the tube length. More...

double	readOutSide () const
	Returns the sign of the readout position in local coordinates. More...

Private Types
using	ReadoutEle_t = std::variant< const MuonGM::MdtReadoutElement , const MuonGMR4::MdtReadoutElement >

Private Member Functions
const Amg::Transform3D &	localToGlobal () const

Amg::Vector3D	center () const

Private Attributes
Identifier	m_id {}

bool	m_isMasked {false}

int16_t	m_adc {0}

int16_t	m_tdc {0}

const ActsGeometryContext *	m_gctx {nullptr}

ReadoutEle_t	m_RE {}

IdentifierHash	m_hash {}

Amg::Vector3D	m_approach {center()}

Amg::Vector3D	m_trackDir {Amg::Vector3D::Zero()}

double	m_ToF {center().mag() * s_inverseSpeed}

double	m_trigTime {0.}
	Trigger time. More...

double	m_distToTrack {0.}
	Distance to track (signed) More...

Static Private Attributes
static constexpr double	s_inverseSpeed {1. / Gaudi::Units::c_light}
	Time of flight. More...

Detailed Description

Definition at line 35 of file MdtCalibInput.h.

Member Typedef Documentation

◆ ReadoutEle_t

using MdtCalibInput::ReadoutEle_t = std::variant<const MuonGM::MdtReadoutElement*, const MuonGMR4::MdtReadoutElement*>

private

Definition at line 153 of file MdtCalibInput.h.

Member Enumeration Documentation

◆ BFieldComp

enum MdtCalibInput::BFieldComp

strong

Enumerator
alongWire
alongTrack

Definition at line 123 of file MdtCalibInput.h.

                            {
         alongWire = 0,
         alongTrack = 1,
       };

Constructor & Destructor Documentation

◆ MdtCalibInput() [1/7]

MdtCalibInput::MdtCalibInput	(	const Identifier &	id,
		const int16_t	adc,
		const int16_t	tdc,
		const MuonGMR4::MdtReadoutElement *	reEle,
		const ActsGeometryContext &	gctx
	)

Minimal constructor in the PhaseII geomerty setup.

It takes all necessary ingredients to run later the calibration loop.

Parameters

id	Identifier of the hit to calibrate
adc	Recorded adc counts from the tube
tdc	Recorded tdc counts from the tube
detMgr	Pointer to the associated readout element
gctx	Geometry context to globally align the tube within ATLAS

Definition at line 32 of file MdtCalibInput.cxx.

                                                              :
    m_id{id},
    m_adc{adc},
    m_tdc{tdc},
    m_gctx{&gctx},
    m_RE{reEle},
    m_hash{std::get<const MuonGMR4::MdtReadoutElement*>(m_RE)->measurementHash(m_id)}  {}

◆ MdtCalibInput() [2/7]

MdtCalibInput::MdtCalibInput	(	const Identifier &	id,
		const int16_t	adc,
		const int16_t	tdc,
		const MuonGM::MdtReadoutElement *	reEle
	)

Minimal constructor in the legacy geomerty setup.

It takes all necessary ingredients to run later the calibration loop.

Parameters

id	Identifier of the hit to calibrate
adc	Recorded adc counts from the tube
tdc	Recorded tdc counts from the tube
reEle	Pointer to the associated readout element

Definition at line 50 of file MdtCalibInput.cxx.

                                                                   :
    m_id{id},
    m_adc{adc},
    m_tdc{tdc},
    m_RE{reEle} {}

◆ MdtCalibInput() [3/7]

MdtCalibInput::MdtCalibInput	(	const MdtDigit &	digit,
		const MuonGM::MuonDetectorManager &	detMgr
	)

Constructor taking the Mdt digit & the legacy II detector manager.

Parameters

digit	Digit containing all adc & tdc information
detMgr	Reference to the Detector manager to fetch the Proper readout element
gctx	Geometry context to globally align the tube within ATLAS

Definition at line 59 of file MdtCalibInput.cxx.

                                                                      :
    MdtCalibInput(digit.identify(), digit.adc(), digit.tdc(), 
                  detMgr.getMdtReadoutElement(digit.identify())) {}

◆ MdtCalibInput() [4/7]

MdtCalibInput::MdtCalibInput	(	const MdtDigit &	digit,
		const MuonGMR4::MuonDetectorManager &	detMgr,
		const ActsGeometryContext &	gctx
	)

Constructor taking the Mdt digit & the Phase II detector manager.

Parameters

digit	Digit containing all adc & tdc information
detMgr	Reference to the Detector manager to fetch the Proper readout element
gctx	Geometry context to globally align the tube within ATLAS

Definition at line 44 of file MdtCalibInput.cxx.

                                                              :
    MdtCalibInput(digit.identify(), digit.adc(), digit.tdc(), 
                  detMgr.getMdtReadoutElement(digit.identify()), gctx){}

◆ MdtCalibInput() [5/7]

MdtCalibInput::MdtCalibInput ( const Muon::MdtPrepData & prd )

Constructor taking the MdtPrepdata.

The

Definition at line 76 of file MdtCalibInput.cxx.

                                                       :
    m_id{prd.identify()},
    m_adc{static_cast<int16_t>(prd.adc())},
    m_tdc{static_cast<int16_t>(prd.tdc())},
    m_RE{prd.detectorElement()},  
    m_approach{prd.globalPosition()} {
 }

◆ MdtCalibInput() [6/7]

MdtCalibInput::MdtCalibInput	(	const xAOD::MdtDriftCircle &	prd,
		const ActsGeometryContext &	gctx
	)

Constructor taking taking the xAOD::MdtDriftCircle.

Parameters

prd	Reference to the uncalibrated Drift circle
gctx	Geometry context to place the drift circle globally within ATLAS

Definition at line 65 of file MdtCalibInput.cxx.

                                                              :
    m_id{prd.identify()},
    m_adc{prd.adc()},
    m_tdc{prd.tdc()},
    m_gctx{&gctx},
    m_RE{prd.readoutElement()},
    m_hash{prd.measurementHash()},  
    m_approach{localToGlobal()* prd.localCirclePosition()} {}

◆ MdtCalibInput() [7/7]

MdtCalibInput::MdtCalibInput ( MdtCalibInput && other )

default

◆ ~MdtCalibInput()

MdtCalibInput::~MdtCalibInput ( )

default

Member Function Documentation

◆ adc()

int16_t MdtCalibInput::adc ( ) const

Returns the amount of accumulated charge.

Definition at line 86 of file MdtCalibInput.cxx.

86 { return m_adc; }

◆ center()

Amg::Vector3D MdtCalibInput::center ( ) const

private

Definition at line 188 of file MdtCalibInput.cxx.

                                         {
    return localToGlobal().translation();
 }

◆ closestApproach()

const Amg::Vector3D & MdtCalibInput::closestApproach ( ) const

Returns the point of closest approach to the wire.

Definition at line 105 of file MdtCalibInput.cxx.

105 {return m_approach; }

◆ decriptor()

const MuonGMR4::MdtReadoutElement * MdtCalibInput::decriptor ( ) const

Returns the R4 readout element.

Definition at line 96 of file MdtCalibInput.cxx.

                                                                 { 
       return std::visit([](const auto& re) -> const MuonGMR4::MdtReadoutElement*{
          using REType = std::decay_t<decltype(re)>;
          if constexpr( std::is_same_v<REType, const MuonGMR4::MdtReadoutElement*>){
             return re;
          }
          return nullptr;
    }, m_RE); 
 }

◆ distanceToTrack()

double MdtCalibInput::distanceToTrack ( ) const

Returns the distance to track (signed)

Definition at line 152 of file MdtCalibInput.cxx.

152 { return m_distToTrack; }

◆ identify()

const Identifier & MdtCalibInput::identify ( ) const

Returns the Identifier of the hit.

Definition at line 84 of file MdtCalibInput.cxx.

84 { return m_id; }

◆ legacyDescriptor()

const MuonGM::MdtReadoutElement * MdtCalibInput::legacyDescriptor ( ) const

Returns the legacy readout element.

Definition at line 87 of file MdtCalibInput.cxx.

                                                                      { 
    return std::visit([](const auto& re) -> const MuonGM::MdtReadoutElement*{
          using REType = std::decay_t<decltype(re)>;
          if constexpr( std::is_same_v<REType, const MuonGM::MdtReadoutElement*>){
             return re;
          }
          return nullptr;
    }, m_RE);
 }

◆ legacySurface()

const Trk::StraightLineSurface & MdtCalibInput::legacySurface ( ) const

Returns the assocaited ideal surface (Throw exception if no legacy RE is available)

Definition at line 134 of file MdtCalibInput.cxx.

                                                                  {
    const MuonGM::MdtReadoutElement* re = legacyDescriptor();
    assert(re != nullptr);
    return re->surface(identify());
 }

◆ localToGlobal()

const Amg::Transform3D & MdtCalibInput::localToGlobal ( ) const

private

Definition at line 177 of file MdtCalibInput.cxx.

                                                          {
    return std::visit([this](const auto& re) ->const Amg::Transform3D&{
          using REType = std::decay_t<decltype(re)>;
          if constexpr(std::is_same_v<REType, const MuonGMR4::MdtReadoutElement*>){
             assert(m_gctx != nullptr);
             return re->localToGlobalTrans(*m_gctx, m_hash);
          } else if (std::is_same_v<REType, const MuonGM::MdtReadoutElement*>) {
             return re->localToGlobalTransf(identify());
          }
    }, m_RE);
 }

◆ operator=()

MdtCalibInput& MdtCalibInput::operator= ( MdtCalibInput && other )

default

◆ projectMagneticField()

Amg::Vector2D MdtCalibInput::projectMagneticField ( const Amg::Vector3D & fieldInGlob ) const

Splits the B-field into the components that point along the transverse track direction & along the tube wire.

Rotate the B-field into the rest frame of the tube (Z-axis along the wire)

In the local coordinate system, the wire points along the z-axis

Convert kilo tesla into tesla... Waaait whaat?

Definition at line 121 of file MdtCalibInput.cxx.

                                                                                     {
    const Amg::Transform3D trf{localToGlobal().inverse()};
    const Amg::Vector3D locBField = trf.linear() * fieldInGlob;
    const Amg::Vector3D locTrkDir = trf.linear() * trackDirection();
  
    const double perpendComp = locTrkDir.block<2,1>(0,0).dot(locBField.block<2,1>(0,0)) 
                             / locTrkDir.perp();
    const double paralelComp = locBField.z();
    return 1000. * Amg::Vector2D{paralelComp, perpendComp};
 }

◆ readOutSide()

double MdtCalibInput::readOutSide ( ) const

Returns the sign of the readout position in local coordinates.

By convention the new readout geometry points along the negative z-axis

Definition at line 165 of file MdtCalibInput.cxx.

                                         {
    const double roSide = std::visit([this](const auto& re) ->double{
                using REType = std::decay_t<decltype(re)>;
                if constexpr(std::is_same_v<REType, const MuonGMR4::MdtReadoutElement*>){
                   return re->getParameters().readoutSide;
                } else if (std::is_same_v<REType, const MuonGM::MdtReadoutElement*>) {
                   return re->tubeFrame_localROPos(identify()).z() > 0. ? 1. : -1.;
                }
             }, m_RE);
    return roSide;
 }

◆ setClosestApproach()

void MdtCalibInput::setClosestApproach ( const Amg::Vector3D & approach )

Sets the closest approach.

Definition at line 106 of file MdtCalibInput.cxx.

                                                                   {
    m_approach = approach;
 }

◆ setTimeOfFlight()

void MdtCalibInput::setTimeOfFlight ( const double toF )

Sets the time of flight (Usually globPos.mag() * inverseSpeed of light)

Definition at line 112 of file MdtCalibInput.cxx.

112 { m_ToF = toF; }

◆ setTrackDirection()

void MdtCalibInput::setTrackDirection ( const Amg::Vector3D & trackDir )

Sets the track direction if it's given from an external seed.

Definition at line 110 of file MdtCalibInput.cxx.

110 { m_trackDir = trackDir; }

◆ setTriggerTime()

void MdtCalibInput::setTriggerTime ( const double trigTime )

Sets the trigger offset time.

Definition at line 115 of file MdtCalibInput.cxx.

115 { m_trigTime = trigTime; }

◆ signalPropagationDistance()

double MdtCalibInput::signalPropagationDistance ( ) const

Calculates the distance that the signal has to travel along the wire.

Definition at line 139 of file MdtCalibInput.cxx.

                                                       {
    const double propDist = std::visit([this](const auto& re) ->double {
                using REType = std::decay_t<decltype(re)>;
                if constexpr(std::is_same_v<REType, const MuonGMR4::MdtReadoutElement*>){
                   assert(m_gctx != nullptr);
                   return re->distanceToReadout(*m_gctx, m_hash, closestApproach());
                } else if (std::is_same_v<REType, const MuonGM::MdtReadoutElement*>) {
                   return re->distanceFromRO(closestApproach(), identify()) -
                          re->RODistanceFromTubeCentre(identify());
                }
             }, m_RE); 
    return propDist;
 }

◆ surfaceCenter()

const Amg::Vector3D & MdtCalibInput::surfaceCenter ( ) const

Returns the center of the associated surface.

Definition at line 117 of file MdtCalibInput.cxx.

                                                       {
     return legacyDescriptor()->surface(identify()).center();
 }

◆ tdc()

int16_t MdtCalibInput::tdc ( ) const

Returns the tdc counts of the hit.

Definition at line 85 of file MdtCalibInput.cxx.

85 { return m_tdc; }

◆ timeOfFlight()

double MdtCalibInput::timeOfFlight ( ) const

Returns the time of flight.

Definition at line 111 of file MdtCalibInput.cxx.

111 { return m_ToF; }

◆ trackDirection()

const Amg::Vector3D & MdtCalibInput::trackDirection ( ) const

Returns the track direction (Can be zero)

Definition at line 109 of file MdtCalibInput.cxx.

109 { return m_trackDir; }

◆ triggerTime()

double MdtCalibInput::triggerTime ( ) const

Returns the trigger offset time.

Definition at line 114 of file MdtCalibInput.cxx.

114 { return m_trigTime; }

◆ tubeLength()

double MdtCalibInput::tubeLength ( ) const

Returns the tube length.

Definition at line 154 of file MdtCalibInput.cxx.

                                        {
    const double tubeLength  = std::visit([this](const auto& re) ->double{
                using REType = std::decay_t<decltype(re)>;
                if constexpr(std::is_same_v<REType, const MuonGMR4::MdtReadoutElement*>){
                   return re->tubeLength(m_hash);
                } else if (std::is_same_v<REType, const MuonGM::MdtReadoutElement*>) {
                   return re->tubeLength(identify());
                }
             }, m_RE);
     return tubeLength;
  }

Member Data Documentation

◆ m_adc

int16_t MdtCalibInput::m_adc {0}

private

Definition at line 147 of file MdtCalibInput.h.

◆ m_approach

Amg::Vector3D MdtCalibInput::m_approach {center()}

private

Definition at line 158 of file MdtCalibInput.h.

◆ m_distToTrack

double MdtCalibInput::m_distToTrack {0.}

private

Distance to track (signed)

Definition at line 167 of file MdtCalibInput.h.

◆ m_gctx

const ActsGeometryContext* MdtCalibInput::m_gctx {nullptr}

private

Definition at line 151 of file MdtCalibInput.h.

◆ m_hash

IdentifierHash MdtCalibInput::m_hash {}

private

Definition at line 156 of file MdtCalibInput.h.

◆ m_id

Identifier MdtCalibInput::m_id {}

private

Definition at line 145 of file MdtCalibInput.h.

◆ m_isMasked

bool MdtCalibInput::m_isMasked {false}

private

Definition at line 146 of file MdtCalibInput.h.

◆ m_RE

ReadoutEle_t MdtCalibInput::m_RE {}

private

Definition at line 154 of file MdtCalibInput.h.

◆ m_tdc

int16_t MdtCalibInput::m_tdc {0}

private

Definition at line 148 of file MdtCalibInput.h.

◆ m_ToF

double MdtCalibInput::m_ToF {center().mag() * s_inverseSpeed}

private

Definition at line 163 of file MdtCalibInput.h.

◆ m_trackDir

Amg::Vector3D MdtCalibInput::m_trackDir {Amg::Vector3D::Zero()}

private

Definition at line 159 of file MdtCalibInput.h.

◆ m_trigTime

double MdtCalibInput::m_trigTime {0.}

private

Trigger time.

Definition at line 165 of file MdtCalibInput.h.

◆ s_inverseSpeed

constexpr double MdtCalibInput::s_inverseSpeed {1. / Gaudi::Units::c_light}

staticconstexprprivate

Time of flight.

Definition at line 162 of file MdtCalibInput.h.

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

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Member Typedef Documentation

◆ ReadoutEle_t

Member Enumeration Documentation

◆ BFieldComp

Constructor & Destructor Documentation

◆ MdtCalibInput() [1/7]

◆ MdtCalibInput() [2/7]

◆ MdtCalibInput() [3/7]

◆ MdtCalibInput() [4/7]

◆ MdtCalibInput() [5/7]

◆ MdtCalibInput() [6/7]

◆ MdtCalibInput() [7/7]

◆ ~MdtCalibInput()

Member Function Documentation

◆ adc()

◆ center()

◆ closestApproach()

◆ decriptor()

◆ distanceToTrack()

◆ identify()

◆ legacyDescriptor()

◆ legacySurface()

◆ localToGlobal()

◆ operator=()

◆ projectMagneticField()

◆ readOutSide()

◆ setClosestApproach()

◆ setTimeOfFlight()

◆ setTrackDirection()

◆ setTriggerTime()

◆ signalPropagationDistance()

◆ surfaceCenter()

◆ tdc()

◆ timeOfFlight()

◆ trackDirection()

◆ triggerTime()

◆ tubeLength()

Member Data Documentation

◆ m_adc

◆ m_approach

◆ m_distToTrack

◆ m_gctx

◆ m_hash

◆ m_id

◆ m_isMasked

◆ m_RE

◆ m_tdc

◆ m_ToF

◆ m_trackDir

◆ m_trigTime

◆ s_inverseSpeed