ACTS
Experiment-independent tracking
Loading...
Searching...
No Matches
Acts::TrackStateProxy< trajectory_t, M, read_only > Class Template Reference

Proxy object to access a single point on the trajectory. More...

#include <Acts/EventData/TrackStateProxy.hpp>

Inheritance diagram for Acts::TrackStateProxy< trajectory_t, M, read_only >:
[legend]
Collaboration diagram for Acts::TrackStateProxy< trajectory_t, M, read_only >:
[legend]

Public Types

template<std::size_t N>
using Calibrated = typename TrackStateTraits<N, false>::Calibrated
 Map-type for a calibrated measurement vector, where the local measurement dimension is variable.
template<std::size_t N>
using CalibratedCovariance
 Map-type for a calibrated measurement covariance matrix, where the local measurement dimension is variable.
template<std::size_t N>
using ConstCalibrated = typename TrackStateTraits<N, true>::Calibrated
 Same as Calibrated, but with const semantics.
template<std::size_t N>
using ConstCalibratedCovariance
 Same as CalibratedCovariance, but with const semantics.
using ConstCovariance = typename TrackStateTraits<M, true>::Covariance
 Same as Covariance, but with const semantics.
using ConstEffectiveCalibrated
 Same as EffectiveCalibrated, but with const semantics.
using ConstEffectiveCalibratedCovariance
 Same as EffectiveCalibratedCovariance, but with const semantics.
using ConstJacobian = typename TrackStateTraits<M, true>::Covariance
 Jacobian shape is identical to Covariance.
using ConstParameters = typename TrackStateTraits<M, true>::Parameters
 Same as Parameters, but with const semantics.
using ConstProxyType = TrackStateProxy<trajectory_t, M, true>
 Alias for an associated const track state proxy, with the same backends.
using Covariance = typename TrackStateTraits<M, false>::Covariance
 Map-type for a bound covariance.
using EffectiveCalibrated
 Map-type for a measurement vector, where the local measurement dimension is variable.
using EffectiveCalibratedCovariance
 Map-type for a measurement covariance matrix, where the local measurement dimension is variable.
using IndexType = TrackIndexType
 The index type of the track state container.
using Jacobian = typename TrackStateTraits<M, false>::Covariance
 Jacobian shape is identical to Covariance.
using Parameters = typename TrackStateTraits<M, false>::Parameters
 Map-type for a bound parameter vector.
using Trajectory = trajectory_t
 The track state container backend given as a template parameter.
Public Types inherited from Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, true >, true >
using ParametersMap
 Mutable Eigen map type for bound track parameters.
using ConstParametersMap
 Const Eigen map type for bound track parameters.
using CovarianceMap
 Mutable Eigen map type for bound track parameter covariance.
using ConstCovarianceMap
 Const Eigen map type for bound track parameter covariance.
using EffectiveCalibratedMap
 Mutable Eigen map type for calibrated measurements (dynamic size).
using ConstEffectiveCalibratedMap
 Const Eigen map type for calibrated measurements (dynamic size).
using EffectiveCalibratedCovarianceMap
 Mutable Eigen map type for calibrated measurement covariance (dynamic size).
using ConstEffectiveCalibratedCovarianceMap
 Const Eigen map type for calibrated measurement covariance (dynamic size).

Public Member Functions

void allocateCalibrated (const Eigen::DenseBase< val_t > &val, const Eigen::DenseBase< cov_t > &cov)
 Allocate and initialize calibrated data from static-size Eigen objects.
TrackStateTraits< measdim, false >::Calibrated calibrated ()
 Access calibrated measurement data with compile-time dimension.
TrackStateTraits< measdim, true >::Calibrated calibrated () const
 Access calibrated measurement data with compile-time dimension.
TrackStateTraits< measdim, false >::CalibratedCovariance calibratedCovariance ()
 Access calibrated covariance data with compile-time dimension.
TrackStateTraits< measdim, true >::CalibratedCovariance calibratedCovariance () const
 Access calibrated covariance data with compile-time dimension.
float & chi2 ()
 Retrieve a mutable reference to the local chi2 contribution.
float chi2 () const
 Retrieve the local chi2 contribution.
auto & container ()
 Get a mutable reference to the track state container backend.
const auto & container () const
 Get a const reference to the track state container backend.
ConstCovarianceMap covariance () const
 Access the best available covariance (smoothed, filtered, or predicted).
EffectiveCalibratedMap effectiveCalibrated ()
 Access mutable calibrated measurement values with runtime dimension.
ConstEffectiveCalibratedMap effectiveCalibrated () const
 Access the calibrated measurement values with runtime dimension.
EffectiveCalibratedCovarianceMap effectiveCalibratedCovariance ()
 Access mutable calibrated covariance with runtime dimension.
ConstEffectiveCalibratedCovarianceMap effectiveCalibratedCovariance () const
 Access the calibrated covariance with runtime dimension.
ParametersMap filtered ()
 Access the filtered parameter vector.
ConstParametersMap filtered () const
 Access the filtered parameter vector.
CovarianceMap filteredCovariance ()
 Access the filtered covariance matrix.
ConstCovarianceMap filteredCovariance () const
 Access the filtered covariance matrix.
TrackStatePropMask getMask () const
 Compute the property mask describing which components are present.
bool hasCalibrated () const
 Check for presence of calibrated measurement data.
bool hasColumn (HashedString key) const
 Check if the track state has a specific dynamic column.
bool hasFiltered () const
 Check for presence of filtered track parameters.
bool hasJacobian () const
 Check for presence of a transport Jacobian.
bool hasPredicted () const
 Check for presence of predicted track parameters.
bool hasPrevious () const
 Check whether this state links to a previous state.
bool hasProjector () const
 Check for presence of a measurement projector.
bool hasSmoothed () const
 Check for presence of smoothed track parameters.
Covariance jacobian ()
 Returns the jacobian from the previous trackstate to this one.
ConstCovariance jacobian () const
 Returns the jacobian from the previous trackstate to this one.
ConstParametersMap parameters () const
 Access the best available parameters (smoothed, filtered, or predicted).
double & pathLength ()
 Retrieve a mutable reference to the accumulated path length.
double pathLength () const
 Retrieve the accumulated path length.
ParametersMap predicted ()
 Access the predicted parameter vector.
ConstParametersMap predicted () const
 Access the predicted parameter vector.
CovarianceMap predictedCovariance ()
 Access the predicted covariance matrix.
ConstCovarianceMap predictedCovariance () const
 Access the predicted covariance matrix.
TrackIndexTypeprevious ()
 Retrieve a mutable reference to the previous track state index.
TrackIndexType previous () const
 Retrieve the previous track state index in the linked trajectory.
VariableBoundSubspaceHelper projectorSubspaceHelper () const
 Creates a variable size subspace helper.
BoundSubspaceIndices projectorSubspaceIndices () const
 Decode the measurement projector indices.
void setProjectorSubspaceIndices (const index_range_t &subspaceIndices)
 Store subspace indices describing the measurement projector.
ParametersMap smoothed ()
 Access the smoothed parameter vector.
ConstParametersMap smoothed () const
 Access the smoothed parameter vector.
CovarianceMap smoothedCovariance ()
 Access the smoothed covariance matrix.
ConstCovarianceMap smoothedCovariance () const
 Access the smoothed covariance matrix.
MultiTrajectory< Trajectory > & trajectory ()
 Return a mutable reference to the underlying backend container.
const MultiTrajectory< Trajectory > & trajectory () const
 Return a const reference to the underlying backend container.
MutableTrackStateTypeMap typeFlags ()
 Retrieve mutable track-state type flags.
ConstTrackStateTypeMap typeFlags () const
 Retrieve the track-state type flags.
Constructors and assignment operator

Public constructors and assignment operators for TrackStateProxy only allow construction from another TrackStateProxy. You should generally not have to construct TrackStateProxy manually.

 TrackStateProxy (const TrackStateProxy &other)=default
 Copy constructor: const to const or mutable to mutable.
TrackStateProxyoperator= (const TrackStateProxy &other)=default
 Copy assignment operator: const to const or mutable to mutable.
 TrackStateProxy (const TrackStateProxy< Trajectory, M, false > &other)
 Constructor from mutable TrackStateProxy.
TrackStateProxyoperator= (const TrackStateProxy< Trajectory, M, false > &other)
 Assignment operator to from mutable TrackStateProxy.
Track state properties

Properties of the track state represented by TrackStateProxy.

Many of these methods come in a const and a non-const version. The non-const version is only available if you have an instance of TrackStateProxy that does not have the read_only template parameter set to true, even if you hold it as an lvalue.

The track states each have an index in the track state container. The sequence of track states is implemented as a one or two-way linked list, which uses indices into the same container.

Each track state has a previous index, which points at the track state immediately preceding. A track state with a previous index of kInvalid is the first (innermost) track state in a track or track candidate. This is also referred to as a stem at the track level.

During track finding and fitting, track states are usually appended to the sequence, populating the previous index of the new track state. Combinatorial track finding can produce track states which fork in this way, by having more than one track state with the same previous index.

The track states have static, optional and dynamic properties. Static properties are always present, and can always be retrieved. Optional components use an extra indirection mechanism that coordinates with the backend to allow both not having the component set, or sharing it with other track states. An example is a branching trajectory from track finding which shares the same predicted parameter vector and associated covariance.

Optional components are

  • predicted parameters and covariance
  • filtered parameters and covariance
  • smoothed parameters and covariance
  • jacobian
  • calibrated measurement info including projector

They can be unset via unset, getMask can be used to check which components are present. The first four are shareable between track states via shareFrom.

IndexType index () const
 Index within the trajectory.
void unset (TrackStatePropMask target)
 Unset an optional track state component.
void addComponents (TrackStatePropMask mask)
 Add additional components to the track state.
const SurfacereferenceSurface () const
 Reference surface.
bool hasReferenceSurface () const
 Returns if the track state has a non nullptr surface associated.
void setReferenceSurface (std::shared_ptr< const Surface > srf)
 Set the reference surface to a given value.
Track state measurement properties

Properties of the measurement associated with the track state represented. This consists of a vector and an associated square matrix of a measurement dimension which is between one and the size of the track parametrization. The measurement coordinate frame is required to be a strict subset of the bound track parametrization on the local geometry coordinate frame, i.e. using a pure projector matrix to convert from the bound parametrization to the measurement frame is possible.

The track state stores the parameter vector and covariance, and the backend is given the possibility to do so in a jagged way, i.e. only storing the number of values needed. This requires calling allocateCalibrated before storing the measurements (even if it might be a no-op).

The projector matrix is packed as a bitset, which is converted to a matrix on-demand (and therefore returned by value).

The track state also includes a SourceLink which acts as a proxy to the original uncalibrated measurement that the calibrated measurement was derived from. It is set and returned by value, to allow unpacking / repacking by the backend, if needed.

SourceLink getUncalibratedSourceLink () const
 Uncalibrated measurement in the form of a source link.
void setUncalibratedSourceLink (SourceLink &&sourceLink)
 Set an uncalibrated source link.
bool hasUncalibratedSourceLink () const
 Check if the point has an associated uncalibrated measurement.
IndexType calibratedSize () const
 Return the (dynamic) number of dimensions stored for this measurement.
void allocateCalibrated (std::size_t measdim)
 Allocate storage to be able to store a measurement of size measdim.
Sharing and copying

Methods to share and copy track state components. Sharing means setting up more than one track state to point to the same component.

Shareable components are

  • predicted parameters and covariance
  • filtered parameters and covariance
  • smoothed parameters and covariance
  • jacobian

See TrackStatePropMask.

void shareFrom (TrackStatePropMask shareSource, TrackStatePropMask shareTarget)
 Share a shareable component within this track state.
template<bool ReadOnlyOther>
requires (!ReadOnly)
void shareFrom (const TrackStateProxy< Trajectory, M, ReadOnlyOther > &other, TrackStatePropMask component)
 Share a shareable component from another track state.
template<bool ReadOnlyOther>
requires (!ReadOnly)
void shareFrom (const TrackStateProxy< Trajectory, M, ReadOnlyOther > &other, TrackStatePropMask shareSource, TrackStatePropMask shareTarget)
 Share a shareable component from another track state.
template<TrackStateProxyConcept track_state_proxy_t>
requires (!ReadOnly)
void copyFrom (const track_state_proxy_t &other, TrackStatePropMask mask=TrackStatePropMask::All, bool onlyAllocated=true)
 Copy the contents of another track state proxy into this one.
Track state proxy Generic component access

template<HashedString key>
constexpr bool has () const
 Check if a component is set.
constexpr bool has (HashedString key) const
 Check if a component is set.
constexpr bool has (std::string_view key) const
 Check if a component is set.
template<typename T, HashedString key>
requires (!ReadOnly)
constexpr T & component ()
 Retrieve a mutable reference to a component.
template<typename T>
requires (!ReadOnly)
constexpr T & component (HashedString key)
 Retrieve a mutable reference to a component.
template<typename T>
requires (!ReadOnly)
constexpr T & component (std::string_view key)
 Retrieve a mutable reference to a component.
template<typename T, HashedString key>
constexpr const T & component () const
 Retrieve a const reference to a component.
template<typename T>
constexpr const T & component (HashedString key) const
 Retrieve a const reference to a component.
template<typename T>
constexpr const T & component (std::string_view key) const
 Retrieve a const reference to a component.
Public Member Functions inherited from Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, true >, true >
void allocateCalibrated (const Eigen::DenseBase< val_t > &val, const Eigen::DenseBase< cov_t > &cov)
 Allocate and initialize calibrated data from static-size Eigen objects.
TrackStateTraits< measdim, true >::Calibrated calibrated () const
 Access calibrated measurement data with compile-time dimension.
TrackStateTraits< measdim, true >::CalibratedCovariance calibratedCovariance () const
 Access calibrated covariance data with compile-time dimension.
float chi2 () const
 Retrieve the local chi2 contribution.
ConstCovarianceMap covariance () const
 Access the best available covariance (smoothed, filtered, or predicted).
ConstEffectiveCalibratedMap effectiveCalibrated () const
 Access the calibrated measurement values with runtime dimension.
ConstEffectiveCalibratedCovarianceMap effectiveCalibratedCovariance () const
 Access the calibrated covariance with runtime dimension.
ConstParametersMap filtered () const
 Access the filtered parameter vector.
ConstCovarianceMap filteredCovariance () const
 Access the filtered covariance matrix.
TrackStatePropMask getMask () const
 Compute the property mask describing which components are present.
bool hasCalibrated () const
 Check for presence of calibrated measurement data.
bool hasFiltered () const
 Check for presence of filtered track parameters.
bool hasJacobian () const
 Check for presence of a transport Jacobian.
bool hasPredicted () const
 Check for presence of predicted track parameters.
bool hasPrevious () const
 Check whether this state links to a previous state.
bool hasProjector () const
 Check for presence of a measurement projector.
bool hasSmoothed () const
 Check for presence of smoothed track parameters.
ConstParametersMap parameters () const
 Access the best available parameters (smoothed, filtered, or predicted).
double pathLength () const
 Retrieve the accumulated path length.
ConstParametersMap predicted () const
 Access the predicted parameter vector.
ConstCovarianceMap predictedCovariance () const
 Access the predicted covariance matrix.
TrackIndexType previous () const
 Retrieve the previous track state index in the linked trajectory.
VariableBoundSubspaceHelper projectorSubspaceHelper () const
 Creates a variable size subspace helper.
BoundSubspaceIndices projectorSubspaceIndices () const
 Decode the measurement projector indices.
void setProjectorSubspaceIndices (const index_range_t &subspaceIndices)
 Store subspace indices describing the measurement projector.
ConstParametersMap smoothed () const
 Access the smoothed parameter vector.
ConstCovarianceMap smoothedCovariance () const
 Access the smoothed covariance matrix.
ConstTrackStateTypeMap typeFlags () const
 Retrieve the track-state type flags.

Static Public Attributes

static constexpr IndexType kInvalid = kTrackIndexInvalid
 Sentinel value that indicates an invalid index.
static constexpr bool ReadOnly = read_only
 Indicates whether this track state proxy is read-only or if it can be modified.

Protected Member Functions

const double * calibratedCovarianceData () const
double * calibratedCovarianceDataMutable ()
const double * calibratedData () const
double * calibratedDataMutable ()
ConstCovariance covarianceAtIndex (IndexType covIndex) const
Covariance covarianceAtIndexMutable (IndexType covIndex)
ConstParameters parametersAtIndex (IndexType parIndex) const
Parameters parametersAtIndexMutable (IndexType parIndex)
Protected Member Functions inherited from Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, true >, true >
constexpr TrackStateProxy< trajectory_t, M, true > & derived ()

Additional Inherited Members

Protected Types inherited from Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, true >, true >
using IndexType

Detailed Description

template<typename trajectory_t, std::size_t M, bool read_only = true>
class Acts::TrackStateProxy< trajectory_t, M, read_only >

Proxy object to access a single point on the trajectory.

Template Parameters
SourceLinkType to link back to an original measurement
MMaximum number of measurement dimensions
read_onlytrue for read-only access to underlying storage

Member Typedef Documentation

◆ Calibrated

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<std::size_t N>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::Calibrated = typename TrackStateTraits<N, false>::Calibrated

Map-type for a calibrated measurement vector, where the local measurement dimension is variable.

◆ CalibratedCovariance

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<std::size_t N>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::CalibratedCovariance
Initial value:
typename detail_tsp::FixedSizeTypes< M, ReadOnly >::CovarianceMap CalibratedCovariance
Definition Types.hpp:104

Map-type for a calibrated measurement covariance matrix, where the local measurement dimension is variable.

◆ ConstCalibrated

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<std::size_t N>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::ConstCalibrated = typename TrackStateTraits<N, true>::Calibrated

Same as Calibrated, but with const semantics.

◆ ConstCalibratedCovariance

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<std::size_t N>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::ConstCalibratedCovariance
Initial value:

Same as CalibratedCovariance, but with const semantics.

◆ ConstCovariance

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::ConstCovariance = typename TrackStateTraits<M, true>::Covariance

Same as Covariance, but with const semantics.

◆ ConstEffectiveCalibrated

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::ConstEffectiveCalibrated
Initial value:
typename detail_tsp::DynamicSizeTypes< ReadOnly >::CoefficientsMap EffectiveCalibrated
Definition Types.hpp:106

Same as EffectiveCalibrated, but with const semantics.

◆ ConstEffectiveCalibratedCovariance

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::ConstEffectiveCalibratedCovariance
Initial value:
typename detail_tsp::DynamicSizeTypes< ReadOnly >::CovarianceMap EffectiveCalibratedCovariance
Definition Types.hpp:108

Same as EffectiveCalibratedCovariance, but with const semantics.

◆ ConstJacobian

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::ConstJacobian = typename TrackStateTraits<M, true>::Covariance

Jacobian shape is identical to Covariance.

◆ ConstParameters

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::ConstParameters = typename TrackStateTraits<M, true>::Parameters

Same as Parameters, but with const semantics.

◆ ConstProxyType

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::ConstProxyType = TrackStateProxy<trajectory_t, M, true>

Alias for an associated const track state proxy, with the same backends.

◆ Covariance

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::Covariance = typename TrackStateTraits<M, false>::Covariance

Map-type for a bound covariance.

This has reference semantics, i.e. points at a matrix by an internal pointer.

◆ EffectiveCalibrated

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::EffectiveCalibrated
Initial value:

Map-type for a measurement vector, where the local measurement dimension is variable.

◆ EffectiveCalibratedCovariance

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::EffectiveCalibratedCovariance
Initial value:

Map-type for a measurement covariance matrix, where the local measurement dimension is variable.

◆ IndexType

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::IndexType = TrackIndexType

The index type of the track state container.

◆ Jacobian

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::Jacobian = typename TrackStateTraits<M, false>::Covariance

Jacobian shape is identical to Covariance.

◆ Parameters

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::Parameters = typename TrackStateTraits<M, false>::Parameters

Map-type for a bound parameter vector.

This has reference semantics, i.e. points at a matrix by an internal pointer.

◆ Trajectory

template<typename trajectory_t, std::size_t M, bool read_only = true>
using Acts::TrackStateProxy< trajectory_t, M, read_only >::Trajectory = trajectory_t

The track state container backend given as a template parameter.

Constructor & Destructor Documentation

◆ TrackStateProxy() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
Acts::TrackStateProxy< trajectory_t, M, read_only >::TrackStateProxy ( const TrackStateProxy< trajectory_t, M, read_only > & other)
default

Copy constructor: const to const or mutable to mutable.

Parameters
otherThe other TrackStateProxy to construct from

◆ TrackStateProxy() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
Acts::TrackStateProxy< trajectory_t, M, read_only >::TrackStateProxy ( const TrackStateProxy< Trajectory, M, false > & other)
explicit

Constructor from mutable TrackStateProxy.

Note
Only available if the track state proxy is read-only
Parameters
otherThe other TrackStateProxy to construct from

Member Function Documentation

◆ addComponents()

template<typename trajectory_t, std::size_t M, bool read_only = true>
void Acts::TrackStateProxy< trajectory_t, M, read_only >::addComponents ( TrackStatePropMask mask)

Add additional components to the track state.

Note
Only available if the track state proxy is not read-only
Parameters
maskThe bitmask that instructs which components to allocate

◆ allocateCalibrated() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
void Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::allocateCalibrated ( const Eigen::DenseBase< val_t > & val,
const Eigen::DenseBase< cov_t > & cov )

Allocate and initialize calibrated data from static-size Eigen objects.

Template Parameters
val_tEigen vector type holding calibrated values.
cov_tEigen matrix type holding the covariance.
Parameters
valVector to copy into the calibrated storage.
covCovariance matrix to copy into the calibrated storage.

◆ allocateCalibrated() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
void Acts::TrackStateProxy< trajectory_t, M, read_only >::allocateCalibrated ( std::size_t measdim)

Allocate storage to be able to store a measurement of size measdim.

This must be called before setting the measurement content.

Parameters
measdimNumber of measurement dimensions to allocate
Note
This does not allocate if an allocation of the same size already exists
This will zero-initialize the allocated storage
This is an error if an existing allocation has different size

◆ calibrated() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
TrackStateTraits< measdim, false >::Calibrated Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::calibrated ( )

Access calibrated measurement data with compile-time dimension.

Template Parameters
measdimMeasurement dimension.
Returns
Mutable Eigen map referencing the calibrated measurement vector.

◆ calibrated() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
TrackStateTraits< measdim, true >::Calibrated Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::calibrated ( ) const

Access calibrated measurement data with compile-time dimension.

Template Parameters
measdimMeasurement dimension.
Returns
Eigen map referencing the calibrated measurement vector.

◆ calibratedCovariance() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
TrackStateTraits< measdim, false >::CalibratedCovariance Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::calibratedCovariance ( )

Access calibrated covariance data with compile-time dimension.

Template Parameters
measdimMeasurement dimension.
Returns
Mutable Eigen map referencing the covariance matrix.

◆ calibratedCovariance() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
TrackStateTraits< measdim, true >::CalibratedCovariance Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::calibratedCovariance ( ) const

Access calibrated covariance data with compile-time dimension.

Template Parameters
measdimMeasurement dimension.
Returns
Eigen map referencing the covariance matrix.

◆ calibratedCovarianceData()

template<typename trajectory_t, std::size_t M, bool read_only = true>
const double * Acts::TrackStateProxy< trajectory_t, M, read_only >::calibratedCovarianceData ( ) const
protected

◆ calibratedCovarianceDataMutable()

template<typename trajectory_t, std::size_t M, bool read_only = true>
double * Acts::TrackStateProxy< trajectory_t, M, read_only >::calibratedCovarianceDataMutable ( )
protected

◆ calibratedData()

template<typename trajectory_t, std::size_t M, bool read_only = true>
const double * Acts::TrackStateProxy< trajectory_t, M, read_only >::calibratedData ( ) const
protected

◆ calibratedDataMutable()

template<typename trajectory_t, std::size_t M, bool read_only = true>
double * Acts::TrackStateProxy< trajectory_t, M, read_only >::calibratedDataMutable ( )
protected

◆ calibratedSize()

template<typename trajectory_t, std::size_t M, bool read_only = true>
IndexType Acts::TrackStateProxy< trajectory_t, M, read_only >::calibratedSize ( ) const

Return the (dynamic) number of dimensions stored for this measurement.

Note
Depending on the backend, this size is used to determine the memory range of the measurement vector and covariance.
Returns
The number of dimensions

◆ chi2() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
float & Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::chi2 ( )

Retrieve a mutable reference to the local chi2 contribution.

Returns
Mutable chi2 value.

◆ chi2() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
float Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::chi2 ( ) const

Retrieve the local chi2 contribution.

Returns
Chi2 value associated with this state.

◆ component() [1/6]

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<typename T, HashedString key>
requires (!ReadOnly)
T & Acts::TrackStateProxy< trajectory_t, M, read_only >::component ( )
constexpr

Retrieve a mutable reference to a component.

Template Parameters
TThe type of the component to access
keyString key for the component to access
Returns
Mutable reference to the component given by key

◆ component() [2/6]

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<typename T, HashedString key>
const T & Acts::TrackStateProxy< trajectory_t, M, read_only >::component ( ) const
constexpr

Retrieve a const reference to a component.

Template Parameters
TThe type of the component to access
keyString key for the component to access
Returns
Const reference to the component given by key

◆ component() [3/6]

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<typename T>
requires (!ReadOnly)
T & Acts::TrackStateProxy< trajectory_t, M, read_only >::component ( HashedString key)
constexpr

Retrieve a mutable reference to a component.

Template Parameters
TThe type of the component to access
Parameters
keyString key for the component to access
Returns
Mutable reference to the component given by key

◆ component() [4/6]

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<typename T>
const T & Acts::TrackStateProxy< trajectory_t, M, read_only >::component ( HashedString key) const
constexpr

Retrieve a const reference to a component.

Template Parameters
TThe type of the component to access
Parameters
keyString key for the component to access
Returns
Const reference to the component given by key

◆ component() [5/6]

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<typename T>
requires (!ReadOnly)
T & Acts::TrackStateProxy< trajectory_t, M, read_only >::component ( std::string_view key)
constexpr

Retrieve a mutable reference to a component.

Template Parameters
TThe type of the component to access
Parameters
keyString key for the component to access
Note
This might hash the key at runtime instead of compile-time
Returns
Mutable reference to the component given by key

◆ component() [6/6]

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<typename T>
const T & Acts::TrackStateProxy< trajectory_t, M, read_only >::component ( std::string_view key) const
constexpr

Retrieve a const reference to a component.

Template Parameters
TThe type of the component to access
Parameters
keyString key for the component to access
Note
This might hash the key at runtime instead of compile-time
Returns
Const reference to the component given by key

◆ container() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
auto & Acts::TrackStateProxy< trajectory_t, M, read_only >::container ( )

Get a mutable reference to the track state container backend.

Returns
a mutable reference to the backend

◆ container() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
const auto & Acts::TrackStateProxy< trajectory_t, M, read_only >::container ( ) const

Get a const reference to the track state container backend.

Returns
a const reference to the backend

◆ copyFrom()

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<TrackStateProxyConcept track_state_proxy_t>
requires (!ReadOnly)
void Acts::TrackStateProxy< trajectory_t, M, read_only >::copyFrom ( const track_state_proxy_t & other,
TrackStatePropMask mask = TrackStatePropMask::All,
bool onlyAllocated = true )

Copy the contents of another track state proxy into this one.

Parameters
otherThe other track state to copy from
maskAn optional mask to determine what to copy from
onlyAllocatedWhether to only copy allocated components
Note
If the this track state proxy does not have compatible allocations with the source track state proxy, and onlyAllocated is false, an exception is thrown.
The mask parameter will not cause a copy of components that are not allocated in the source track state proxy.

◆ covariance()

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstCovarianceMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::covariance ( ) const

Access the best available covariance (smoothed, filtered, or predicted).

Returns
Bound covariance map for the state.

◆ covarianceAtIndex()

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstCovariance Acts::TrackStateProxy< trajectory_t, M, read_only >::covarianceAtIndex ( IndexType covIndex) const
protected

◆ covarianceAtIndexMutable()

template<typename trajectory_t, std::size_t M, bool read_only = true>
Covariance Acts::TrackStateProxy< trajectory_t, M, read_only >::covarianceAtIndexMutable ( IndexType covIndex)
protected

◆ effectiveCalibrated() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
EffectiveCalibratedMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::effectiveCalibrated ( )

Access mutable calibrated measurement values with runtime dimension.

Returns
Eigen map referencing the calibrated measurement vector.

◆ effectiveCalibrated() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstEffectiveCalibratedMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::effectiveCalibrated ( ) const

Access the calibrated measurement values with runtime dimension.

Returns
Eigen map referencing the calibrated measurement vector.

◆ effectiveCalibratedCovariance() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
EffectiveCalibratedCovarianceMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::effectiveCalibratedCovariance ( )

Access mutable calibrated covariance with runtime dimension.

Returns
Eigen map referencing the measurement covariance matrix.

◆ effectiveCalibratedCovariance() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstEffectiveCalibratedCovarianceMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::effectiveCalibratedCovariance ( ) const

Access the calibrated covariance with runtime dimension.

Returns
Eigen map referencing the measurement covariance matrix.

◆ filtered() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ParametersMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::filtered ( )

Access the filtered parameter vector.

Returns
Mutable bound parameter map for the filtered state.

◆ filtered() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstParametersMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::filtered ( ) const

Access the filtered parameter vector.

Returns
Bound parameter map for the filtered state.

◆ filteredCovariance() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
CovarianceMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::filteredCovariance ( )

Access the filtered covariance matrix.

Returns
Mutable bound covariance map for the filtered state.

◆ filteredCovariance() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstCovarianceMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::filteredCovariance ( ) const

Access the filtered covariance matrix.

Returns
Bound covariance map for the filtered state.

◆ getMask()

template<typename trajectory_t, std::size_t M, bool read_only = true>
TrackStatePropMask Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::getMask ( ) const

Compute the property mask describing which components are present.

Returns
Bit mask of available properties.

◆ getUncalibratedSourceLink()

template<typename trajectory_t, std::size_t M, bool read_only = true>
SourceLink Acts::TrackStateProxy< trajectory_t, M, read_only >::getUncalibratedSourceLink ( ) const

Uncalibrated measurement in the form of a source link.

Const version

Returns
The uncalibrated measurement source link

◆ has() [1/3]

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<HashedString key>
bool Acts::TrackStateProxy< trajectory_t, M, read_only >::has ( ) const
constexpr

Check if a component is set.

Template Parameters
keyHashed string key to check for
Returns
true if the component exists, false if not

◆ has() [2/3]

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxy< trajectory_t, M, read_only >::has ( HashedString key) const
constexpr

Check if a component is set.

Parameters
keyHashed string key to check for
Returns
true if the component exists, false if not

◆ has() [3/3]

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxy< trajectory_t, M, read_only >::has ( std::string_view key) const
constexpr

Check if a component is set.

Parameters
keyString key to check for
Note
This might hash the key at runtime instead of compile-time
Returns
true if the component exists, false if not

◆ hasCalibrated()

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::hasCalibrated ( ) const

Check for presence of calibrated measurement data.

Returns
True if calibrated measurements exist.

◆ hasColumn()

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxy< trajectory_t, M, read_only >::hasColumn ( HashedString key) const

Check if the track state has a specific dynamic column.

Parameters
keyThe hashed column key
Returns
true if the column exists

◆ hasFiltered()

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::hasFiltered ( ) const

Check for presence of filtered track parameters.

Returns
True if the filtered component exists.

◆ hasJacobian()

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::hasJacobian ( ) const

Check for presence of a transport Jacobian.

Returns
True if a Jacobian is stored.

◆ hasPredicted()

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::hasPredicted ( ) const

Check for presence of predicted track parameters.

Returns
True if the predicted component exists.

◆ hasPrevious()

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::hasPrevious ( ) const

Check whether this state links to a previous state.

Returns
True if the previous index is valid.

◆ hasProjector()

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::hasProjector ( ) const

Check for presence of a measurement projector.

Returns
True if projector indices are stored.

◆ hasReferenceSurface()

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxy< trajectory_t, M, read_only >::hasReferenceSurface ( ) const

Returns if the track state has a non nullptr surface associated.

Returns
whether a surface exists or not

◆ hasSmoothed()

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::hasSmoothed ( ) const

Check for presence of smoothed track parameters.

Returns
True if the smoothed component exists.

◆ hasUncalibratedSourceLink()

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxy< trajectory_t, M, read_only >::hasUncalibratedSourceLink ( ) const

Check if the point has an associated uncalibrated measurement.

Returns
Whether it is set

◆ index()

template<typename trajectory_t, std::size_t M, bool read_only = true>
IndexType Acts::TrackStateProxy< trajectory_t, M, read_only >::index ( ) const

Index within the trajectory.

Returns
the index

◆ jacobian() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
Covariance Acts::TrackStateProxy< trajectory_t, M, read_only >::jacobian ( )

Returns the jacobian from the previous trackstate to this one.

Returns
The jacobian matrix
Note
Mutable version

◆ jacobian() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstCovariance Acts::TrackStateProxy< trajectory_t, M, read_only >::jacobian ( ) const

Returns the jacobian from the previous trackstate to this one.

Returns
The jacobian matrix
Note
Const version

◆ operator=() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
TrackStateProxy & Acts::TrackStateProxy< trajectory_t, M, read_only >::operator= ( const TrackStateProxy< trajectory_t, M, read_only > & other)
default

Copy assignment operator: const to const or mutable to mutable.

Parameters
otherThe other TrackStateProxy to assign from
Returns
Reference to this TrackStateProxy

◆ operator=() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
TrackStateProxy & Acts::TrackStateProxy< trajectory_t, M, read_only >::operator= ( const TrackStateProxy< Trajectory, M, false > & other)

Assignment operator to from mutable TrackStateProxy.

Parameters
otherThe other TrackStateProxy to assign from
Note
Only available if the track state proxy is read-only
Returns
Reference to this TrackStateProxy

◆ parameters()

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstParametersMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::parameters ( ) const

Access the best available parameters (smoothed, filtered, or predicted).

Returns
Bound parameter map for the state.

◆ parametersAtIndex()

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstParameters Acts::TrackStateProxy< trajectory_t, M, read_only >::parametersAtIndex ( IndexType parIndex) const
protected

◆ parametersAtIndexMutable()

template<typename trajectory_t, std::size_t M, bool read_only = true>
Parameters Acts::TrackStateProxy< trajectory_t, M, read_only >::parametersAtIndexMutable ( IndexType parIndex)
protected

◆ pathLength() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
double & Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::pathLength ( )

Retrieve a mutable reference to the accumulated path length.

Returns
Mutable path length.

◆ pathLength() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
double Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::pathLength ( ) const

Retrieve the accumulated path length.

Returns
Path length stored on the state.

◆ predicted() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ParametersMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::predicted ( )

Access the predicted parameter vector.

Returns
Mutable bound parameter map for the predicted state.

◆ predicted() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstParametersMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::predicted ( ) const

Access the predicted parameter vector.

Returns
Bound parameter map for the predicted state.

◆ predictedCovariance() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
CovarianceMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::predictedCovariance ( )

Access the predicted covariance matrix.

Returns
Mutable bound covariance map for the predicted state.

◆ predictedCovariance() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstCovarianceMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::predictedCovariance ( ) const

Access the predicted covariance matrix.

Returns
Bound covariance map for the predicted state.

◆ previous() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
TrackIndexType & Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::previous ( )

Retrieve a mutable reference to the previous track state index.

Returns
Mutable index of the previous state.

◆ previous() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
TrackIndexType Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::previous ( ) const

Retrieve the previous track state index in the linked trajectory.

Returns
Index of the previous state or kTrackIndexInvalid.

◆ projectorSubspaceHelper()

template<typename trajectory_t, std::size_t M, bool read_only = true>
VariableBoundSubspaceHelper Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::projectorSubspaceHelper ( ) const

Creates a variable size subspace helper.

Returns
The subspace helper

◆ projectorSubspaceIndices()

template<typename trajectory_t, std::size_t M, bool read_only = true>
BoundSubspaceIndices Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::projectorSubspaceIndices ( ) const

Decode the measurement projector indices.

Returns
Bound parameter indices used for projection.

◆ referenceSurface()

template<typename trajectory_t, std::size_t M, bool read_only = true>
const Surface & Acts::TrackStateProxy< trajectory_t, M, read_only >::referenceSurface ( ) const

Reference surface.

Returns
the reference surface

◆ setProjectorSubspaceIndices()

template<typename trajectory_t, std::size_t M, bool read_only = true>
void Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::setProjectorSubspaceIndices ( const index_range_t & subspaceIndices)

Store subspace indices describing the measurement projector.

Template Parameters
index_range_tRange of indices to encode.
Parameters
subspaceIndicesCollection of bound indices forming the projector rows.

◆ setReferenceSurface()

template<typename trajectory_t, std::size_t M, bool read_only = true>
void Acts::TrackStateProxy< trajectory_t, M, read_only >::setReferenceSurface ( std::shared_ptr< const Surface > srf)

Set the reference surface to a given value.

Parameters
srfShared pointer to the surface to set
Note
This overload is only present in case ReadOnly is false.

◆ setUncalibratedSourceLink()

template<typename trajectory_t, std::size_t M, bool read_only = true>
void Acts::TrackStateProxy< trajectory_t, M, read_only >::setUncalibratedSourceLink ( SourceLink && sourceLink)

Set an uncalibrated source link.

Parameters
sourceLinkThe uncalibrated source link to set

◆ shareFrom() [1/3]

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<bool ReadOnlyOther>
requires (!ReadOnly)
void Acts::TrackStateProxy< trajectory_t, M, read_only >::shareFrom ( const TrackStateProxy< Trajectory, M, ReadOnlyOther > & other,
TrackStatePropMask component )

Share a shareable component from another track state.

Parameters
otherTrack state proxy to share component from
componentWhich component to share.
Note
The track states both need to be stored in the same MultiTrajectory instance

◆ shareFrom() [2/3]

template<typename trajectory_t, std::size_t M, bool read_only = true>
template<bool ReadOnlyOther>
requires (!ReadOnly)
void Acts::TrackStateProxy< trajectory_t, M, read_only >::shareFrom ( const TrackStateProxy< Trajectory, M, ReadOnlyOther > & other,
TrackStatePropMask shareSource,
TrackStatePropMask shareTarget )

Share a shareable component from another track state.

Parameters
otherTrack state proxy to share component(s) from
shareSourceWhich component to share from
shareTargetWhich component to share as. This can be be different from as shareSource, e.g. predicted can be shared as filtered.
Note
Shareable components are predicted, filtered, smoothed, calibrated, jacobian, or projector. See TrackStatePropMask.

◆ shareFrom() [3/3]

template<typename trajectory_t, std::size_t M, bool read_only = true>
void Acts::TrackStateProxy< trajectory_t, M, read_only >::shareFrom ( TrackStatePropMask shareSource,
TrackStatePropMask shareTarget )

Share a shareable component within this track state.

Parameters
shareSourceWhich component to share from
shareTargetWhich component to share as. This should be different from as shareSource, e.g. predicted can be shared as filtered.

◆ smoothed() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ParametersMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::smoothed ( )

Access the smoothed parameter vector.

Returns
Mutable bound parameter map for the smoothed state.

◆ smoothed() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstParametersMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::smoothed ( ) const

Access the smoothed parameter vector.

Returns
Bound parameter map for the smoothed state.

◆ smoothedCovariance() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
CovarianceMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::smoothedCovariance ( )

Access the smoothed covariance matrix.

Returns
Mutable bound covariance map for the smoothed state.

◆ smoothedCovariance() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstCovarianceMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::smoothedCovariance ( ) const

Access the smoothed covariance matrix.

Returns
Bound covariance map for the smoothed state.

◆ trajectory() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
MultiTrajectory< Trajectory > & Acts::TrackStateProxy< trajectory_t, M, read_only >::trajectory ( )

Return a mutable reference to the underlying backend container.

Returns
A reference to the backend container

◆ trajectory() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
const MultiTrajectory< Trajectory > & Acts::TrackStateProxy< trajectory_t, M, read_only >::trajectory ( ) const

Return a const reference to the underlying backend container.

Returns
A const reference to the backend container

◆ typeFlags() [1/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
MutableTrackStateTypeMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::typeFlags ( )

Retrieve mutable track-state type flags.

Returns
Mutable bit mask describing the state type.

◆ typeFlags() [2/2]

template<typename trajectory_t, std::size_t M, bool read_only = true>
ConstTrackStateTypeMap Acts::TrackStateProxyCommon< TrackStateProxy< trajectory_t, M, read_only >, read_only >::typeFlags ( ) const

Retrieve the track-state type flags.

Returns
Bit mask describing the state type.

◆ unset()

template<typename trajectory_t, std::size_t M, bool read_only = true>
void Acts::TrackStateProxy< trajectory_t, M, read_only >::unset ( TrackStatePropMask target)

Unset an optional track state component.

Note
Only available if the track state proxy is not read-only
Parameters
targetThe component to unset

Member Data Documentation

◆ kInvalid

template<typename trajectory_t, std::size_t M, bool read_only = true>
IndexType Acts::TrackStateProxy< trajectory_t, M, read_only >::kInvalid = kTrackIndexInvalid
staticconstexpr

Sentinel value that indicates an invalid index.

◆ ReadOnly

template<typename trajectory_t, std::size_t M, bool read_only = true>
bool Acts::TrackStateProxy< trajectory_t, M, read_only >::ReadOnly = read_only
staticconstexpr

Indicates whether this track state proxy is read-only or if it can be modified.