Muon::CscClusterOnTrack Class Reference

Class to represent the calibrated clusters created from CSC strips. More...

#include <CscClusterOnTrack.h>

Inheritance diagram for Muon::CscClusterOnTrack:

Collaboration diagram for Muon::CscClusterOnTrack:

Public Member Functions
	CscClusterOnTrack ()
	CscClusterOnTrack (const CscClusterOnTrack &)
CscClusterOnTrack &	operator= (const CscClusterOnTrack &)
	CscClusterOnTrack (const CscPrepData *RIO, Trk::LocalParameters &&locpos, Amg::MatrixX &&locerr, double positionAlongStrip, CscClusterStatus status, CscTimeStatus timeStatus=Muon::CscTimeStatusUndefined, float time=9999.0)
	Constructor with parameters : The base class owns local position, error matrix.
	CscClusterOnTrack (const ElementLinkToIDC_CSC_Container &RIO, Trk::LocalParameters &&locpos, Amg::MatrixX &&locerr, const Identifier &id, const MuonGM::CscReadoutElement *detEL, double positionAlongStrip, CscClusterStatus status, CscTimeStatus timeStatus=Muon::CscTimeStatusUndefined, float time=9999.0)
virtual	~CscClusterOnTrack ()
	Destructor.
virtual CscClusterOnTrack *	clone () const override final
	Clone this ROT.
virtual const CscPrepData *	prepRawData () const override final
	Returns the CscPrepData - is a CscPrepData in this scope.
const ElementLinkToIDC_CSC_Container &	prepRawDataLink () const
virtual const MuonGM::CscReadoutElement *	detectorElement () const override final
	Returns the detector element, associated with the PRD of this class.
virtual const Trk::Surface &	associatedSurface () const override final
	Returns the surface on which this measurement was taken.
CscClusterStatus	status () const
	Returns Csc position measurement status flag.
CscTimeStatus	timeStatus () const
	Returns Csc time measurement status flag.
float	time () const
	Return the time(ns)
virtual MsgStream &	dump (MsgStream &stream) const override final
	Dumps information about the PRD.
virtual std::ostream &	dump (std::ostream &stream) const override final
	Dumps information about the PRD.
virtual const Amg::Vector3D &	globalPosition () const override
	Returns global position.
virtual double	positionAlongStrip () const
virtual IdentifierHash	collectionHash () const
	Returns the hashID of the PRD collection.
virtual IdentifierHash	idDE () const override
	Returns an invalid hash.
virtual bool	rioType (Trk::RIO_OnTrackType::Type type) const override final
	Method checking the Rio On Track type.
std::unique_ptr< RIO_OnTrack >	uniqueClone () const
	NVI clone returning unique_ptr.
virtual bool	type (MeasurementBaseType::Type type) const override final
	Extended method checking the type.
Identifier	identify () const
	return the identifier -extends MeasurementBase
const LocalParameters &	localParameters () const
	Interface method to get the LocalParameters.
const Amg::MatrixX &	localCovariance () const
	Interface method to get the localError.

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
double	m_positionAlongStrip
	The position along the strip - used to calculate the GlobalPosition.
Identifier	m_identifier {}
	Identifier of the RIO_OnTrack (comes from the associated Trk::PrepRawData)
LocalParameters	m_localParams
Amg::MatrixX	m_localCovariance

Private Member Functions
virtual void	setValues (const Trk::TrkDetElementBase *, const Trk::PrepRawData *) override final
	this method is only used by the custom convertors.

Private Attributes
ElementLinkToIDC_CSC_Container	m_rio
	PrepRawData object assoicated with this measurement.
const MuonGM::CscReadoutElement *	m_detEl
	The detector element, associated with this measurement.
CscClusterStatus	m_status
	cluster position measurement status
CscTimeStatus	m_timeStatus
	cluster time measurement status
float	m_time

Friends
class	Trk::ITrkEventCnvTool

Detailed Description

Class to represent the calibrated clusters created from CSC strips.

Definition at line 46 of file CscClusterOnTrack.h.

Constructor & Destructor Documentation

CscClusterOnTrack() [1/4]

Muon::CscClusterOnTrack::CscClusterOnTrack

(

)

Definition at line 22 of file CscClusterOnTrack.cxx.

                                      :
    MuonClusterOnTrack(), // call base class ctor
    m_rio(),
    m_detEl(nullptr),
    m_status(CscStatusUndefined),
    m_timeStatus(CscTimeStatusUndefined),
    m_time(9999.0)
  {}

CscClusterOnTrack() [2/4]

Muon::CscClusterOnTrack::CscClusterOnTrack ( const CscClusterOnTrack & )

default

CscClusterOnTrack() [3/4]

Muon::CscClusterOnTrack::CscClusterOnTrack	(	const CscPrepData *	RIO,
		Trk::LocalParameters &&	locpos,
		Amg::MatrixX &&	locerr,
		double	positionAlongStrip,
		CscClusterStatus	status,
		CscTimeStatus	timeStatus = Muon::CscTimeStatusUndefined,
		float	time = 9999.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.
[in]	status	Required Measure of 'quality' of cluster - see CscClusterStatus for more info.
[in]	time	Required

Definition at line 35 of file CscClusterOnTrack.cxx.

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

CscClusterOnTrack() [4/4]

Muon::CscClusterOnTrack::CscClusterOnTrack	(	const ElementLinkToIDC_CSC_Container &	RIO,
		Trk::LocalParameters &&	locpos,
		Amg::MatrixX &&	locerr,
		const Identifier &	id,
		const MuonGM::CscReadoutElement *	detEL,
		double	positionAlongStrip,
		CscClusterStatus	status,
		CscTimeStatus	timeStatus = Muon::CscTimeStatusUndefined,
		float	time = 9999.0 )

Definition at line 54 of file CscClusterOnTrack.cxx.

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

~CscClusterOnTrack()

Muon::CscClusterOnTrack::~CscClusterOnTrack ( )

virtualdefault

Destructor.

Member Function Documentation

associatedSurface()

const Trk::Surface & Muon::CscClusterOnTrack::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 172 of file CscClusterOnTrack.h.

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

clone()

CscClusterOnTrack * Muon::CscClusterOnTrack::clone ( ) const

inlinefinaloverridevirtual

Clone this ROT.

Implements Muon::MuonClusterOnTrack.

Definition at line 149 of file CscClusterOnTrack.h.

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

inlinefinaloverridevirtual

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

Implements Muon::MuonClusterOnTrack.

Definition at line 167 of file CscClusterOnTrack.h.

{
    return m_detEl;
}

dump() [1/2]

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

finaloverridevirtual

Dumps information about the PRD.

Reimplemented from Muon::MuonClusterOnTrack.

Definition at line 92 of file CscClusterOnTrack.cxx.

  {
    stream << MSG::INFO<<"CscClusterOnTrack {"<<std::endl;
    stream <<"Time: "<<m_time<<std::endl;
    stream <<"Status: "<<m_status<<std::endl;
    stream <<"TimeStatus: "<<m_timeStatus<<std::endl;
 
    MuonClusterOnTrack::dump(stream);
 
    stream << "Cluster Status: "<<toString(m_status)<<std::endl;
    stream << "Cluster Time Status: "<<toString(m_timeStatus)<<std::endl;
 
    stream<<"}"<<endmsg;
    return stream;
  }

dump() [2/2]

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

finaloverridevirtual

Dumps information about the PRD.

Reimplemented from Muon::MuonClusterOnTrack.

Definition at line 108 of file CscClusterOnTrack.cxx.

  {
    stream << "CscClusterOnTrack {"<<std::endl;
    stream <<"Time: "<<m_time<<std::endl;
    stream <<"Status: "<<m_status<<std::endl;
    stream <<"TimeStatus: "<<m_timeStatus<<std::endl;
 
    MuonClusterOnTrack::dump(stream);
 
    stream << "Cluster Status: "<<toString(m_status)<<std::endl;
    stream << "Cluster Time Status: "<<toString(m_timeStatus)<<std::endl;
 
    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()

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

CscClusterOnTrack & Muon::CscClusterOnTrack::operator=

(

const CscClusterOnTrack &

rot

)

Definition at line 78 of file CscClusterOnTrack.cxx.

  {
    if ( &rot != this)
      {
        MuonClusterOnTrack::operator=(rot);//base class ass. op.
        m_rio = rot.m_rio;
        m_detEl = rot.m_detEl;
        m_status = rot.m_status;
        m_timeStatus = rot.m_timeStatus;
        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 CscPrepData * Muon::CscClusterOnTrack::prepRawData ( ) const

inlinefinaloverridevirtual

Returns the CscPrepData - is a CscPrepData in this scope.

Implements Muon::MuonClusterOnTrack.

Definition at line 154 of file CscClusterOnTrack.h.

{
    if (m_rio.isValid()) return m_rio.cachedElement();
    //std::cout<<"CscClusterOnTrack::WARNING invalid PRD"<<std::endl;
    return 0;
}

prepRawDataLink()

const ElementLinkToIDC_CSC_Container & Muon::CscClusterOnTrack::prepRawDataLink ( ) const

inline

Definition at line 162 of file CscClusterOnTrack.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::CscClusterOnTrack::setValues ( const Trk::TrkDetElementBase * detEl, const Trk::PrepRawData *  )

inlinefinaloverrideprivatevirtual

this method is only used by the custom convertors.

Warning

At the moment it only actually sets the CscPrepData, since that's all that's stored

Todo

Throw exception if TrkDetElementBase isn't correct concrete type

Implements Muon::MuonClusterOnTrack.

Definition at line 193 of file CscClusterOnTrack.h.

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

status()

CscClusterStatus Muon::CscClusterOnTrack::status ( ) const

inline

Returns Csc position measurement status flag.

Definition at line 178 of file CscClusterOnTrack.h.

{
  return m_status;
}

time()

float Muon::CscClusterOnTrack::time ( ) const

inline

Return the time(ns)

Definition at line 188 of file CscClusterOnTrack.h.

{
    return m_time;
}

timeStatus()

CscTimeStatus Muon::CscClusterOnTrack::timeStatus ( ) const

inline

Returns Csc time measurement status flag.

Definition at line 183 of file CscClusterOnTrack.h.

{
  return m_timeStatus;
}

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 Symbol Documentation

Trk::ITrkEventCnvTool

friend class Trk::ITrkEventCnvTool

friend

Definition at line 50 of file CscClusterOnTrack.h.

Member Data Documentation

m_detEl

const MuonGM::CscReadoutElement* Muon::CscClusterOnTrack::m_detEl

private

The detector element, associated with this measurement.

Definition at line 133 of file CscClusterOnTrack.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_CSC_Container Muon::CscClusterOnTrack::m_rio

private

PrepRawData object assoicated with this measurement.

Definition at line 130 of file CscClusterOnTrack.h.

m_status

CscClusterStatus Muon::CscClusterOnTrack::m_status

private

cluster position measurement status

Definition at line 136 of file CscClusterOnTrack.h.

m_time

float Muon::CscClusterOnTrack::m_time

private

Definition at line 141 of file CscClusterOnTrack.h.

m_timeStatus

CscTimeStatus Muon::CscClusterOnTrack::m_timeStatus

private

cluster time measurement status

Definition at line 139 of file CscClusterOnTrack.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:

• CscClusterOnTrack.h
• CscClusterOnTrack.cxx