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

#include <IterativeChi2BasedEventTimeExtractor.h>

Inheritance diagram for IterativeChi2BasedEventTimeExtractor:

Public Types
using	IOTypes = std::tuple< AIOTypes... >
	Types that should be served to apply on invocation.

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

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 concrete 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< EventT0 >	m_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::EventT0Component >	m_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::EventT0Component >	m_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 happened before.

bool	m_terminated = false
	Flag to keep track whether termination happened 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.

Member Typedef Documentation

◆ IOTypes

using IOTypes = std::tuple<AIOTypes...>

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOVectors

using IOVectors = std::tuple< std::vector<AIOTypes>... >

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ Super

using Super = IterativeEventTimeExtractor<Chi2BasedEventTimeExtractor>

private

Type of the base class.

Definition at line 26 of file IterativeChi2BasedEventTimeExtractor.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Member Function Documentation

◆ addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener * psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 55 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

◆ apply()

void apply ( std::vector< RecoTrack * > & recoTracks )

finaloverrideinherited

Timing extraction for this findlet.

Definition at line 40 of file IterativeEventTimeExtractor.icc.h.

  {
    m_wasSuccessful = false;
 
    m_eventT0WithQuality.clear();
 
    TimeExtractionUtils::addEventT0WithQuality(recoTracks, m_eventT0, m_eventT0WithQuality);
 
    unsigned int iteration = 0;
    for (; iteration < m_param_maxIterations; iteration++) {
      // The findlet will set the final event t0, but will probably not add any temporary event t0s, which is fine as we will do so.
      m_findlet.apply(recoTracks);
 
      bool breakLoop = false;
      if (m_findlet.wasSuccessful()) {
 
        if (not m_eventT0WithQuality.empty()) {
          const double deltaT0 = std::abs(m_eventT0->getEventT0() - m_eventT0WithQuality.back().eventT0);
          if (deltaT0 < m_param_minimalDeltaT0 and iteration >= m_param_minIterations) {
            breakLoop = true;
          }
        }
        TimeExtractionUtils::addEventT0WithQuality(recoTracks, m_eventT0, m_eventT0WithQuality);
      } else if (m_param_abortOnUnsuccessfulStep) {
        B2DEBUG(25, "Aborting because time extraction was not successful.");
        breakLoop = true;
      }
 
      if (breakLoop) {
        break;
      }
    }
 
    if (not m_eventT0WithQuality.empty() and iteration != m_param_maxIterations) {
      if (m_param_useLastEventT0) {
        m_eventT0->addTemporaryEventT0(m_eventT0WithQuality.back());
        m_eventT0->setEventT0(m_eventT0WithQuality.back());
      } else {
        // Look for the best event t0 (with the smallest chi2)
        const auto& bestEventT0 = std::max_element(m_eventT0WithQuality.begin(), m_eventT0WithQuality.end(),
        [](const auto & lhs, const auto & rhs) {
          return lhs.quality < rhs.quality;
        });
        m_eventT0->setEventT0(*bestEventT0);
      }
      m_wasSuccessful = true;
    }
  }

◆ beginEvent()

void beginEvent

overridevirtualinherited

Create the event t0 store obj ptr.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 39 of file BaseEventTimeExtractor.icc.h.

  {
    Super::beginEvent();
 
    m_wasSuccessful = false;
 
    if (not m_eventT0.isValid()) {
      m_eventT0.create();
    }
 
    m_eventT0Before = m_eventT0->getEventT0Component();
  }

◆ beginRun()

void beginRun ( )

overridevirtualinherited

Receive and dispatch signal for the beginning of a new run.

Reimplemented from ProcessingSignalListener.

Reimplemented in LayerRelationFilter< AFilter >, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, and TrackCandidateResultRefiner.

Definition at line 23 of file CompositeProcessingSignalListener.cc.

{
  Super::beginRun();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginRun();
  }
}

◆ endRun()

void endRun ( )

overridevirtualinherited

Receive and dispatch signal for the end of the run.

Reimplemented from ProcessingSignalListener.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->endRun();
  }
  Super::endRun();
}

◆ exposeParameters()

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

inlinefinaloverridevirtual

Expose our parameters to the super module.

Reimplemented from BaseEventTimeExtractor< RecoTrack * >.

Definition at line 29 of file IterativeChi2BasedEventTimeExtractor.h.

    {
      Super::exposeParameters(moduleParamList, prefix);
 
      moduleParamList->getParameter<bool>(TrackFindingCDC::prefixed(prefix, "useLastEventT0")).setDefaultValue(false);
    }

◆ getDescription()

virtual std::string getDescription ( )

inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

Reimplemented in HitBasedT0Extractor.

Definition at line 60 of file Findlet.h.

      {
        return "(no description)";
      }

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

◆ initialize()

void initialize

overridevirtualinherited

Initialize the event t0 store obj ptr.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 36 of file BaseEventTimeExtractor.icc.h.

  {
    Super::initialize();
    m_eventT0.registerInDataStore();
  }

◆ resetEventT0()

void resetEventT0

protectedinherited

Reset the t0 value to cached value if it exists or clear it otherwise.

Definition at line 43 of file BaseEventTimeExtractor.icc.h.

  {
    if (m_eventT0Before) {
      m_eventT0->setEventT0(*m_eventT0Before);
    } else {
      m_eventT0->clearEventT0();
    }
  }

◆ terminate()

void terminate ( )

overridevirtualinherited

Receive and dispatch Signal for termination of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, and StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >.

Definition at line 47 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->terminate();
  }
  Super::terminate();
}

◆ wasSuccessful()

bool wasSuccessful

inherited

Returns true if the last run t0 extraction was successful.

Definition at line 30 of file BaseEventTimeExtractor.icc.h.

  {
    return m_wasSuccessful;
  }

Member Data Documentation

◆ m_eventT0

StoreObjPtr<EventT0> m_eventT0

protectedinherited

Pointer to the storage of the eventwise T0 estimation in the data store.

Definition at line 46 of file BaseEventTimeExtractor.dcl.h.

◆ m_eventT0Before

std::optional<EventT0::EventT0Component> m_eventT0Before

privateinherited

Storage for the event t0 before this module ran.

Definition at line 56 of file BaseEventTimeExtractor.dcl.h.

◆ m_eventT0WithQuality

std::vector<EventT0::EventT0Component> m_eventT0WithQuality

privateinherited

Pool for the event t0s with chi2.

Definition at line 56 of file IterativeEventTimeExtractor.dcl.h.

◆ m_findlet

Chi2BasedEventTimeExtractor m_findlet

privateinherited

The subfindlet.

Definition at line 54 of file IterativeEventTimeExtractor.dcl.h.

◆ m_initialized

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happened before.

Definition at line 52 of file ProcessingSignalListener.h.

◆ m_initializedAs

std::string m_initializedAs

privateinherited

Name of the type during initialisation.

Definition at line 58 of file ProcessingSignalListener.h.

◆ m_param_abortOnUnsuccessfulStep

bool m_param_abortOnUnsuccessfulStep

privateinherited

Parameter: abort if a single iteration is not working.

Definition at line 50 of file IterativeEventTimeExtractor.dcl.h.

◆ m_param_maxIterations

unsigned int m_param_maxIterations

privateinherited

Parameter: how many iterations should be done maximally?

Definition at line 44 of file IterativeEventTimeExtractor.dcl.h.

◆ m_param_minimalDeltaT0

double m_param_minimalDeltaT0

privateinherited

Parameter: What is the final precision?

Definition at line 48 of file IterativeEventTimeExtractor.dcl.h.

◆ m_param_minIterations

unsigned int m_param_minIterations

privateinherited

Parameter: how many iterations should be done minimally?

Definition at line 46 of file IterativeEventTimeExtractor.dcl.h.

◆ m_param_overwriteExistingEstimation

bool m_param_overwriteExistingEstimation

privateinherited

Parameter if it is fine to overwrite the current EventT0.

Definition at line 53 of file BaseEventTimeExtractor.dcl.h.

◆ m_param_useLastEventT0

bool m_param_useLastEventT0

privateinherited

Parameter: use the last event t0 instead of the best one.

Definition at line 52 of file IterativeEventTimeExtractor.dcl.h.

◆ m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 52 of file CompositeProcessingSignalListener.h.

◆ m_terminated

bool m_terminated = false

privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.

◆ m_wasSuccessful

bool m_wasSuccessful

protectedinherited

Variable to show that the execution was successful.

Definition at line 49 of file BaseEventTimeExtractor.dcl.h.

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

tracking/eventTimeExtraction/findlets/include/IterativeChi2BasedEventTimeExtractor.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Protected Attributes

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Super

◆ ToVector

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ resetEventT0()

◆ terminate()

◆ wasSuccessful()

Member Data Documentation

◆ m_eventT0

◆ m_eventT0Before

◆ m_eventT0WithQuality

◆ m_findlet

◆ m_initialized

◆ m_initializedAs

◆ m_param_abortOnUnsuccessfulStep

◆ m_param_maxIterations

◆ m_param_minimalDeltaT0

◆ m_param_minIterations

◆ m_param_overwriteExistingEstimation

◆ m_param_useLastEventT0

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_wasSuccessful