ATLAS Offline Software
Loading...
Searching...
No Matches
xAOD::MMCluster_v1 Class Reference

#include <MMCluster_v1.h>

Inheritance diagram for xAOD::MMCluster_v1:
Collaboration diagram for xAOD::MMCluster_v1:

Public Types

using Author = ::Muon::MMPrepData::Author
using Quality = ::Muon::MMPrepData::Quality
using DriftCov_t = PosAccessor<2>::element_type
 returns the list of drift distances

Public Member Functions

 MMCluster_v1 ()=default
 Default constructor.
virtual ~MMCluster_v1 ()=default
 Virtual destructor.
xAOD::UncalibMeasType type () const override final
 Returns the type of the MM strip as a simple enumeration.
Amg::Vector3D localMeasurementPos () const override final
 Returns the local measurement position as 3-vector.
std::uint8_t measuresPhi () const override final
 Returns whether the phi coordinate is measured.
unsigned numDimensions () const override final
 Returns the number of dimensions of the measurement.
std::uint8_t gasGap () const
 Returns the gas gap number to which the clsuter.
void setGasGap (std::uint8_t gap)
std::uint16_t channelNumber () const
 returns the number of the central strip
void setChannelNumber (std::uint16_t strip)
 Set the channel number of the central strip.
IdentifierHash measurementHash () const override final
 Returns the hash of the measurement channel.
IdentifierHash layerHash () const override final
 Returns the hash of the associated layer (Needed for surface retrieval).
std::uint16_t time () const
 Returns the time (ns).
void setTime (std::uint16_t value)
 Sets the TDC counts.
std::uint32_t charge () const
 Returns the charge The charge is calibrated, i.e.
void setCharge (std::uint32_t value)
 Sets the calibrated charge.
float driftDist () const
 Returns the Drift Distance.
void setDriftDist (float value)
 Sets the drift distance.
float angle () const
 Returns the microTPC angle.
void setAngle (float value)
 Sets the microTPC angle.
float chiSqProb () const
 Returns the microTPC chisq Prob.
void setChiSqProb (float value)
 Sets the microTPC chisq probability.
Author author () const
void setAuthor (Author author)
Quality quality () const
void setQuality (Quality quality)
const std::vector< std::uint16_t > & stripNumbers () const
 returns the list of strip numbers
void setStripNumbers (const std::vector< std::uint16_t > &stripNumbers)
const std::vector< std::int16_t > & stripTimes () const
 returns the list of times
void setStripTimes (const std::vector< std::int16_t > &stripTimes)
const std::vector< int > & stripCharges () const
 returns the list of charges
void setStripCharges (const std::vector< int > &stripCharges)
const std::vector< float > & stripDriftDist () const
 returns the list of drift distances
void setStripDriftDist (const std::vector< float > &stripDriftDist)
const std::vector< DriftCov_t > & stripDriftErrors () const
void setStripDriftErrors (const std::vector< DriftCov_t > &stripDriftErrors)
void setStripDriftErrors (const std::vector< AmgVector(2)> &stripDriftErrors)
void setReadoutElement (const MuonGMR4::MmReadoutElement *readoutEle)
 set the pointer to the MmReadoutElement
const MuonGMR4::MmReadoutElementreadoutElement () const override final
 Retrieve the associated MmReadoutElement.
const Identifieridentify () 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< Identifierm_identifier {}

Detailed Description

Definition at line 13 of file MMCluster_v1.h.

Member Typedef Documentation

◆ Author

◆ DriftCov_t

using xAOD::MMCluster_v1::DriftCov_t = PosAccessor<2>::element_type

returns the list of drift distances

Definition at line 99 of file MMCluster_v1.h.

◆ Quality

Constructor & Destructor Documentation

◆ MMCluster_v1()

xAOD::MMCluster_v1::MMCluster_v1 ( )
default

Default constructor.

◆ ~MMCluster_v1()

virtual xAOD::MMCluster_v1::~MMCluster_v1 ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ angle()

float xAOD::MMCluster_v1::angle ( ) const

Returns the microTPC angle.

◆ author()

Author xAOD::MMCluster_v1::author ( ) const

◆ channelNumber()

std::uint16_t xAOD::MMCluster_v1::channelNumber ( ) const

returns the number of the central strip

◆ charge()

std::uint32_t xAOD::MMCluster_v1::charge ( ) const

Returns the charge The charge is calibrated, i.e.

it is in units of electrons, after pedestal subtraction.

◆ chiSqProb()

float xAOD::MMCluster_v1::chiSqProb ( ) const

Returns the microTPC chisq Prob.

◆ driftDist()

float xAOD::MMCluster_v1::driftDist ( ) const

Returns the Drift Distance.

◆ gasGap()

std::uint8_t xAOD::MMCluster_v1::gasGap ( ) const

Returns the gas gap number to which the clsuter.

◆ 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.

15 {
16 if (!m_identifier.isValid()){
17 m_identifier.set(readoutElement()->measurementId(measurementHash()));
18 }
19 return (*m_identifier.ptr());
20 }
virtual const MuonGMR4::MuonReadoutElement * readoutElement() const =0
Returns the pointer to the associated readout element.
CxxUtils::CachedValue< Identifier > m_identifier
virtual IdentifierHash measurementHash() const =0
Returns the hash of the measurement channel.

◆ layerHash()

IdentifierHash xAOD::MMCluster_v1::layerHash ( ) const
finaloverridevirtual

Returns the hash of the associated layer (Needed for surface retrieval).

Implements xAOD::MuonMeasurement_v1.

Definition at line 23 of file MMCluster_v1.cxx.

23 {
25}
static IdentifierHash createHash(const int gasGap, const int strip)
std::uint8_t gasGap() const
Returns the gas gap number to which the clsuter.

◆ 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::MMCluster_v1::localMeasurementPos ( ) const
finaloverridevirtual

Returns the local measurement position as 3-vector.

Implements xAOD::MuonMeasurement_v1.

Definition at line 56 of file MMCluster_v1.cxx.

56 {
57 return localPosition<1>()[0] * Amg::Vector3D::UnitX();
58}
ConstVectorMap< N > localPosition() const
Returns the local position of the measurement.

◆ 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::MMCluster_v1::measurementHash ( ) const
finaloverridevirtual

Returns the hash of the measurement channel.

Implements xAOD::MuonMeasurement_v1.

Definition at line 20 of file MMCluster_v1.cxx.

20 {
22}
std::uint16_t channelNumber() const
returns the number of the central strip

◆ measuresPhi()

std::uint8_t xAOD::MMCluster_v1::measuresPhi ( ) const
inlinefinaloverridevirtual

Returns whether the phi coordinate is measured.

Implements xAOD::MuonMeasurement_v1.

Definition at line 28 of file MMCluster_v1.h.

28{ return 0; }

◆ numDimensions()

unsigned xAOD::MMCluster_v1::numDimensions ( ) const
inlinefinaloverridevirtual

Returns the number of dimensions of the measurement.

Implements xAOD::UncalibratedMeasurement_v1.

Definition at line 30 of file MMCluster_v1.h.

30{ return 1; }

◆ quality()

Quality xAOD::MMCluster_v1::quality ( ) const

◆ readoutElement()

const MuonGMR4::MmReadoutElement * xAOD::MMCluster_v1::readoutElement ( ) const
finaloverridevirtual

Retrieve the associated MmReadoutElement.

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.

◆ setAngle()

void xAOD::MMCluster_v1::setAngle ( float value)

Sets the microTPC angle.

◆ setAuthor()

void xAOD::MMCluster_v1::setAuthor ( Author author)

◆ setChannelNumber()

void xAOD::MMCluster_v1::setChannelNumber ( std::uint16_t strip)

Set the channel number of the central strip.

◆ setCharge()

void xAOD::MMCluster_v1::setCharge ( std::uint32_t value)

Sets the calibrated charge.

◆ setChiSqProb()

void xAOD::MMCluster_v1::setChiSqProb ( float value)

Sets the microTPC chisq probability.

◆ setDriftDist()

void xAOD::MMCluster_v1::setDriftDist ( float value)

Sets the drift distance.

◆ setGasGap()

void xAOD::MMCluster_v1::setGasGap ( std::uint8_t gap)

◆ 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).

◆ 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.

◆ setQuality()

void xAOD::MMCluster_v1::setQuality ( Quality quality)

◆ setReadoutElement()

void xAOD::MMCluster_v1::setReadoutElement ( const MuonGMR4::MmReadoutElement * readoutEle)

set the pointer to the MmReadoutElement

◆ setStripCharges()

void xAOD::MMCluster_v1::setStripCharges ( const std::vector< int > & stripCharges)

◆ setStripDriftDist()

void xAOD::MMCluster_v1::setStripDriftDist ( const std::vector< float > & stripDriftDist)

◆ setStripDriftErrors() [1/2]

void xAOD::MMCluster_v1::setStripDriftErrors ( const std::vector< AmgVector(2)> & stripDriftErrors)

Definition at line 44 of file MMCluster_v1.cxx.

44 {
45 std::vector<DriftCov_t> covariance{};
46 std::transform(stripDriftErrors.begin(), stripDriftErrors.end(),
47 std::back_inserter(covariance),
48 [](const AmgVector(2) & cov) {
49 DriftCov_t toRet{};
50 toRet [0] = cov[0];
51 toRet [1] = cov[1];
52 return toRet;
53 });
54 setStripDriftErrors(covariance);
55}
#define AmgVector(rows)
void setStripDriftErrors(const std::vector< DriftCov_t > &stripDriftErrors)
PosAccessor< 2 >::element_type DriftCov_t
returns the list of drift distances
const std::vector< DriftCov_t > & stripDriftErrors() const

◆ setStripDriftErrors() [2/2]

void xAOD::MMCluster_v1::setStripDriftErrors ( const std::vector< DriftCov_t > & stripDriftErrors)

◆ setStripNumbers()

void xAOD::MMCluster_v1::setStripNumbers ( const std::vector< std::uint16_t > & stripNumbers)

◆ setStripTimes()

void xAOD::MMCluster_v1::setStripTimes ( const std::vector< std::int16_t > & stripTimes)

◆ setTime()

void xAOD::MMCluster_v1::setTime ( std::uint16_t value)

Sets the TDC counts.

◆ stripCharges()

const std::vector< int > & xAOD::MMCluster_v1::stripCharges ( ) const

returns the list of charges

◆ stripDriftDist()

const std::vector< float > & xAOD::MMCluster_v1::stripDriftDist ( ) const

returns the list of drift distances

◆ stripDriftErrors()

const std::vector< DriftCov_t > & xAOD::MMCluster_v1::stripDriftErrors ( ) const

◆ stripNumbers()

const std::vector< std::uint16_t > & xAOD::MMCluster_v1::stripNumbers ( ) const

returns the list of strip numbers

◆ stripTimes()

const std::vector< std::int16_t > & xAOD::MMCluster_v1::stripTimes ( ) const

returns the list of times

◆ time()

std::uint16_t xAOD::MMCluster_v1::time ( ) const

Returns the time (ns).

The time is calibrated, i.e. it is in units of ns, after t0 subtraction.

◆ type()

xAOD::UncalibMeasType xAOD::MMCluster_v1::type ( ) const
inlinefinaloverridevirtual

Returns the type of the MM strip as a simple enumeration.

Implements xAOD::UncalibratedMeasurement_v1.

Definition at line 22 of file MMCluster_v1.h.

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: