Trk::Segment Class Reference

#include <Segment.h>

Inheritance diagram for Trk::Segment:

Collaboration diagram for Trk::Segment:

Public Types
enum	Author {   AuthorUnknown = 0, MooMdtSegmentMakerTool = 1, MooCscSegmentMakerTool = 2, Muonboy = 3,   DCMathSegmentMaker = 4, MDT_DHoughSegmentMakerTool = 5, CSC_DHoughSegmentMakerTool = 6, Csc2dSegmentMaker = 7,   Csc4dSegmentMaker = 8, TRT_SegmentMaker = 9, CTBTracking = 10, DCMathSegmentMakerCurved = 11,   NswStereoSeeded = 12, NswStgcSeeded = 13, NswPadSeeded = 14, NswQuadAlign = 15,   NumberOfAuthors = 16 }
	enum to identify who created the segment. More...

Public Member Functions
	Segment ()
	Default Constructor for POOL. More...
	Segment (const Segment &seg)
	Copy Constructor. More...
	Segment (Segment &&) noexcept
	Move Constructor. More...
Segment &	operator= (const Segment &seg)
	Assignment operator. More...
Segment &	operator= (Segment &&) noexcept
	Move assignment operator. More...
	Segment (LocalParameters &&locpars, Amg::MatrixX &&locerr, DataVector< const MeasurementBase > &&measurements, FitQuality *fitq=nullptr, Author author=AuthorUnknown)
	Constructor with parameters. More...
virtual	~Segment ()
	Destructor. More...
virtual Segment *	clone () const override=0
	Pseudo-constructor: needed to avoid excessive RTTI. More...
std::unique_ptr< Segment >	uniqueClone () const
	NVI uniqueClone method. More...
virtual bool	type (MeasurementBaseType::Type type) const override final
	Extended method checking the type. More...
const std::vector< const Trk::MeasurementBase * > &	containedMeasurements () const
	returns the vector of Trk::MeasurementBase objects More...
const DataVector< const Trk::MeasurementBase > &	containedMeasurementsDataVector () const
bool	hasContainedMeasurements () const
unsigned int	numberOfMeasurementBases () const
	Return the number of contained Trk::MeasurementBase (s) More...
const MeasurementBase *	measurement (unsigned int) const
	returns the Trk::MeasurementBase objects depending on the integer More...
const FitQuality *	fitQuality () const
	return the FitQuality object, returns NULL if no FitQuality is defined More...
void	setAuthor (Author a)
	sets the segment author More...
Author	author () const
	return segment author More...
std::string	dumpAuthor () const
	returns human readble string version of author More...
const LocalParameters &	localParameters () const
	Interface method to get the LocalParameters. More...
const Amg::MatrixX &	localCovariance () const
	Interface method to get the localError. More...
virtual const Surface &	associatedSurface () const =0
	Interface method to get the associated Surface. More...
virtual const Amg::Vector3D &	globalPosition () const =0
	Interface method to get the global Position. More...
virtual MsgStream &	dump (MsgStream &out) const =0
	Interface method for output, to be overloaded by child classes*. More...
virtual std::ostream &	dump (std::ostream &out) const =0
	Interface method for output, to be overloaded by child classes*. More...

Static Public Member Functions
static std::size_t	numberOfInstantiations ()

Static Public Attributes
static std::atomic_size_t	s_numberOfInstantiations

Protected Attributes
std::unique_ptr< FitQuality >	m_fitQuality
	The fit quality of the Segment. More...
DataVector< const MeasurementBase >	m_containedMeasBases
	The vector of contained (generic) Trk::MeasurementBase objects. More...
Author	m_author
	segment author More...
LocalParameters	m_localParams
Amg::MatrixX	m_localCovariance

Friends
class	::SegmentCnv_p1

Detailed Description

Base class for all TrackSegment implementations, extends the common MeasurementBase.

Trk::LocalParameters, an Trk::ErrorMatrix and a number of fitted RIOs are the commonalities of all track segments, the derived classes can overwrite the base class definitions of Trk::RIO_OnTrack, Trk::PrepRawData and Trk::Surface with derived classes for internal use and to avoid extensive RTTI.

The Surface is chosen not to be a private member of the base class, such that dedicated Segments can save specific Surface types and overwrite the return type by a child class to avoid extensive RTTI.

Access to any information of the contained ROTs, such as the underlying Trk::PrepRawData, the pointer to the Trk::DetectorElementBase such as identifiers have to be retrieved from the ROT itself.

Author

Andre.nosp@m.as.S.nosp@m.alzbu.nosp@m.rger.nosp@m.@cern.nosp@m..ch

Christos Anastopoulos Athena MT

Definition at line 53 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

Member Enumeration Documentation

Author

enum Trk::Segment::Author

enum to identify who created the segment.

If you update this don't forget to update the dump method.

Enumerator
AuthorUnknown
MooMdtSegmentMakerTool
MooCscSegmentMakerTool
Muonboy
DCMathSegmentMaker
MDT_DHoughSegmentMakerTool
CSC_DHoughSegmentMakerTool
Csc2dSegmentMaker
Csc4dSegmentMaker
TRT_SegmentMaker
CTBTracking
DCMathSegmentMakerCurved
NswStereoSeeded
NswStgcSeeded
NswPadSeeded
NswQuadAlign
NumberOfAuthors

Definition at line 62 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

  {
    AuthorUnknown = 0,
    MooMdtSegmentMakerTool = 1,
    MooCscSegmentMakerTool = 2,
    Muonboy = 3,
    DCMathSegmentMaker = 4,
    MDT_DHoughSegmentMakerTool = 5,
    CSC_DHoughSegmentMakerTool = 6,
    Csc2dSegmentMaker = 7,
    Csc4dSegmentMaker = 8,
    TRT_SegmentMaker = 9,
    CTBTracking = 10,
    DCMathSegmentMakerCurved = 11,
    NswStereoSeeded = 12,
    NswStgcSeeded = 13,
    NswPadSeeded = 14,
    NswQuadAlign = 15,
    NumberOfAuthors = 16
  };

Constructor & Destructor Documentation

Segment() [1/4]

Trk::Segment::Segment

(

)

Default Constructor for POOL.

Definition at line 15 of file TrkEvent/TrkSegment/src/Segment.cxx.

  : Trk::MeasurementBase()
  , Trk::ObjectCounter<Trk::Segment>()
  , m_fitQuality(nullptr)
  , m_containedMeasBases()
  , m_author(AuthorUnknown)
{
}

Segment() [2/4]

Trk::Segment::Segment

(

const Segment &

seg

)

Copy Constructor.

Definition at line 38 of file TrkEvent/TrkSegment/src/Segment.cxx.

  : Trk::MeasurementBase(seg)
  , Trk::ObjectCounter<Trk::Segment>(seg)
  , m_fitQuality(seg.m_fitQuality ? seg.m_fitQuality->clone() : nullptr)
  , m_containedMeasBases()
  , m_author(seg.m_author)
{
  // DV deep copy
  m_containedMeasBases.reserve(seg.m_containedMeasBases.size());
  for (const Trk::MeasurementBase* const measurement :
       seg.m_containedMeasBases) {
    m_containedMeasBases.push_back(measurement->clone());
  }
}

Segment() [3/4]

Trk::Segment::Segment ( Trk::Segment &&  seg )

noexcept

Move Constructor.

Definition at line 54 of file TrkEvent/TrkSegment/src/Segment.cxx.

  : Trk::MeasurementBase(seg)
  , m_fitQuality(std::move(seg.m_fitQuality))
  , m_containedMeasBases(std::move(seg.m_containedMeasBases))
  , m_author(seg.m_author)
{
}

Segment() [4/4]

Trk::Segment::Segment	(	Trk::LocalParameters &&	locpars,
		Amg::MatrixX &&	locerr,
		DataVector< const MeasurementBase > &&	measurements,
		FitQuality *	fitq = nullptr,
		Author	author = AuthorUnknown
	)

Constructor with parameters.

Definition at line 24 of file TrkEvent/TrkSegment/src/Segment.cxx.

  : Trk::MeasurementBase(std::move(locpars), std::move(locerr))
  , Trk::ObjectCounter<Trk::Segment>()
  , m_fitQuality(fitqual)
  , m_containedMeasBases(std::move(measurements))
  , m_author(author)
{
}

~Segment()

Trk::Segment::~Segment ( )

virtualdefault

Destructor.

Member Function Documentation

associatedSurface()

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

pure virtualinherited

Interface method to get the associated Surface.

Implemented in Trk::RIO_OnTrack, Muon::MdtDriftCircleOnTrack, InDet::PixelClusterOnTrack, Muon::MuonSegment, Muon::CscClusterOnTrack, InDet::TRT_DriftCircleOnTrack, InDet::SCT_ClusterOnTrack, Muon::RpcClusterOnTrack, Trk::TrackSegment, Trk::VertexOnTrack, HGTD_ClusterOnTrack, Muon::sTgcClusterOnTrack, Trk::PseudoMeasurementOnTrack, Trk::SpacePoint, Trk::CaloCluster_OnTrack, Muon::CompetingMuonClustersOnTrack, Muon::TgcClusterOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, InDet::CompetingPixelClustersOnTrack, Muon::MMClusterOnTrack, and InDet::CompetingSCT_ClustersOnTrack.

author()

Segment::Author Trk::Segment::author ( ) const

inline

return segment author

Definition at line 199 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

{
  return m_author;
}

clone()

virtual Segment* Trk::Segment::clone ( ) const

overridepure virtual

Pseudo-constructor: needed to avoid excessive RTTI.

Implements Trk::MeasurementBase.

Implemented in Muon::MuonSegment, and Trk::TrackSegment.

containedMeasurements()

const std::vector< const MeasurementBase * > & Trk::Segment::containedMeasurements ( ) const

inline

returns the vector of Trk::MeasurementBase objects

• specific for this TrackSegment: Trk::MeasurementBase (generic)

Definition at line 166 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

{
  return m_containedMeasBases.stdcont();
}

containedMeasurementsDataVector()

const DataVector< const MeasurementBase > & Trk::Segment::containedMeasurementsDataVector ( ) const

inline

Definition at line 172 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

{
  return m_containedMeasBases;
}

dump() [1/2]

virtual MsgStream& Trk::MeasurementBase::dump ( MsgStream &  out ) const

pure virtualinherited

Interface method for output, to be overloaded by child classes*.

Implemented in Muon::MdtDriftCircleOnTrack, Muon::CscClusterOnTrack, Muon::RpcClusterOnTrack, Muon::sTgcClusterOnTrack, Muon::MuonClusterOnTrack, Muon::TgcClusterOnTrack, Muon::MMClusterOnTrack, Trk::SpacePoint, Muon::MuonSegment, InDet::TRT_DriftCircleOnTrack, InDet::PixelClusterOnTrack, InDet::SCT_ClusterOnTrack, HGTD_ClusterOnTrack, Trk::VertexOnTrack, Trk::PseudoMeasurementOnTrack, Trk::TrackSegment, Trk::CaloCluster_OnTrack, InDet::SCT_SpacePoint, InDet::PixelSpacePoint, Trk::CompetingRIOsOnTrack, Trk::RIO_OnTrack, InDet::SiClusterOnTrack, Muon::CompetingMuonClustersOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, InDet::CompetingPixelClustersOnTrack, and InDet::CompetingSCT_ClustersOnTrack.

dump() [2/2]

virtual std::ostream& Trk::MeasurementBase::dump ( std::ostream &  out ) const

pure virtualinherited

Interface method for output, to be overloaded by child classes*.

Implemented in Muon::MdtDriftCircleOnTrack, Muon::CscClusterOnTrack, Muon::RpcClusterOnTrack, Muon::sTgcClusterOnTrack, Muon::MuonClusterOnTrack, Muon::TgcClusterOnTrack, Muon::MMClusterOnTrack, Trk::SpacePoint, Muon::MuonSegment, InDet::PixelClusterOnTrack, InDet::TRT_DriftCircleOnTrack, InDet::SCT_ClusterOnTrack, HGTD_ClusterOnTrack, Trk::VertexOnTrack, Trk::TrackSegment, Trk::PseudoMeasurementOnTrack, Trk::CaloCluster_OnTrack, InDet::SCT_SpacePoint, InDet::PixelSpacePoint, Trk::CompetingRIOsOnTrack, Trk::RIO_OnTrack, InDet::SiClusterOnTrack, Muon::CompetingMuonClustersOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, InDet::CompetingPixelClustersOnTrack, and InDet::CompetingSCT_ClustersOnTrack.

dumpAuthor()

std::string Trk::Segment::dumpAuthor

(

)

const

returns human readble string version of author

Definition at line 97 of file TrkEvent/TrkSegment/src/Segment.cxx.

                                       {
  std::string author;
  switch (m_author) {
    case AuthorUnknown:
      author = "AuthorUnknown";
      break;
    case MooMdtSegmentMakerTool:
      author = "MooMdtSegmentMakerTool";
      break;
    case MooCscSegmentMakerTool:
      author = "MooCscSegmentMakerTool";
      break;
    case Muonboy:
      author = "Muonboy";
      break;
    case DCMathSegmentMaker:
      author = "DCMathSegmentMaker";
      break;
    case MDT_DHoughSegmentMakerTool:
      author = "MDT_DHoughSegmentMakerTool";
      break;
    case CSC_DHoughSegmentMakerTool:
      author = "CSC_DHoughSegmentMakerTool";
      break;
    case Csc2dSegmentMaker:
      author = "Csc2dSegmentMaker";
      break;
    case Csc4dSegmentMaker:
      author = "Csc4dSegmentMaker";
      break;
    case TRT_SegmentMaker:
      author = "TRT_SegmentMaker";
      break;
    case NswStereoSeeded:
      author = "Nsw MM stereo seeded";
      break;
    case NswStgcSeeded:
      author = "Nsw sTgc seeded";
      break;
    case NswQuadAlign:
      author = "Nsw single quad";
      break;
    case NswPadSeeded:
      author = "Nsw single quad";
      break;
    default:
      author = "Unrecognised author, enum = " + std::to_string(m_author);
      break;
  }
  return author;
}

fitQuality()

const FitQuality * Trk::Segment::fitQuality ( ) const

inline

return the FitQuality object, returns NULL if no FitQuality is defined

• extends Trk::MeasurementBase

Definition at line 160 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

{
  return m_fitQuality.get();
}

globalPosition()

virtual const Amg::Vector3D& Trk::MeasurementBase::globalPosition ( ) const

pure virtualinherited

Interface method to get the global Position.

Implemented in Trk::RIO_OnTrack, Muon::MdtDriftCircleOnTrack, Muon::MuonSegment, HGTD_ClusterOnTrack, InDet::TRT_DriftCircleOnTrack, Trk::TrackSegment, Trk::VertexOnTrack, Trk::PseudoMeasurementOnTrack, Trk::SpacePoint, Trk::CaloCluster_OnTrack, InDet::SiClusterOnTrack, Muon::MuonClusterOnTrack, Muon::CompetingMuonClustersOnTrack, InDet::CompetingTRT_DriftCirclesOnTrack, InDet::CompetingPixelClustersOnTrack, and InDet::CompetingSCT_ClustersOnTrack.

hasContainedMeasurements()

bool Trk::Segment::hasContainedMeasurements ( ) const

inline

Definition at line 178 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

{
  return !m_containedMeasBases.empty();
}

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

measurement()

const MeasurementBase * Trk::Segment::measurement ( unsigned int  indx ) const

inline

returns the Trk::MeasurementBase objects depending on the integer

Definition at line 184 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

{
  if (!m_containedMeasBases.empty() && indx < m_containedMeasBases.size()) {
    return std::as_const(m_containedMeasBases)[indx];
  }
  return nullptr;
}

numberOfInstantiations()

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

inlinestaticinherited

Definition at line 25 of file TrkObjectCounter.h.

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

numberOfMeasurementBases()

unsigned int Trk::Segment::numberOfMeasurementBases ( ) const

inline

Return the number of contained Trk::MeasurementBase (s)

Definition at line 193 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

{
  return m_containedMeasBases.size();
}

operator=() [1/2]

Trk::Segment & Trk::Segment::operator=

(

const Segment &

seg

)

Assignment operator.

Definition at line 67 of file TrkEvent/TrkSegment/src/Segment.cxx.

{
  if (this != &seg) {
    Trk::MeasurementBase::operator=(seg);
    m_fitQuality.reset(seg.m_fitQuality ? seg.m_fitQuality->clone() : nullptr);
    // Deep copy
    m_containedMeasBases.clear();
    m_containedMeasBases.reserve(seg.m_containedMeasBases.size());
    for (const Trk::MeasurementBase* const measurement :
         seg.m_containedMeasBases) {
      m_containedMeasBases.push_back(measurement->clone());
    }
    m_author = seg.m_author;
  }
  return (*this);
}

operator=() [2/2]

Trk::Segment & Trk::Segment::operator= ( Trk::Segment &&  seg )

noexcept

Move assignment operator.

Definition at line 86 of file TrkEvent/TrkSegment/src/Segment.cxx.

{
  if (this != &seg) {
    Trk::MeasurementBase::operator=(seg);
    m_fitQuality = std::move(seg.m_fitQuality);
    m_containedMeasBases = std::move(seg.m_containedMeasBases);
    m_author = seg.m_author;
  }
  return (*this);
}

setAuthor()

void Trk::Segment::setAuthor

(

Author

a

)

sets the segment author

Definition at line 148 of file TrkEvent/TrkSegment/src/Segment.cxx.

                                   {
   m_author = a;
}

type()

virtual bool Trk::Segment::type ( MeasurementBaseType::Type  type ) const

inlinefinaloverridevirtual

Extended method checking the type.

Implements Trk::MeasurementBase.

Definition at line 114 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

  {
    return (type == MeasurementBaseType::Segment);
  }

uniqueClone()

std::unique_ptr<Segment> Trk::Segment::uniqueClone ( ) const

inline

NVI uniqueClone method.

Definition at line 108 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

  {
    return std::unique_ptr<Segment>(clone());
  }

Friends And Related Function Documentation

::SegmentCnv_p1

friend class ::SegmentCnv_p1

friend

Definition at line 147 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

Member Data Documentation

m_author

Author Trk::Segment::m_author

protected

segment author

Definition at line 156 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

m_containedMeasBases

DataVector<const MeasurementBase> Trk::Segment::m_containedMeasBases

protected

The vector of contained (generic) Trk::MeasurementBase objects.

Definition at line 153 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h.

m_fitQuality

std::unique_ptr<FitQuality> Trk::Segment::m_fitQuality

protected

The fit quality of the Segment.

Definition at line 150 of file Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.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.

s_numberOfInstantiations

std::atomic_size_t Trk::ObjectCounter< Trk::Segment >::s_numberOfInstantiations

inlinestaticinherited

Definition at line 22 of file TrkObjectCounter.h.

---

The documentation for this class was generated from the following files:

• Tracking/TrkEvent/TrkSegment/TrkSegment/Segment.h
• TrkEvent/TrkSegment/src/Segment.cxx