Belle II Software  release-08-01-10
AdvanceFilter< AState, AnAdvancer > Class Template Reference

Filter which can be used on a pair of path (vector of states) and states, which will call the extrapolate function of the given advancer class, to extrapolate the last path state to the plane of the new state and store the mSoP in the new state. More...

#include <AdvanceFilter.h>

Inheritance diagram for AdvanceFilter< AState, AnAdvancer >:
Collaboration diagram for AdvanceFilter< AState, AnAdvancer >:

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

void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
 Expose the parameters of the advancer.
 
TrackFindingCDC::Weight operator() (const std::pair< const std::vector< TrackFindingCDC::WithWeight< const AState * >>, AState * > &pair) override
 Extrapolate and return the result. Update the mSoP of the new state.
 
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 = TrackFindingCDC::Filter< std::pair< const std::vector< TrackFindingCDC::WithWeight< const AState * > >, AState * > >
 Type of the base class.
 

Private Attributes

AnAdvancer m_advancer
 The advancer to use.
 
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 AnAdvancer>
class Belle2::AdvanceFilter< AState, AnAdvancer >

Filter which can be used on a pair of path (vector of states) and states, which will call the extrapolate function of the given advancer class, to extrapolate the last path state to the plane of the new state and store the mSoP in the new state.

Will return the result of the advancers extrapolation function as a filter result or NAN of the extrapolation throws a genfit::Exception.

Template Parameters
AStateshould have the basic functionality of a CKFState.
AnAdvancerThe class to be used during extrapolation. Should have the functions:
  • exposeParameters(moduleParamList, prefix)
  • setMaterialEffectsToParameterValue()
  • extrapolateToPlane(mSoP, plane)
  • resetMaterialEffects() should be a ProcessingSignalListener.

Definition at line 44 of file AdvanceFilter.h.

Member Function Documentation

◆ operator()() [1/2]

Weight operator() ( const Object obj)
virtualinherited

Function to evaluate the object.

Base implementation accepts all objects.

Parameters
objThe 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
objThe 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: