Trk::TrackSegment Class Reference

Class for a generic track segment that holdes polymorphic Trk::MeasurementBase objects, it extends the Trk::Segment base class. More...

#include <TrackSegment.h>

Inheritance diagram for Trk::TrackSegment:

Collaboration diagram for Trk::TrackSegment:

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
	TrackSegment ()
	Default Constructor for POOL.
	TrackSegment (const TrackSegment &seg)=default
	Copy Constructor.
	TrackSegment (TrackSegment &&) noexcept=default
	Move Constructor.
TrackSegment &	operator= (const TrackSegment &seg)=default
	Assignment operator.
TrackSegment &	operator= (TrackSegment &&) noexcept=default
	Move assignment operator.
	TrackSegment (LocalParameters &&locpars, Amg::MatrixX &&locerr, const Surface *sf, DataVector< const MeasurementBase > &&crots, FitQuality *fqual, Segment::Author author=Segment::AuthorUnknown)
	Constructor with parameters.
virtual	~TrackSegment ()=default
	Destructor.
virtual TrackSegment *	clone () const override final
	needed to avoid excessive RTTI
const Surface &	associatedSurface () const override final
	returns the surface for the local to global transformation
const Amg::Vector3D &	globalPosition () const override final
	Interface method to get the global Position.
MsgStream &	dump (MsgStream &out) const override final
	returns some information about this MeasurementBase/TrackSegment.
std::ostream &	dump (std::ostream &out) const override final
	returns some information about this MeasurementBase/TrackSegment.
std::unique_ptr< Segment >	uniqueClone () const
	NVI uniqueClone method.
virtual bool	type (MeasurementBaseType::Type type) const override final
	Extended method checking the type.
const std::vector< const Trk::MeasurementBase * > &	containedMeasurements () const
	returns the vector of Trk::MeasurementBase objects
const DataVector< const Trk::MeasurementBase > &	containedMeasurementsDataVector () const
bool	hasContainedMeasurements () const
unsigned int	numberOfMeasurementBases () const
	Return the number of contained Trk::MeasurementBase (s)
const MeasurementBase *	measurement (unsigned int) const
	returns the Trk::MeasurementBase objects depending on the integer
const FitQuality *	fitQuality () const
	return the FitQuality object, returns NULL if no FitQuality is defined
void	setAuthor (Author a)
	sets the segment author
Author	author () const
	return segment author
std::string	dumpAuthor () const
	returns human readble string version of author
const LocalParameters &	localParameters () const
	Interface method to get the LocalParameters.
const Amg::MatrixX &	localCovariance () const
	Interface method to get the localError.
const Surface *	surfacePtr ()
	return the ptr we hold useful for tests
const Surface *	release () noexcept
	release ala unique_ptr release
void	destroySurface () noexcept
	destroySurface deletes the ptr if not null and the surface has not a associatedDetectorElement Usefull also for testing

Static Public Member Functions
static std::size_t	numberOfInstantiations ()
static const Surface *	cloneHelper (const Surface *input)
	Helper for cloning or not when we need depending on if we have an associatedDetectorElement.

Static Public Attributes
static std::atomic_size_t	s_numberOfInstantiations

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

Private Attributes
Amg::Vector3D	m_globalPosition

Friends
class	::TrackSegmentCnv_p1

Detailed Description

Class for a generic track segment that holdes polymorphic Trk::MeasurementBase objects, it extends the Trk::Segment base class.

Trk::MeasurementBase objects of different type can be used to describe this track segment. The fitted Trk::LocalParameters such as the associated ErrorMatrix are directly forwarded to be stored in the Trk::MeasurementBase base class.

A Surface has to be provided to give the reference frame the \ Trk::TrackSegment is expressed to.

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 TrackSegment.h.

Member Enumeration Documentation

Author

enum Trk::Segment::Author

inherited

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

TrackSegment() [1/4]

Trk::TrackSegment::TrackSegment

(

)

Default Constructor for POOL.

Definition at line 20 of file TrackSegment.cxx.

  : Trk::Segment()
  , SurfacePtrHolderDetEl()
  , m_globalPosition(INVALID_VECTOR3D)
{
}

TrackSegment() [2/4]

Trk::TrackSegment::TrackSegment ( const TrackSegment & seg )

default

Copy Constructor.

TrackSegment() [3/4]

Trk::TrackSegment::TrackSegment ( TrackSegment && )

defaultnoexcept

Move Constructor.

TrackSegment() [4/4]

Trk::TrackSegment::TrackSegment	(	Trk::LocalParameters &&	locpars,
		Amg::MatrixX &&	locerr,
		const Surface *	sf,
		DataVector< const MeasurementBase > &&	crots,
		FitQuality *	fqual,
		Segment::Author	author = Segment::AuthorUnknown )

Constructor with parameters.

Definition at line 28 of file TrackSegment.cxx.

  : Trk::Segment(std::move(locpars), std::move(locerr),
                 std::move(crots), fqual, author)
  , SurfacePtrHolderDetEl(sf)
  , m_globalPosition(INVALID_VECTOR3D)
{
  if (m_associatedSurface) {
    m_globalPosition =
      Amg::Vector3D(m_associatedSurface->localToGlobal(localParameters()));
  }
}

~TrackSegment()

virtual Trk::TrackSegment::~TrackSegment ( )

virtualdefault

Destructor.

Member Function Documentation

associatedSurface()

const Surface & Trk::TrackSegment::associatedSurface ( ) const

inlinefinaloverridevirtual

returns the surface for the local to global transformation

• interface from MeasurementBase

Implements Trk::MeasurementBase.

Definition at line 112 of file TrackSegment.h.

{
  return (*m_associatedSurface);
}

author()

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

inlineinherited

return segment author

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

{
  return m_author;
}

clone()

TrackSegment * Trk::TrackSegment::clone ( ) const

inlinefinaloverridevirtual

needed to avoid excessive RTTI

Implements Trk::Segment.

Definition at line 106 of file TrackSegment.h.

{
  return new TrackSegment(*this);
}

cloneHelper()

const Surface * Trk::SurfacePtrHolderImplDetEl< Surface >::cloneHelper ( const Surface * input )

inlinestaticinherited

Helper for cloning or not when we need depending on if we have an associatedDetectorElement.

Definition at line 213 of file SurfaceHolderImpl.h.

  {
    return (input && input->associatedDetectorElement() == nullptr
              ? input->clone()
              : input);
  }

containedMeasurements()

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

inlineinherited

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

inlineinherited

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

{
  return m_containedMeasBases;
}

destroySurface()

void Trk::SurfacePtrHolderImplDetEl< Surface >::destroySurface ( )

inlinenoexceptinherited

destroySurface deletes the ptr if not null and the surface has not a associatedDetectorElement Usefull also for testing

Definition at line 201 of file SurfaceHolderImpl.h.

  {
    if (m_associatedSurface &&
        m_associatedSurface->associatedDetectorElement() == nullptr) {
      delete m_associatedSurface;
    }
    //
    m_associatedSurface = nullptr;
  }

dump() [1/2]

MsgStream & Trk::TrackSegment::dump ( MsgStream & out ) const

finaloverridevirtual

returns some information about this MeasurementBase/TrackSegment.

It should be overloaded by any child classes

Implements Trk::MeasurementBase.

Definition at line 52 of file TrackSegment.cxx.

{
  out << "Trk::TrackSegment (generic track segment) " << std::endl;
  out << "  - it contains   : " << numberOfMeasurementBases()
      << " RIO_OnTrack object" << std::endl;
  out << "  - parmaters     : " << std::endl;
  out << "  - parameter key : " << std::endl;
  // TODO - out proper output (see MuonSegment) EJWM
  return out;
}

dump() [2/2]

std::ostream & Trk::TrackSegment::dump ( std::ostream & out ) const

finaloverridevirtual

returns some information about this MeasurementBase/TrackSegment.

It should be overloaded by any child classes

Implements Trk::MeasurementBase.

Definition at line 64 of file TrackSegment.cxx.

{
  out << "Trk::TrackSegment (generic track segment) " << std::endl;
  out << "  - it contains   : " << numberOfMeasurementBases()
      << " RIO_OnTrack object" << std::endl;
  out << "  - parmaters     : " << std::endl;
  out << "  - parameter key : " << std::endl;
  // TODO - out proper output (see MuonSegment) EJWM
  return out;
}

dumpAuthor()

std::string Trk::Segment::dumpAuthor ( ) const

inherited

returns human readble string version of author

Definition at line 99 of file Tracking/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

inlineinherited

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

const Amg::Vector3D & Trk::TrackSegment::globalPosition ( ) const

finaloverridevirtual

Interface method to get the global Position.

• interface from MeasurementBase

Implements Trk::MeasurementBase.

Definition at line 46 of file TrackSegment.cxx.

{
  return m_globalPosition;
}

hasContainedMeasurements()

bool Trk::Segment::hasContainedMeasurements ( ) const

inlineinherited

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

inlineinherited

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

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

inlineinherited

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]

TrackSegment & Trk::TrackSegment::operator= ( const TrackSegment & seg )

default

Assignment operator.

operator=() [2/2]

TrackSegment & Trk::TrackSegment::operator= ( TrackSegment && )

defaultnoexcept

Move assignment operator.

release()

const Surface * Trk::SurfacePtrHolderImplDetEl< Surface >::release ( )

inlinenoexceptinherited

release ala unique_ptr release

Definition at line 192 of file SurfaceHolderImpl.h.

  {
    const S* tmp = m_associatedSurface;
    m_associatedSurface = nullptr;
    return tmp;
  }

setAuthor()

void Trk::Segment::setAuthor ( Author a )

inherited

sets the segment author

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

                                   {
   m_author = a;
}

surfacePtr()

const Surface * Trk::SurfacePtrHolderImplDetEl< Surface >::surfacePtr ( )

inlineinherited

return the ptr we hold useful for tests

Definition at line 190 of file SurfaceHolderImpl.h.

{ return m_associatedSurface; }

type()

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

inlinefinaloverridevirtualinherited

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

inlineinherited

NVI uniqueClone method.

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

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

Friends And Related Symbol Documentation

::TrackSegmentCnv_p1

friend class ::TrackSegmentCnv_p1

friend

Definition at line 100 of file TrackSegment.h.

Member Data Documentation

m_associatedSurface

const Surface* Trk::SurfacePtrHolderImplDetEl< Surface >::m_associatedSurface

protectedinherited

Definition at line 221 of file SurfaceHolderImpl.h.

m_author

Author Trk::Segment::m_author

protectedinherited

segment author

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

m_containedMeasBases

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

protectedinherited

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

protectedinherited

The fit quality of the Segment.

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

m_globalPosition

Amg::Vector3D Trk::TrackSegment::m_globalPosition

private

Definition at line 102 of file TrackSegment.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:

• TrackSegment.h
• TrackSegment.cxx