Belle II Software development
ClusterPreparer Class Referenceabstract

Findlet to cluster the wire hits in the CDC to form locally connected groups with two granularities.";. More...

#include <ClusterPreparer.h>

Inheritance diagram for ClusterPreparer:
Findlet< CDCWireHit &, CDCWireHitCluster, CDCWireHitCluster > 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

 ClusterPreparer ()
 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 > &inputWireHits, std::vector< CDCWireHitCluster > &clusters, std::vector< CDCWireHitCluster > &superClusters) final
 Generates the segment from 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&, CDCWireHitCluster, CDCWireHitCluster>
 Type of the base class.
 

Private Attributes

SuperClusterCreator m_superClusterCreator
 Composes the super clusters.
 
ClusterRefiner< BridgingWireHitRelationFilterm_clusterRefiner
 Creates the clusters from super clusters.
 
ClusterBackgroundDetector m_clusterBackgroundDetector
 Marks the clusters as background.
 
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 to cluster the wire hits in the CDC to form locally connected groups with two granularities.";.

Definition at line 29 of file ClusterPreparer.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

Type of the base class.

Definition at line 33 of file ClusterPreparer.h.

◆ ToVector

using ToVector
protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ ClusterPreparer()

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

Definition at line 15 of file ClusterPreparer.cc.

16{
20}
ClusterRefiner< BridgingWireHitRelationFilter > m_clusterRefiner
Creates the clusters from super clusters.
ClusterBackgroundDetector m_clusterBackgroundDetector
Marks the clusters as background.
SuperClusterCreator m_superClusterCreator
Composes the super clusters.

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 > & inputWireHits,
std::vector< CDCWireHitCluster > & clusters,
std::vector< CDCWireHitCluster > & superClusters )
final

Generates the segment from wire hits.

Definition at line 34 of file ClusterPreparer.cc.

37{
38 clusters.reserve(100);
39 superClusters.reserve(50);
40
41 m_superClusterCreator.apply(inputWireHits, superClusters);
42 m_clusterRefiner.apply(superClusters, clusters);
43 m_clusterBackgroundDetector.apply(clusters);
44}

◆ 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 ClusterPreparer.cc.

28{
29 m_superClusterCreator.exposeParameters(moduleParamList, prefixed(prefix, "SuperCluster"));
30 m_clusterRefiner.exposeParameters(moduleParamList, prefix);
31 m_clusterBackgroundDetector.exposeParameters(moduleParamList, prefixed(prefix, "Cluster"));
32}

◆ getDescription()

std::string getDescription ( )
finalvirtual

Short description of the findlet.

Reimplemented from Findlet< CDCWireHit &, CDCWireHitCluster, CDCWireHitCluster >.

Definition at line 22 of file ClusterPreparer.cc.

23{
24 return "Clusters the wire hits in the CDC to form locally connected groups with two granularities.";
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_clusterBackgroundDetector

ClusterBackgroundDetector m_clusterBackgroundDetector
private

Marks the clusters as background.

Definition at line 59 of file ClusterPreparer.h.

◆ m_clusterRefiner

ClusterRefiner<BridgingWireHitRelationFilter> m_clusterRefiner
private

Creates the clusters from super clusters.

Definition at line 56 of file ClusterPreparer.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_superClusterCreator

SuperClusterCreator m_superClusterCreator
private

Composes the super clusters.

Definition at line 53 of file ClusterPreparer.h.

◆ m_terminated

bool m_terminated
privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.


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