Belle II Software  release-08-01-10
IterativeChi2BasedEventTimeExtractor Class Referencefinalabstract

Class to iteratively extract the event t0 using the chi-squared approach. More...

#include <IterativeChi2BasedEventTimeExtractor.h>

Inheritance diagram for IterativeChi2BasedEventTimeExtractor:
Collaboration diagram for IterativeChi2BasedEventTimeExtractor:

Public Types

using IOTypes = std::tuple< AIOTypes... >
 Types that should be served to apply on invokation.
 
using IOVectors = std::tuple< std::vector< AIOTypes >... >
 Vector types that should be served to apply on invokation.
 

Public Member Functions

void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override final
 Expose our parameters to the super module.
 
void apply (std::vector< RecoTrack * > &recoTracks) override final
 Timing extraction for this findlet.
 
virtual void apply (ToVector< AIOTypes > &... ioVectors)=0
 Main function executing the algorithm.
 
bool wasSuccessful () const
 Returns true if the last run t0 extraction was successful.
 
virtual void initialize () override
 Initialize the event t0 store obj ptr.
 
virtual void beginEvent () override
 Create the event t0 store obj ptr.
 
virtual std::string getDescription ()
 Brief description of the purpose of the concret findlet.
 
void beginRun () override
 Receive and dispatch signal for the beginning of a new run.
 
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 Types

using ToVector = typename ToVectorImpl< T >::Type
 Short hand for ToRangeImpl.
 

Protected Member Functions

void resetEventT0 () const
 Reset the t0 value to cached value if it exists or clear it otherwise.
 
void addProcessingSignalListener (ProcessingSignalListener *psl)
 Register a processing signal listener to be notified.
 
int getNProcessingSignalListener ()
 Get the number of currently registered listeners.
 

Protected Attributes

StoreObjPtr< EventT0m_eventT0
 Pointer to the storage of the eventwise T0 estimation in the data store.
 
bool m_wasSuccessful
 Variable to show that the execution was successful.
 

Private Types

using Super = IterativeEventTimeExtractor< Chi2BasedEventTimeExtractor >
 Type of the base class.
 

Private Attributes

unsigned int m_param_maxIterations
 Parameter: how many iterations should be done maximally?
 
unsigned int m_param_minIterations
 Parameter: how many iterations should be done minimally?
 
double m_param_minimalDeltaT0
 Parameter: What is the final precision?
 
bool m_param_abortOnUnsuccessfulStep
 Parameter: abort if a single iteration is not working.
 
bool m_param_useLastEventT0
 Parameter: use the last event t0 instead of the best one.
 
Chi2BasedEventTimeExtractor m_findlet
 The subfindlet.
 
std::vector< EventT0::EventT0Componentm_eventT0WithQuality
 Pool for the event t0s with chi2.
 
bool m_param_overwriteExistingEstimation
 Parameter if it is fine to overwrite the current EventT0.
 
std::optional< EventT0::EventT0Componentm_eventT0Before
 Storage for the event t0 before this module ran.
 
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

Class to iteratively extract the event t0 using the chi-squared approach.

Definition at line 23 of file IterativeChi2BasedEventTimeExtractor.h.


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