Options struct how the CombinatorialKalmanFilter (CKF) is called. More...

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

Collaboration diagram for Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >:

Public Types
using	SourceLinkSelector = source_link_selector_t

using	SourceLinkSelectorConfig = typename SourceLinkSelector::Config

Public Member Functions
	CombinatorialKalmanFilterOptions ()=delete
	Deleted default constructor.

	CombinatorialKalmanFilterOptions (std::reference_wrapper< const GeometryContext > gctx, std::reference_wrapper< const MagneticFieldContext > mctx, std::reference_wrapper< const CalibrationContext > cctx, const SourceLinkSelectorConfig &slsCfg, LoggerWrapper logger_, const PropagatorPlainOptions &pOptions, const Surface *rSurface=nullptr, bool mScattering=true, bool eLoss=true, bool rSmoothing=true)

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

SourceLinkSelectorConfig	sourcelinkSelectorConfig
	The config for the source link selector.

PropagatorPlainOptions	propagatorPlainOptions
	The trivial propagator options.

const Surface *	referenceSurface = nullptr
	The 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.

LoggerWrapper	logger
	Logger instance.

Detailed Description

template<typename source_link_selector_t>
struct Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >

Options struct how the CombinatorialKalmanFilter (CKF) is called.

Template Parameters

source_link_selector_t The source link selector type

It contains the context of the CKF call, the source link selector config, the optional surface where to express the track finding/fitting result, config for material effects and whether to run smoothing to get fitted parameters

Note: the context objects must be provided

Definition at line 74 of file CombinatorialKalmanFilter.hpp.

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

Member Typedef Documentation

template<typename source_link_selector_t>

using Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::SourceLinkSelector = source_link_selector_t

Definition at line 76 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_selector_t>

using Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::SourceLinkSelectorConfig = typename SourceLinkSelector::Config

Definition at line 79 of file CombinatorialKalmanFilter.hpp.

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

Constructor & Destructor Documentation

template<typename source_link_selector_t>

Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::CombinatorialKalmanFilterOptions ( )

delete

Deleted default constructor.

template<typename source_link_selector_t>

Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::CombinatorialKalmanFilterOptions	(	std::reference_wrapper< const GeometryContext >	gctx,
		std::reference_wrapper< const MagneticFieldContext >	mctx,
		std::reference_wrapper< const CalibrationContext >	cctx,
		const SourceLinkSelectorConfig &	slsCfg,
		LoggerWrapper	logger_,
		const PropagatorPlainOptions &	pOptions,
		const Surface *	rSurface = `nullptr`,
		bool	mScattering = `true`,
		bool	eLoss = `true`,
		bool	rSmoothing = `true`
	)

inline

PropagatorOptions with context

Parameters

gctx	The goemetry context for this track finding/fitting
mctx	The magnetic context for this track finding/fitting
cctx	The calibration context for this track finding/fitting
slsCfg	The config for the source link selector for this track finding/fitting
logger_	The logger wrapper
pOptions	The plain propagator options
rSurface	The reference surface for the eventual track fitting to be expressed at
mScattering	Whether to include multiple scattering
eLoss	Whether to include energy loss
rSmoothing	Whether to run smoothing to get fitted parameter

Definition at line 98 of file CombinatorialKalmanFilter.hpp.

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

Member Data Documentation

template<typename source_link_selector_t>

std::reference_wrapper<const CalibrationContext> Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::calibrationContext

context object for the calibration

Definition at line 121 of file CombinatorialKalmanFilter.hpp.

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

template<typename source_link_selector_t>

bool Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::energyLoss = true

Whether to consider energy loss.

Definition at line 136 of file CombinatorialKalmanFilter.hpp.

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

Referenced by Acts::CombinatorialKalmanFilter< propagator_t, updater_t, smoother_t, source_link_selector_t, branch_stopper_t, calibrator_t >::findTracks().

template<typename source_link_selector_t>

std::reference_wrapper<const GeometryContext> Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::geoContext

Context object for the geometry.

Definition at line 117 of file CombinatorialKalmanFilter.hpp.

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

Referenced by Acts::CombinatorialKalmanFilter< propagator_t, updater_t, smoother_t, source_link_selector_t, branch_stopper_t, calibrator_t >::findTracks().

template<typename source_link_selector_t>

LoggerWrapper Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::logger

Logger instance.

Definition at line 142 of file CombinatorialKalmanFilter.hpp.

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

Referenced by Acts::CombinatorialKalmanFilter< propagator_t, updater_t, smoother_t, source_link_selector_t, branch_stopper_t, calibrator_t >::findTracks().

template<typename source_link_selector_t>

std::reference_wrapper<const MagneticFieldContext> Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::magFieldContext

Context object for the magnetic field.

Definition at line 119 of file CombinatorialKalmanFilter.hpp.

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

Referenced by Acts::CombinatorialKalmanFilter< propagator_t, updater_t, smoother_t, source_link_selector_t, branch_stopper_t, calibrator_t >::findTracks().

template<typename source_link_selector_t>

bool Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::multipleScattering = true

Whether to consider multiple scattering.

Definition at line 133 of file CombinatorialKalmanFilter.hpp.

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

Referenced by Acts::CombinatorialKalmanFilter< propagator_t, updater_t, smoother_t, source_link_selector_t, branch_stopper_t, calibrator_t >::findTracks().

template<typename source_link_selector_t>

PropagatorPlainOptions Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::propagatorPlainOptions

The trivial propagator options.

Definition at line 127 of file CombinatorialKalmanFilter.hpp.

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

Referenced by Acts::CombinatorialKalmanFilter< propagator_t, updater_t, smoother_t, source_link_selector_t, branch_stopper_t, calibrator_t >::findTracks().

template<typename source_link_selector_t>

const Surface* Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::referenceSurface = nullptr

The reference Surface.

Definition at line 130 of file CombinatorialKalmanFilter.hpp.

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

Referenced by Acts::CombinatorialKalmanFilter< propagator_t, updater_t, smoother_t, source_link_selector_t, branch_stopper_t, calibrator_t >::findTracks().

template<typename source_link_selector_t>

bool Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::smoothing = true

Whether to run smoothing to get fitted parameter.

Definition at line 139 of file CombinatorialKalmanFilter.hpp.

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

Referenced by Acts::CombinatorialKalmanFilter< propagator_t, updater_t, smoother_t, source_link_selector_t, branch_stopper_t, calibrator_t >::findTracks().

template<typename source_link_selector_t>

SourceLinkSelectorConfig Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >::sourcelinkSelectorConfig

The config for the source link selector.

Definition at line 124 of file CombinatorialKalmanFilter.hpp.

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

Referenced by Acts::CombinatorialKalmanFilter< propagator_t, updater_t, smoother_t, source_link_selector_t, branch_stopper_t, calibrator_t >::findTracks().

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

acts/blob/sPHENIX/Core/include/Acts/TrackFinding/CombinatorialKalmanFilter.hpp

Public Types

Public Member Functions

Public Attributes

Detailed Description

template<typename source_link_selector_t> struct Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Data Documentation

template<typename source_link_selector_t>
struct Acts::CombinatorialKalmanFilterOptions< source_link_selector_t >