Analysis Software
Documentation for sPHENIX simulation software
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Groups Pages
Acts::CombinatorialKalmanFilterExtensions< traj_t > Struct Template Reference

Extension struct which holds the delegates to customize the CKF behavior. More...

#include <acts/blob/sPHENIX/Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp>

+ Collaboration diagram for Acts::CombinatorialKalmanFilterExtensions< traj_t >:

Public Types

using candidate_container_t = typename std::vector< typename traj_t::TrackStateProxy >
 
using MeasurementSelector = Delegate< Result< std::pair< typename candidate_container_t::iterator, typename candidate_container_t::iterator >>(candidate_container_t &trackStates, bool &, const Logger &)>
 
using BranchStopper = Delegate< bool(const CombinatorialKalmanFilterTipState &)>
 

Public Member Functions

 CombinatorialKalmanFilterExtensions ()
 Default constructor which connects the default void components.
 

Public Attributes

KalmanFitterExtensions< traj_t >
::Calibrator 
calibrator
 
KalmanFitterExtensions< traj_t >
::Updater 
updater
 The updater incorporates measurement information into the track parameters.
 
KalmanFitterExtensions< traj_t >
::Smoother 
smoother
 The smoother back-propagates measurement information along the track.
 
MeasurementSelector measurementSelector
 The measurement selector is called during the filtering by the Actor.
 
BranchStopper branchStopper
 

Static Private Member Functions

static Result< std::pair
< typename std::vector
< typename
traj_t::TrackStateProxy >
::iterator, typename
std::vector< typename
traj_t::TrackStateProxy >
::iterator > > 
voidMeasurementSelector (typename std::vector< typename traj_t::TrackStateProxy > &candidates, bool &isOutlier, const Logger &logger)
 
static bool voidBranchStopper (const CombinatorialKalmanFilterTipState &tipState)
 

Detailed Description

template<typename traj_t>
struct Acts::CombinatorialKalmanFilterExtensions< traj_t >

Extension struct which holds the delegates to customize the CKF behavior.

Definition at line 80 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 80 of file CombinatorialKalmanFilter.hpp

Member Typedef Documentation

template<typename traj_t>
using Acts::CombinatorialKalmanFilterExtensions< traj_t >::BranchStopper = Delegate<bool(const CombinatorialKalmanFilterTipState&)>

Definition at line 88 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 88 of file CombinatorialKalmanFilter.hpp

template<typename traj_t>
using Acts::CombinatorialKalmanFilterExtensions< traj_t >::candidate_container_t = typename std::vector<typename traj_t::TrackStateProxy>

Definition at line 82 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 82 of file CombinatorialKalmanFilter.hpp

template<typename traj_t>
using Acts::CombinatorialKalmanFilterExtensions< traj_t >::MeasurementSelector = Delegate<Result<std::pair<typename candidate_container_t::iterator, typename candidate_container_t::iterator>>( candidate_container_t& trackStates, bool&, const Logger&)>

Definition at line 86 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 86 of file CombinatorialKalmanFilter.hpp

Constructor & Destructor Documentation

template<typename traj_t>
Acts::CombinatorialKalmanFilterExtensions< traj_t >::CombinatorialKalmanFilterExtensions ( )
inline

Default constructor which connects the default void components.

Definition at line 107 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 107 of file CombinatorialKalmanFilter.hpp

References Acts::CombinatorialKalmanFilterExtensions< traj_t >::branchStopper, Acts::CombinatorialKalmanFilterExtensions< traj_t >::calibrator, Acts::CombinatorialKalmanFilterExtensions< traj_t >::measurementSelector, Acts::CombinatorialKalmanFilterExtensions< traj_t >::smoother, Acts::CombinatorialKalmanFilterExtensions< traj_t >::updater, and Acts::CombinatorialKalmanFilterExtensions< traj_t >::voidBranchStopper().

+ Here is the call graph for this function:

Member Function Documentation

template<typename traj_t>
static bool Acts::CombinatorialKalmanFilterExtensions< traj_t >::voidBranchStopper ( const CombinatorialKalmanFilterTipState tipState)
inlinestaticprivate

Default branch stopper which will never stop

Parameters
tipStateThe tip state to decide whether to stop (unused)
Returns
false

Definition at line 134 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 134 of file CombinatorialKalmanFilter.hpp

Referenced by Acts::CombinatorialKalmanFilterExtensions< traj_t >::CombinatorialKalmanFilterExtensions().

+ Here is the caller graph for this function:

template<typename traj_t>
static Result<std::pair< typename std::vector<typename traj_t::TrackStateProxy>::iterator, typename std::vector<typename traj_t::TrackStateProxy>::iterator> > Acts::CombinatorialKalmanFilterExtensions< traj_t >::voidMeasurementSelector ( typename std::vector< typename traj_t::TrackStateProxy > &  candidates,
bool &  isOutlier,
const Logger logger 
)
inlinestaticprivate

Default measurement selector which will return all measurements

Parameters
candidatesMeasurement track state candidates
isOutlierOutput variable indicating whether the returned state is an outlier (unused)
loggerA logger instance

Definition at line 123 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 123 of file CombinatorialKalmanFilter.hpp

Member Data Documentation

template<typename traj_t>
BranchStopper Acts::CombinatorialKalmanFilterExtensions< traj_t >::branchStopper

Definition at line 104 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 104 of file CombinatorialKalmanFilter.hpp

Referenced by Acts::CombinatorialKalmanFilterExtensions< traj_t >::CombinatorialKalmanFilterExtensions().

template<typename traj_t>
KalmanFitterExtensions<traj_t>::Calibrator Acts::CombinatorialKalmanFilterExtensions< traj_t >::calibrator

The Calibrator is a dedicated calibration algorithm that allows to calibrate measurements using track information, this could be e.g. sagging for wires, module deformations, etc.

Definition at line 93 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 93 of file CombinatorialKalmanFilter.hpp

Referenced by Acts::CombinatorialKalmanFilterExtensions< traj_t >::CombinatorialKalmanFilterExtensions(), ActsExamples::TrackFindingFromPrototrackAlgorithm::execute(), and ActsExamples::TrackFindingAlgorithm::execute().

template<typename traj_t>
MeasurementSelector Acts::CombinatorialKalmanFilterExtensions< traj_t >::measurementSelector

The measurement selector is called during the filtering by the Actor.

Definition at line 102 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 102 of file CombinatorialKalmanFilter.hpp

Referenced by Acts::CombinatorialKalmanFilterExtensions< traj_t >::CombinatorialKalmanFilterExtensions(), ActsExamples::TrackFindingFromPrototrackAlgorithm::execute(), and ActsExamples::TrackFindingAlgorithm::execute().

template<typename traj_t>
KalmanFitterExtensions<traj_t>::Smoother Acts::CombinatorialKalmanFilterExtensions< traj_t >::smoother

The smoother back-propagates measurement information along the track.

Definition at line 99 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 99 of file CombinatorialKalmanFilter.hpp

Referenced by Acts::CombinatorialKalmanFilterExtensions< traj_t >::CombinatorialKalmanFilterExtensions(), ActsExamples::TrackFindingFromPrototrackAlgorithm::execute(), and ActsExamples::TrackFindingAlgorithm::execute().

template<typename traj_t>
KalmanFitterExtensions<traj_t>::Updater Acts::CombinatorialKalmanFilterExtensions< traj_t >::updater

The updater incorporates measurement information into the track parameters.

Definition at line 96 of file CombinatorialKalmanFilter.hpp.

View newest version in sPHENIX GitHub at line 96 of file CombinatorialKalmanFilter.hpp

Referenced by Acts::CombinatorialKalmanFilterExtensions< traj_t >::CombinatorialKalmanFilterExtensions(), ActsExamples::TrackFindingFromPrototrackAlgorithm::execute(), and ActsExamples::TrackFindingAlgorithm::execute().


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