Class to represent measurements from the Monitored Drift Tubes. More...

#include <MdtPrepData.h>

Inheritance diagram for Muon::MdtPrepData:

Collaboration diagram for Muon::MdtPrepData:

Public Member Functions
	MdtPrepData ()

	MdtPrepData (const MdtPrepData &)

	MdtPrepData (MdtPrepData &&) noexcept

MdtPrepData &	operator= (const MdtPrepData &)

MdtPrepData &	operator= (MdtPrepData &&) noexcept

	MdtPrepData (const Identifier &id, const Amg::Vector2D &driftRadius, const Amg::MatrixX &errDriftRadius, const MuonGM::MdtReadoutElement *detEl, const int tdc, const int adc, const MdtDriftCircleStatus status)
	Constructor with parameters: this class owns the pointers passed (except the MuonDetectorElement) More...

virtual	~MdtPrepData ()
	Destructor. More...

virtual const Amg::Vector3D &	globalPosition () const
	Returns the global position of the CENTER of the drift tube (i.e. More...

virtual const MuonGM::MdtReadoutElement *	detectorElement () const override
	Returns the detector element corresponding to this PRD. More...

virtual bool	type (Trk::PrepRawDataType type) const override
	Interface method checking the type. More...

unsigned int	dimension () const
	Returns the dimension of the MdtPrepData. More...

int	tdc () const
	Returns the TDC (typically range is 0 to 2500). More...

int	adc () const
	Returns the ADC (typically range is 0 to 250) More...

MdtDriftCircleStatus	status () const
	Returns the status of the measurement. More...

virtual IdentifierHash	collectionHash () const
	Returns the IdentifierHash corresponding to the Mdt tube which was hit. 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...

Identifier	identify () const
	return the identifier More...

const Amg::Vector2D &	localPosition () const
	return the local position reference More...

const std::vector< Identifier > &	rdoList () const
	return the List of rdo identifiers (pointers) More...

const Amg::MatrixX &	localCovariance () const
	return const ref to the error matrix More...

bool	hasLocalCovariance () const
	returns localCovariance().size()!=0 More...

void	setHashAndIndex (unsigned short collHash, unsigned short objIndex)
	TEMP for testing: might make some classes friends later ... More...

const IdentContIndex &	getHashAndIndex () const

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 {}
	Global position of measurement. More...

Private Attributes
const MuonGM::MdtReadoutElement *	m_detEl {nullptr}
	Cached pointer to detector element (not deleted in destructor, not written to disk) More...

int	m_tdc {0}
	TDC value - typical TDC spectra can go from 0 up to 2500. More...

int	m_adc {0}
	ADC value - typical ADC spectra can go from 0 up to 250. More...

MdtDriftCircleStatus	m_status {MdtDriftCircleStatus::MdtStatusUnDefined}
	enum to hold 'status' of measurement More...

Identifier	m_clusId { 0 }
	PrepRawData ID, not const because of DataPool. More...

Amg::Vector2D	m_localPos {}
	see derived classes for definition of meaning of LocalPosition More...

std::vector< Identifier >	m_rdoList {}
	Stores the identifiers of the RDOs. More...

Amg::MatrixX	m_localCovariance {}
	See derived classes for definition of ErrorMatrix. More...

IdentContIndex	m_indexAndHash
	Stores its own position (index) in collection plus the hash id for the collection (needed for the EL to IDC) More...

Friends
class	::MdtPrepDataContainerCnv

class	Muon::MdtPrepDataContainerCnv_p1

Detailed Description

Class to represent measurements from the Monitored Drift Tubes.

Definition at line 32 of file MdtPrepData.h.

Constructor & Destructor Documentation

◆ MdtPrepData() [1/4]

Muon::MdtPrepData::MdtPrepData ( )

default

◆ MdtPrepData() [2/4]

Muon::MdtPrepData::MdtPrepData ( const MdtPrepData & RIO )

Definition at line 44 of file MdtPrepData.cxx.

                                                 :
     PrepRawData( RIO ),
     m_detEl(RIO.m_detEl),
     m_tdc(RIO.m_tdc),
     m_adc(RIO.m_adc),
     m_status(RIO.m_status) {}

◆ MdtPrepData() [3/4]

Muon::MdtPrepData::MdtPrepData ( MdtPrepData && RIO )

noexcept

Definition at line 52 of file MdtPrepData.cxx.

                                                     :
     PrepRawData( std::move(RIO) ),
     m_detEl(RIO.m_detEl),
     m_tdc(RIO.m_tdc),
     m_adc(RIO.m_adc),
     m_status(RIO.m_status) {}

◆ MdtPrepData() [4/4]

Muon::MdtPrepData::MdtPrepData	(	const Identifier &	id,
		const Amg::Vector2D &	driftRadius,
		const Amg::MatrixX &	errDriftRadius,
		const MuonGM::MdtReadoutElement *	detEl,
		const int	tdc,
		const int	adc,
		const MdtDriftCircleStatus	status
	)

Constructor with parameters: this class owns the pointers passed (except the MuonDetectorElement)

Parameters

id	Identifier of the tube which generated DriftCircle,
collectionHash	IdentifierHash of the PRD collection in which the MdtPrepData is stored
driftRadius	this local position object should contain the drift radius
errDriftRadius	the error on the driftRadius (i.e. 1d error matix)
detEl	pointer to the associated detectr element (will not be owned by MdtPrepData - i.e. will not be deleted)
tdc	TDC count
adc	ADC count
status	enum to indicate whether the measurement is masked, in time, etc (see MdtPrepDataStatus for details).

Definition at line 21 of file MdtPrepData.cxx.

                                                             :
     PrepRawData(id, driftRadius, errDriftRadius), //call base class constructor
     m_detEl(detEl),
     m_tdc(tdc), 
     m_adc(adc), 
     m_status(status)
    
 {
 //    assert(rdoList.size()==1); 
 //    assert( rdoList[0]==id);
 }

◆ ~MdtPrepData()

Muon::MdtPrepData::~MdtPrepData ( )

virtualdefault

Destructor.

Member Function Documentation

◆ adc()

int Muon::MdtPrepData::adc ( ) const

inline

Returns the ADC (typically range is 0 to 250)

Definition at line 146 of file MdtPrepData.h.

146 { return m_adc; }

◆ collectionHash()

IdentifierHash Muon::MdtPrepData::collectionHash ( ) const

inlinevirtual

Returns the IdentifierHash corresponding to the Mdt tube which was hit.

Definition at line 148 of file MdtPrepData.h.

                                                         {
     return getHashAndIndex().collHash();
 }

◆ detectorElement()

const MuonGM::MdtReadoutElement * Muon::MdtPrepData::detectorElement ( ) const

inlineoverridevirtual

Returns the detector element corresponding to this PRD.

The pointer will be zero if the det el is not defined (i.e. it was not passed in by the ctor)

Implements Trk::PrepRawData.

Definition at line 141 of file MdtPrepData.h.

                                                                         {
     return m_detEl;
 }

◆ dimension()

unsigned int Muon::MdtPrepData::dimension ( ) const

inline

Returns the dimension of the MdtPrepData.

Ordinary prepData has dimension one twin drift circles have dimension 2

Definition at line 85 of file MdtPrepData.h.

                                    {
         return localCovariance().rows();
     }

◆ dump() [1/2]

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

overridevirtual

Dumps information about the PRD.

Reimplemented from Trk::PrepRawData.

Reimplemented in Muon::MdtTwinPrepData.

Definition at line 87 of file MdtPrepData.cxx.

   {
     stream << MSG::INFO<<"MdtPrepData {"<<std::endl;
  
     Trk::PrepRawData::dump(stream);
  
     //MdtPrepData methods
     stream <<"TDC = "<<tdc()<<", ";
     stream <<"ADC = "<<adc()<<", ";
     stream <<"status = "<<status()<<", ";
     stream<<"} End MdtPrepData"<<endmsg;
  
     return stream;
   }

◆ dump() [2/2]

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

overridevirtual

Dumps information about the PRD.

Reimplemented from Trk::PrepRawData.

Reimplemented in Muon::MdtTwinPrepData.

Definition at line 102 of file MdtPrepData.cxx.

   {
     stream << "MdtPrepData {"<<std::endl;
  
     Trk::PrepRawData::dump(stream);
  
     //MdtPrepData methods
     stream <<"TDC = "<<tdc()<<", ";
     stream <<"ADC = "<<adc()<<", ";
     stream <<"status = "<<status()<<", ";
     stream<<"} End MdtPrepData"<<std::endl;
     return stream;
   }

◆ getHashAndIndex()

const IdentContIndex& Trk::PrepRawData::getHashAndIndex ( ) const

inherited

◆ globalPosition()

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

inlinevirtual

Returns the global position of the CENTER of the drift tube (i.e.

it is important to realise that this is NOT the true position of the measurement). The reason that this is done here, and not simply through the detector element is that here it can be cached for better performance.

Reimplemented in Muon::MdtTwinPrepData.

Definition at line 133 of file MdtPrepData.h.

                                                             {
     if (!m_globalPosition) {
         m_globalPosition.set(std::make_unique<Amg::Vector3D>(m_detEl->surface(identify()).center()));
     }
     return *m_globalPosition;
 }

◆ hasLocalCovariance()

bool Trk::PrepRawData::hasLocalCovariance ( ) const

inherited

returns localCovariance().size()!=0

◆ identify()

Identifier Trk::PrepRawData::identify ( ) const

inherited

return the identifier

◆ localCovariance()

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

inherited

return const ref to the error matrix

◆ localPosition()

const Amg::Vector2D& Trk::PrepRawData::localPosition ( ) const

inherited

return the local position reference

◆ numberOfInstantiations()

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

inlinestaticinherited

Definition at line 25 of file TrkObjectCounter.h.

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

◆ operator=() [1/2]

MdtPrepData & Muon::MdtPrepData::operator= ( const MdtPrepData & RIO )

Definition at line 60 of file MdtPrepData.cxx.

                                                           {
     if (&RIO !=this) {
       Trk::PrepRawData::operator=(RIO);
         m_detEl           = RIO.m_detEl;
         m_tdc             = RIO.m_tdc;
         m_adc             = RIO.m_adc;
         m_status          = RIO.m_status;
         if (m_globalPosition) m_globalPosition.release();
     }
     return *this;
 }

◆ operator=() [2/2]

MdtPrepData & Muon::MdtPrepData::operator= ( MdtPrepData && RIO )

noexcept

Definition at line 73 of file MdtPrepData.cxx.

                                                               {
     if (&RIO !=this) {
       m_detEl = RIO.m_detEl;
       m_tdc = RIO.m_tdc;
       m_adc = RIO.m_adc;
       m_status = RIO.m_status;
       Trk::PrepRawData::operator=(std::move(RIO));
       if (m_globalPosition) {
           m_globalPosition.release();
       }        
     }
     return *this;
 }

◆ rdoList()

const std::vector<Identifier>& Trk::PrepRawData::rdoList ( ) const

inherited

return the List of rdo identifiers (pointers)

◆ setHashAndIndex()

void Trk::PrepRawData::setHashAndIndex	(	unsigned short	collHash,
		unsigned short	objIndex
	)

inherited

TEMP for testing: might make some classes friends later ...

◆ status()

MdtDriftCircleStatus Muon::MdtPrepData::status ( ) const

inline

Returns the status of the measurement.

Definition at line 147 of file MdtPrepData.h.

147 { return m_status; }

◆ tdc()

int Muon::MdtPrepData::tdc ( ) const

inline

Returns the TDC (typically range is 0 to 2500).

Definition at line 145 of file MdtPrepData.h.

145 { return m_tdc; }

◆ type()

virtual bool Muon::MdtPrepData::type ( Trk::PrepRawDataType type ) const

inlineoverridevirtual

Interface method checking the type.

Implements Trk::PrepRawData.

Definition at line 80 of file MdtPrepData.h.

                                                               {
       return type == Trk::PrepRawDataType::MdtPrepData;
     }

Friends And Related Function Documentation

◆ ::MdtPrepDataContainerCnv

friend class ::MdtPrepDataContainerCnv

friend

Definition at line 40 of file MdtPrepData.h.

◆ Muon::MdtPrepDataContainerCnv_p1

friend class Muon::MdtPrepDataContainerCnv_p1

friend

Definition at line 41 of file MdtPrepData.h.

Member Data Documentation

◆ m_adc

int Muon::MdtPrepData::m_adc {0}

private

ADC value - typical ADC spectra can go from 0 up to 250.

Definition at line 115 of file MdtPrepData.h.

◆ m_clusId

Identifier Trk::PrepRawData::m_clusId { 0 }

privateinherited

PrepRawData ID, not const because of DataPool.

Definition at line 151 of file PrepRawData.h.

◆ m_detEl

const MuonGM::MdtReadoutElement* Muon::MdtPrepData::m_detEl {nullptr}

private

Cached pointer to detector element (not deleted in destructor, not written to disk)

Definition at line 109 of file MdtPrepData.h.

◆ m_globalPosition

CxxUtils::CachedUniquePtr<const Amg::Vector3D> Muon::MdtPrepData::m_globalPosition {}

protected

Global position of measurement.

Calculated on demand and cached (not deleted in destructor, not written to disk)

Definition at line 124 of file MdtPrepData.h.

◆ m_indexAndHash

IdentContIndex Trk::PrepRawData::m_indexAndHash

privateinherited

Stores its own position (index) in collection plus the hash id for the collection (needed for the EL to IDC)

Definition at line 162 of file PrepRawData.h.

◆ m_localCovariance

Amg::MatrixX Trk::PrepRawData::m_localCovariance {}

privateinherited

See derived classes for definition of ErrorMatrix.

Definition at line 158 of file PrepRawData.h.

◆ m_localPos

Amg::Vector2D Trk::PrepRawData::m_localPos {}

privateinherited

see derived classes for definition of meaning of LocalPosition

Definition at line 154 of file PrepRawData.h.

◆ m_rdoList

std::vector<Identifier> Trk::PrepRawData::m_rdoList {}

privateinherited

Stores the identifiers of the RDOs.

Definition at line 156 of file PrepRawData.h.

◆ m_status

MdtDriftCircleStatus Muon::MdtPrepData::m_status {MdtDriftCircleStatus::MdtStatusUnDefined}

private

enum to hold 'status' of measurement

Definition at line 118 of file MdtPrepData.h.

◆ m_tdc

int Muon::MdtPrepData::m_tdc {0}

private

TDC value - typical TDC spectra can go from 0 up to 2500.

Definition at line 112 of file MdtPrepData.h.

◆ s_numberOfInstantiations

std::atomic_size_t Trk::ObjectCounter< Trk::PrepRawData >::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 Attributes

Friends

Detailed Description

Constructor & Destructor Documentation

◆ MdtPrepData() [1/4]

◆ MdtPrepData() [2/4]

◆ MdtPrepData() [3/4]

◆ MdtPrepData() [4/4]

◆ ~MdtPrepData()

Member Function Documentation

◆ adc()

◆ collectionHash()

◆ detectorElement()

◆ dimension()

◆ dump() [1/2]

◆ dump() [2/2]

◆ getHashAndIndex()

◆ globalPosition()

◆ hasLocalCovariance()

◆ identify()

◆ localCovariance()

◆ localPosition()

◆ numberOfInstantiations()

◆ operator=() [1/2]

◆ operator=() [2/2]

◆ rdoList()

◆ setHashAndIndex()

◆ status()

◆ tdc()

◆ type()

Friends And Related Function Documentation

◆ ::MdtPrepDataContainerCnv

◆ Muon::MdtPrepDataContainerCnv_p1

Member Data Documentation

◆ m_adc

◆ m_clusId

◆ m_detEl

◆ m_globalPosition

◆ m_indexAndHash

◆ m_localCovariance

◆ m_localPos

◆ m_rdoList

◆ m_status

◆ m_tdc

◆ s_numberOfInstantiations