Muon::RpcClusterOnTrack Class Reference

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

#include <RpcClusterOnTrack.h>

Inheritance diagram for Muon::RpcClusterOnTrack:

Collaboration diagram for Muon::RpcClusterOnTrack:

Public Member Functions
	RpcClusterOnTrack ()
	RpcClusterOnTrack (const RpcClusterOnTrack &)
RpcClusterOnTrack &	operator= (const RpcClusterOnTrack &)
	RpcClusterOnTrack (const RpcPrepData *RIO, Trk::LocalParameters &&locpos, Amg::MatrixX &&locerr, double positionAlongStrip, float time=0.0)
	Constructor with parameters : The base class owns local position, error matrix. More...
	RpcClusterOnTrack (const ElementLinkToIDC_RPC_Container &RIO, Trk::LocalParameters &&locpos, Amg::MatrixX &&locerr, const Identifier &id, const MuonGM::RpcReadoutElement *detEl, double positionAlongStrip, float time)
virtual	~RpcClusterOnTrack ()
	Destructor. More...
virtual RpcClusterOnTrack *	clone () const override final
	Clone this ROT. More...
virtual const RpcPrepData *	prepRawData () const override final
	Returns the RpcPrepData - is a TRT_DriftCircle in this scope. More...
const ElementLinkToIDC_RPC_Container &	prepRawDataLink () const
virtual const MuonGM::RpcReadoutElement *	detectorElement () const override final
	Returns the detector element, assoicated with the PRD of this class. More...
virtual const Trk::Surface &	associatedSurface () const override final
	Returns the surface on which this measurement was taken. More...
float	time () const
	Return the time (ns) More...
virtual MsgStream &	dump (MsgStream &stream) const override final
	Dumps information about the PRD. More...
virtual std::ostream &	dump (std::ostream &stream) const override final
	Dumps information about the PRD. 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...
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 *) override final
	Sets the DetElement and Trk::PrepRawData pointers after reading from disk. More...

Private Attributes
ElementLinkToIDC_RPC_Container	m_rio
	PrepRawData object assoicated with this measurement. More...
const MuonGM::RpcReadoutElement *	m_detEl
	The detector element, assoicated with this measurement. More...
float	m_time
	The time in ns. More...

Friends
class	Trk::ITrkEventCnvTool
class	::RpcClusterOnTrackCnv_p1

Detailed Description

Class to represent calibrated clusters formed from RPC strips.

Definition at line 34 of file RpcClusterOnTrack.h.

Constructor & Destructor Documentation

RpcClusterOnTrack() [1/4]

Muon::RpcClusterOnTrack::RpcClusterOnTrack

(

)

Definition at line 22 of file RpcClusterOnTrack.cxx.

    :
    MuonClusterOnTrack(), // call base class ctor
   m_rio(),
    m_detEl(nullptr),
    m_time(0.0)
{}

RpcClusterOnTrack() [2/4]

Muon::RpcClusterOnTrack::RpcClusterOnTrack ( const RpcClusterOnTrack &  )

default

RpcClusterOnTrack() [3/4]

Muon::RpcClusterOnTrack::RpcClusterOnTrack	(	const RpcPrepData *	RIO,
		Trk::LocalParameters &&	locpos,
		Amg::MatrixX &&	locerr,
		double	positionAlongStrip,
		float	time = 0.0
	)

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 35 of file RpcClusterOnTrack.cxx.

    :
    MuonClusterOnTrack(std::move(locpos), std::move(locerr), RIO->identify(), positionAlongStrip ), //call base class constructor
    m_detEl( RIO->detectorElement() ),
    m_time(time)
{
    //Set EL
    // m_rio = ElementLinkToIDC_RPC_Container("RPC_Measurements", RIO->getHashAndIndex().hashAndIndex(), RIO);
    m_rio.setElement(RIO);
 }

RpcClusterOnTrack() [4/4]

Muon::RpcClusterOnTrack::RpcClusterOnTrack	(	const ElementLinkToIDC_RPC_Container &	RIO,
		Trk::LocalParameters &&	locpos,
		Amg::MatrixX &&	locerr,
		const Identifier &	id,
		const MuonGM::RpcReadoutElement *	detEl,
		double	positionAlongStrip,
		float	time
	)

Definition at line 52 of file RpcClusterOnTrack.cxx.

    :
    MuonClusterOnTrack(std::move(locpos), std::move(locerr), id, positionAlongStrip ), //call base class constructor
    m_rio (RIO),
    m_detEl( detEl ),
    m_time(time)
{
}

~RpcClusterOnTrack()

Muon::RpcClusterOnTrack::~RpcClusterOnTrack ( )

virtual

Destructor.

Definition at line 69 of file RpcClusterOnTrack.cxx.

{
    // we don't own the m_rio object (it belongs to SG), so don't delete it.
}

Member Function Documentation

associatedSurface()

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

inlinefinaloverridevirtual

Returns the surface on which this measurement was taken.

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

Implements Trk::RIO_OnTrack.

Definition at line 143 of file RpcClusterOnTrack.h.

{
    // FIXME! This will crash if detectorElement() returns 0! EJWM
    return detectorElement()->surface(identify());
}

clone()

RpcClusterOnTrack * Muon::RpcClusterOnTrack::clone ( ) const

inlinefinaloverridevirtual

Clone this ROT.

Implements Muon::MuonClusterOnTrack.

Definition at line 122 of file RpcClusterOnTrack.h.

{
    return new RpcClusterOnTrack(*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::RpcReadoutElement * Muon::RpcClusterOnTrack::detectorElement ( ) const

inlinefinaloverridevirtual

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

Implements Muon::MuonClusterOnTrack.

Definition at line 138 of file RpcClusterOnTrack.h.

{
  return m_detEl;
}

dump() [1/2]

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

finaloverridevirtual

Dumps information about the PRD.

Reimplemented from Muon::MuonClusterOnTrack.

Definition at line 87 of file RpcClusterOnTrack.cxx.

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

dump() [2/2]

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

finaloverridevirtual

Dumps information about the PRD.

Reimplemented from Muon::MuonClusterOnTrack.

Definition at line 97 of file RpcClusterOnTrack.cxx.

{
  stream << "RpcClusterOnTrack {"<<std::endl;
  stream <<"Time: "<<m_time<<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.

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

RpcClusterOnTrack & Muon::RpcClusterOnTrack::operator=

(

const RpcClusterOnTrack &

rot

)

Definition at line 75 of file RpcClusterOnTrack.cxx.

{
    if ( &rot != this)
    {
        MuonClusterOnTrack::operator=(rot);//base class ass. op.
        m_rio = rot.m_rio;
        m_detEl = rot.m_detEl;
        m_time = rot.m_time;
    }
    return *this;
}

positionAlongStrip()

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

inlinevirtualinherited

Definition at line 68 of file MuonClusterOnTrack.h.

                                              {
      return m_positionAlongStrip;
    }

prepRawData()

const RpcPrepData * Muon::RpcClusterOnTrack::prepRawData ( ) const

inlinefinaloverridevirtual

Returns the RpcPrepData - is a TRT_DriftCircle in this scope.

Implements Muon::MuonClusterOnTrack.

Definition at line 127 of file RpcClusterOnTrack.h.

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

prepRawDataLink()

const ElementLinkToIDC_RPC_Container & Muon::RpcClusterOnTrack::prepRawDataLink ( ) const

inline

Definition at line 133 of file RpcClusterOnTrack.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);
    }

setValues()

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

inlinefinaloverrideprivatevirtual

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 149 of file RpcClusterOnTrack.h.

{
    // TODO should check this works EJWM
    //m_rio = dynamic_cast<const RpcPrepData*>(rio);
    //assert(0!=m_rio);
    m_detEl = dynamic_cast<const MuonGM::RpcReadoutElement*>(detEl);
    assert(0!=m_detEl);
}

time()

float Muon::RpcClusterOnTrack::time ( ) const

inline

Return the time (ns)

Definition at line 159 of file RpcClusterOnTrack.h.

{
    return m_time;
}

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

::RpcClusterOnTrackCnv_p1

friend class ::RpcClusterOnTrackCnv_p1

friend

Definition at line 40 of file RpcClusterOnTrack.h.

Trk::ITrkEventCnvTool

friend class Trk::ITrkEventCnvTool

friend

Definition at line 39 of file RpcClusterOnTrack.h.

Member Data Documentation

m_detEl

const MuonGM::RpcReadoutElement* Muon::RpcClusterOnTrack::m_detEl

private

The detector element, assoicated with this measurement.

Definition at line 111 of file RpcClusterOnTrack.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_RPC_Container Muon::RpcClusterOnTrack::m_rio

private

PrepRawData object assoicated with this measurement.

Definition at line 108 of file RpcClusterOnTrack.h.

m_time

float Muon::RpcClusterOnTrack::m_time

private

The time in ns.

Definition at line 114 of file RpcClusterOnTrack.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:

• RpcClusterOnTrack.h
• RpcClusterOnTrack.cxx