Class to represent calibrated clusters formed from TGC strips. More...

#include <MMClusterOnTrack.h>

Inheritance diagram for Muon::MMClusterOnTrack:

Collaboration diagram for Muon::MMClusterOnTrack:

Public Types
enum	Author { unKnownAuthor = 64, SimpleClusterBuilder, ClusterTimeProjectionClusterBuilder, uTPCClusterBuilder }

Public Member Functions
	MMClusterOnTrack ()=default

	MMClusterOnTrack (const MMClusterOnTrack &)=default

MMClusterOnTrack &	operator= (const MMClusterOnTrack &)=default

	MMClusterOnTrack (MMClusterOnTrack &&)=default

MMClusterOnTrack &	operator= (MMClusterOnTrack &&)=default

	MMClusterOnTrack (const MMPrepData *RIO, Trk::LocalParameters &&locpos, Amg::MatrixX &&locerr, double positionAlongStrip, std::vector< float > &&stripDriftDists, std::vector< Amg::MatrixX > &&stripDriftDistErrors)
	Constructor with parameters : The base class owns local position, error matrix. More...

	MMClusterOnTrack (const ElementLinkToIDC_MM_Container &RIO, Trk::LocalParameters &&locpos, Amg::MatrixX &&locerr, const Identifier &id, const MuonGM::MMReadoutElement *detEl, double positionAlongStrip, std::vector< float > &&stripDriftDists, std::vector< Amg::MatrixX > &&stripDriftDistErrors)

virtual	~MMClusterOnTrack ()=default
	Destructor. More...

virtual MMClusterOnTrack *	clone () const
	Clone this ROT. More...

virtual const MMPrepData *	prepRawData () const
	Returns the MMPrepData - is a TRT_DriftCircle in this scope. More...

const ElementLinkToIDC_MM_Container &	prepRawDataLink () const

virtual const MuonGM::MMReadoutElement *	detectorElement () const
	Returns the detector element, assoicated with the PRD of this class. More...

virtual const Trk::Surface &	associatedSurface () const
	Returns the surface on which this measurement was taken. More...

const std::vector< float > &	stripDriftDists () const

const std::vector< Amg::MatrixX > &	stripDriftDistErrors () const

virtual MsgStream &	dump (MsgStream &stream) const
	Dumps information about the PRD. More...

virtual std::ostream &	dump (std::ostream &stream) const
	Dumps information about the PRD. More...

void	setAuthor (Author a)

Author	author () const

virtual const Amg::Vector3D &	globalPosition () const override
	Returns global position. More...

virtual double	positionAlongStrip () const

virtual IdentifierHash	collectionHash () const
	Returns the hashID of the PRD collection. More...

virtual IdentifierHash	idDE () const override
	Returns an invalid hash. More...

virtual bool	rioType (Trk::RIO_OnTrackType::Type type) const override final
	Method checking the Rio On Track type. More...

std::unique_ptr< RIO_OnTrack >	uniqueClone () const
	NVI clone returning unique_ptr. More...

virtual bool	type (MeasurementBaseType::Type type) const override final
	Extended method checking the type. More...

Identifier	identify () const
	return the identifier -extends MeasurementBase More...

const LocalParameters &	localParameters () const
	Interface method to get the LocalParameters. More...

const Amg::MatrixX &	localCovariance () const
	Interface method to get the localError. More...

Static Public Member Functions
static std::size_t	numberOfInstantiations ()

Static Public Attributes
static std::atomic_size_t	s_numberOfInstantiations

Protected Attributes
CxxUtils::CachedUniquePtr< const Amg::Vector3D >	m_globalPosition
	cache global position, the global position has to be calculated in the inheriting classes More...

double	m_positionAlongStrip
	The position along the strip - used to calculate the GlobalPosition. More...

Identifier	m_identifier {}
	Identifier of the RIO_OnTrack (comes from the associated Trk::PrepRawData) More...

LocalParameters	m_localParams

Amg::MatrixX	m_localCovariance

Private Member Functions
virtual void	setValues (const Trk::TrkDetElementBase , const Trk::PrepRawData )
	Sets the DetElement and Trk::PrepRawData pointers after reading from disk. More...

Private Attributes
ElementLinkToIDC_MM_Container	m_rio {}
	PrepRawData object assoicated with this measurement. More...

const MuonGM::MMReadoutElement *	m_detEl {nullptr}
	The detector element, assoicated with this measurement. More...

std::vector< float >	m_stripDriftDists {}

std::vector< Amg::MatrixX >	m_stripDriftDistErrors {}

Author	m_author {Author::unKnownAuthor}

Friends
class	Trk::ITrkEventCnvTool

Detailed Description

Class to represent calibrated clusters formed from TGC strips.

Definition at line 26 of file MMClusterOnTrack.h.

Member Enumeration Documentation

◆ Author

enum Muon::MMClusterOnTrack::Author

Enumerator
unKnownAuthor
SimpleClusterBuilder
ClusterTimeProjectionClusterBuilder
uTPCClusterBuilder

Definition at line 89 of file MMClusterOnTrack.h.

                {
       unKnownAuthor = 64,
       SimpleClusterBuilder,
       ClusterTimeProjectionClusterBuilder,
       uTPCClusterBuilder,
     };

Constructor & Destructor Documentation

◆ MMClusterOnTrack() [1/5]

Muon::MMClusterOnTrack::MMClusterOnTrack ( )

default

◆ MMClusterOnTrack() [2/5]

Muon::MMClusterOnTrack::MMClusterOnTrack ( const MMClusterOnTrack & )

default

◆ MMClusterOnTrack() [3/5]

Muon::MMClusterOnTrack::MMClusterOnTrack ( MMClusterOnTrack && )

default

◆ MMClusterOnTrack() [4/5]

Muon::MMClusterOnTrack::MMClusterOnTrack	(	const MMPrepData *	RIO,
		Trk::LocalParameters &&	locpos,
		Amg::MatrixX &&	locerr,
		double	positionAlongStrip,
		std::vector< float > &&	stripDriftDists,
		std::vector< Amg::MatrixX > &&	stripDriftDistErrors
	)

Constructor with parameters : The base class owns local position, error matrix.

Everything else has ownership elsewhere.

Parameters

[in]	RIO	Required (i.e. must not be NULL). Ownership is not taken.
[in]	locpos	Required (i.e. must not be NULL). Ownership is taken.
[in]	locerr	Required (i.e. must not be NULL). Ownership is taken.
[in]	positionAlongStrip	Required Used to calculate global position.

Definition at line 13 of file MMClusterOnTrack.cxx.

                                                                                    :
     MuonClusterOnTrack(std::move(locpos), std::move(locerr), RIO->identify(), positionAlongStrip),
     m_detEl( RIO->detectorElement() ),
     m_stripDriftDists(std::move(stripDriftDists)),
     m_stripDriftDistErrors(std::move(stripDriftDistErrors)) {
     //Set EL
     m_rio.setElement(RIO);
   }

◆ MMClusterOnTrack() [5/5]

Muon::MMClusterOnTrack::MMClusterOnTrack	(	const ElementLinkToIDC_MM_Container &	RIO,
		Trk::LocalParameters &&	locpos,
		Amg::MatrixX &&	locerr,
		const Identifier &	id,
		const MuonGM::MMReadoutElement *	detEl,
		double	positionAlongStrip,
		std::vector< float > &&	stripDriftDists,
		std::vector< Amg::MatrixX > &&	stripDriftDistErrors
	)

Definition at line 27 of file MMClusterOnTrack.cxx.

                                                                                    :
     MuonClusterOnTrack(std::move(locpos), std::move(locerr), id, positionAlongStrip),  // call base class constructor
     m_rio( RIO ),
     m_detEl( detEl ),
     m_stripDriftDists(stripDriftDists),
     m_stripDriftDistErrors(stripDriftDistErrors)
   {
   }

◆ ~MMClusterOnTrack()

virtual Muon::MMClusterOnTrack::~MMClusterOnTrack ( )

virtualdefault

Destructor.

Member Function Documentation

◆ associatedSurface()

const Trk::Surface & Muon::MMClusterOnTrack::associatedSurface ( ) const

inlinevirtual

Returns the surface on which this measurement was taken.

(i.e. a surface of a detector element)

Implements Trk::RIO_OnTrack.

Definition at line 144 of file MMClusterOnTrack.h.

   {
     assert(0!=detectorElement());
     return detectorElement()->surface(identify());
   }

◆ author()

MMClusterOnTrack::Author Muon::MMClusterOnTrack::author ( ) const

inline

Definition at line 122 of file MMClusterOnTrack.h.

122 { return m_author; }

◆ clone()

MMClusterOnTrack * Muon::MMClusterOnTrack::clone ( ) const

inlinevirtual

Clone this ROT.

Implements Muon::MuonClusterOnTrack.

Definition at line 123 of file MMClusterOnTrack.h.

   {
     return new MMClusterOnTrack(*this);
   }

◆ collectionHash()

IdentifierHash Muon::MuonClusterOnTrack::collectionHash ( ) const

inlinevirtualinherited

Returns the hashID of the PRD collection.

Definition at line 111 of file MuonClusterOnTrack.h.

                                                                  {
     if( this->prepRawData() ) return prepRawData()->collectionHash();
     return IdentifierHash();
   }

◆ detectorElement()

const MuonGM::MMReadoutElement * Muon::MMClusterOnTrack::detectorElement ( ) const

inlinevirtual

Returns the detector element, assoicated with the PRD of this class.

Implements Muon::MuonClusterOnTrack.

Definition at line 139 of file MMClusterOnTrack.h.

   {
     return m_detEl;
   }

◆ dump() [1/2]

MsgStream & Muon::MMClusterOnTrack::dump ( MsgStream & stream ) const

virtual

Dumps information about the PRD.

Reimplemented from Muon::MuonClusterOnTrack.

Definition at line 45 of file MMClusterOnTrack.cxx.

   {
     stream << MSG::INFO<<"MMClusterOnTrack {"<<std::endl;
  
     MuonClusterOnTrack::dump(stream);
  
     stream<<"}"<<endmsg;
     return stream;
   }

◆ dump() [2/2]

std::ostream & Muon::MMClusterOnTrack::dump ( std::ostream & stream ) const

virtual

Dumps information about the PRD.

Reimplemented from Muon::MuonClusterOnTrack.

Definition at line 55 of file MMClusterOnTrack.cxx.

   {
     stream << "MMClusterOnTrack {"<<std::endl;
  
     MuonClusterOnTrack::dump(stream);
  
     stream<<"}"<<std::endl;
     return stream;
   }

◆ globalPosition()

const Amg::Vector3D & Muon::MuonClusterOnTrack::globalPosition ( ) const

overridevirtualinherited

Returns global position.

Implements Trk::RIO_OnTrack.

Definition at line 93 of file MuonClusterOnTrack.cxx.

                                                             {
   if (detectorElement()==nullptr){
     // Not much we can do here - no detelement, so just return 0,0,0
     m_globalPosition.set(std::make_unique<const Amg::Vector3D>(0.0,0.0,0.0));
   }
  
   if (not m_globalPosition) {
     // calculate global position from the position of the strip and the position along the strip
     Amg::Vector2D lpos{Amg::Vector2D::Zero()};
     if( localParameters().contains( Trk::locX ) )
       lpos = Amg::Vector2D( localParameters().get(Trk::locX), m_positionAlongStrip );
     else
       lpos = Amg::Vector2D( m_positionAlongStrip, localParameters().get(Trk::locY) );
  
     Amg::Vector3D gpos{Amg::Vector3D::Zero()};
     detectorElement()->surface( identify() ).localToGlobal(lpos, gpos, gpos);
  
     m_globalPosition.set(std::make_unique<const Amg::Vector3D>(gpos));
   }
  
   return *m_globalPosition;
 }

◆ idDE()

IdentifierHash Muon::MuonClusterOnTrack::idDE ( ) const

inlineoverridevirtualinherited

Returns an invalid hash.

Implements Trk::RIO_OnTrack.

Definition at line 116 of file MuonClusterOnTrack.h.

                                                        {
       return IdentifierHash();
   }

◆ identify()

Identifier Trk::RIO_OnTrack::identify ( ) const

inlineinherited

return the identifier -extends MeasurementBase

Definition at line 152 of file RIO_OnTrack.h.

153 { return m_identifier; }

◆ localCovariance()

const Amg::MatrixX & Trk::MeasurementBase::localCovariance ( ) const

inlineinherited

Interface method to get the localError.

Definition at line 138 of file MeasurementBase.h.

 {
   return m_localCovariance;
 }

◆ localParameters()

const Trk::LocalParameters & Trk::MeasurementBase::localParameters ( ) const

inlineinherited

Interface method to get the LocalParameters.

Definition at line 132 of file MeasurementBase.h.

 {
   return m_localParams;
 }

◆ numberOfInstantiations()

static std::size_t Trk::ObjectCounter< Trk::RIO_OnTrack >::numberOfInstantiations ( )

inlinestaticinherited

Definition at line 25 of file TrkObjectCounter.h.

   {
 #ifndef NDEBUG
     return s_numberOfInstantiations.load();
 #endif
     return 0;
   }

◆ operator=() [1/2]

MMClusterOnTrack& Muon::MMClusterOnTrack::operator= ( const MMClusterOnTrack & )

default

◆ operator=() [2/2]

MMClusterOnTrack& Muon::MMClusterOnTrack::operator= ( MMClusterOnTrack && )

default

◆ positionAlongStrip()

virtual double Muon::MuonClusterOnTrack::positionAlongStrip ( ) const

inlinevirtualinherited

Definition at line 68 of file MuonClusterOnTrack.h.

                                               {
       return m_positionAlongStrip;
     }

◆ prepRawData()

const MMPrepData * Muon::MMClusterOnTrack::prepRawData ( ) const

inlinevirtual

Returns the MMPrepData - is a TRT_DriftCircle in this scope.

Implements Muon::MuonClusterOnTrack.

Definition at line 128 of file MMClusterOnTrack.h.

   {
     if (m_rio.isValid()) return m_rio.cachedElement();
     else return nullptr;
   }

◆ prepRawDataLink()

const ElementLinkToIDC_MM_Container & Muon::MMClusterOnTrack::prepRawDataLink ( ) const

inline

Definition at line 134 of file MMClusterOnTrack.h.

   {
     return m_rio;
   }

◆ rioType()

virtual bool Muon::MuonClusterOnTrack::rioType ( Trk::RIO_OnTrackType::Type type ) const

inlinefinaloverridevirtualinherited

Method checking the Rio On Track type.

Implements Trk::RIO_OnTrack.

Definition at line 78 of file MuonClusterOnTrack.h.

     {
       return (type == Trk::RIO_OnTrackType::MuonCluster);
     }

◆ setAuthor()

void Muon::MMClusterOnTrack::setAuthor ( Author a )

inline

Definition at line 119 of file MMClusterOnTrack.h.

                                                   {
       m_author = a;
   }

◆ setValues()

void Muon::MMClusterOnTrack::setValues	(	const Trk::TrkDetElementBase *	detEl,
		const Trk::PrepRawData *
	)

inlineprivatevirtual

Sets the DetElement and Trk::PrepRawData pointers after reading from disk.

Warning: Only intended for use by persistency convertors.

Todo:: Throw exception if TrkDetElementBase isn't correct concrete type

Implements Muon::MuonClusterOnTrack.

Definition at line 161 of file MMClusterOnTrack.h.

   {
     // m_rio = dynamic_cast<const MMPrepData*>(rio);
     //assert(0!=m_rio);
     m_detEl = dynamic_cast<const MuonGM::MMReadoutElement*>(detEl);
     assert(0!=m_detEl);
   }

◆ stripDriftDistErrors()

const std::vector< Amg::MatrixX > & Muon::MMClusterOnTrack::stripDriftDistErrors ( ) const

inline

Definition at line 155 of file MMClusterOnTrack.h.

   {
     return m_stripDriftDistErrors;
   }

◆ stripDriftDists()

const std::vector< float > & Muon::MMClusterOnTrack::stripDriftDists ( ) const

inline

Definition at line 150 of file MMClusterOnTrack.h.

   {
     return m_stripDriftDists;
   }

◆ type()

virtual bool Trk::RIO_OnTrack::type ( MeasurementBaseType::Type type ) const

inlinefinaloverridevirtualinherited

Extended method checking the type.

Implements Trk::MeasurementBase.

Definition at line 110 of file RIO_OnTrack.h.

       {
         return (type == MeasurementBaseType::RIO_OnTrack);
       }

◆ uniqueClone()

std::unique_ptr<RIO_OnTrack> Trk::RIO_OnTrack::uniqueClone ( ) const

inlineinherited

NVI clone returning unique_ptr.

Definition at line 97 of file RIO_OnTrack.h.

                                                     {
        return std::unique_ptr<RIO_OnTrack>(clone());
       };

Friends And Related Function Documentation

◆ Trk::ITrkEventCnvTool

friend class Trk::ITrkEventCnvTool

friend

Definition at line 29 of file MMClusterOnTrack.h.

Member Data Documentation

◆ m_author

Author Muon::MMClusterOnTrack::m_author {Author::unKnownAuthor}

private

Definition at line 112 of file MMClusterOnTrack.h.

◆ m_detEl

const MuonGM::MMReadoutElement* Muon::MMClusterOnTrack::m_detEl {nullptr}

private

The detector element, assoicated with this measurement.

Definition at line 108 of file MMClusterOnTrack.h.

◆ m_globalPosition

CxxUtils::CachedUniquePtr<const Amg::Vector3D> Muon::MuonClusterOnTrack::m_globalPosition

protectedinherited

cache global position, the global position has to be calculated in the inheriting classes

Definition at line 94 of file MuonClusterOnTrack.h.

◆ m_identifier

Identifier Trk::RIO_OnTrack::m_identifier {}

protectedinherited

Identifier of the RIO_OnTrack (comes from the associated Trk::PrepRawData)

Definition at line 149 of file RIO_OnTrack.h.

◆ m_localCovariance

Amg::MatrixX Trk::MeasurementBase::m_localCovariance

protectedinherited

Definition at line 112 of file MeasurementBase.h.

◆ m_localParams

LocalParameters Trk::MeasurementBase::m_localParams

protectedinherited

Definition at line 111 of file MeasurementBase.h.

◆ m_positionAlongStrip

double Muon::MuonClusterOnTrack::m_positionAlongStrip

protectedinherited

The position along the strip - used to calculate the GlobalPosition.

Definition at line 97 of file MuonClusterOnTrack.h.

◆ m_rio

ElementLinkToIDC_MM_Container Muon::MMClusterOnTrack::m_rio {}

private

PrepRawData object assoicated with this measurement.

Definition at line 105 of file MMClusterOnTrack.h.

◆ m_stripDriftDistErrors

std::vector<Amg::MatrixX> Muon::MMClusterOnTrack::m_stripDriftDistErrors {}

private

Definition at line 111 of file MMClusterOnTrack.h.

◆ m_stripDriftDists

std::vector<float> Muon::MMClusterOnTrack::m_stripDriftDists {}

private

Definition at line 110 of file MMClusterOnTrack.h.

◆ s_numberOfInstantiations

std::atomic_size_t Trk::ObjectCounter< Trk::RIO_OnTrack >::s_numberOfInstantiations

inlinestaticinherited

Definition at line 22 of file TrkObjectCounter.h.

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Enumeration Documentation

◆ Author

Constructor & Destructor Documentation

◆ MMClusterOnTrack() [1/5]

◆ MMClusterOnTrack() [2/5]

◆ MMClusterOnTrack() [3/5]

◆ MMClusterOnTrack() [4/5]

◆ MMClusterOnTrack() [5/5]

◆ ~MMClusterOnTrack()

Member Function Documentation

◆ associatedSurface()

◆ author()

◆ clone()

◆ collectionHash()

◆ detectorElement()

◆ dump() [1/2]

◆ dump() [2/2]

◆ globalPosition()

◆ idDE()

◆ identify()

◆ localCovariance()

◆ localParameters()

◆ numberOfInstantiations()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ positionAlongStrip()

◆ prepRawData()

◆ prepRawDataLink()

◆ rioType()

◆ setAuthor()

◆ setValues()

◆ stripDriftDistErrors()

◆ stripDriftDists()

◆ type()

◆ uniqueClone()

Friends And Related Function Documentation

◆ Trk::ITrkEventCnvTool

Member Data Documentation

◆ m_author

◆ m_detEl

◆ m_globalPosition

◆ m_identifier

◆ m_localCovariance

◆ m_localParams

◆ m_positionAlongStrip

◆ m_rio

◆ m_stripDriftDistErrors

◆ m_stripDriftDists

◆ s_numberOfInstantiations