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

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

+ Collaboration diagram for Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >:

Public Types

using SourceLinkIterator = source_link_iterator_t
 
using SourceLinkAccessor = SourceLinkAccessorDelegate< source_link_iterator_t >
 

Public Member Functions

 CombinatorialKalmanFilterOptions (const GeometryContext &gctx, const MagneticFieldContext &mctx, std::reference_wrapper< const CalibrationContext > cctx, SourceLinkAccessor accessor_, CombinatorialKalmanFilterExtensions< traj_t > extensions_, const PropagatorPlainOptions &pOptions, const Surface *rSurface=nullptr, bool mScattering=true, bool eLoss=true, bool rSmoothing=true)
 
 CombinatorialKalmanFilterOptions ()=delete
 Contexts are required and the options must not be default-constructible.
 

Public Attributes

std::reference_wrapper< const
GeometryContext
geoContext
 Context object for the geometry.
 
std::reference_wrapper< const
MagneticFieldContext
magFieldContext
 Context object for the magnetic field.
 
std::reference_wrapper< const
CalibrationContext
calibrationContext
 context object for the calibration
 
SourceLinkAccessor sourcelinkAccessor
 The source link accessor.
 
CombinatorialKalmanFilterExtensions
< traj_t > 
extensions
 The filter extensions.
 
PropagatorPlainOptions propagatorPlainOptions
 The trivial propagator options.
 
const SurfacefilterTargetSurface = nullptr
 The filter target surface.
 
const SurfacesmoothingTargetSurface = nullptr
 The smoothing target surface.
 
CombinatorialKalmanFilterTargetSurfaceStrategy smoothingTargetSurfaceStrategy
 Strategy to propagate to reference surface.
 
bool multipleScattering = true
 Whether to consider multiple scattering.
 
bool energyLoss = true
 Whether to consider energy loss.
 
bool smoothing = true
 Whether to run smoothing to get fitted parameter.
 

Detailed Description

template<typename source_link_iterator_t, typename traj_t>
struct Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >

Combined options for the combinatorial Kalman filter.

Template Parameters
source_link_accessor_tSource link accessor type, should be semiregular.

Definition at line 153 of file CombinatorialKalmanFilter.hpp.

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

Member Typedef Documentation

template<typename source_link_iterator_t, typename traj_t>
using Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::SourceLinkAccessor = SourceLinkAccessorDelegate<source_link_iterator_t>

Definition at line 155 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
using Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::SourceLinkIterator = source_link_iterator_t

Definition at line 154 of file CombinatorialKalmanFilter.hpp.

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

Constructor & Destructor Documentation

template<typename source_link_iterator_t, typename traj_t>
Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::CombinatorialKalmanFilterOptions ( const GeometryContext gctx,
const MagneticFieldContext mctx,
std::reference_wrapper< const CalibrationContext cctx,
SourceLinkAccessor  accessor_,
CombinatorialKalmanFilterExtensions< traj_t >  extensions_,
const PropagatorPlainOptions pOptions,
const Surface rSurface = nullptr,
bool  mScattering = true,
bool  eLoss = true,
bool  rSmoothing = true 
)
inline

PropagatorOptions with context

Parameters
gctxThe geometry context for this track finding/fitting
mctxThe magnetic context for this track finding/fitting
cctxThe calibration context for this track finding/fitting
accessor_The source link accessor
extensions_The extension struct
pOptionsThe plain propagator options
rSurfaceThe reference surface for the eventual track fitting to be expressed at
mScatteringWhether to include multiple scattering
eLossWhether to include energy loss
rSmoothingWhether to run smoothing to get fitted parameter

Definition at line 170 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::CombinatorialKalmanFilterOptions ( )
delete

Contexts are required and the options must not be default-constructible.

Member Data Documentation

template<typename source_link_iterator_t, typename traj_t>
std::reference_wrapper<const CalibrationContext> Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::calibrationContext

context object for the calibration

Definition at line 196 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
bool Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::energyLoss = true

Whether to consider energy loss.

Definition at line 222 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
CombinatorialKalmanFilterExtensions<traj_t> Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::extensions

The filter extensions.

Definition at line 202 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
const Surface* Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::filterTargetSurface = nullptr

The filter target surface.

Definition at line 208 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
std::reference_wrapper<const GeometryContext> Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::geoContext

Context object for the geometry.

Definition at line 192 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
std::reference_wrapper<const MagneticFieldContext> Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::magFieldContext

Context object for the magnetic field.

Definition at line 194 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
bool Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::multipleScattering = true

Whether to consider multiple scattering.

Definition at line 219 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
PropagatorPlainOptions Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::propagatorPlainOptions

The trivial propagator options.

Definition at line 205 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
bool Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::smoothing = true

Whether to run smoothing to get fitted parameter.

Definition at line 225 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
const Surface* Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::smoothingTargetSurface = nullptr

The smoothing target surface.

Definition at line 211 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
CombinatorialKalmanFilterTargetSurfaceStrategy Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::smoothingTargetSurfaceStrategy
Initial value:
=
CombinatorialKalmanFilterTargetSurfaceStrategy::firstOrLast

Strategy to propagate to reference surface.

Definition at line 215 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_iterator_t, typename traj_t>
SourceLinkAccessor Acts::CombinatorialKalmanFilterOptions< source_link_iterator_t, traj_t >::sourcelinkAccessor

The source link accessor.

Definition at line 199 of file CombinatorialKalmanFilter.hpp.

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


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