#include <MdtCalibInput.h>

Collaboration diagram for MdtCalibInput:

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

Public Member Functions
	MdtCalibInput (const Identifier &id, const int16_t adc, const int16_t tdc, const MuonGMR4::MdtReadoutElement *reEle, const ActsTrk::GeometryContext &gctx)
	Minimal constructor in the PhaseII geomerty setup.
	MdtCalibInput (const Identifier &id, const int16_t adc, const int16_t tdc, const MuonGM::MdtReadoutElement *reEle)
	Minimal constructor in the legacy geomerty setup.
	MdtCalibInput (const MdtDigit &digit, const MuonGM::MuonDetectorManager &detMgr)
	Constructor taking the Mdt digit & the legacy II detector manager.
	MdtCalibInput (const MdtDigit &digit, const MuonGMR4::MuonDetectorManager &detMgr, const ActsTrk::GeometryContext &gctx)
	Constructor taking the Mdt digit & the Phase II detector manager.
	MdtCalibInput (const Muon::MdtPrepData &prd)
	Constructor taking the MdtPrepdata.
	MdtCalibInput (const xAOD::MdtDriftCircle &prd, const ActsTrk::GeometryContext &gctx)
	Constructor taking taking the xAOD::MdtDriftCircle.
	MdtCalibInput (MdtCalibInput &&other)=default
MdtCalibInput &	operator= (MdtCalibInput &&other)=default
	~MdtCalibInput ()
const Identifier &	identify () const
	Returns the Identifier of the hit.
int16_t	tdc () const
	Returns the tdc counts of the hit.
int16_t	adc () const
	Returns the amount of accumulated charge.
const MuonGM::MdtReadoutElement *	legacyDescriptor () const
	Returns the legacy readout element.
const MuonGMR4::MdtReadoutElement *	decriptor () const
	Returns the R4 readout element.
const Amg::Vector3D &	closestApproach () const
	Returns the point of closest approach to the wire.
void	setClosestApproach (const Amg::Vector3D &approach)
	Sets the closest approach.
const Amg::Vector3D &	trackDirection () const
	Returns the track direction (Can be zero)
void	setTrackDirection (const Amg::Vector3D &trackDir, bool hasPhi)
	Sets the direction of the externally determined track.
bool	trackDirHasPhi () const
	Returns whether the track has a phi constaint or not.
double	timeOfFlight () const
	Returns the time of flight.
void	setTimeOfFlight (const double toF)
	Sets the time of flight (Usually globPos.mag() * inverseSpeed of light)
double	triggerTime () const
	Returns the trigger offset time.
void	setTriggerTime (const double trigTime)
	Sets the trigger offset time.
double	distanceToTrack () const
	Returns the distance to track (signed)
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.
double	signalPropagationDistance () const
	Calculates the distance that the signal has to travel along the wire.
const Trk::StraightLineSurface &	legacySurface () const
	Returns the assocaited ideal surface (Throw exception if no legacy RE is available)
double	tubeLength () const
	Returns the tube length.
double	readOutSide () const
	Returns the sign of the readout position in local coordinates.
double	innerTubeR () const
	Returns the inner tube radius.

Private Types
using	ReadoutEle_t = std::variant<const MuonGM::MdtReadoutElement, const MuonGMR4::MdtReadoutElement>
	Variant type to store the legacy & Phase-II style readout geometry in a single variable.

Private Member Functions
void	print (std::ostream &ostr) const
	Print the object on screen.
const Amg::Transform3D &	localToGlobal () const
	Local to global transformation of the tube.

Private Attributes
Identifier	m_id {}
	Tube identifier.
int16_t	m_adc {0}
	Adc counts of the hit.
int16_t	m_tdc {0}
	Tdc counts of the hit.
const ActsTrk::GeometryContext *	m_gctx {nullptr}
	Geometry context, needed to fetch the alignment.
ReadoutEle_t	m_RE {}
	Pointer to the associated readout element.
IdentifierHash	m_hash {}
	Measurement hash of the Identifier (needed for Phase II)
CxxUtils::CachedValue< Amg::Vector3D >	m_approach {}
	Point of closest approach of the track.
Amg::Vector3D	m_trackDir {Amg::Vector3D::Zero()}
	Global track direction.
bool	m_trackHasPhi {false}
	Does the track direction contain a phi constraint.
CxxUtils::CachedValue< double >	m_ToF {}
	Time of flight.
double	m_trigTime {0.}
	Trigger time.
double	m_distToTrack {0.}
	Distance to track (signed)

Friends
std::ostream &	operator<< (std::ostream &ostr, const MdtCalibInput &input)

Detailed Description

Definition at line 36 of file MdtCalibInput.h.

Member Typedef Documentation

◆ ReadoutEle_t

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

private

Variant type to store the legacy & Phase-II style readout geometry in a single variable.

Definition at line 164 of file MdtCalibInput.h.

Member Enumeration Documentation

◆ BFieldComp

enum class MdtCalibInput::BFieldComp

strong

Enumerator
alongWire
alongTrack

Definition at line 126 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 ActsTrk::GeometryContext &	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 42 of file MdtCalibInput.cxx.

                                                                :
   m_id{id},
   m_adc{adc},
   m_tdc{tdc},
   m_gctx{&gctx},
   m_RE{reEle},
   m_hash{reEle->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 60 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 69 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 ActsTrk::GeometryContext &	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 54 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 86 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 ActsTrk::GeometryContext &	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 75 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.localMeasurementPos()} {}

◆ 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 96 of file MdtCalibInput.cxx.

96{ return m_adc; }

◆ closestApproach()

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

Returns the point of closest approach to the wire.

Definition at line 109 of file MdtCalibInput.cxx.

                                                        { 
   if (!m_approach.isValid()) {
      m_approach.set(localToGlobal().translation());
   }
   assert(m_approach.ptr() != nullptr);
   return *m_approach.ptr(); 
}

◆ decriptor()

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

Returns the R4 readout element.

Definition at line 103 of file MdtCalibInput.cxx.

                                                                { 
   if (std::holds_alternative<const MuonGMR4::MdtReadoutElement*>(m_RE)) {
      return std::get<const MuonGMR4::MdtReadoutElement*>(m_RE);
   }
   return nullptr;
}

◆ distanceToTrack()

double MdtCalibInput::distanceToTrack ( ) const

Returns the distance to track (signed)

Definition at line 168 of file MdtCalibInput.cxx.

168{ return m_distToTrack; }

MdtCalibInput::m_distToTrack

double m_distToTrack

Distance to track (signed)

Definition MdtCalibInput.h:180

◆ identify()

const Identifier & MdtCalibInput::identify ( ) const

Returns the Identifier of the hit.

Definition at line 94 of file MdtCalibInput.cxx.

94{ return m_id; }

◆ innerTubeR()

double MdtCalibInput::innerTubeR ( ) const

Returns the inner tube radius.

Definition at line 181 of file MdtCalibInput.cxx.

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

◆ legacyDescriptor()

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

Returns the legacy readout element.

Definition at line 97 of file MdtCalibInput.cxx.

                                                                     { 
   if (std::holds_alternative<const MuonGM::MdtReadoutElement*>(m_RE)) {
      return std::get<const MuonGM::MdtReadoutElement*>(m_RE);
   }
   return nullptr;
}

◆ legacySurface()

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

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

Definition at line 150 of file MdtCalibInput.cxx.

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

◆ localToGlobal()

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

private

Local to global transformation of the tube.

Definition at line 204 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->localToGlobalTransform(*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

◆ print()

void MdtCalibInput::print ( std::ostream & ostr ) const

private

Print the object on screen.

Parameters

ostr	Outstream into which the object is piped

Definition at line 27 of file MdtCalibInput.cxx.

                                                {
   ostr<<"adc: "<<adc()<<", ";
   ostr<<"tdc: "<<tdc()<<", ";
   if (m_approach.isValid()) {
      ostr<<"closest approach: "<<Amg::toString(closestApproach(), 2)<<", ";
   }
   ostr<<"global direction: "<<Amg::toString(trackDirection(), 2)<<", ";
   ostr<<"prop distance: "<<signalPropagationDistance()<<", ";
   if (m_ToF.isValid()) {
      ostr<<"ToF: "<<timeOfFlight()<<", ";
   }
   ostr<<"trigger time: "<<triggerTime();
 
}

◆ 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 137 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 192 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 116 of file MdtCalibInput.cxx.

                                                                  {
   m_approach.store(approach);
}

◆ setTimeOfFlight()

void MdtCalibInput::setTimeOfFlight ( const double toF )

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

Definition at line 132 of file MdtCalibInput.cxx.

132{ m_ToF.store(toF); }

◆ setTrackDirection()

void MdtCalibInput::setTrackDirection	(	const Amg::Vector3D &	trackDir,
		bool	hasPhi )

Sets the direction of the externally determined track.

Parameters

trackDir	Direction vector of the track (global frame)
hasPhi	Flag whether the track direction contains phi information

Definition at line 120 of file MdtCalibInput.cxx.

                                                                              { 
   m_trackDir = trackDir;
   m_trackHasPhi = hasPhi;
}

◆ setTriggerTime()

void MdtCalibInput::setTriggerTime ( const double trigTime )

Sets the trigger offset time.

Definition at line 135 of file MdtCalibInput.cxx.

135{ m_trigTime = trigTime; }

MdtCalibInput::m_trigTime

double m_trigTime

Trigger time.

Definition MdtCalibInput.h:178

◆ signalPropagationDistance()

double MdtCalibInput::signalPropagationDistance ( ) const

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

Definition at line 155 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;
}

◆ tdc()

int16_t MdtCalibInput::tdc ( ) const

Returns the tdc counts of the hit.

Definition at line 95 of file MdtCalibInput.cxx.

95{ return m_tdc; }

◆ timeOfFlight()

double MdtCalibInput::timeOfFlight ( ) const

Returns the time of flight.

Definition at line 125 of file MdtCalibInput.cxx.

                                         { 
   if (!m_ToF.isValid()) {
      m_ToF.set(closestApproach().mag() * s_inverseSpeed);
   }
   assert(m_ToF.ptr() != nullptr);
   return *m_ToF.ptr(); 
}

◆ trackDirection()

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

Returns the track direction (Can be zero)

Definition at line 119 of file MdtCalibInput.cxx.

119{ return m_trackDir; }

◆ trackDirHasPhi()

bool MdtCalibInput::trackDirHasPhi ( ) const

Returns whether the track has a phi constaint or not.

Definition at line 124 of file MdtCalibInput.cxx.

124{ return m_trackHasPhi; }

◆ triggerTime()

double MdtCalibInput::triggerTime ( ) const

Returns the trigger offset time.

Definition at line 134 of file MdtCalibInput.cxx.

134{ return m_trigTime; }

◆ tubeLength()

double MdtCalibInput::tubeLength ( ) const

Returns the tube length.

Definition at line 170 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;
 }

◆ operator<<

std::ostream & operator<<	(	std::ostream &	ostr,
		const MdtCalibInput &	input )

friend

Definition at line 144 of file MdtCalibInput.h.

                                                                                  {
          input.print(ostr);
          return ostr;
      }

Member Data Documentation

◆ m_adc

int16_t MdtCalibInput::m_adc {0}

private

Adc counts of the hit.

Definition at line 157 of file MdtCalibInput.h.

157{0};

◆ m_approach

CxxUtils::CachedValue<Amg::Vector3D> MdtCalibInput::m_approach {}

private

Point of closest approach of the track.

Definition at line 170 of file MdtCalibInput.h.

170{};

◆ m_distToTrack

double MdtCalibInput::m_distToTrack {0.}

private

Distance to track (signed)

Definition at line 180 of file MdtCalibInput.h.

180{0.};

◆ m_gctx

const ActsTrk::GeometryContext* MdtCalibInput::m_gctx {nullptr}

private

Geometry context, needed to fetch the alignment.

Definition at line 162 of file MdtCalibInput.h.

162{nullptr};

◆ m_hash

IdentifierHash MdtCalibInput::m_hash {}

private

Measurement hash of the Identifier (needed for Phase II)

Definition at line 168 of file MdtCalibInput.h.

168{};

◆ m_id

Identifier MdtCalibInput::m_id {}

private

Tube identifier.

Definition at line 155 of file MdtCalibInput.h.

155{};

◆ m_RE

ReadoutEle_t MdtCalibInput::m_RE {}

private

Pointer to the associated readout element.

Definition at line 166 of file MdtCalibInput.h.

166{};

◆ m_tdc

int16_t MdtCalibInput::m_tdc {0}

private

Tdc counts of the hit.

Definition at line 159 of file MdtCalibInput.h.

159{0};

◆ m_ToF

CxxUtils::CachedValue<double> MdtCalibInput::m_ToF {}

private

Time of flight.

Definition at line 176 of file MdtCalibInput.h.

176{};

◆ m_trackDir

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

private

Global track direction.

Definition at line 172 of file MdtCalibInput.h.

172{Amg::Vector3D::Zero()};

◆ m_trackHasPhi

bool MdtCalibInput::m_trackHasPhi {false}

private

Does the track direction contain a phi constraint.

Definition at line 174 of file MdtCalibInput.h.

174{false};

◆ m_trigTime

double MdtCalibInput::m_trigTime {0.}

private

Trigger time.

Definition at line 178 of file MdtCalibInput.h.

178{0.};

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

Public Types

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

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()

◆ closestApproach()

◆ decriptor()

◆ distanceToTrack()

◆ identify()

◆ innerTubeR()

◆ legacyDescriptor()

◆ legacySurface()

◆ localToGlobal()

◆ operator=()

◆ print()

◆ projectMagneticField()

◆ readOutSide()

◆ setClosestApproach()

◆ setTimeOfFlight()

◆ setTrackDirection()

◆ setTriggerTime()

◆ signalPropagationDistance()

◆ tdc()

◆ timeOfFlight()

◆ trackDirection()

◆ trackDirHasPhi()

◆ triggerTime()

◆ tubeLength()

Friends And Related Symbol Documentation

◆ operator<<

Member Data Documentation

◆ m_adc

◆ m_approach

◆ m_distToTrack

◆ m_gctx

◆ m_hash

◆ m_id

◆ m_RE

◆ m_tdc

◆ m_ToF

◆ m_trackDir

◆ m_trackHasPhi

◆ m_trigTime