Belle II Software development
WireHitPreparer Class Referenceabstract

Findlet preparing the wire hits for the track finding. More...

#include <WireHitPreparer.h>

Inheritance diagram for WireHitPreparer:
Findlet< CDCWireHit > CompositeProcessingSignalListener ProcessingSignalListener

Public Types

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

Public Member Functions

 WireHitPreparer ()
 Constructor registering the subordinary findlets to the processing signal distribution machinery.
 
std::string getDescription () final
 Short description of the findlet.
 
void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
 Expose the parameters to a module.
 
void apply (std::vector< CDCWireHit > &outputWireHits) final
 Main function preparing the wire hits.
 
virtual void apply (ToVector< AIOTypes > &... ioVectors)=0
 Main function executing the algorithm.
 
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 Types

using ToVector
 Short hand for ToRangeImpl.
 

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 = Findlet<CDCWireHit>
 Type of the base class.
 

Private Attributes

WireHitCreator m_wireHitCreator
 Creates the wire hits from CDCHits attaching geometry information.
 
WireHitBackgroundBlocker m_wireHitBackgroundBlocker
 Marks hits as background based on simple heuristics.
 
WireHitBackgroundDetector m_wireHitBackgroundDetector
 Marks hits as background based on the result of a filter.
 
AsicBackgroundDetector m_asicBackgroundDetector
 Marks hits as background based on ASIC cross-talk signature.
 
WireHitMCMultiLoopBlocker m_wireHitMCMultiLoopBlocker
 Marks higher order loops as background for tuning analysis.
 
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

Findlet preparing the wire hits for the track finding.

Definition at line 30 of file WireHitPreparer.h.

Member Typedef Documentation

◆ IOTypes

using IOTypes
inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOVectors

using IOVectors
inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ Super

using Super = Findlet<CDCWireHit>
private

Type of the base class.

Definition at line 34 of file WireHitPreparer.h.

◆ ToVector

using ToVector
protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ WireHitPreparer()

Constructor registering the subordinary findlets to the processing signal distribution machinery.

Definition at line 13 of file WireHitPreparer.cc.

14{
20}
WireHitBackgroundDetector m_wireHitBackgroundDetector
Marks hits as background based on the result of a filter.
WireHitCreator m_wireHitCreator
Creates the wire hits from CDCHits attaching geometry information.
AsicBackgroundDetector m_asicBackgroundDetector
Marks hits as background based on ASIC cross-talk signature.
WireHitBackgroundBlocker m_wireHitBackgroundBlocker
Marks hits as background based on simple heuristics.
WireHitMCMultiLoopBlocker m_wireHitMCMultiLoopBlocker
Marks higher order loops as background for tuning analysis.

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.

56{
58}
Interface for a minimal algorithm part that wants to expose some parameters to a module.
Definition Findlet.h:26

◆ apply()

void apply ( std::vector< CDCWireHit > & outputWireHits)
final

Main function preparing the wire hits.

Definition at line 36 of file WireHitPreparer.cc.

37{
38 m_wireHitCreator.apply(outputWireHits);
39 m_wireHitBackgroundBlocker.apply(outputWireHits);
40 m_wireHitBackgroundDetector.apply(outputWireHits);
41 m_wireHitMCMultiLoopBlocker.apply(outputWireHits);
42 m_asicBackgroundDetector.apply(outputWireHits);
43}

◆ beginEvent()

void beginEvent ( )
overrideinherited

Receive and dispatch signal for the start of a new event.

Definition at line 36 of file CompositeProcessingSignalListener.cc.

32{
35 psl->beginEvent();
36 }
37}
void beginEvent() override
Receive and dispatch signal for the start of a new event.
virtual void beginEvent()
Receive signal for the start of a new event.

◆ beginRun()

void beginRun ( )
overrideinherited

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

Definition at line 33 of file CompositeProcessingSignalListener.cc.

24{
27 psl->beginRun();
28 }
29}
void beginRun() override
Receive and dispatch signal for the beginning of a new run.
virtual void beginRun()
Receive signal for the beginning of a new run.

◆ endRun()

void endRun ( )
overrideinherited

Receive and dispatch signal for the end of the run.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

40{
42 psl->endRun();
43 }
45}
void endRun() override
Receive and dispatch signal for the end of the run.
virtual void endRun()
Receive signal for the end of the run.

◆ exposeParameters()

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

Expose the parameters to a module.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 27 of file WireHitPreparer.cc.

28{
29 m_wireHitCreator.exposeParameters(moduleParamList, prefix);
30 m_wireHitBackgroundBlocker.exposeParameters(moduleParamList, prefix);
31 m_wireHitBackgroundDetector.exposeParameters(moduleParamList, prefix);
32 m_wireHitMCMultiLoopBlocker.exposeParameters(moduleParamList, prefix);
33 m_asicBackgroundDetector.exposeParameters(moduleParamList, prefix);
34}

◆ getDescription()

std::string getDescription ( )
finalvirtual

Short description of the findlet.

Reimplemented from Findlet< CDCWireHit >.

Definition at line 22 of file WireHitPreparer.cc.

23{
24 return "Combine the CDCHits from the DataStore with the geometry information.";
25}

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )
protectedinherited

Get the number of currently registered listeners.

Definition at line 56 of file CompositeProcessingSignalListener.cc.

61{
63}

◆ initialize()

void initialize ( )
overrideinherited

Receive and dispatch signal before the start of the event processing.

Definition at line 30 of file CompositeProcessingSignalListener.cc.

16{
19 psl->initialize();
20 }
21}
void initialize() override
Receive and dispatch signal before the start of the event processing.
virtual void initialize()
Receive signal before the start of the event processing.

◆ terminate()

void terminate ( )
overrideinherited

Receive and dispatch Signal for termination of the event processing.

Definition at line 42 of file CompositeProcessingSignalListener.cc.

48{
50 psl->terminate();
51 }
53}
void terminate() override
Receive and dispatch Signal for termination of the event processing.
virtual void terminate()
Receive Signal for termination of the event processing.

Member Data Documentation

◆ m_asicBackgroundDetector

AsicBackgroundDetector m_asicBackgroundDetector
private

Marks hits as background based on ASIC cross-talk signature.

Definition at line 61 of file WireHitPreparer.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_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_wireHitBackgroundBlocker

WireHitBackgroundBlocker m_wireHitBackgroundBlocker
private

Marks hits as background based on simple heuristics.

Definition at line 55 of file WireHitPreparer.h.

◆ m_wireHitBackgroundDetector

WireHitBackgroundDetector m_wireHitBackgroundDetector
private

Marks hits as background based on the result of a filter.

Definition at line 58 of file WireHitPreparer.h.

◆ m_wireHitCreator

WireHitCreator m_wireHitCreator
private

Creates the wire hits from CDCHits attaching geometry information.

Definition at line 52 of file WireHitPreparer.h.

◆ m_wireHitMCMultiLoopBlocker

WireHitMCMultiLoopBlocker m_wireHitMCMultiLoopBlocker
private

Marks higher order loops as background for tuning analysis.

Definition at line 64 of file WireHitPreparer.h.


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