Base class for Muon cluster RIO_OnTracks. More...

#include <MuonClusterOnTrack.h>

Inheritance diagram for Muon::MuonClusterOnTrack:

Collaboration diagram for Muon::MuonClusterOnTrack:

Public Member Functions
	MuonClusterOnTrack ()
	Pool constructor. More...

	MuonClusterOnTrack (Trk::LocalParameters &&locpos, Amg::MatrixX &&locerr, const Identifier &id, const double positionAlongStrip)
	Constructor with parameters. More...

	MuonClusterOnTrack (const MuonClusterOnTrack &)

MuonClusterOnTrack &	operator= (const MuonClusterOnTrack &)

virtual	~MuonClusterOnTrack ()
	Destructor. More...

virtual MuonClusterOnTrack *	clone () const override=0
	Clone this ROT. More...

virtual const MuonCluster *	prepRawData () const override=0
	Returns the Trk::PrepRawData - is a MuonCluster in this scope. More...

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

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

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

virtual const MuonGM::MuonClusterReadoutElement *	detectorElement () const override=0
	Returns the detector element, associated with the PRD of this class. More...

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

virtual const Surface &	associatedSurface () const override=0
	returns the surface for the local to global transformation 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 ) override=0
	Used by custom convertors. More...

Friends
class	::MuonClusterOnTrackCnv_p1

Detailed Description

Base class for Muon cluster RIO_OnTracks.

Definition at line 34 of file MuonClusterOnTrack.h.

Constructor & Destructor Documentation

◆ MuonClusterOnTrack() [1/3]

Muon::MuonClusterOnTrack::MuonClusterOnTrack ( )

Pool constructor.

Definition at line 22 of file MuonClusterOnTrack.cxx.

                                       :
     Trk::RIO_OnTrack(),
     m_globalPosition(),
     m_positionAlongStrip(0)
 { }

◆ MuonClusterOnTrack() [2/3]

Muon::MuonClusterOnTrack::MuonClusterOnTrack	(	Trk::LocalParameters &&	locpos,
		Amg::MatrixX &&	locerr,
		const Identifier &	id,
		const double	positionAlongStrip
	)

Constructor with parameters.

Definition at line 39 of file MuonClusterOnTrack.cxx.

     : RIO_OnTrack(std::move(locpos), std::move(locerr), id),  // call base class constructor
       m_globalPosition(),
       m_positionAlongStrip(positionAlongStrip) {}

◆ MuonClusterOnTrack() [3/3]

Muon::MuonClusterOnTrack::MuonClusterOnTrack ( const MuonClusterOnTrack & rot )

Definition at line 29 of file MuonClusterOnTrack.cxx.

                                                                        :
     Trk::RIO_OnTrack(rot),
     m_globalPosition()
 {
   m_positionAlongStrip = rot.m_positionAlongStrip;
   if (rot.m_globalPosition) m_globalPosition.store(std::make_unique<const Amg::Vector3D>(*rot.m_globalPosition));
 }

◆ ~MuonClusterOnTrack()

Muon::MuonClusterOnTrack::~MuonClusterOnTrack ( )

virtualdefault

Destructor.

Member Function Documentation

◆ associatedSurface()

virtual const Surface& Trk::RIO_OnTrack::associatedSurface ( ) const

overridepure virtualinherited

returns the surface for the local to global transformation

interface from MeasurementBase

Implements Trk::MeasurementBase.

Implemented in Muon::MdtDriftCircleOnTrack, InDet::PixelClusterOnTrack, Muon::CscClusterOnTrack, InDet::TRT_DriftCircleOnTrack, InDet::SCT_ClusterOnTrack, Muon::RpcClusterOnTrack, HGTD_ClusterOnTrack, Muon::sTgcClusterOnTrack, Muon::TgcClusterOnTrack, and Muon::MMClusterOnTrack.

◆ clone()

virtual MuonClusterOnTrack* Muon::MuonClusterOnTrack::clone ( ) const

overridepure virtual

Clone this ROT.

Implements Trk::RIO_OnTrack.

Implemented in Muon::CscClusterOnTrack, Muon::RpcClusterOnTrack, Muon::sTgcClusterOnTrack, Muon::TgcClusterOnTrack, and Muon::MMClusterOnTrack.

◆ collectionHash()

IdentifierHash Muon::MuonClusterOnTrack::collectionHash ( ) const

inlinevirtual

Returns the hashID of the PRD collection.

Definition at line 111 of file MuonClusterOnTrack.h.

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

◆ detectorElement()

virtual const MuonGM::MuonClusterReadoutElement* Muon::MuonClusterOnTrack::detectorElement ( ) const

overridepure virtual

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

Implements Trk::RIO_OnTrack.

Implemented in Muon::CscClusterOnTrack, Muon::RpcClusterOnTrack, Muon::sTgcClusterOnTrack, Muon::TgcClusterOnTrack, and Muon::MMClusterOnTrack.

◆ dump() [1/2]

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

overridevirtual

Dumps information about the PRD.

Reimplemented from Trk::RIO_OnTrack.

Reimplemented in Muon::CscClusterOnTrack, Muon::RpcClusterOnTrack, Muon::sTgcClusterOnTrack, Muon::TgcClusterOnTrack, and Muon::MMClusterOnTrack.

Definition at line 62 of file MuonClusterOnTrack.cxx.

 {
   stream << MSG::INFO<<"MuonClusterOnTrack {"<<std::endl;
  
   Trk::RIO_OnTrack::dump(stream);
  
   stream << "Global position (x,y,z) = (";
   stream  <<this->globalPosition().x()<<", "
           <<this->globalPosition().y()<<", "
           <<this->globalPosition().z()<<")"<<std::endl;
   stream << "Position along strip: "<<m_positionAlongStrip<<std::endl;
   stream<<"}"<<endmsg;
   return stream;
 }

◆ dump() [2/2]

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

overridevirtual

Dumps information about the PRD.

Reimplemented from Trk::RIO_OnTrack.

Reimplemented in Muon::CscClusterOnTrack, Muon::RpcClusterOnTrack, Muon::sTgcClusterOnTrack, Muon::TgcClusterOnTrack, and Muon::MMClusterOnTrack.

Definition at line 77 of file MuonClusterOnTrack.cxx.

 {
   stream << "MuonClusterOnTrack {"<<std::endl;
   std::ios_base::fmtflags originalFormat = stream.flags();
  
   Trk::RIO_OnTrack::dump(stream);
  
   stream << std::setiosflags(std::ios::fixed)<< std::setprecision(3);
  
   stream << "Position along strip: "<<m_positionAlongStrip<<std::endl;
   stream<<"}"<<std::endl;
   stream.flags( originalFormat );
  
   return stream;
 }

◆ globalPosition()

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

overridevirtual

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

inlineoverridevirtual

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=()

MuonClusterOnTrack & Muon::MuonClusterOnTrack::operator= ( const MuonClusterOnTrack & rot )

Definition at line 52 of file MuonClusterOnTrack.cxx.

                                                                                {
   if ( &rot != this) {
     Trk::RIO_OnTrack::operator=(rot);//base class ass. op.
     m_positionAlongStrip = rot.m_positionAlongStrip;
     if (rot.m_globalPosition) m_globalPosition.store(std::make_unique<const Amg::Vector3D>(*rot.m_globalPosition));
     else if (m_globalPosition) m_globalPosition.release().reset();
   }
   return *this;
 }

◆ positionAlongStrip()

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

inlinevirtual

Definition at line 68 of file MuonClusterOnTrack.h.

                                               {
       return m_positionAlongStrip;
     }

◆ prepRawData()

virtual const MuonCluster* Muon::MuonClusterOnTrack::prepRawData ( ) const

overridepure virtual

Returns the Trk::PrepRawData - is a MuonCluster in this scope.

Implements Trk::RIO_OnTrack.

Implemented in Muon::CscClusterOnTrack, Muon::RpcClusterOnTrack, Muon::sTgcClusterOnTrack, Muon::TgcClusterOnTrack, and Muon::MMClusterOnTrack.

◆ rioType()

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

inlinefinaloverridevirtual

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);
     }

◆ setValues()

virtual void Muon::MuonClusterOnTrack::setValues	(	const Trk::TrkDetElementBase *	,
		const Trk::PrepRawData *
	)

overrideprivatepure virtual

Used by custom convertors.

Implements Trk::RIO_OnTrack.

Implemented in Muon::CscClusterOnTrack, Muon::RpcClusterOnTrack, Muon::sTgcClusterOnTrack, Muon::TgcClusterOnTrack, and Muon::MMClusterOnTrack.

◆ 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

◆ ::MuonClusterOnTrackCnv_p1

friend class ::MuonClusterOnTrackCnv_p1

friend

Definition at line 100 of file MuonClusterOnTrack.h.

Member Data Documentation

◆ m_globalPosition

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

protected

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

protected

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

Definition at line 97 of file MuonClusterOnTrack.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 Member Functions

Static Public Member Functions

Static Public Attributes

Protected Attributes

Private Member Functions

Friends

Detailed Description

Constructor & Destructor Documentation

◆ MuonClusterOnTrack() [1/3]

◆ MuonClusterOnTrack() [2/3]

◆ MuonClusterOnTrack() [3/3]

◆ ~MuonClusterOnTrack()

Member Function Documentation

◆ associatedSurface()

◆ clone()

◆ collectionHash()

◆ detectorElement()

◆ dump() [1/2]

◆ dump() [2/2]

◆ globalPosition()

◆ idDE()

◆ identify()

◆ localCovariance()

◆ localParameters()

◆ numberOfInstantiations()

◆ operator=()

◆ positionAlongStrip()

◆ prepRawData()

◆ rioType()

◆ setValues()

◆ type()

◆ uniqueClone()

Friends And Related Function Documentation

◆ ::MuonClusterOnTrackCnv_p1

Member Data Documentation

◆ m_globalPosition

◆ m_identifier

◆ m_localCovariance

◆ m_localParams

◆ m_positionAlongStrip

◆ s_numberOfInstantiations