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

#include <FullGridChi2TrackTimeExtractor.h>

Inheritance diagram for FullGridChi2TrackTimeExtractor:

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
	FullGridChi2TrackTimeExtractor ()
	Constructor.

void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override final
	Copy the parameters.

void	apply (std::vector< RecoTrack * > &) override final
	Timing extraction for this findlet.

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.

virtual void	apply (ToVector< AIOTypes > &... ioVectors)=0
	Main function executing the algorithm.

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 = BaseEventTimeExtractor< RecoTrack * >
	Type of the base class.

Private Attributes
GridEventTimeExtractor< Chi2BasedEventTimeExtractor >	m_gridExtractor
	Slow grid based extractor.

IterativeChi2BasedEventTimeExtractor	m_finalExtractor
	Refining extractor in the end.

bool	m_skipIfSVDEventT0Present = true
	Skip FullGrid EventT0 extraction if SVD EventT0 is present.

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 extract the event t0 using the chi-squared approach.

Definition at line 26 of file FullGridChi2TrackTimeExtractor.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 = BaseEventTimeExtractor<RecoTrack*>

private

Type of the base class.

Definition at line 29 of file FullGridChi2TrackTimeExtractor.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ FullGridChi2TrackTimeExtractor()

FullGridChi2TrackTimeExtractor ( )

Constructor.

Definition at line 21 of file FullGridChi2TrackTimeExtractor.cc.

{
  addProcessingSignalListener(&m_finalExtractor);
  addProcessingSignalListener(&m_gridExtractor);
}

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 )

finaloverride

Timing extraction for this findlet.

Definition at line 44 of file FullGridChi2TrackTimeExtractor.cc.

{
  // Don't execute this time consuming algorithm if a valid SVD based EventT0 estimate is present
  if (m_skipIfSVDEventT0Present and m_eventT0->hasTemporaryEventT0(Const::EDetector::SVD)) {
    return;
  }
 
  const auto& temporaryT0Extractions = m_eventT0->getTemporaryEventT0s(Const::CDC);
  B2ASSERT("There should only be a single or none extraction at this stage!", temporaryT0Extractions.size() <= 1);
 
  if (temporaryT0Extractions.empty()) {
    m_gridExtractor.apply(recoTracks);
    // if neither the hit based nor the grid based extraction finds something, we can not do anything
    if (not m_gridExtractor.wasSuccessful()) {
      m_wasSuccessful = false;
      return;
    }
  } else {
    // Make sure to actually use the temporary hit based extraction result
    m_eventT0->setEventT0(temporaryT0Extractions[0]);
  }
 
  m_finalExtractor.apply(recoTracks);
  m_wasSuccessful = m_finalExtractor.wasSuccessful();
 
  if (not wasSuccessful()) {
    B2DEBUG(25, "Resetting the event t0 as the final extraction was not successful.");
    resetEventT0();
  }
}

◆ 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
	)

finaloverridevirtual

Copy the parameters.

Reimplemented from BaseEventTimeExtractor< RecoTrack * >.

Definition at line 28 of file FullGridChi2TrackTimeExtractor.cc.

{
  m_gridExtractor.exposeParameters(moduleParamList, prefixed("Grid", prefix));
  m_finalExtractor.exposeParameters(moduleParamList, prefixed("Refiner", prefix));
 
  moduleParamList->getParameter<unsigned int>("GridIterations").setDefaultValue(1);
  moduleParamList->getParameter<bool>("RefinerUseLastEventT0").setDefaultValue(true);
 
  moduleParamList->addParameter(prefixed(prefix, "skipIfSVDEventT0Present"),
                                m_skipIfSVDEventT0Present,
                                "Skip execution of the time consuming FullGridChi2 algorithm if a valid SVD based EventT0 estimate is present. " \
                                "If set to true, this module is only used to get an CDC based EventT0 in the few events where no sufficient SVD information is available to estimate EventT0.",
                                m_skipIfSVDEventT0Present);
}

◆ 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_finalExtractor

IterativeChi2BasedEventTimeExtractor m_finalExtractor

private

Refining extractor in the end.

Definition at line 45 of file FullGridChi2TrackTimeExtractor.h.

◆ m_gridExtractor

GridEventTimeExtractor<Chi2BasedEventTimeExtractor> m_gridExtractor

private

Slow grid based extractor.

Definition at line 43 of file FullGridChi2TrackTimeExtractor.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_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_skipIfSVDEventT0Present

bool m_skipIfSVDEventT0Present = true

private

Skip FullGrid EventT0 extraction if SVD EventT0 is present.

Definition at line 47 of file FullGridChi2TrackTimeExtractor.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 files:

tracking/eventTimeExtraction/findlets/include/FullGridChi2TrackTimeExtractor.h
tracking/eventTimeExtraction/findlets/src/FullGridChi2TrackTimeExtractor.cc

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

Constructor & Destructor Documentation

◆ FullGridChi2TrackTimeExtractor()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ resetEventT0()

◆ terminate()

◆ wasSuccessful()

Member Data Documentation

◆ m_eventT0

◆ m_eventT0Before

◆ m_finalExtractor

◆ m_gridExtractor

◆ m_initialized

◆ m_initializedAs

◆ m_param_overwriteExistingEstimation

◆ m_skipIfSVDEventT0Present

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_wasSuccessful