Trk::Track Class Reference

The ATLAS Track class. More...

#include <Track.h>

Inheritance diagram for Trk::Track:

Collaboration diagram for Trk::Track:

Public Member Functions
	Track ()=default
	Default constructor Here for POOL and simple tests. More...
	Track (const TrackInfo &info, std::unique_ptr< TrackStates > trackStateOnSurfaces, std::unique_ptr< FitQuality > fitQuality)
	Full constructors. More...
	Track (const Track &rhs)
	copy constructor More...
Track &	operator= (const Track &rhs)
	assignment operator More...
	Track (Track &&rhs)=default
	move constructor More...
Track &	operator= (Track &&rhs)=default
	move assignment operator More...
virtual	~Track ()=default
	destructor More...
bool	isValid () const
	returns true if the track has non-nullptr fitQuality and non-empty Trk::TrackStates More...
const FitQuality *	fitQuality () const
	return a pointer to the fit quality const-overload More...
FitQuality *	fitQuality ()
	return a pointer to the fit quality non-const overload More...
void	setFitQuality (std::unique_ptr< FitQuality > quality)
	set FitQuality. More...
const Trk::TrackStates *	trackStateOnSurfaces () const
	return a pointer to a const DataVector of const TrackStateOnSurfaces. More...
Trk::TrackStates *	trackStateOnSurfaces ()
	return a pointer to a DataVector of const TrackStateOnSurfaces. More...
void	setTrackStateOnSurfaces (std::unique_ptr< Trk::TrackStates > input)
	Set the TrackStateOnSurfaces. More...
const TrackInfo &	info () const
	Returns a const ref to info of a const tracks. More...
TrackInfo &	info ()
	returns a ref to the info. More...
void	setInfo (const TrackInfo &input)
	set the info. More...
const Trk::TrackSummary *	trackSummary () const
	Returns a pointer to the const Trk::TrackSummary owned by this const track (could be nullptr) More...
Trk::TrackSummary *	trackSummary ()
	Returns a pointer to the Trk::TrackSummary owned by this track (could be nullptr) More...
void	setTrackSummary (std::unique_ptr< Trk::TrackSummary > input)
	Set the track summary. More...
const Perigee *	perigeeParameters () const
	return Perigee. More...
const DataVector< const TrackParameters > *	trackParameters () const
	Return a pointer to a vector of TrackParameters. More...
const DataVector< const MeasurementBase > *	measurementsOnTrack () const
	return a pointer to a vector of MeasurementBase (NOT including any that come from outliers). More...
const DataVector< const MeasurementBase > *	outliersOnTrack () const
	return a pointer to a vector of MeasurementBase, which represent outliers (i.e. More...
void	resetCaches ()
	reset all caches More...

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

Static Public Attributes
static std::atomic_size_t	s_numberOfInstantiations

Protected Types
typedef Trk::TrackStates::const_iterator	TSoS_iterator

Protected Member Functions
void	findPerigee () const
	Find perigee in the vector of track parameters. More...
void	copyHelper (const Track &rhs)
	Helper method to factor common part of copy ctor and copy assignment. More...

Protected Attributes
std::unique_ptr< TrackStates >	m_trackStateVector = nullptr
	TrackStateOnSurface. More...
CxxUtils::CachedValue< DataVector< const TrackParameters > >	m_cachedParameterVector {}
	A vector of TrackParameters: these can be any of the classes that derive from Trk::TrackParameters, for example, Perigee, MeasuredPerigee, AtaCylinder etc. More...
CxxUtils::CachedValue< DataVector< const MeasurementBase > >	m_cachedMeasurementVector {}
	A vector of MeasurementBase: these objects represent the "hits" on the track (but not outliers - see m_cachedOutlierVector) More...
CxxUtils::CachedValue< DataVector< const MeasurementBase > >	m_cachedOutlierVector {}
	These objects represent the "outliers" on the track. More...
CxxUtils::CachedValue< const Perigee * >	m_perigeeParameters {}
	A pointer to the Track's Perigee parameters. More...
std::unique_ptr< FitQuality >	m_fitQuality {nullptr}
	A pointer to the Track's FitQuality. More...
std::unique_ptr< Trk::TrackSummary >	m_trackSummary {nullptr}
	Datamember to cache the TrackSummary. More...
Trk::TrackInfo	m_trackInfo {}
	This is a class which stores the identity of where the track was created, fitted, which properties the reconstruction had. More...

Private Member Functions
void	findPerigeeImpl () const
	find PerigeeImpl. More...

Friends
class	TrackSlimmingTool
class	::TrackCnv_p1
class	::TrackCnv_p2
class	::TrackCnv_p3
class	::TrackCnv_p4
class	::TrackCnv_p12

Detailed Description

The ATLAS Track class.

This class is designed to work as a common track class, usable in a wide variety of applications, whilst remaining as simple as possible.

A Track is typically constructed via

• Trk::TrackInfo which holds information for the fitter employed.
• The relevant quality of the fit (Trk::FitQuality)
• A DataVector of const Trk::TrackStateOnSurface (TrackStates) representint the relevant measurements, parameters etc.

The usage of DataVector allows to constuct a track from a Datavector<DerivedFromTSOS> where DerivedFromTSOS is a type that derives from Trk::TrackStateOnSurface.

A Track will be valid if it holds a non empty DataVector and a non-nullpr FitQuality.

This class provides convenient helpers to retrieve and cache

• DataVectors (VIEW ELEMENTs) const TrackParameters
• DataVectors (VIEW ELEMENTs) const Measurements
• DataVectors (VIEW ELEMENTs) const Outliers
• The Track Parameter at perigee

The above are implemented via lazy initialization of see CxxUtils::CachedValue

If the TrackStates get modified the caches can be reset via the resetCaches method

Furthermore a Track can contain a Trk::TrackSummary (ptr so can be nullptr). This is typically is created via the TrackSummaryTool.

Author

edwar.nosp@m.d.mo.nosp@m.yse@c.nosp@m.ern..nosp@m.ch

Kiril.nosp@m.l.Pr.nosp@m.okofi.nosp@m.ev@c.nosp@m.ern.c.nosp@m.h

Christos Anastopoulos (MT modifications)

Definition at line 73 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

Member Typedef Documentation

TSoS_iterator

typedef Trk::TrackStates::const_iterator Trk::Track::TSoS_iterator

protected

Definition at line 228 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

Constructor & Destructor Documentation

Track() [1/4]

Trk::Track::Track ( )

default

Default constructor Here for POOL and simple tests.

The track will return isValid() == false. It is not expected to be used in production.

Track() [2/4]

Track::Track	(	const TrackInfo &	info,
		std::unique_ptr< TrackStates >	trackStateOnSurfaces,
		std::unique_ptr< FitQuality >	fitQuality
	)

Full constructors.

Definition at line 16 of file Tracking/TrkEvent/TrkTrack/src/Track.cxx.

    : Trk::ObjectCounter<Trk::Track>(),
      m_trackStateVector(std::move(trackStateOnSurfaces)),
      m_cachedParameterVector{},
      m_cachedMeasurementVector{},
      m_cachedOutlierVector{},
      m_perigeeParameters{},
      m_fitQuality(std::move(fitQuality)),
      m_trackInfo(info) {
  // find the Perigee params they will become valid given the outcome
  findPerigeeImpl();
}

Track() [3/4]

Track::Track

(

const Track &

rhs

)

copy constructor

Definition at line 31 of file Tracking/TrkEvent/TrkTrack/src/Track.cxx.

    : Trk::ObjectCounter<Trk::Track>(rhs),
      m_cachedParameterVector{},
      m_cachedMeasurementVector{},
      m_cachedOutlierVector{},
      m_perigeeParameters{},
      m_fitQuality(nullptr) {
  // Do the actual payload copy
  copyHelper(rhs);
}

Track() [4/4]

Trk::Track::Track ( Track &&  rhs )

default

move constructor

~Track()

virtual Trk::Track::~Track ( )

virtualdefault

destructor

Member Function Documentation

copyHelper()

void Track::copyHelper ( const Track &  rhs )

protected

Helper method to factor common part of copy ctor and copy assignment.

Definition at line 56 of file Tracking/TrkEvent/TrkTrack/src/Track.cxx.

                                             {
  // set the author to be that of the Track being copied.
  m_trackInfo = rhs.m_trackInfo;
 
  // create & copy other variables if available
  if (rhs.fitQuality() != nullptr) {
    m_fitQuality = std::make_unique<Trk::FitQuality>(*(rhs.m_fitQuality));
  }
  // create & copy other variables
  if (rhs.trackSummary() != nullptr) {
    m_trackSummary = std::make_unique<Trk::TrackSummary>(*(rhs.m_trackSummary));
  }
  // Create the TrackStateVector and the perigeeParameters
 
  if (rhs.m_trackStateVector != nullptr) {
    m_trackStateVector = std::make_unique<TrackStates>();
    m_trackStateVector->reserve(rhs.m_trackStateVector->size());
 
    TSoS_iterator itTSoSEnd = rhs.m_trackStateVector->cend();
    for (TSoS_iterator itTSoS = rhs.m_trackStateVector->cbegin();
         itTSoS != itTSoSEnd; ++itTSoS) {
      assert(*itTSoS != nullptr);  // check that is defined.
      // clone and store
      TrackStateOnSurface* tsos = (**itTSoS).clone();
      m_trackStateVector->push_back(tsos);
      // Check if this a perigee so we can already cache it
      if (tsos != nullptr && tsos->type(TrackStateOnSurface::Perigee)) {
        const Trk::Perigee* perigee = nullptr;
        const Trk::TrackParameters* tp = tsos->trackParameters();
        if (tp && tp->type() == Trk::AtaSurface &&
            tp->surfaceType() == Trk::SurfaceType::Perigee) {
          perigee = static_cast<const Trk::Perigee*>(tp);
        }
        if (perigee != nullptr) {
          m_perigeeParameters.store(perigee);  // Now they will be valid
        }
      }
    }
  }
}

findPerigee()

void Track::findPerigee ( ) const

protected

Find perigee in the vector of track parameters.

It can be used to lazy-init the m_perigeeParameters

Definition at line 123 of file Tracking/TrkEvent/TrkTrack/src/Track.cxx.

                                 {
  if (!m_perigeeParameters.isValid()) {
    findPerigeeImpl();
  }
}

findPerigeeImpl()

void Track::findPerigeeImpl ( ) const

private

find PerigeeImpl.

Assumes that Perigee parameters are currently inValid.

Definition at line 129 of file Tracking/TrkEvent/TrkTrack/src/Track.cxx.

                                     {
  // loop through all passed parameters and, if there is a at Perigee in there,
  // assign it to Perigee parameters. There should never be more
  // than one perigee type.
  // Note that there can be other objects, like VertexOnTrack measurements, with
  // params at a Perigee surface, thus the  TSoS check.
 
  const Trk::Perigee* tmpPerigeeParameters = nullptr;
  if (!m_trackStateVector) {
    return;
  }
  Trk::TrackStates::const_iterator it =
      m_trackStateVector->cbegin();
  Trk::TrackStates::const_iterator itEnd =
      m_trackStateVector->cend();
  for (; it != itEnd; ++it) {
    if ((*it)->type(TrackStateOnSurface::Perigee)) {
      const Trk::TrackParameters* tp = (*it)->trackParameters();
      if (tp && tp->type() == Trk::AtaSurface &&
          tp->surfaceType() == Trk::SurfaceType::Perigee) {
        tmpPerigeeParameters = static_cast<const Trk::Perigee*>(tp);
      }
 
      if (tmpPerigeeParameters != nullptr) {
        break;  // found perigee so stop loop.
      }
    }
  }
  // set to value and valid
  if (tmpPerigeeParameters) {
    m_perigeeParameters.set(tmpPerigeeParameters);
  }
}

fitQuality() [1/2]

FitQuality* Trk::Track::fitQuality

(

)

return a pointer to the fit quality non-const overload

fitQuality() [2/2]

const FitQuality* Trk::Track::fitQuality

(

)

const

return a pointer to the fit quality const-overload

info() [1/2]

TrackInfo& Trk::Track::info

(

)

returns a ref to the info.

non-const overload

info() [2/2]

const TrackInfo& Trk::Track::info

(

)

const

Returns a const ref to info of a const tracks.

isValid()

bool Trk::Track::isValid

(

)

const

returns true if the track has non-nullptr fitQuality and non-empty Trk::TrackStates

measurementsOnTrack()

const DataVector< const Trk::MeasurementBase > * Track::measurementsOnTrack

(

)

const

return a pointer to a vector of MeasurementBase (NOT including any that come from outliers).

This DataVector is lazily created by this method and cached.

Returns

Pointer to a DV of MeasurementBase. The MeasurementBases are not owned by the DV (it is a view)

Definition at line 178 of file Tracking/TrkEvent/TrkTrack/src/Track.cxx.

          {
  if (!m_trackStateVector) {
    return nullptr;
  }
 
  // We only need to do work if not valid.
  if (!m_cachedMeasurementVector.isValid()) {
    // create new DataVector which DOES NOT OWN ELEMENTS .
    DataVector<const Trk::MeasurementBase> tmpMeasurementVector(
        SG::VIEW_ELEMENTS);
    // for measurements on track it is very likely that #(meas) ~ #(TSOS)->
    // reserve(#(TSOS))
    tmpMeasurementVector.reserve(m_trackStateVector->size());
 
    TSoS_iterator itTSoSEnd = m_trackStateVector->cend();
    for (TSoS_iterator itTSoS = m_trackStateVector->cbegin(); itTSoS != itTSoSEnd;
         ++itTSoS) {
      if (!(*itTSoS)->type(TrackStateOnSurface::Outlier)) {
        const Trk::MeasurementBase* rot = (*itTSoS)->measurementOnTrack();
        // does it have a measurement ?
        if (rot != nullptr) {
          tmpMeasurementVector.push_back(rot);
        }
      }
    }
    m_cachedMeasurementVector.set(std::move(tmpMeasurementVector));
  }
 
  return m_cachedMeasurementVector.ptr();
}

numberOfInstantiations()

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

inlinestaticinherited

Definition at line 25 of file TrkObjectCounter.h.

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

operator=() [1/2]

Trk::Track & Track::operator=

(

const Track &

rhs

)

assignment operator

Definition at line 42 of file Tracking/TrkEvent/TrkTrack/src/Track.cxx.

                                                 {
  if (this != &rhs) {
    // First clear this object
    m_fitQuality.reset(nullptr);
    m_trackSummary.reset(nullptr);
    // Invalidate the caches
    resetCaches();
    m_trackStateVector.reset();
    // copy payload of rhs to this
    copyHelper(rhs);
  }
  return *this;
}

operator=() [2/2]

Track& Trk::Track::operator= ( Track &&  rhs )

default

move assignment operator

outliersOnTrack()

const DataVector< const Trk::MeasurementBase > * Track::outliersOnTrack

(

)

const

return a pointer to a vector of MeasurementBase, which represent outliers (i.e.

measurements not used in the track fit). This DataVector is created lazily by this method and then cached.

Returns

Pointer to a DV of MeasurementBase, representing outliers. The MeasurementBases are not owned by the DV (it is a view)

Definition at line 210 of file Tracking/TrkEvent/TrkTrack/src/Track.cxx.

          {
  if (!m_trackStateVector) {
    return nullptr;
  }
  // We only need to do work if not valid
  if (!m_cachedOutlierVector.isValid()) {
    // create new DataVector which DOES NOT OWN ELEMENTS .
    DataVector<const Trk::MeasurementBase> tmpOutlierVector(SG::VIEW_ELEMENTS);
    TSoS_iterator itTSoSEnd = m_trackStateVector->cend();
    for (TSoS_iterator itTSoS = m_trackStateVector->cbegin(); itTSoS != itTSoSEnd;
         ++itTSoS) {
      if ((*itTSoS)->type(TrackStateOnSurface::Outlier)) {
        const Trk::MeasurementBase* rot = (*itTSoS)->measurementOnTrack();
        assert(rot != nullptr);
        tmpOutlierVector.push_back(rot);
      }
    }
    m_cachedOutlierVector.set(std::move(tmpOutlierVector));
  }
  return m_cachedOutlierVector.ptr();
}

perigeeParameters()

const Trk::Perigee * Track::perigeeParameters

(

)

const

return Perigee.

Can be nullptr if no perigee parameters were assigned to the Track.

This method performs lazy initialization and caches the result.

PLEASE NOTE! if there is more than one Perigee in trackStateOnSurfaces (which there shouldn't be!!), only the first one will be returned by Trk::Track::perigeeParameters Although the Perigee is just a type of TrackParameter, it has a dedicated method because of the specific physics interest

Definition at line 163 of file Tracking/TrkEvent/TrkTrack/src/Track.cxx.

                                                    {
  if (!m_perigeeParameters.isValid()) {
    // findPerigee performs the setting of the parameters
    // i.e does the CachedValue set
    findPerigeeImpl();
  }
 
  // Return payload if valid
  if (m_perigeeParameters.isValid()) {
    return *(m_perigeeParameters.ptr());
  }
 
  return nullptr;
}

resetCaches()

void Trk::Track::resetCaches

(

)

reset all caches

setFitQuality()

void Trk::Track::setFitQuality

(

std::unique_ptr< FitQuality >

quality

)

set FitQuality.

setInfo()

void Trk::Track::setInfo

(

const TrackInfo &

input

)

set the info.

setTrackStateOnSurfaces()

void Trk::Track::setTrackStateOnSurfaces

(

std::unique_ptr< Trk::TrackStates >

input

)

Set the TrackStateOnSurfaces.

setTrackSummary()

void Trk::Track::setTrackSummary

(

std::unique_ptr< Trk::TrackSummary >

input

)

Set the track summary.

trackParameters()

const DataVector< const Trk::TrackParameters > * Track::trackParameters

(

)

const

Return a pointer to a vector of TrackParameters.

It is created Lazily by this method and then cached.

Returns

Pointer to a DV of TrackParameters, or 0. The TrackParameters are not owned by the DV (it is a view)

Definition at line 97 of file Tracking/TrkEvent/TrkTrack/src/Track.cxx.

          {
 
  if (!m_trackStateVector) {
    return nullptr;
  }
  // Do work only if it is not valid.
  if (!m_cachedParameterVector.isValid()) {
    // create cached parameter vector (which DOES NOT OWN ELEMENTS)
    DataVector<const Trk::TrackParameters> tmp_ParameterVector(
        SG::VIEW_ELEMENTS);
    tmp_ParameterVector.reserve(m_trackStateVector->size());
    TSoS_iterator itTSoSEnd = m_trackStateVector->cend();
    for (TSoS_iterator itTSoS = m_trackStateVector->cbegin(); itTSoS != itTSoSEnd;
         ++itTSoS) {
      const TrackParameters* trackParameters = (*itTSoS)->trackParameters();
      // check to make sure that the TrackParameters exists first
      if (trackParameters != nullptr) {
        tmp_ParameterVector.push_back(trackParameters);
      }
    }
    m_cachedParameterVector.set(std::move(tmp_ParameterVector));
  }
  return m_cachedParameterVector.ptr();
}

trackStateOnSurfaces() [1/2]

Trk::TrackStates* Trk::Track::trackStateOnSurfaces

(

)

return a pointer to a DataVector of const TrackStateOnSurfaces.

non-const overload

trackStateOnSurfaces() [2/2]

const Trk::TrackStates* Trk::Track::trackStateOnSurfaces

(

)

const

return a pointer to a const DataVector of const TrackStateOnSurfaces.

const overload

trackSummary() [1/2]

Trk::TrackSummary* Trk::Track::trackSummary

(

)

Returns a pointer to the Trk::TrackSummary owned by this track (could be nullptr)

trackSummary() [2/2]

const Trk::TrackSummary* Trk::Track::trackSummary

(

)

const

Returns a pointer to the const Trk::TrackSummary owned by this const track (could be nullptr)

Friends And Related Function Documentation

::TrackCnv_p1

friend class ::TrackCnv_p1

friend

Definition at line 222 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

::TrackCnv_p12

friend class ::TrackCnv_p12

friend

Definition at line 226 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

::TrackCnv_p2

friend class ::TrackCnv_p2

friend

Definition at line 223 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

::TrackCnv_p3

friend class ::TrackCnv_p3

friend

Definition at line 224 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

::TrackCnv_p4

friend class ::TrackCnv_p4

friend

Definition at line 225 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

TrackSlimmingTool

friend class TrackSlimmingTool

friend

Definition at line 75 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

Member Data Documentation

m_cachedMeasurementVector

CxxUtils::CachedValue<DataVector<const MeasurementBase> > Trk::Track::m_cachedMeasurementVector {}

protected

A vector of MeasurementBase: these objects represent the "hits" on the track (but not outliers - see m_cachedOutlierVector)

It is created in the return method by looping over all Trk::TrackStateOnSurface adding their pointers to the payload of m_cachedMeasurementVector

Definition at line 271 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

m_cachedOutlierVector

CxxUtils::CachedValue<DataVector<const MeasurementBase> > Trk::Track::m_cachedOutlierVector {}

protected

These objects represent the "outliers" on the track.

It is created in the return method by looping over all Trk::TrackStateOnSurface adding their pointers to the payload of m_cachedRioVector

Definition at line 280 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

m_cachedParameterVector

CxxUtils::CachedValue<DataVector<const TrackParameters> > Trk::Track::m_cachedParameterVector {}

protected

A vector of TrackParameters: these can be any of the classes that derive from Trk::TrackParameters, for example, Perigee, MeasuredPerigee, AtaCylinder etc.

It is created in the return method by looping over all Trk::TrackStateOnSurface adding their pointers to the payload of m_cachedParameterVector

Definition at line 260 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

m_fitQuality

std::unique_ptr<FitQuality> Trk::Track::m_fitQuality {nullptr}

protected

A pointer to the Track's FitQuality.

Definition at line 293 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

m_perigeeParameters

CxxUtils::CachedValue<const Perigee*> Trk::Track::m_perigeeParameters {}

protected

A pointer to the Track's Perigee parameters.

This will be null if the track does not contain a Perigee or MeasuredPerigee parameter

Definition at line 288 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

m_trackInfo

Trk::TrackInfo Trk::Track::m_trackInfo {}

protected

This is a class which stores the identity of where the track was created, fitted, which properties the reconstruction had.

Definition at line 304 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

m_trackStateVector

std::unique_ptr<TrackStates> Trk::Track::m_trackStateVector = nullptr

protected

TrackStateOnSurface.

These objects link the various parameters related to a surface, for example, TrackParameter, RIO_OnTrack and FitQualityOnSurface

Definition at line 248 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

m_trackSummary

std::unique_ptr<Trk::TrackSummary> Trk::Track::m_trackSummary {nullptr}

protected

Datamember to cache the TrackSummary.

Definition at line 298 of file Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h.

s_numberOfInstantiations

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

inlinestaticinherited

Definition at line 22 of file TrkObjectCounter.h.

---

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

• Tracking/TrkEvent/TrkTrack/TrkTrack/Track.h
• Tracking/TrkEvent/TrkTrack/src/Track.cxx