ECCE @ EIC Software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::GainMatrixUpdater< parameters_t > Class Template Reference

Update step of Kalman Filter using gain matrix formalism. More...

#include <acts/blob/master/Core/include/Acts/Fitter/GainMatrixUpdater.hpp>

Public Member Functions

 GainMatrixUpdater (std::shared_ptr< const Logger > logger=std::shared_ptr< const Logger >(getDefaultLogger("GainMatrixUpdater", Logging::INFO).release()))
 
template<typename track_state_t >
Result< voidoperator() (const GeometryContext &, track_state_t trackState, const NavigationDirection &direction=forward) const
 Public call operator for the boost visitor pattern.
 
const Loggerlogger () const
 Getter for the logger, to support logging macros.
 

Public Attributes

std::shared_ptr< const Loggerm_logger {nullptr}
 Pointer to a logger that is owned by the parent, KalmanFilter.
 

Detailed Description

template<typename parameters_t>
class Acts::GainMatrixUpdater< parameters_t >

Update step of Kalman Filter using gain matrix formalism.

Template Parameters
parameters_tType of the parameters to be filtered
jacobian_tType of the Transport jacobian

Definition at line 31 of file GainMatrixUpdater.hpp.

View newest version in sPHENIX GitHub at line 31 of file GainMatrixUpdater.hpp

Constructor & Destructor Documentation

template<typename parameters_t>
Acts::GainMatrixUpdater< parameters_t >::GainMatrixUpdater ( std::shared_ptr< const Logger logger = std::shared_ptr<const Logger>(          getDefaultLogger("GainMatrixUpdater< parameters_t >", Logging::INFO).release()))
inline

Explicit constructor

Parameters
calibratoris the calibration struct/class that converts uncalibrated measurements into calibrated ones
loggera logger instance

Definition at line 38 of file GainMatrixUpdater.hpp.

View newest version in sPHENIX GitHub at line 38 of file GainMatrixUpdater.hpp

Member Function Documentation

template<typename parameters_t>
const Logger& Acts::GainMatrixUpdater< parameters_t >::logger ( ) const
inline

Getter for the logger, to support logging macros.

Definition at line 162 of file GainMatrixUpdater.hpp.

View newest version in sPHENIX GitHub at line 162 of file GainMatrixUpdater.hpp

References Acts::GainMatrixUpdater< parameters_t >::m_logger.

template<typename parameters_t>
template<typename track_state_t >
Result<void> Acts::GainMatrixUpdater< parameters_t >::operator() ( const GeometryContext ,
track_state_t  trackState,
const NavigationDirection direction = forward 
) const
inline

Public call operator for the boost visitor pattern.

Template Parameters
track_state_tType of the track state for the update
Parameters
gctxThe current geometry context object, e.g. alignment
trackStatethe measured track state
directionthe navigation direction
Returns
Bool indicating whether this update was 'successful'
Note
Non-'successful' updates could be holes or outliers, which need to be treated differently in calling code.

Definition at line 55 of file GainMatrixUpdater.hpp.

View newest version in sPHENIX GitHub at line 55 of file GainMatrixUpdater.hpp

References ACTS_VERBOSE, error, Acts::forward, H, and Acts::visit_measurement().

+ Here is the call graph for this function:

Member Data Documentation

template<typename parameters_t>
std::shared_ptr<const Logger> Acts::GainMatrixUpdater< parameters_t >::m_logger {nullptr}

Pointer to a logger that is owned by the parent, KalmanFilter.

Definition at line 159 of file GainMatrixUpdater.hpp.

View newest version in sPHENIX GitHub at line 159 of file GainMatrixUpdater.hpp

Referenced by Acts::GainMatrixUpdater< parameters_t >::logger().


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