Muon::MMPrepData Class Reference

Class to represent MM measurements. More...

#include <MMPrepData.h>

Inheritance diagram for Muon::MMPrepData:

Collaboration diagram for Muon::MMPrepData:

Public Types
enum class	Author : short {   RDOTOPRDConverter = -1 , SimpleClusterBuilder , ClusterTimeProjectionClusterBuilder , uTPCClusterBuilder ,   nAuthorsPRD }
enum class	Quality : uint8_t { unKnown = 0 }

Public Member Functions
	MMPrepData ()=default
	MMPrepData (const MMPrepData &)=delete
MMPrepData &	operator= (const MMPrepData &)=delete
	MMPrepData (MMPrepData &&) noexcept=default
MMPrepData &	operator= (MMPrepData &&) noexcept=default
	MMPrepData (const Identifier &RDOId, const IdentifierHash &idDE, Amg::Vector2D &&locpos, std::vector< Identifier > &&rdoList, Amg::MatrixX &&locErrMat, const MuonGM::MMReadoutElement *detEl, const short int time, const int charge, const float driftDist, std::vector< uint16_t > &&stripNumbers, std::vector< short int > &&stripTimes, std::vector< int > &&stripCharges)
	Constructor.
	MMPrepData (const Identifier &RDOId, const IdentifierHash &idDE, Amg::Vector2D &&locpos, std::vector< Identifier > &&rdoList, Amg::MatrixX &&locErrMat, const MuonGM::MMReadoutElement *detEl, const short int time, const int charge, const float driftDist)
	constructor including time and charge and drift distance
	MMPrepData (const Identifier &RDOId, const IdentifierHash &idDE, Amg::Vector2D &&locpos, std::vector< Identifier > &&rdoList, Amg::MatrixX &&locErrMat, const MuonGM::MMReadoutElement *detEl, const short int time, const int charge)
	constructor including time and charge
	MMPrepData (const Identifier &RDOId, const IdentifierHash &idDE, Amg::Vector2D &&locpos, std::vector< Identifier > &&rdoList, Amg::MatrixX &&locErrMat, const MuonGM::MMReadoutElement *detEl)
virtual	~MMPrepData ()=default
	Destructor:
void	setMicroTPC (float angle, float chisqProb)
	set microTPC parameters
void	setDriftDist (std::vector< float > &&driftDist, std::vector< AmgVector(2)> &&driftDistErrors)
	set drift distances and uncertainties
void	setDriftDist (std::vector< float > &&driftDist, std::vector< float > &&stripDriftErrors_0_0, std::vector< float > &&stripDriftErrors_1_1)
virtual const Amg::Vector3D &	globalPosition () const override final
	Returns the global position.
virtual const MuonGM::MMReadoutElement *	detectorElement () const override final
	Returns the detector element corresponding to this PRD.
virtual Trk::PrepRawDataType	prdType () const override
	Interface method returning the prdType.
short int	time () const
	Returns the time (in ns)
int	charge () const
	Returns the AD.
float	driftDist () const
	Returns the Drift Distance.
float	angle () const
	Returns the microTPC angle.
float	chisqProb () const
	Returns the microTPC chisq Prob.
const std::vector< uint16_t > &	stripNumbers () const
	returns the list of strip numbers
const std::vector< short int > &	stripTimes () const
	returns the list of times
const std::vector< int > &	stripCharges () const
	returns the list of charges
const std::vector< float > &	stripDriftDist () const
	returns the list of drift distances
const std::vector< AmgVector(2)> &	stripDriftErrors () const
	returns the list of drift distances
std::vector< float >	stripDriftErrors_0_0 () const
std::vector< float >	stripDriftErrors_1_1 () const
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.
Quality	quality () const
void	setQuality (const Quality q)
Author	author () const
void	setAuthor (Author author)
virtual IdentifierHash	collectionHash () const
	Returns the IdentifierHash corresponding to the PRD collection in the PRD container.
Identifier	identify () const
	return the identifier
const Amg::Vector2D &	localPosition () const
	return the local position reference
const std::vector< Identifier > &	rdoList () const
	return the List of rdo identifiers (pointers)
const Amg::MatrixX &	localCovariance () const
	return const ref to the error matrix
bool	hasLocalCovariance () const
	returns localCovariance().size()!=0
virtual bool	type (PrepRawDataType type) const
	Interface method checking the type.
void	setHashAndIndex (unsigned short collHash, unsigned short objIndex)
	TEMP for testing: might make some classes friends later ...
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.

Private Attributes
const MuonGM::MMReadoutElement *	m_detEl {nullptr}
	Cached pointer to the detector element - should never be zero.
short int	m_time {0}
	measured time
int	m_charge {0}
	measured charge
float	m_driftDist {0.f}
	drift distance
float	m_angle {0.f}
	@angle and chisquare from micro-TPC fit
float	m_chisqProb {0.f}
std::vector< uint16_t >	m_stripNumbers {}
	@list of strip numbers, time and charge, of the strips associated to the PRD
std::vector< short int >	m_stripTimes {}
std::vector< int >	m_stripCharges {}
std::vector< float >	m_stripDriftDist {}
std::vector< AmgVector(2)>	m_stripDriftErrors {}
Author	m_author {Author::nAuthorsPRD}
Quality	m_quality {Quality::unKnown}
Identifier	m_clusId { 0 }
	PrepRawData ID, not const because of DataPool.
Amg::Vector2D	m_localPos {}
	see derived classes for definition of meaning of LocalPosition
std::vector< Identifier >	m_rdoList {}
	Stores the identifiers of the RDOs.
Amg::MatrixX	m_localCovariance {}
	See derived classes for definition of ErrorMatrix.
IdentContIndex	m_indexAndHash
	Stores its own position (index) in collection plus the hash id for the collection (needed for the EL to IDC)

Detailed Description

Class to represent MM measurements.

Definition at line 22 of file MMPrepData.h.

Member Enumeration Documentation

Author

enum class Muon::MMPrepData::Author : short

strong

Enumerator
RDOTOPRDConverter
SimpleClusterBuilder
ClusterTimeProjectionClusterBuilder
uTPCClusterBuilder
nAuthorsPRD

Definition at line 156 of file MMPrepData.h.

                     : short{
      RDOTOPRDConverter = -1,
      SimpleClusterBuilder,
      ClusterTimeProjectionClusterBuilder,
      uTPCClusterBuilder,
      nAuthorsPRD
    };

Quality

enum class Muon::MMPrepData::Quality : uint8_t

strong

Enumerator
unKnown

Definition at line 164 of file MMPrepData.h.

                      : uint8_t{
       unKnown = 0,
    };

Constructor & Destructor Documentation

MMPrepData() [1/7]

Muon::MMPrepData::MMPrepData ( )

default

MMPrepData() [2/7]

Muon::MMPrepData::MMPrepData ( const MMPrepData & )

delete

MMPrepData() [3/7]

Muon::MMPrepData::MMPrepData ( MMPrepData && )

defaultnoexcept

MMPrepData() [4/7]

Muon::MMPrepData::MMPrepData	(	const Identifier &	RDOId,
		const IdentifierHash &	idDE,
		Amg::Vector2D &&	locpos,
		std::vector< Identifier > &&	rdoList,
		Amg::MatrixX &&	locErrMat,
		const MuonGM::MMReadoutElement *	detEl,
		const short int	time,
		const int	charge,
		const float	driftDist,
		std::vector< uint16_t > &&	stripNumbers,
		std::vector< short int > &&	stripTimes,
		std::vector< int > &&	stripCharges )

Constructor.

Parameters

RDOId	The identifier of the central strip of the cluster
locpos	The local coords of the measurement (this object will now own the LocalPostion)
rdoList	Vector of all the Identifiers of the strips used in this cluster
locErrMat	The error of the measurement (this object will now own the ErrorMatrix)
detEl	The pointer to the Detector Element on which this measurement was made (must NOT be zero). Ownership is NOT taken (the pointer is assumed to belong to GeoModel and will not be deleted)

full constructor including time, charge and strip vectors

Definition at line 11 of file MMPrepData.cxx.

  : MuonCluster(RDOId, idDE,locpos, std::move(rdoList), std::move(locErrMat))
  , m_detEl(detEl)
  , m_time(time)
  , m_charge(charge)
  , m_driftDist(driftDist)
  , m_stripNumbers(std::move(stripNumbers))
  , m_stripTimes(std::move(stripTimes))
  , m_stripCharges(std::move(stripCharges)) {}

MMPrepData() [5/7]

Muon::MMPrepData::MMPrepData	(	const Identifier &	RDOId,
		const IdentifierHash &	idDE,
		Amg::Vector2D &&	locpos,
		std::vector< Identifier > &&	rdoList,
		Amg::MatrixX &&	locErrMat,
		const MuonGM::MMReadoutElement *	detEl,
		const short int	time,
		const int	charge,
		const float	driftDist )

constructor including time and charge and drift distance

Definition at line 45 of file MMPrepData.cxx.

  : MuonCluster(RDOId, idDE, locpos, std::move(rdoList), std::move(locErrMat))
  , m_detEl(detEl)
  , m_time(time)
  , m_charge(charge)
  , m_driftDist(driftDist) {}

MMPrepData() [6/7]

Muon::MMPrepData::MMPrepData	(	const Identifier &	RDOId,
		const IdentifierHash &	idDE,
		Amg::Vector2D &&	locpos,
		std::vector< Identifier > &&	rdoList,
		Amg::MatrixX &&	locErrMat,
		const MuonGM::MMReadoutElement *	detEl,
		const short int	time,
		const int	charge )

constructor including time and charge

Definition at line 32 of file MMPrepData.cxx.

  : MuonCluster(RDOId, idDE, locpos, std::move(rdoList), std::move(locErrMat))
  , m_detEl(detEl)
  , m_time(time)
  , m_charge(charge){}

MMPrepData() [7/7]

Muon::MMPrepData::MMPrepData	(	const Identifier &	RDOId,
		const IdentifierHash &	idDE,
		Amg::Vector2D &&	locpos,
		std::vector< Identifier > &&	rdoList,
		Amg::MatrixX &&	locErrMat,
		const MuonGM::MMReadoutElement *	detEl )

Definition at line 60 of file MMPrepData.cxx.

  : MuonCluster(RDOId, idDE, locpos, std::move(rdoList), std::move(locErrMat))
  , m_detEl(detEl) {}

~MMPrepData()

virtual Muon::MMPrepData::~MMPrepData ( )

virtualdefault

Destructor:

Member Function Documentation

angle()

float Muon::MMPrepData::angle ( ) const

inline

Returns the microTPC angle.

Definition at line 237 of file MMPrepData.h.

  {
    return m_angle;
  }

author()

MMPrepData::Author Muon::MMPrepData::author ( ) const

inline

Definition at line 272 of file MMPrepData.h.

                                                   {
    return m_author;
  }

charge()

int Muon::MMPrepData::charge ( ) const

inline

Returns the AD.

Definition at line 227 of file MMPrepData.h.

  {
    return m_charge;
  }

chisqProb()

float Muon::MMPrepData::chisqProb ( ) const

inline

Returns the microTPC chisq Prob.

Definition at line 242 of file MMPrepData.h.

  {
    return m_chisqProb;
  }

collectionHash()

IdentifierHash MuonCluster::collectionHash ( ) const

inlinevirtualinherited

Returns the IdentifierHash corresponding to the PRD collection in the PRD container.

Definition at line 97 of file MuonSpectrometer/MuonReconstruction/MuonRecEvent/MuonPrepRawData/MuonPrepRawData/MuonCluster.h.

  {
      return getHashAndIndex().collHash();
  }

detectorElement()

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

inlinefinaloverridevirtual

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 206 of file MMPrepData.h.

  {
    return m_detEl;
  }

driftDist()

float Muon::MMPrepData::driftDist ( ) const

inline

Returns the Drift Distance.

Definition at line 232 of file MMPrepData.h.

  {
    return m_driftDist;
  }

dump() [1/2]

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

finaloverridevirtual

Dumps information about the PRD.

Reimplemented from Muon::MuonCluster.

Definition at line 102 of file MMPrepData.cxx.

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

dump() [2/2]

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

finaloverridevirtual

Dumps information about the PRD.

Reimplemented from Muon::MuonCluster.

Definition at line 109 of file MMPrepData.cxx.

                                                      {
    stream << "MMPrepData {"<<std::endl;    
    MuonCluster::dump(stream);
    stream<<"}"<<std::endl;
    return stream;
}

getHashAndIndex()

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

inherited

globalPosition()

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

inlinefinaloverridevirtual

Returns the global position.

Implements Muon::MuonCluster.

Definition at line 211 of file MMPrepData.h.

  {
    if (!m_globalPosition) {
      m_globalPosition.set(std::make_unique<Amg::Vector3D>(
        m_detEl->surface(identify())
          .Trk::Surface::localToGlobal(localPosition())));
    }
    if (not m_globalPosition) throw Trk::PrepRawDataUndefinedVariable();
    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()

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]

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

delete

operator=() [2/2]

MMPrepData & Muon::MMPrepData::operator= ( MMPrepData && )

defaultnoexcept

prdType()

virtual Trk::PrepRawDataType Muon::MMPrepData::prdType ( ) const

inlineoverridevirtual

Interface method returning the prdType.

Implements Trk::PrepRawData.

Definition at line 110 of file MMPrepData.h.

                                                        {
      return Trk::PrepRawDataType::MMPrepData;
    }

quality()

Quality Muon::MMPrepData::quality ( ) const

inline

Definition at line 168 of file MMPrepData.h.

{ return m_quality; }

rdoList()

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

inherited

return the List of rdo identifiers (pointers)

setAuthor()

void Muon::MMPrepData::setAuthor

(

MMPrepData::Author

author

)

Definition at line 96 of file MMPrepData.cxx.

                                                   {
    m_author = author;
  }

setDriftDist() [1/2]

void Muon::MMPrepData::setDriftDist	(	std::vector< float > &&	driftDist,
		std::vector< AmgVector(2)> &&	driftDistErrors )

set drift distances and uncertainties

set drift distances and errors

Definition at line 78 of file MMPrepData.cxx.

                                                                         {
    m_stripDriftDist = std::move(driftDist);
    m_stripDriftErrors = std::move(driftDistErrors);
}

setDriftDist() [2/2]

void Muon::MMPrepData::setDriftDist	(	std::vector< float > &&	driftDist,
		std::vector< float > &&	stripDriftErrors_0_0,
		std::vector< float > &&	stripDriftErrors_1_1 )

Definition at line 83 of file MMPrepData.cxx.

                                                                       {
    m_stripDriftDist = std::move(driftDist);
    m_stripDriftErrors.reserve(stripDriftErrors_1_1.size());
    for(uint i_strip = 0; i_strip < stripDriftErrors_1_1.size(); i_strip++){
      AmgVector(2) tmp{AmgVector(2)::Zero()};
      tmp[0] = stripDriftErrors_0_0.at(i_strip);
      tmp[1] = stripDriftErrors_1_1.at(i_strip);
      m_stripDriftErrors.push_back(std::move(tmp));
    }
  }

setHashAndIndex()

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

inherited

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

setMicroTPC()

void Muon::MMPrepData::setMicroTPC	(	float	angle,
		float	chisqProb )

set microTPC parameters

set the micro-tpc quantities

Definition at line 72 of file MMPrepData.cxx.

                                                    {
    m_angle = angle;
    m_chisqProb = chisqProb;
}

setQuality()

void Muon::MMPrepData::setQuality ( const Quality q )

inline

Definition at line 169 of file MMPrepData.h.

{ m_quality = q; }

stripCharges()

const std::vector< int > & Muon::MMPrepData::stripCharges ( ) const

inline

returns the list of charges

Definition at line 257 of file MMPrepData.h.

  {
    return m_stripCharges;
  }

stripDriftDist()

const std::vector< float > & Muon::MMPrepData::stripDriftDist ( ) const

inline

returns the list of drift distances

Definition at line 262 of file MMPrepData.h.

  {
    return m_stripDriftDist;
  }

stripDriftErrors()

const std::vector< AmgVector(2)> & Muon::MMPrepData::stripDriftErrors ( ) const

inline

returns the list of drift distances

Definition at line 267 of file MMPrepData.h.

  {
    return m_stripDriftErrors;
  }

stripDriftErrors_0_0()

std::vector< float > Muon::MMPrepData::stripDriftErrors_0_0

(

)

const

Definition at line 116 of file MMPrepData.cxx.

                                                         {
    std::vector<float> ret;
    ret.reserve(m_stripDriftErrors.size());
    for (const AmgVector(2)& mat: m_stripDriftErrors) {
      ret.push_back(mat[0]);
    }
    return ret;
}

stripDriftErrors_1_1()

std::vector< float > Muon::MMPrepData::stripDriftErrors_1_1

(

)

const

Definition at line 125 of file MMPrepData.cxx.

                                                         {
  std::vector<float> ret;
  ret.reserve(m_stripDriftErrors.size());
  for (const AmgVector(2)& mat: m_stripDriftErrors) {
      ret.push_back(mat[1]);
  }
  return ret;
}

stripNumbers()

const std::vector< uint16_t > & Muon::MMPrepData::stripNumbers ( ) const

inline

returns the list of strip numbers

Definition at line 247 of file MMPrepData.h.

  {
    return m_stripNumbers;
  }

stripTimes()

const std::vector< short int > & Muon::MMPrepData::stripTimes ( ) const

inline

returns the list of times

Definition at line 252 of file MMPrepData.h.

  {
    return m_stripTimes;
  }

time()

short int Muon::MMPrepData::time ( ) const

inline

Returns the time (in ns)

Definition at line 222 of file MMPrepData.h.

  {
    return m_time;
  }

type()

virtual bool Trk::PrepRawData::type ( PrepRawDataType type ) const

inlinevirtualinherited

Interface method checking the type.

Reimplemented in InDet::PixelCluster, and InDet::SCT_Cluster.

Definition at line 133 of file PrepRawData.h.

                                                {
      return prdType() == type;
  }

Member Data Documentation

m_angle

float Muon::MMPrepData::m_angle {0.f}

private

@angle and chisquare from micro-TPC fit

Definition at line 192 of file MMPrepData.h.

{0.f};

m_author

Author Muon::MMPrepData::m_author {Author::nAuthorsPRD}

private

Definition at line 201 of file MMPrepData.h.

{Author::nAuthorsPRD};

m_charge

int Muon::MMPrepData::m_charge {0}

private

measured charge

the charge is calibrated, i.e. it is in units of electrons, after pedestal subtraction

Definition at line 186 of file MMPrepData.h.

{0};

m_chisqProb

float Muon::MMPrepData::m_chisqProb {0.f}

private

Definition at line 193 of file MMPrepData.h.

{0.f};

m_clusId

Identifier Trk::PrepRawData::m_clusId { 0 }

privateinherited

PrepRawData ID, not const because of DataPool.

Definition at line 156 of file PrepRawData.h.

{ 0 };

m_detEl

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

private

Cached pointer to the detector element - should never be zero.

Definition at line 178 of file MMPrepData.h.

{nullptr};

m_driftDist

float Muon::MMPrepData::m_driftDist {0.f}

private

drift distance

Definition at line 189 of file MMPrepData.h.

{0.f};

m_globalPosition

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

protectedinherited

Global position of measurement.

Calculated on demand and cached

Definition at line 89 of file MuonSpectrometer/MuonReconstruction/MuonRecEvent/MuonPrepRawData/MuonPrepRawData/MuonCluster.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 167 of file PrepRawData.h.

m_localCovariance

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

privateinherited

See derived classes for definition of ErrorMatrix.

Definition at line 163 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 159 of file PrepRawData.h.

{};

m_quality

Quality Muon::MMPrepData::m_quality {Quality::unKnown}

private

Definition at line 202 of file MMPrepData.h.

{Quality::unKnown};

m_rdoList

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

privateinherited

Stores the identifiers of the RDOs.

Definition at line 161 of file PrepRawData.h.

{};

m_stripCharges

std::vector<int> Muon::MMPrepData::m_stripCharges {}

private

Definition at line 198 of file MMPrepData.h.

{};

m_stripDriftDist

std::vector<float> Muon::MMPrepData::m_stripDriftDist {}

private

Definition at line 199 of file MMPrepData.h.

{};

m_stripDriftErrors

std::vector<AmgVector(2)> Muon::MMPrepData::m_stripDriftErrors {}

private

Definition at line 200 of file MMPrepData.h.

{};

m_stripNumbers

std::vector<uint16_t> Muon::MMPrepData::m_stripNumbers {}

private

@list of strip numbers, time and charge, of the strips associated to the PRD

Definition at line 196 of file MMPrepData.h.

{};

m_stripTimes

std::vector<short int> Muon::MMPrepData::m_stripTimes {}

private

Definition at line 197 of file MMPrepData.h.

{};

m_time

short int Muon::MMPrepData::m_time {0}

private

measured time

the time is calibrated, i.e. it is in units of ns, after t0 subtraction

Definition at line 182 of file MMPrepData.h.

{0};

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:

• MMPrepData.h
• MMPrepData.cxx