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

#include <sTgcStripCluster_v1.h>

Inheritance diagram for xAOD::sTgcStripCluster_v1:
Collaboration diagram for xAOD::sTgcStripCluster_v1:

Public Types

using Quality = ::Muon::sTgcPrepData::Quality
 Which quality flag does the Measurement pass.
using sTgcChannelTypes = sTgcIdHelper::sTgcChannelTypes
using Author = ::Muon::sTgcPrepData::Author
 Which algorithm produced the Measurement object.

Public Member Functions

 sTgcStripCluster_v1 ()=default
 Default constructor.
virtual ~sTgcStripCluster_v1 ()=default
 Virtual destructor.
sTgcChannelTypes channelType () const override final
 Returns the type of the Tgc strip as a simple enumeration.
const std::vector< uint16_t > & stripNumbers () const
 returns the list of strip numbers building up the cluster
const std::vector< short int > & stripTimes () const
 returns the list of invidvidual channel times building up the cluster
const std::vector< int > & stripCharges () const
 returns the list of the inidivudal channel charges bulding up the cluster
void setStripNumbers (const std::vector< uint16_t > &strips)
 Set the list of individual strip clusters.
void setStripTimes (const std::vector< short int > &times)
 Set the list of indivual strip times.
void setStripCharges (const std::vector< int > &charges)
 Set the individual list of contributing charges.
Quality quality () const
void setQuality (Quality q)
 Set the quality flag.
xAOD::UncalibMeasType type () const override final
 Returns the type of the Tgc strip as a simple enumeration.
unsigned numDimensions () const override final
 Pad measurements have 2 dimensions. Strips & Wires have only 1.
std::uint8_t measuresPhi () const override final
 Returns whether the phi coordinate is measured.
IdentifierHash measurementHash () const override final
 Returns the hash of the measurement channel w.r.t ReadoutElement.
IdentifierHash layerHash () const override final
 Returns the hash of the associated gasGap layer.
Amg::Vector3D localMeasurementPos () const override final
 Returns the local measurement position as 3-vector.
Author author () const
std::uint8_t gasGap () const
 In which gasGap is the Measurement.
std::uint16_t channelNumber () const
 Channel number of the Measurement.
int charge () const
 : Collected charge on the wire
short int time () const
 : Calibrated time of the wire measurement
const MuonGMR4::sTgcReadoutElementreadoutElement () const override final
 Retrieve the associated sTgcReadoutElement.
void setReadoutElement (const MuonGMR4::sTgcReadoutElement *readoutEle)
 set the pointer to the sTgcReadoutElement
void setAuthor (Author a)
 Set the author of the producing algorithm.
void setGasGap (std::uint8_t gap)
 Set the associated gas gap of the measurement.
void setChannelNumber (std::uint16_t channel)
 Set the channel number of the measurement.
void setTime (short int t)
 : Set the calibrated time of the wire measurement
void setCharge (int q)
 : Set the collected charge on the wire
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 sTgcStripCluster_v1.h.

Member Typedef Documentation

◆ Author

Which algorithm produced the Measurement object.

Definition at line 48 of file sTgcMeasurement_v1.h.

◆ Quality

Which quality flag does the Measurement pass.

Definition at line 42 of file sTgcStripCluster_v1.h.

◆ sTgcChannelTypes

Constructor & Destructor Documentation

◆ sTgcStripCluster_v1()

xAOD::sTgcStripCluster_v1::sTgcStripCluster_v1 ( )
default

Default constructor.

◆ ~sTgcStripCluster_v1()

virtual xAOD::sTgcStripCluster_v1::~sTgcStripCluster_v1 ( )
virtualdefault

Virtual destructor.

Member Function Documentation

◆ author()

Author xAOD::sTgcMeasurement_v1::author ( ) const
inherited

◆ channelNumber()

std::uint16_t xAOD::sTgcMeasurement_v1::channelNumber ( ) const
inherited

Channel number of the Measurement.

◆ channelType()

sTgcChannelTypes xAOD::sTgcStripCluster_v1::channelType ( ) const
inlinefinaloverridevirtual

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

Implements xAOD::sTgcMeasurement_v1.

Definition at line 22 of file sTgcStripCluster_v1.h.

22 {
23 return sTgcChannelTypes::Strip;
24 }

◆ charge()

int xAOD::sTgcMeasurement_v1::charge ( ) const
inherited

: Collected charge on the wire

◆ gasGap()

std::uint8_t xAOD::sTgcMeasurement_v1::gasGap ( ) const
inherited

In which gasGap is the Measurement.

◆ 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::sTgcMeasurement_v1::layerHash ( ) const
finaloverridevirtualinherited

Returns the hash of the associated gasGap layer.

Implements xAOD::MuonMeasurement_v1.

Definition at line 32 of file sTgcMeasurement_v1.cxx.

32 {
34}
static IdentifierHash createHash(const unsigned gasGap, const unsigned channelType, const unsigned channel, const unsigned wireInGrp=0)
Create a measurement hash from the Identifier fields.
std::uint8_t gasGap() const
In which gasGap is the Measurement.

◆ 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::sTgcMeasurement_v1::localMeasurementPos ( ) const
finaloverridevirtualinherited

Returns the local measurement position as 3-vector.

Implements xAOD::MuonMeasurement_v1.

Definition at line 35 of file sTgcMeasurement_v1.cxx.

35 {
36 switch (channelType()) {
38 case Strip:
39 case Wire:
40 return localPosition<1>()[0] * Amg::Vector3D::Unit(channelType() == Wire);
41 case Pad:{
42 Amg::Vector3D locPos{localPosition<2>()[0], localPosition<2>()[1], 0.};
43 return locPos;
44 }
45 }
46 return Amg::Vector3D::Zero();
47}
ConstVectorMap< N > localPosition() const
Returns the local position of the measurement.
virtual sTgcChannelTypes channelType() const =0
Returns the channel type of the measurement (Pad/Wire/Strip).
Eigen::Matrix< double, 3, 1 > Vector3D

◆ 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::sTgcMeasurement_v1::measurementHash ( ) const
finaloverridevirtualinherited

Returns the hash of the measurement channel w.r.t ReadoutElement.

Implements xAOD::MuonMeasurement_v1.

Definition at line 29 of file sTgcMeasurement_v1.cxx.

29 {
31}
std::uint16_t channelNumber() const
Channel number of the Measurement.

◆ measuresPhi()

std::uint8_t xAOD::sTgcMeasurement_v1::measuresPhi ( ) const
inlinefinaloverridevirtualinherited

Returns whether the phi coordinate is measured.

Implements xAOD::MuonMeasurement_v1.

Definition at line 40 of file sTgcMeasurement_v1.h.

40{ return channelType() != sTgcChannelTypes::Strip; }

◆ numDimensions()

unsigned xAOD::sTgcMeasurement_v1::numDimensions ( ) const
inlinefinaloverridevirtualinherited

Pad measurements have 2 dimensions. Strips & Wires have only 1.

Implements xAOD::UncalibratedMeasurement_v1.

Definition at line 36 of file sTgcMeasurement_v1.h.

36 {
37 return channelType() == sTgcChannelTypes::Pad ? 2 : 1;
38 }

◆ quality()

Quality xAOD::sTgcStripCluster_v1::quality ( ) const

◆ readoutElement()

const MuonGMR4::sTgcReadoutElement * xAOD::sTgcMeasurement_v1::readoutElement ( ) const
finaloverridevirtualinherited

Retrieve the associated sTgcReadoutElement.

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.

◆ setAuthor()

void xAOD::sTgcMeasurement_v1::setAuthor ( Author a)
inherited

Set the author of the producing algorithm.

◆ setChannelNumber()

void xAOD::sTgcMeasurement_v1::setChannelNumber ( std::uint16_t channel)
inherited

Set the channel number of the measurement.

◆ setCharge()

void xAOD::sTgcMeasurement_v1::setCharge ( int q)
inherited

: Set the collected charge on the wire

◆ setGasGap()

void xAOD::sTgcMeasurement_v1::setGasGap ( std::uint8_t gap)
inherited

Set the associated gas gap of the measurement.

◆ 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::sTgcStripCluster_v1::setQuality ( Quality q)

Set the quality flag.

◆ setReadoutElement()

void xAOD::sTgcMeasurement_v1::setReadoutElement ( const MuonGMR4::sTgcReadoutElement * readoutEle)
inherited

set the pointer to the sTgcReadoutElement

◆ setStripCharges()

void xAOD::sTgcStripCluster_v1::setStripCharges ( const std::vector< int > & charges)

Set the individual list of contributing charges.

◆ setStripNumbers()

void xAOD::sTgcStripCluster_v1::setStripNumbers ( const std::vector< uint16_t > & strips)

Set the list of individual strip clusters.

◆ setStripTimes()

void xAOD::sTgcStripCluster_v1::setStripTimes ( const std::vector< short int > & times)

Set the list of indivual strip times.

◆ setTime()

void xAOD::sTgcMeasurement_v1::setTime ( short int t)
inherited

: Set the calibrated time of the wire measurement

◆ stripCharges()

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

returns the list of the inidivudal channel charges bulding up the cluster

◆ stripNumbers()

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

returns the list of strip numbers building up the cluster

◆ stripTimes()

const std::vector< short int > & xAOD::sTgcStripCluster_v1::stripTimes ( ) const

returns the list of invidvidual channel times building up the cluster

◆ time()

short int xAOD::sTgcMeasurement_v1::time ( ) const
inherited

: Calibrated time of the wire measurement

◆ type()

xAOD::UncalibMeasType xAOD::sTgcMeasurement_v1::type ( ) const
inlinefinaloverridevirtualinherited

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

Implements xAOD::UncalibratedMeasurement_v1.

Definition at line 29 of file sTgcMeasurement_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 file: