Filter which can be used on a pair of path (vector of states) and states, which will call the kalmanStep function of the given stepper class, to update the mSoP of the new state with a klaman update. More...

#include <KalmanFilter.h>

Inheritance diagram for KalmanFilter< AState, AKalmanStepper >:

[legend]

Collaboration diagram for KalmanFilter< AState, AKalmanStepper >:

[legend]

Public Types
using	Object = std::pair< const std::vector< TrackFindingCDC::WithWeight< const AState * > >, AState * >
	Type of the object to be analysed.

using	Interface = Filter< std::pair< const std::vector< TrackFindingCDC::WithWeight< const AState * > >, AState * > >
	Mark this class as the basic interface.

Public Member Functions
TrackFindingCDC::Weight	operator() (const std::pair< const std::vector< TrackFindingCDC::WithWeight< const AState * >>, AState * > &pair) override
	Call the kalmanStep and update the new state and its chi2.

virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Expose the set of parameters of the filter to the module parameter list. More...

virtual bool	needsTruthInformation ()
	Indicates if the filter requires Monte Carlo information.

virtual Weight	operator() (const Object &obj)
	Function to evaluate the object. More...

Weight	operator() (const Object *obj)
	Function to evaluate the object. More...

void	initialize () override
	Receive and dispatch signal before the start of the event processing.

void	beginRun () override
	Receive and dispatch signal for the beginning of a new run.

void	beginEvent () override
	Receive and dispatch signal for the start of a new event.

void	endRun () override
	Receive and dispatch signal for the end of the run.

void	terminate () override
	Receive and dispatch Signal for termination of the event processing.

Protected Member Functions
void	addProcessingSignalListener (ProcessingSignalListener *psl)
	Register a processing signal listener to be notified.

int	getNProcessingSignalListener ()
	Get the number of currently registered listeners.

Private Types
using	Super = ProcessingSignalListener
	Type of the base class.

Private Attributes
AKalmanStepper	m_kalmanStepper
	The used stepper algorithm.

std::vector< ProcessingSignalListener * >	m_subordinaryProcessingSignalListeners
	References to subordinary signal processing listener contained in this findlet.

bool	m_initialized = false
	Flag to keep track whether initialization happend before.

bool	m_terminated = false
	Flag to keep track whether termination happend before.

std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

template<class AState, class AKalmanStepper>
class Belle2::KalmanFilter< AState, AKalmanStepper >

Filter which can be used on a pair of path (vector of states) and states, which will call the kalmanStep function of the given stepper class, to update the mSoP of the new state with a klaman update.

Will return the result of the steppers kalmanStep function as a filter result (which should be the chi2) and will also set the chi2 of the new state.

Template Parameters

AState	should have the basic functionality of a CKFState.
AKalmanStepper	should have a kalmanStep function.

Definition at line 31 of file KalmanFilter.h.

Member Function Documentation

◆ exposeParameters()

void exposeParameters	(	ModuleParamList *	moduleParamList,
		const std::string &	prefix
	)

virtualinherited

Expose the set of parameters of the filter to the module parameter list.

Note that not all filters have yet exposed their parameters in this way.

This method is deprecated as the exposeParams below uses a less compile heavy equivalent.

Reimplemented in AdvanceFilter< AState, AnAdvancer >.

Definition at line 52 of file Filter.icc.h.

◆ operator()() [1/2]

Weight operator() ( const Object & obj )

virtualinherited

Function to evaluate the object.

Base implementation accepts all objects.

Parameters

obj	The object to be accepted or rejected.

Returns: A finite float value if the object is accepted. NAN if the object is rejected.

Definition at line 66 of file Filter.icc.h.

◆ operator()() [2/2]

Weight operator() ( const Object * obj )

inherited

Function to evaluate the object.

Base implementation accepts all objects, except nullptr.

Parameters

obj	The object to be accepted or rejected.

Returns: A finit float value if the object is accepted. NAN if the object is rejected. Nullptr is always rejected.

Definition at line 76 of file Filter.icc.h.

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

tracking/ckf/general/filters/include/KalmanFilter.h

Public Types

Public Member Functions

Protected Member Functions

Private Types