Representation of Mdt drift circle (DC) measurements. More...

#include <MdtDriftCircle_v1.h>

Inheritance diagram for xAOD::MdtDriftCircle_v1:

Collaboration diagram for xAOD::MdtDriftCircle_v1:

Public Types
using	MdtDriftCircleStatus = ::Muon::MdtDriftCircleStatus

Public Member Functions
	MdtDriftCircle_v1 ()=default
	Default constructor.
virtual	~MdtDriftCircle_v1 ()=default
	Virtual destructor.
xAOD::UncalibMeasType	type () const override final
	Returns the type of the Mdt drift circle as a simple enumeration.
Amg::Vector3D	localMeasurementPos () const override final
	: Return the measurement's position vector in the local frame.
unsigned	numDimensions () const override
	Override the dimensions to be 1.
std::int16_t	tdc () const
	Returns the TDC (typically range is 0 to 2500).
std::int16_t	adc () const
	Returns the ADC (typically range is 0 to 250).
std::uint16_t	driftTube () const
	Returns the tube number of the measurement (1-120).
std::uint8_t	tubeLayer () const
	Returns the layer number of the measurement (1-4).
IdentifierHash	measurementHash () const override final
	Returns the hash of the measurement channel (tube (x) layer).
IdentifierHash	layerHash () const override final
	Returns the layer hash of the tube layer.
std::uint8_t	measuresPhi () const override final
	Returns whether the drift circle measures phi.
MdtDriftCircleStatus	status () const
	Returns the status of the measurement.
float	driftRadius () const
	Returns the drift radius.
float	driftRadiusCov () const
	Returns the covariance of the drift radius.
float	driftRadiusUncert () const
	Returns the uncertainty on the drift radius.
void	setTdc (std::int16_t tdc)
	Setter methods.
void	setAdc (std::int16_t adc)
	Sets the ADC counts.
void	setTube (std::uint16_t tube_n)
	Sets the tube number.
void	setLayer (std::uint8_t layer_n)
	Sets the layer number.
void	setStatus (MdtDriftCircleStatus st)
	Sets the status of the drift circle.
void	setReadoutElement (const MuonGMR4::MdtReadoutElement *readoutEle)
	set the pointer to the MdtReadoutElement
virtual const MuonGMR4::MdtReadoutElement *	readoutElement () const override final
	Retrieve the associated MdtReadoutElement.
const Identifier &	identify () const
	Returns the Athena identifier of the measurement.
Functions to get measurement properties
DetectorIDHashType	identifierHash () const
	Returns the IdentifierHash of the measurement (corresponds to the detector element IdentifierHash).
DetectorIdentType	identifier () const
	Returns the full Identifier of the measurement.
template<int N>
ConstVectorMap< N >	localPosition () const
	Returns the local position of the measurement.
template<int N>
VectorMap< N >	localPosition ()
	Returns the local position as mutable eigen map which can be assigned as well.
template<int N>
ConstMatrixMap< N >	localCovariance () const
	Returns the local covariance of the measurement.
template<int N>
MatrixMap< N >	localCovariance ()
	Returns the local covariance as mutable eigen map which can be assigned as well.
Functions to set measurement properties
void	setIdentifierHash (const DetectorIDHashType idHash)
	Sets the IdentifierHash of the measurement (corresponds to the detector element IdentifierHash).
void	setIdentifier (const DetectorIdentType measId)
	Sets the full Identifier of the measurement.
Direct method to set measurement properties
template<int N>
void	setMeasurement (const DetectorIDHashType idHash, MeasVector< N > locPos, MeasMatrix< N > locCov)
	Sets IdentifierHash, local position and local covariance of the measurement.

Protected Attributes
CxxUtils::CachedValue< const MuonGMR4::MuonReadoutElement * >	m_readoutEle {}
	Cache value of the.

Private Attributes
CxxUtils::CachedValue< Identifier >	m_identifier {}

Detailed Description

Representation of Mdt drift circle (DC) measurements.

DC measurements consists of the raw tdc/adc values needed for later calibration, the identifier fields tube layer, tube and the driftRadius and its uncertainty stored as 1 dimensional localPosition and covariance, respectively.

Definition at line 21 of file MdtDriftCircle_v1.h.

Member Typedef Documentation

◆ MdtDriftCircleStatus

using xAOD::MdtDriftCircle_v1::MdtDriftCircleStatus = ::Muon::MdtDriftCircleStatus

Definition at line 24 of file MdtDriftCircle_v1.h.

Constructor & Destructor Documentation

◆ MdtDriftCircle_v1()

xAOD::MdtDriftCircle_v1::MdtDriftCircle_v1 ( )

default

Default constructor.

◆ ~MdtDriftCircle_v1()

virtual xAOD::MdtDriftCircle_v1::~MdtDriftCircle_v1 ( )

virtualdefault

Virtual destructor.

Member Function Documentation

◆ adc()

std::int16_t xAOD::MdtDriftCircle_v1::adc ( ) const

Returns the ADC (typically range is 0 to 250).

◆ driftRadius()

float xAOD::MdtDriftCircle_v1::driftRadius ( ) const

Returns the drift radius.

Definition at line 45 of file MdtDriftCircle_v1.cxx.

                                           {
    return numDimensions() == 1 ? localPosition<1>()[Trk::locR] 
                                : localPosition<2>()[Trk::locR];
}

◆ driftRadiusCov()

float xAOD::MdtDriftCircle_v1::driftRadiusCov ( ) const

Returns the covariance of the drift radius.

Definition at line 50 of file MdtDriftCircle_v1.cxx.

                                              {
    return numDimensions() == 1 ? localCovariance<1>()(Trk::locR, Trk::locR) 
                                : localCovariance<2>()(Trk::locR, Trk::locR);
}

◆ driftRadiusUncert()

float xAOD::MdtDriftCircle_v1::driftRadiusUncert ( ) const

Returns the uncertainty on the drift radius.

Definition at line 55 of file MdtDriftCircle_v1.cxx.

                                                 {
    return std::sqrt(driftRadiusCov());
}

◆ driftTube()

std::uint16_t xAOD::MdtDriftCircle_v1::driftTube ( ) const

Returns the tube number of the measurement (1-120).

◆ identifier()

DetectorIdentType xAOD::UncalibratedMeasurement_v1::identifier ( ) const

inherited

Returns the full Identifier of the measurement.

◆ identifierHash()

DetectorIDHashType xAOD::UncalibratedMeasurement_v1::identifierHash ( ) const

inherited

Returns the IdentifierHash of the measurement (corresponds to the detector element IdentifierHash).

◆ identify()

const Identifier & xAOD::MuonMeasurement_v1::identify ( ) const

inherited

Returns the Athena identifier of the measurement.

Definition at line 15 of file MuonMeasurement_v1.cxx.

                                                         {
        if (!m_identifier.isValid()){
            m_identifier.set(readoutElement()->measurementId(measurementHash()));
        }
        return (*m_identifier.ptr());
    }

◆ layerHash()

IdentifierHash xAOD::MdtDriftCircle_v1::layerHash ( ) const

finaloverridevirtual

Returns the layer hash of the tube layer.

Implements xAOD::MuonMeasurement_v1.

Definition at line 33 of file MdtDriftCircle_v1.cxx.

                                                  {
    return MuonGMR4::MdtReadoutElement::layerHash(measurementHash());
}

◆ localCovariance() [1/2]

template<int N>

MatrixMap< N > xAOD::UncalibratedMeasurement_v1::localCovariance ( )

inherited

Returns the local covariance as mutable eigen map which can be assigned as well.

◆ localCovariance() [2/2]

template<int N>

ConstMatrixMap< N > xAOD::UncalibratedMeasurement_v1::localCovariance ( ) const

inherited

Returns the local covariance of the measurement.

◆ localMeasurementPos()

Amg::Vector3D xAOD::MdtDriftCircle_v1::localMeasurementPos ( ) const

finaloverridevirtual

: Return the measurement's position vector in the local frame.

If the measurement is an ordinary 1D drift circle, the Zero vector is returned. Otherwise the local position along z

Implements xAOD::MuonMeasurement_v1.

Definition at line 39 of file MdtDriftCircle_v1.cxx.

                                                         {
    if (numDimensions() == 1) {
        return Amg::Vector3D::Zero();
    }
    return localPosition<2>()[Trk::locZ] * Amg::Vector3D::UnitZ(); 
}

◆ localPosition() [1/2]

template<int N>

VectorMap< N > xAOD::UncalibratedMeasurement_v1::localPosition ( )

inherited

Returns the local position as mutable eigen map which can be assigned as well.

◆ localPosition() [2/2]

template<int N>

ConstVectorMap< N > xAOD::UncalibratedMeasurement_v1::localPosition ( ) const

inherited

Returns the local position of the measurement.

◆ measurementHash()

IdentifierHash xAOD::MdtDriftCircle_v1::measurementHash ( ) const

finaloverridevirtual

Returns the hash of the measurement channel (tube (x) layer).

Implements xAOD::MuonMeasurement_v1.

Definition at line 29 of file MdtDriftCircle_v1.cxx.

                                                        {
    return MuonGMR4::MdtReadoutElement::measurementHash(tubeLayer(),
                                                       driftTube());
}

◆ measuresPhi()

std::uint8_t xAOD::MdtDriftCircle_v1::measuresPhi ( ) const

finaloverridevirtual

Returns whether the drift circle measures phi.

Implements xAOD::MuonMeasurement_v1.

Definition at line 36 of file MdtDriftCircle_v1.cxx.

                                                {
    return numDimensions() == 2;
}

◆ numDimensions()

unsigned xAOD::MdtDriftCircle_v1::numDimensions ( ) const

inlineoverridevirtual

Override the dimensions to be 1.

Implements xAOD::UncalibratedMeasurement_v1.

Reimplemented in xAOD::MdtTwinDriftCircle_v1.

Definition at line 39 of file MdtDriftCircle_v1.h.

39{ return 1; }

◆ readoutElement()

virtual const MuonGMR4::MdtReadoutElement * xAOD::MdtDriftCircle_v1::readoutElement ( ) const

finaloverridevirtual

Retrieve the associated MdtReadoutElement.

If the element has not been set before, it's tried to load it on the fly. Exceptions are thrown if that fails as well

Implements xAOD::MuonMeasurement_v1.

◆ setAdc()

void xAOD::MdtDriftCircle_v1::setAdc ( std::int16_t adc )

Sets the ADC counts.

◆ setIdentifier()

void xAOD::UncalibratedMeasurement_v1::setIdentifier ( const DetectorIdentType measId )

inherited

Sets the full Identifier of the measurement.

◆ setIdentifierHash()

void xAOD::UncalibratedMeasurement_v1::setIdentifierHash ( const DetectorIDHashType idHash )

inherited

Sets the IdentifierHash of the measurement (corresponds to the detector element IdentifierHash).

◆ setLayer()

void xAOD::MdtDriftCircle_v1::setLayer ( std::uint8_t layer_n )

Sets the layer number.

◆ setMeasurement()

template<int N>

void xAOD::UncalibratedMeasurement_v1::setMeasurement	(	const DetectorIDHashType	idHash,
		MeasVector< N >	locPos,
		MeasMatrix< N >	locCov )

inherited

Sets IdentifierHash, local position and local covariance of the measurement.

◆ setReadoutElement()

void xAOD::MdtDriftCircle_v1::setReadoutElement ( const MuonGMR4::MdtReadoutElement * readoutEle )

set the pointer to the MdtReadoutElement

◆ setStatus()

void xAOD::MdtDriftCircle_v1::setStatus ( MdtDriftCircleStatus st )

Sets the status of the drift circle.

◆ setTdc()

void xAOD::MdtDriftCircle_v1::setTdc ( std::int16_t tdc )

Setter methods.

Sets the TDC counts

◆ setTube()

void xAOD::MdtDriftCircle_v1::setTube ( std::uint16_t tube_n )

Sets the tube number.

◆ status()

MdtDriftCircleStatus xAOD::MdtDriftCircle_v1::status ( ) const

Returns the status of the measurement.

◆ tdc()

std::int16_t xAOD::MdtDriftCircle_v1::tdc ( ) const

Returns the TDC (typically range is 0 to 2500).

◆ tubeLayer()

std::uint8_t xAOD::MdtDriftCircle_v1::tubeLayer ( ) const

Returns the layer number of the measurement (1-4).

◆ type()

xAOD::UncalibMeasType xAOD::MdtDriftCircle_v1::type ( ) const

inlinefinaloverridevirtual

Returns the type of the Mdt drift circle as a simple enumeration.

Implements xAOD::UncalibratedMeasurement_v1.

Definition at line 31 of file MdtDriftCircle_v1.h.

                                                    {
        return xAOD::UncalibMeasType::MdtDriftCircleType;
    }

Member Data Documentation

◆ m_identifier

CxxUtils::CachedValue<Identifier> xAOD::MuonMeasurement_v1::m_identifier {}

privateinherited

Definition at line 48 of file MuonMeasurement_v1.h.

48{};

◆ m_readoutEle

CxxUtils::CachedValue<const MuonGMR4::MuonReadoutElement*> xAOD::MuonMeasurement_v1::m_readoutEle {}

protectedinherited

Cache value of the.

Definition at line 46 of file MuonMeasurement_v1.h.

46{};

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

Public Types

Public Member Functions

Protected Attributes

Private Attributes

Detailed Description

Member Typedef Documentation

◆ MdtDriftCircleStatus

Constructor & Destructor Documentation

◆ MdtDriftCircle_v1()

◆ ~MdtDriftCircle_v1()

Member Function Documentation

◆ adc()

◆ driftRadius()

◆ driftRadiusCov()

◆ driftRadiusUncert()

◆ driftTube()

◆ identifier()

◆ identifierHash()

◆ identify()

◆ layerHash()

◆ localCovariance() [1/2]

◆ localCovariance() [2/2]

◆ localMeasurementPos()

◆ localPosition() [1/2]

◆ localPosition() [2/2]

◆ measurementHash()

◆ measuresPhi()

◆ numDimensions()

◆ readoutElement()

◆ setAdc()

◆ setIdentifier()

◆ setIdentifierHash()

◆ setLayer()

◆ setMeasurement()

◆ setReadoutElement()

◆ setStatus()

◆ setTdc()

◆ setTube()

◆ status()

◆ tdc()

◆ tubeLayer()

◆ type()

Member Data Documentation

◆ m_identifier

◆ m_readoutEle