ACTS
Experiment-independent tracking
Loading...
Searching...
No Matches
Acts::TrackProxyCommon< Derived, index_t, read_only > Class Template Reference

Common CRTP implementation shared by the various track proxy front-ends. More...

#include <Acts/EventData/TrackProxyCommon.hpp>

Inheritance diagram for Acts::TrackProxyCommon< Derived, index_t, read_only >:
[legend]

Public Types

using IndexType = index_t
 Index type used for referencing track states.

Public Member Functions

double absoluteMomentum () const
 Get the absolute momentum.
double charge () const
 Get the charge.
float & chi2 ()
 Return a mutable reference to the local chi-squared contribution.
float chi2 () const
 Return the local chi-squared contribution.
Vector3 direction () const
 Get a unit vector along the track direction at the reference surface.
Vector4 fourMomentum () const
 Get the four-momentum vector: (px, py, pz, e).
double loc0 () const
 Access the loc0 parameter of the track at the reference surface.
double loc1 () const
 Access the loc1 parameter of the track at the reference surface.
Vector3 momentum () const
 Get the global momentum vector.
unsigned int & nDoF ()
 Return a mutable reference to the number of degrees of freedom.
unsigned int nDoF () const
 Return the number of degrees of freedom.
unsigned int & nHoles ()
 Return a mutable reference to the number of holes.
unsigned int nHoles () const
 Return the number of holes on this track.
unsigned int & nMeasurements ()
 Return a mutable reference to the number of measurements.
unsigned int nMeasurements () const
 Return the number of measurements assigned to this track.
unsigned int & nOutliers ()
 Return a mutable reference to the number of outliers.
unsigned int nOutliers () const
 Return the number of outliers for this track.
unsigned int & nSharedHits ()
 Return a mutable reference to the number of shared hits.
unsigned int nSharedHits () const
 Return the number of shared hits for this track.
double phi () const
 Access the phi parameter of the track at the reference surface.
double qOverP () const
 Access the q/p (curvature) parameter of the track at the reference surface.
IndexTypestemIndex ()
 Get a mutable reference to the stem index.
IndexType stemIndex () const
 Get the stem index, i.e. the innermost track state in the track.
double theta () const
 Access the theta parameter of the track at the reference surface.
double time () const
 Access the time parameter of the track at the reference surface.
IndexTypetipIndex ()
 Get a mutable reference to the tip index.
IndexType tipIndex () const
 Get the tip index, i.e. the entry point into the track state container.
double transverseMomentum () const
 Get the transverse momentum.

Protected Member Functions

constexpr Derived & derived ()
constexpr const Derived & derived () const

Detailed Description

template<typename Derived, typename index_t, bool read_only>
class Acts::TrackProxyCommon< Derived, index_t, read_only >

Common CRTP implementation shared by the various track proxy front-ends.

The derived proxy only needs to expose the component helpers, while this base class wires up the commonly used convenience methods.

Template Parameters
DerivedThe proxy implementation inheriting from this base
index_tThe index type used by the proxy
read_onlyWhether the proxy provides mutable access

Member Typedef Documentation

◆ IndexType

template<typename Derived, typename index_t, bool read_only>
using Acts::TrackProxyCommon< Derived, index_t, read_only >::IndexType = index_t

Index type used for referencing track states.

Member Function Documentation

◆ absoluteMomentum()

template<typename Derived, typename index_t, bool read_only>
double Acts::TrackProxyCommon< Derived, index_t, read_only >::absoluteMomentum ( ) const

Get the absolute momentum.

Returns
The absolute momentum value

◆ charge()

template<typename Derived, typename index_t, bool read_only>
double Acts::TrackProxyCommon< Derived, index_t, read_only >::charge ( ) const

Get the charge.

Returns
The charge value

◆ chi2() [1/2]

template<typename Derived, typename index_t, bool read_only>
float & Acts::TrackProxyCommon< Derived, index_t, read_only >::chi2 ( )

Return a mutable reference to the local chi-squared contribution.

◆ chi2() [2/2]

template<typename Derived, typename index_t, bool read_only>
float Acts::TrackProxyCommon< Derived, index_t, read_only >::chi2 ( ) const

Return the local chi-squared contribution.

◆ derived() [1/2]

template<typename Derived, typename index_t, bool read_only>
Derived & Acts::TrackProxyCommon< Derived, index_t, read_only >::derived ( )
constexprprotected

◆ derived() [2/2]

template<typename Derived, typename index_t, bool read_only>
const Derived & Acts::TrackProxyCommon< Derived, index_t, read_only >::derived ( ) const
constexprprotected

◆ direction()

template<typename Derived, typename index_t, bool read_only>
Vector3 Acts::TrackProxyCommon< Derived, index_t, read_only >::direction ( ) const

Get a unit vector along the track direction at the reference surface.

Returns
The direction unit vector

◆ fourMomentum()

template<typename Derived, typename index_t, bool read_only>
Vector4 Acts::TrackProxyCommon< Derived, index_t, read_only >::fourMomentum ( ) const

Get the four-momentum vector: (px, py, pz, e).

Returns
the four-momentum vector

◆ loc0()

template<typename Derived, typename index_t, bool read_only>
double Acts::TrackProxyCommon< Derived, index_t, read_only >::loc0 ( ) const

Access the loc0 parameter of the track at the reference surface.

Returns
The loc0 parameter

◆ loc1()

template<typename Derived, typename index_t, bool read_only>
double Acts::TrackProxyCommon< Derived, index_t, read_only >::loc1 ( ) const

Access the loc1 parameter of the track at the reference surface.

Returns
The loc1 parameter

◆ momentum()

template<typename Derived, typename index_t, bool read_only>
Vector3 Acts::TrackProxyCommon< Derived, index_t, read_only >::momentum ( ) const

Get the global momentum vector.

Returns
the global momentum vector

◆ nDoF() [1/2]

template<typename Derived, typename index_t, bool read_only>
unsigned int & Acts::TrackProxyCommon< Derived, index_t, read_only >::nDoF ( )

Return a mutable reference to the number of degrees of freedom.

◆ nDoF() [2/2]

template<typename Derived, typename index_t, bool read_only>
unsigned int Acts::TrackProxyCommon< Derived, index_t, read_only >::nDoF ( ) const

Return the number of degrees of freedom.

◆ nHoles() [1/2]

template<typename Derived, typename index_t, bool read_only>
unsigned int & Acts::TrackProxyCommon< Derived, index_t, read_only >::nHoles ( )

Return a mutable reference to the number of holes.

◆ nHoles() [2/2]

template<typename Derived, typename index_t, bool read_only>
unsigned int Acts::TrackProxyCommon< Derived, index_t, read_only >::nHoles ( ) const

Return the number of holes on this track.

◆ nMeasurements() [1/2]

template<typename Derived, typename index_t, bool read_only>
unsigned int & Acts::TrackProxyCommon< Derived, index_t, read_only >::nMeasurements ( )

Return a mutable reference to the number of measurements.

◆ nMeasurements() [2/2]

template<typename Derived, typename index_t, bool read_only>
unsigned int Acts::TrackProxyCommon< Derived, index_t, read_only >::nMeasurements ( ) const

Return the number of measurements assigned to this track.

◆ nOutliers() [1/2]

template<typename Derived, typename index_t, bool read_only>
unsigned int & Acts::TrackProxyCommon< Derived, index_t, read_only >::nOutliers ( )

Return a mutable reference to the number of outliers.

◆ nOutliers() [2/2]

template<typename Derived, typename index_t, bool read_only>
unsigned int Acts::TrackProxyCommon< Derived, index_t, read_only >::nOutliers ( ) const

Return the number of outliers for this track.

◆ nSharedHits() [1/2]

template<typename Derived, typename index_t, bool read_only>
unsigned int & Acts::TrackProxyCommon< Derived, index_t, read_only >::nSharedHits ( )

Return a mutable reference to the number of shared hits.

◆ nSharedHits() [2/2]

template<typename Derived, typename index_t, bool read_only>
unsigned int Acts::TrackProxyCommon< Derived, index_t, read_only >::nSharedHits ( ) const

Return the number of shared hits for this track.

◆ phi()

template<typename Derived, typename index_t, bool read_only>
double Acts::TrackProxyCommon< Derived, index_t, read_only >::phi ( ) const

Access the phi parameter of the track at the reference surface.

Returns
The phi parameter

◆ qOverP()

template<typename Derived, typename index_t, bool read_only>
double Acts::TrackProxyCommon< Derived, index_t, read_only >::qOverP ( ) const

Access the q/p (curvature) parameter of the track at the reference surface.

Returns
The q/p parameter

◆ stemIndex() [1/2]

template<typename Derived, typename index_t, bool read_only>
IndexType & Acts::TrackProxyCommon< Derived, index_t, read_only >::stemIndex ( )

Get a mutable reference to the stem index.

◆ stemIndex() [2/2]

template<typename Derived, typename index_t, bool read_only>
IndexType Acts::TrackProxyCommon< Derived, index_t, read_only >::stemIndex ( ) const

Get the stem index, i.e. the innermost track state in the track.

◆ theta()

template<typename Derived, typename index_t, bool read_only>
double Acts::TrackProxyCommon< Derived, index_t, read_only >::theta ( ) const

Access the theta parameter of the track at the reference surface.

Returns
The theta parameter

◆ time()

template<typename Derived, typename index_t, bool read_only>
double Acts::TrackProxyCommon< Derived, index_t, read_only >::time ( ) const

Access the time parameter of the track at the reference surface.

Returns
The time parameter

◆ tipIndex() [1/2]

template<typename Derived, typename index_t, bool read_only>
IndexType & Acts::TrackProxyCommon< Derived, index_t, read_only >::tipIndex ( )

Get a mutable reference to the tip index.

◆ tipIndex() [2/2]

template<typename Derived, typename index_t, bool read_only>
IndexType Acts::TrackProxyCommon< Derived, index_t, read_only >::tipIndex ( ) const

Get the tip index, i.e. the entry point into the track state container.

◆ transverseMomentum()

template<typename Derived, typename index_t, bool read_only>
double Acts::TrackProxyCommon< Derived, index_t, read_only >::transverseMomentum ( ) const

Get the transverse momentum.

Returns
The transverse momentum value