GridEventTimeExtractor< AFindlet > Class Template Reference

Generic findlet applying a certain time extractor multiple times. More...

#include <GridEventTimeExtractor.dcl.h>

Inheritance diagram for GridEventTimeExtractor< AFindlet >:

Public Types
using	IOTypes
	Types that should be served to apply on invocation.
using	IOTypes
	Types that should be served to apply on invocation.
using	IOVectors
	Vector types that should be served to apply on invocation.
using	IOVectors
	Vector types that should be served to apply on invocation.

Public Member Functions
	GridEventTimeExtractor ()
	Add the subfindlet as listener.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override final
	Expose the parameters.
void	apply (std::vector< RecoTrack * > &recoTracks) override final
	Timing extraction for this findlet.
bool	wasSuccessful () const
	Returns true if the last run t0 extraction was successful.
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	initialize () override
	Initialize the event t0 store obj ptr.
virtual void	beginEvent () override
	Create 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 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
	Short hand for ToRangeImpl.
using	ToVector
	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	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.
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.
bool	m_wasSuccessful
	Variable to show that the execution was successful.

Private Types
using	Super = BaseEventTimeExtractor<RecoTrack*>
	Type of the base class.

Private Attributes
unsigned int	m_param_iterations = 2
	Parameter: how many iterations should be done?
bool	m_param_abortOnUnsuccessfulStep = true
	Parameter: abort if a single iteration is not working.
double	m_param_maximalT0Value = 70
	Parameter: Maximal T0 value.
double	m_param_minimalT0Value = -70
	Parameter: Minimal T0 value.
unsigned int	m_param_gridSteps = 8
	Parameter: Number of grid points.
AFindlet	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.
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::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
	Flag to keep track whether initialization happened before.
bool	m_terminated
	Flag to keep track whether termination happened before.
std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

template<class AFindlet>
class Belle2::GridEventTimeExtractor< AFindlet >

Generic findlet applying a certain time extractor multiple times.

Will abort if the extraction was not successful (can be controlled by a parameter).

Definition at line 27 of file GridEventTimeExtractor.dcl.h.

Member Typedef Documentation

IOTypes [1/2]

using IOTypes

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

IOTypes [2/2]

using IOTypes

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

IOVectors [1/2]

using IOVectors

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

IOVectors [2/2]

using IOVectors

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

Super

template<class AFindlet>

using Super = BaseEventTimeExtractor<RecoTrack*>

private

Type of the base class.

Definition at line 30 of file GridEventTimeExtractor.dcl.h.

ToVector [1/2]

using ToVector

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

ToVector [2/2]

using ToVector

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 53 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

beginEvent() [1/2]

virtual void beginEvent ( )

overridevirtualinherited

Create the event t0 store obj ptr.

Reimplemented from ProcessingSignalListener.

beginEvent() [2/2]

void beginEvent ( )

overridevirtualinherited

Create the event t0 store obj ptr.

Reimplemented from ProcessingSignalListener.

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

overrideinherited

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

Definition at line 33 of file CompositeProcessingSignalListener.cc.

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

endRun()

void endRun ( )

overrideinherited

Receive and dispatch signal for the end of the run.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

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

getDescription() [1/2]

virtual std::string getDescription ( )

inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

Definition at line 60 of file Findlet.h.

      {
        return "(no description)";
      }

getDescription() [2/2]

virtual std::string getDescription ( )

inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

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 56 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

initialize() [1/2]

virtual void initialize ( )

overridevirtualinherited

Initialize the event t0 store obj ptr.

Reimplemented from ProcessingSignalListener.

initialize() [2/2]

void initialize ( )

overridevirtualinherited

Initialize the event t0 store obj ptr.

Reimplemented from ProcessingSignalListener.

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

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

resetEventT0()

void resetEventT0 ( ) const

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

overrideinherited

Receive and dispatch Signal for termination of the event processing.

Definition at line 42 of file CompositeProcessingSignalListener.cc.

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

wasSuccessful()

bool wasSuccessful ( ) const

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 [1/2]

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_eventT0 [2/2]

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 [1/2]

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_eventT0Before [2/2]

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

template<class AFindlet>

std::vector<EventT0::EventT0Component> m_eventT0WithQuality

private

Pool for the event t0s with chi2.

Definition at line 57 of file GridEventTimeExtractor.dcl.h.

m_findlet

template<class AFindlet>

AFindlet m_findlet

private

The subfindlet.

Definition at line 55 of file GridEventTimeExtractor.dcl.h.

m_initialized

bool m_initialized

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

template<class AFindlet>

bool m_param_abortOnUnsuccessfulStep = true

private

Parameter: abort if a single iteration is not working.

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

m_param_gridSteps

template<class AFindlet>

unsigned int m_param_gridSteps = 8

private

Parameter: Number of grid points.

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

m_param_iterations

template<class AFindlet>

unsigned int m_param_iterations = 2

private

Parameter: how many iterations should be done?

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

m_param_maximalT0Value

template<class AFindlet>

double m_param_maximalT0Value = 70

private

Parameter: Maximal T0 value.

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

m_param_minimalT0Value

template<class AFindlet>

double m_param_minimalT0Value = -70

private

Parameter: Minimal T0 value.

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

m_param_overwriteExistingEstimation [1/2]

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_overwriteExistingEstimation [2/2]

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_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 60 of file CompositeProcessingSignalListener.h.

m_terminated

bool m_terminated

privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.

m_wasSuccessful [1/2]

bool m_wasSuccessful

protectedinherited

Variable to show that the execution was successful.

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

m_wasSuccessful [2/2]

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/GridEventTimeExtractor.dcl.h
• tracking/eventTimeExtraction/findlets/include/GridEventTimeExtractor.icc.h