xAOD::sTgcMeasurement_v1 Class Reference

#include <sTgcMeasurement_v1.h>

Inheritance diagram for xAOD::sTgcMeasurement_v1:

Collaboration diagram for xAOD::sTgcMeasurement_v1:

Public Types
using	sTgcChannelTypes = sTgcIdHelper::sTgcChannelTypes
using	Author = ::Muon::sTgcPrepData::Author
	Which algorithm produced the Measurement object.

Public Member Functions
	sTgcMeasurement_v1 ()=default
	Default constructor.
virtual	~sTgcMeasurement_v1 ()=default
	Virtual destructor.
xAOD::UncalibMeasType	type () const override final
	Returns the type of the Tgc strip as a simple enumeration.
virtual sTgcChannelTypes	channelType () const =0
	Returns the channel type of the measurement (Pad/Wire/Strip).
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::sTgcReadoutElement *	readoutElement () 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 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

Definition at line 20 of file sTgcMeasurement_v1.h.

Member Typedef Documentation

Author

using xAOD::sTgcMeasurement_v1::Author = ::Muon::sTgcPrepData::Author

Which algorithm produced the Measurement object.

Definition at line 48 of file sTgcMeasurement_v1.h.

sTgcChannelTypes

using xAOD::sTgcMeasurement_v1::sTgcChannelTypes = sTgcIdHelper::sTgcChannelTypes

Definition at line 32 of file sTgcMeasurement_v1.h.

Constructor & Destructor Documentation

sTgcMeasurement_v1()

xAOD::sTgcMeasurement_v1::sTgcMeasurement_v1 ( )

default

Default constructor.

~sTgcMeasurement_v1()

virtual xAOD::sTgcMeasurement_v1::~sTgcMeasurement_v1 ( )

virtualdefault

Virtual destructor.

Member Function Documentation

author()

Author xAOD::sTgcMeasurement_v1::author

(

)

const

channelNumber()

std::uint16_t xAOD::sTgcMeasurement_v1::channelNumber

(

)

const

Channel number of the Measurement.

channelType()

virtual sTgcChannelTypes xAOD::sTgcMeasurement_v1::channelType ( ) const

pure virtual

Returns the channel type of the measurement (Pad/Wire/Strip).

Implemented in xAOD::sTgcPadHit_v1, xAOD::sTgcStripCluster_v1, and xAOD::sTgcWireHit_v1.

charge()

int xAOD::sTgcMeasurement_v1::charge

(

)

const

: Collected charge on the wire

gasGap()

std::uint8_t xAOD::sTgcMeasurement_v1::gasGap

(

)

const

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.

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

layerHash()

IdentifierHash xAOD::sTgcMeasurement_v1::layerHash ( ) const

finaloverridevirtual

Returns the hash of the associated gasGap layer.

Implements xAOD::MuonMeasurement_v1.

Definition at line 32 of file sTgcMeasurement_v1.cxx.

                                                   {
   return MuonGMR4::sTgcReadoutElement::createHash(gasGap(), sTgcIdHelper::sTgcChannelTypes::Strip, 0);
}

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

finaloverridevirtual

Returns the local measurement position as 3-vector.

Implements xAOD::MuonMeasurement_v1.

Definition at line 35 of file sTgcMeasurement_v1.cxx.

                                                          {
   switch (channelType()) {
      using enum sTgcIdHelper::sTgcChannelTypes;
      case Strip:
      case Wire:
         return localPosition<1>()[0] * Amg::Vector3D::Unit(channelType() == Wire);
      case Pad:{
         Amg::Vector3D locPos{localPosition<2>()[0], localPosition<2>()[1], 0.};
         return locPos;
      }      
   }
   return Amg::Vector3D::Zero();
}

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

finaloverridevirtual

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

Implements xAOD::MuonMeasurement_v1.

Definition at line 29 of file sTgcMeasurement_v1.cxx.

                                                         {
   return MuonGMR4::sTgcReadoutElement::createHash(gasGap(), channelType(), channelNumber());
}

measuresPhi()

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

inlinefinaloverridevirtual

Returns whether the phi coordinate is measured.

Implements xAOD::MuonMeasurement_v1.

Definition at line 40 of file sTgcMeasurement_v1.h.

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

numDimensions()

unsigned xAOD::sTgcMeasurement_v1::numDimensions ( ) const

inlinefinaloverridevirtual

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

Implements xAOD::UncalibratedMeasurement_v1.

Definition at line 36 of file sTgcMeasurement_v1.h.

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

readoutElement()

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

finaloverridevirtual

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

)

Set the author of the producing algorithm.

setChannelNumber()

void xAOD::sTgcMeasurement_v1::setChannelNumber

(

std::uint16_t

channel

)

Set the channel number of the measurement.

setCharge()

void xAOD::sTgcMeasurement_v1::setCharge

(

int

q

)

: Set the collected charge on the wire

setGasGap()

void xAOD::sTgcMeasurement_v1::setGasGap

(

std::uint8_t

gap

)

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.

setReadoutElement()

void xAOD::sTgcMeasurement_v1::setReadoutElement

(

const MuonGMR4::sTgcReadoutElement *

readoutEle

)

set the pointer to the sTgcReadoutElement

setTime()

void xAOD::sTgcMeasurement_v1::setTime

(

short int

t

)

: Set the calibrated time of the wire measurement

time()

short int xAOD::sTgcMeasurement_v1::time

(

)

const

: Calibrated time of the wire measurement

type()

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

inlinefinaloverridevirtual

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

Implements xAOD::UncalibratedMeasurement_v1.

Definition at line 29 of file sTgcMeasurement_v1.h.

                                                  {
    return xAOD::UncalibMeasType::sTgcStripType;
  }

Member Data Documentation

m_identifier

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

privateinherited

Definition at line 48 of file MuonMeasurement_v1.h.

{};

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.

{};

---

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

• sTgcMeasurement_v1.h
• sTgcMeasurement_v1.cxx