MdtCalibInput Class Reference

#include <MdtCalibInput.h>

Collaboration diagram for MdtCalibInput:

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

Public Member Functions
	MdtCalibInput (const MdtDigit &digit, const MuonGM::MuonDetectorManager &detMgr)
	Constructor taking the MdtDigits – Typically used inside digitization or RDO -> PRD conversion Given that digits don't have intrinsically any readout element attached, the detector manager needs to parsed for fetching the proper element. More...
	MdtCalibInput (const MdtDigit &digit, const MuonGMR4::MuonDetectorManager &detMgr, const ActsGeometryContext &gctx)
	MdtCalibInput (const Muon::MdtPrepData &prd)
	Constructor taking the MdtPrepdata More...
	MdtCalibInput (const Identifier &id, const int adc, const int tdc, const Amg::Vector3D &globalPos)
	Constructor taking the. More...
const Identifier &	identify () const
	Returns the Identifier of the hit. More...
int	tdc () const
	Returns the tdc counts of the hit. More...
int	adc () const
	Returns the amount of accumulated charge. More...
bool	isMasked () const
	Returns whether the constructing digit has been masked. 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 &	globalPos () const
	Returns the global position of the hit. 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::SaggedLineSurface &	idealSurface () const
	Returns the assocaited ideal surface (Throw exception if no legacy RE is available) More...
const Trk::StraightLineSurface &	saggedSurface () const
	Returns the surface modeling the wire sagging at the point of the closest approach (Throw exceptions if no legacy RE is available) More...
std::unique_ptr< Trk::StraightLineSurface >	releaseSurface ()
	Releases the sagged line surface (Can be a nullptr) More...
const Amg::Vector3D &	surfaceCenter () const
	Returns the center of the associated surface. More...
const Amg::Vector3D &	saggedSurfCenter () const
	Returns the center of the sagged line 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 Attributes
Identifier	m_id {0}
bool	m_isMasked {false}
int	m_adc {0}
int	m_tdc {0}
const MuonGM::MdtReadoutElement *	m_legRE {nullptr}
	Pointer to the readout elements of the legacy geometry. More...
const ActsGeometryContext *	m_gctx {nullptr}
const MuonGMR4::MdtReadoutElement *	m_RE {nullptr}
IdentifierHash	m_hash {}
Amg::Transform3D	m_globToLoc {Amg::Transform3D::Identity()}
Amg::Vector3D	m_globPos {Amg::Vector3D::Zero()}
Amg::Vector3D	m_approach {m_globPos}
Amg::Vector3D	m_trackDir {Amg::Vector3D::Zero()}
double	m_ToF {m_globPos.mag() * s_inverseSpeed}
double	m_trigTime {0.}
	Trigger time. More...
double	m_distToTrack {0.}
	Distance to track (signed) More...
CxxUtils::CachedUniquePtrT< Trk::StraightLineSurface >	m_saggedSurf {}

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

Detailed Description

Definition at line 27 of file MdtCalibInput.h.

Member Enumeration Documentation

BFieldComp

enum MdtCalibInput::BFieldComp

Enumerator
alongWire
alongTrack

Definition at line 86 of file MdtCalibInput.h.

                   {
      alongWire = 0,
      alongTrack = 1,
    };

Constructor & Destructor Documentation

MdtCalibInput() [1/4]

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

Constructor taking the MdtDigits – Typically used inside digitization or RDO -> PRD conversion Given that digits don't have intrinsically any readout element attached, the detector manager needs to parsed for fetching the proper element.

Definition at line 22 of file MdtCalibInput.cxx.

                                                                     :
   m_id{digit.identify()},
   m_isMasked{digit.is_masked()},
   m_adc{digit.adc()},
   m_tdc{digit.tdc()},
   m_legRE{detMgr.getMdtReadoutElement(m_id)},
   m_globToLoc{m_legRE->globalToLocalTransf(m_id)},
   m_globPos{m_legRE->center(m_id)}  {}

MdtCalibInput() [2/4]

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

Definition at line 32 of file MdtCalibInput.cxx.

                                                             :
   m_id{digit.identify()},
   m_isMasked{digit.is_masked()},
   m_adc{digit.adc()},
   m_tdc{digit.tdc()},  
   m_gctx{&gctx},
   m_RE{detMgr.getMdtReadoutElement(m_id)},
   m_hash{m_RE->measurementHash(m_id)},
   m_globToLoc{m_RE->globalToLocalTrans(gctx, m_hash)},
   m_globPos{m_RE->center(gctx, m_hash)} {}

MdtCalibInput() [3/4]

MdtCalibInput::MdtCalibInput

(

const Muon::MdtPrepData &

prd

)

Constructor taking the MdtPrepdata

Definition at line 51 of file MdtCalibInput.cxx.

                                                      :
   m_id{prd.identify()},
   m_adc{prd.adc()},
   m_tdc{prd.tdc()},
   m_legRE{prd.detectorElement()},
   m_globToLoc{m_legRE->globalToLocalTransf(m_id)},
   m_globPos{prd.globalPosition()} {
 
}

MdtCalibInput() [4/4]

MdtCalibInput::MdtCalibInput	(	const Identifier &	id,
		const int	adc,
		const int	tdc,
		const Amg::Vector3D &	globalPos
	)

Constructor taking the.

Definition at line 45 of file MdtCalibInput.cxx.

                                                                                                          :
   m_id{id},
   m_adc{adc},
   m_tdc{tdc},
   m_globPos{globPos} {}

Member Function Documentation

adc()

int MdtCalibInput::adc

(

)

const

Returns the amount of accumulated charge.

Definition at line 64 of file MdtCalibInput.cxx.

{ return m_adc; }

closestApproach()

const Amg::Vector3D & MdtCalibInput::closestApproach

(

)

const

Returns the point of closest approach to the wire.

Definition at line 69 of file MdtCalibInput.cxx.

{return m_approach; }

decriptor()

const MuonGMR4::MdtReadoutElement * MdtCalibInput::decriptor

(

)

const

Returns the R4 readout element.

Definition at line 66 of file MdtCalibInput.cxx.

{ return m_RE; }

distanceToTrack()

double MdtCalibInput::distanceToTrack

(

)

const

Returns the distance to track (signed)

Definition at line 141 of file MdtCalibInput.cxx.

{ return m_distToTrack; }

globalPos()

const Amg::Vector3D & MdtCalibInput::globalPos

(

)

const

Returns the global position of the hit.

Definition at line 68 of file MdtCalibInput.cxx.

{ return m_globPos; }

idealSurface()

const Trk::SaggedLineSurface & MdtCalibInput::idealSurface

(

)

const

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

Definition at line 102 of file MdtCalibInput.cxx.

                                                              {
    if (!m_legRE) {
      std::stringstream except{};
      except<<__FILE__<<":"<<__LINE__<<" idealSurface() can only be called together with the legacy readout geometry";
      throw std::runtime_error(except.str());         
   }
   return m_legRE->surface(identify());
}

identify()

const Identifier & MdtCalibInput::identify

(

)

const

Returns the Identifier of the hit.

Definition at line 62 of file MdtCalibInput.cxx.

{ return m_id; }

isMasked()

bool MdtCalibInput::isMasked

(

)

const

Returns whether the constructing digit has been masked.

Definition at line 67 of file MdtCalibInput.cxx.

{ return m_isMasked; } 

legacyDescriptor()

const MuonGM::MdtReadoutElement * MdtCalibInput::legacyDescriptor

(

)

const

Returns the legacy readout element.

Definition at line 65 of file MdtCalibInput.cxx.

{ return m_legRE; }

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

                                                                                    {
   const Amg::Vector3D locBField = m_globToLoc.linear() * fieldInGlob;
   const Amg::Vector3D locTrkDir = m_globToLoc.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 148 of file MdtCalibInput.cxx.

                                        {
   if (m_legRE) return m_legRE->tubeFrame_localROPos(identify()).z() > 0. ? 1. : -1.;
   else if (m_RE) return -1.;
   return 0.;
}

releaseSurface()

std::unique_ptr< Trk::StraightLineSurface > MdtCalibInput::releaseSurface

(

)

Releases the sagged line surface (Can be a nullptr)

Definition at line 74 of file MdtCalibInput.cxx.

                                                                    {
   return m_saggedSurf.release();
}

saggedSurface()

const Trk::StraightLineSurface & MdtCalibInput::saggedSurface

(

)

const

Returns the surface modeling the wire sagging at the point of the closest approach (Throw exceptions if no legacy RE is available)

Definition at line 110 of file MdtCalibInput.cxx.

                                                                 {
   if (!m_legRE) {
      std::stringstream except{};
      except<<__FILE__<<":"<<__LINE__<<" saggedSurface() can only be called together with the legacy readout geometry";
      throw std::runtime_error(except.str());         
   }
   if (!m_saggedSurf) {
      const Trk::SaggedLineSurface& surf{idealSurface()};
      const Trk::Surface& baseSurf{surf};
      std::optional<Amg::Vector2D> locApproach = baseSurf.globalToLocal(closestApproach(),1000.);
      if (!locApproach) {
         return surf;
      }
      std::unique_ptr<Trk::StraightLineSurface> sagged{surf.correctedSurface(*locApproach)};
      if (!sagged) {
         return surf;
      }
      return (*m_saggedSurf.set(std::move(sagged)));
   }
   return (*m_saggedSurf);
}

saggedSurfCenter()

const Amg::Vector3D & MdtCalibInput::saggedSurfCenter

(

)

const

Returns the center of the sagged line surface.

Definition at line 88 of file MdtCalibInput.cxx.

{ return saggedSurface().center();}

setClosestApproach()

void MdtCalibInput::setClosestApproach

(

const Amg::Vector3D &

approach

)

Sets the closest approach.

Definition at line 70 of file MdtCalibInput.cxx.

                                                                  {
   m_approach = approach;
   releaseSurface();
}

setTimeOfFlight()

void MdtCalibInput::setTimeOfFlight

(

const double

toF

)

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

Definition at line 80 of file MdtCalibInput.cxx.

{ 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 78 of file MdtCalibInput.cxx.

{ m_trackDir = trackDir; }

setTriggerTime()

void MdtCalibInput::setTriggerTime

(

const double

trigTime

)

Sets the trigger offset time.

Definition at line 83 of file MdtCalibInput.cxx.

{ m_trigTime = trigTime; }

signalPropagationDistance()

double MdtCalibInput::signalPropagationDistance

(

)

const

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

Definition at line 131 of file MdtCalibInput.cxx.

                                                      {
   double propDist{0.};
   if (m_legRE) {
      const double distToRO = m_legRE->distanceFromRO(closestApproach(), identify());
      propDist = distToRO - m_legRE->RODistanceFromTubeCentre(identify());
   } else if (m_RE) {
      return m_RE->distanceToReadout(*m_gctx, identify(), closestApproach());
   }
   return propDist;
}

surfaceCenter()

const Amg::Vector3D & MdtCalibInput::surfaceCenter

(

)

const

Returns the center of the associated surface.

Definition at line 85 of file MdtCalibInput.cxx.

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

tdc()

int MdtCalibInput::tdc

(

)

const

Returns the tdc counts of the hit.

Definition at line 63 of file MdtCalibInput.cxx.

{ return m_tdc; }

timeOfFlight()

double MdtCalibInput::timeOfFlight

(

)

const

Returns the time of flight.

Definition at line 79 of file MdtCalibInput.cxx.

{ return m_ToF; }

trackDirection()

const Amg::Vector3D & MdtCalibInput::trackDirection

(

)

const

Returns the track direction (Can be zero)

Definition at line 77 of file MdtCalibInput.cxx.

{ return m_trackDir; }

triggerTime()

double MdtCalibInput::triggerTime

(

)

const

Returns the trigger offset time.

Definition at line 82 of file MdtCalibInput.cxx.

{ return m_trigTime; }

tubeLength()

double MdtCalibInput::tubeLength

(

)

const

Returns the tube length.

Definition at line 143 of file MdtCalibInput.cxx.

                                       {
    if (m_legRE) return m_legRE->tubeLength(identify());
    else if (m_RE) return m_RE->tubeLength(m_hash);
    return 0.;
 }

Member Data Documentation

m_adc

int MdtCalibInput::m_adc {0}

private

Definition at line 116 of file MdtCalibInput.h.

m_approach

Amg::Vector3D MdtCalibInput::m_approach {m_globPos}

private

Definition at line 127 of file MdtCalibInput.h.

m_distToTrack

double MdtCalibInput::m_distToTrack {0.}

private

Distance to track (signed)

Definition at line 136 of file MdtCalibInput.h.

m_gctx

const ActsGeometryContext* MdtCalibInput::m_gctx {nullptr}

private

Definition at line 121 of file MdtCalibInput.h.

m_globPos

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

private

Definition at line 126 of file MdtCalibInput.h.

m_globToLoc

Amg::Transform3D MdtCalibInput::m_globToLoc {Amg::Transform3D::Identity()}

private

Definition at line 125 of file MdtCalibInput.h.

m_hash

IdentifierHash MdtCalibInput::m_hash {}

private

Definition at line 123 of file MdtCalibInput.h.

m_id

Identifier MdtCalibInput::m_id {0}

private

Definition at line 114 of file MdtCalibInput.h.

m_isMasked

bool MdtCalibInput::m_isMasked {false}

private

Definition at line 115 of file MdtCalibInput.h.

m_legRE

const MuonGM::MdtReadoutElement* MdtCalibInput::m_legRE {nullptr}

private

Pointer to the readout elements of the legacy geometry.

Definition at line 119 of file MdtCalibInput.h.

m_RE

const MuonGMR4::MdtReadoutElement* MdtCalibInput::m_RE {nullptr}

private

Definition at line 122 of file MdtCalibInput.h.

m_saggedSurf

CxxUtils::CachedUniquePtrT<Trk::StraightLineSurface> MdtCalibInput::m_saggedSurf {}

private

Definition at line 138 of file MdtCalibInput.h.

m_tdc

int MdtCalibInput::m_tdc {0}

private

Definition at line 117 of file MdtCalibInput.h.

m_ToF

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

private

Definition at line 132 of file MdtCalibInput.h.

m_trackDir

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

private

Definition at line 128 of file MdtCalibInput.h.

m_trigTime

double MdtCalibInput::m_trigTime {0.}

private

Trigger time.

Definition at line 134 of file MdtCalibInput.h.

s_inverseSpeed

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

staticconstexprprivate

Time of flight.

Definition at line 131 of file MdtCalibInput.h.

---

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

• MdtCalibInput.h
• MdtCalibInput.cxx