Belle II Software development
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Types | Private Attributes | List of all members
ClusterRefiner< AWireHitRelationFilter > Class Template Referenceabstract

Refines the clustering of wire hits from super clusters to clustexrs. More...

#include <ClusterRefiner.h>

Inheritance diagram for ClusterRefiner< AWireHitRelationFilter >:
Findlet< const 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

 ClusterRefiner ()
 Constructor adding the filter as a subordinary processing signal listener.
 
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 (const std::vector< CDCWireHitCluster > &inputSuperClusters, std::vector< CDCWireHitCluster > &outputClusters) final
 Main algorithm applying the cluster refinement.
 
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<const CDCWireHitCluster, CDCWireHitCluster>
 Type of the base class.
 

Private Attributes

Clusterizer< CDCWireHit, CDCWireHitCluster > m_wireHitClusterizer
 Instance of the hit cluster generator.
 
std::vector< WeightedRelation< CDCWireHit > > m_wireHitRelations
 Memory for the wire hit neighborhood in a super cluster.
 
AWireHitRelationFilter m_wireHitRelationFilter
 Wire hit neighborhood relation filter.
 
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 AWireHitRelationFilter>
class Belle2::TrackFindingCDC::ClusterRefiner< AWireHitRelationFilter >

Refines the clustering of wire hits from super clusters to clustexrs.

Definition at line 34 of file ClusterRefiner.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

template<class AWireHitRelationFilter>
using Super = Findlet<const CDCWireHitCluster, CDCWireHitCluster>
private

Type of the base class.

Definition at line 38 of file ClusterRefiner.h.

◆ ToVector

using ToVector
protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ ClusterRefiner()

template<class AWireHitRelationFilter>
ClusterRefiner ( )
inline

Constructor adding the filter as a subordinary processing signal listener.

Definition at line 42 of file ClusterRefiner.h.

43 {
44 this->addProcessingSignalListener(&m_wireHitRelationFilter);
45 }

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{
57 m_subordinaryProcessingSignalListeners.push_back(psl);
58}
Belle2::TrackFindingCDC::Findlet
Interface for a minimal algorithm part that wants to expose some parameters to a module.
Definition Findlet.h:26

◆ apply()

template<class AWireHitRelationFilter>
void apply ( const std::vector< CDCWireHitCluster > & inputSuperClusters,
std::vector< CDCWireHitCluster > & outputClusters )
inlinefinal

Main algorithm applying the cluster refinement.

Definition at line 59 of file ClusterRefiner.h.

60 {
61 for (const CDCWireHitCluster& superCluster : inputSuperClusters)
62 {
63 B2ASSERT("Expect the clusters to be sorted", std::is_sorted(superCluster.begin(),
64 superCluster.end()));
65
66 // Obtain the wire hits as pointers
67 const std::vector<CDCWireHit*>& wireHitPtrs = superCluster;
68
69 // Create the wire hit relations within the supercluster.
70 m_wireHitRelations.clear();
71 RelationFilterUtil::appendUsing(m_wireHitRelationFilter, wireHitPtrs, m_wireHitRelations);
72 const std::size_t nClustersBefore = outputClusters.size();
73 m_wireHitClusterizer.apply(superCluster, m_wireHitRelations, outputClusters);
74 const std::size_t nClustersAfter = outputClusters.size();
75
76 // Update the super cluster id of the just created clusters
77 int iSuperCluster = superCluster.getISuperCluster();
78 for (std::size_t iCluster = nClustersBefore; iCluster < nClustersAfter; ++iCluster) {
79 CDCWireHitCluster& cluster = outputClusters[iCluster];
80 cluster.setISuperCluster(iSuperCluster);
81 std::sort(cluster.begin(), cluster.end());
82 }
83 }
84 }

◆ beginEvent()

void beginEvent ( )
overrideinherited

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

Definition at line 36 of file CompositeProcessingSignalListener.cc.

32{
33 Super::beginEvent();
34 for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
35 psl->beginEvent();
36 }
37}
Belle2::TrackFindingCDC::CompositeProcessingSignalListener::beginEvent
void beginEvent() override
Receive and dispatch signal for the start of a new event.
Definition CompositeProcessingSignalListener.cc:31
Belle2::TrackFindingCDC::ProcessingSignalListener::beginEvent
virtual void beginEvent()
Receive signal for the start of a new event.
Definition ProcessingSignalListener.cc:45

◆ beginRun()

void beginRun ( )
overrideinherited

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

Definition at line 33 of file CompositeProcessingSignalListener.cc.

24{
25 Super::beginRun();
26 for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
27 psl->beginRun();
28 }
29}
Belle2::TrackFindingCDC::CompositeProcessingSignalListener::beginRun
void beginRun() override
Receive and dispatch signal for the beginning of a new run.
Definition CompositeProcessingSignalListener.cc:23
Belle2::TrackFindingCDC::ProcessingSignalListener::beginRun
virtual void beginRun()
Receive signal for the beginning of a new run.
Definition ProcessingSignalListener.cc:38

◆ endRun()

void endRun ( )
overrideinherited

Receive and dispatch signal for the end of the run.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

40{
41 for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
42 psl->endRun();
43 }
44 Super::endRun();
45}
Belle2::TrackFindingCDC::CompositeProcessingSignalListener::endRun
void endRun() override
Receive and dispatch signal for the end of the run.
Definition CompositeProcessingSignalListener.cc:39
Belle2::TrackFindingCDC::ProcessingSignalListener::endRun
virtual void endRun()
Receive signal for the end of the run.
Definition ProcessingSignalListener.cc:52

◆ exposeParameters()

template<class AWireHitRelationFilter>
void exposeParameters ( ModuleParamList * moduleParamList,
const std::string & prefix )
inlinefinalvirtual

Expose the parameters to a module.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 53 of file ClusterRefiner.h.

53 {
54 m_wireHitRelationFilter.exposeParameters(moduleParamList, prefix);
55 }

◆ getDescription()

template<class AWireHitRelationFilter>
std::string getDescription ( )
inlinefinalvirtual

Short description of the findlet.

Reimplemented from Findlet< const CDCWireHitCluster, CDCWireHitCluster >.

Definition at line 48 of file ClusterRefiner.h.

48 {
49 return "Breaks bigger wire hit super cluster into smaller wire hit clusters";
50 }

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )
protectedinherited

Get the number of currently registered listeners.

Definition at line 56 of file CompositeProcessingSignalListener.cc.

61{
62 return m_subordinaryProcessingSignalListeners.size();
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{
17 Super::initialize();
18 for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
19 psl->initialize();
20 }
21}
Belle2::TrackFindingCDC::CompositeProcessingSignalListener::initialize
void initialize() override
Receive and dispatch signal before the start of the event processing.
Definition CompositeProcessingSignalListener.cc:15
Belle2::TrackFindingCDC::ProcessingSignalListener::initialize
virtual void initialize()
Receive signal before the start of the event processing.
Definition ProcessingSignalListener.cc:28

◆ terminate()

void terminate ( )
overrideinherited

Receive and dispatch Signal for termination of the event processing.

Definition at line 42 of file CompositeProcessingSignalListener.cc.

48{
49 for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
50 psl->terminate();
51 }
52 Super::terminate();
53}
Belle2::TrackFindingCDC::CompositeProcessingSignalListener::terminate
void terminate() override
Receive and dispatch Signal for termination of the event processing.
Definition CompositeProcessingSignalListener.cc:47
Belle2::TrackFindingCDC::ProcessingSignalListener::terminate
virtual void terminate()
Receive Signal for termination of the event processing.
Definition ProcessingSignalListener.cc:59

Member Data Documentation

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

template<class AWireHitRelationFilter>
Clusterizer<CDCWireHit, CDCWireHitCluster> m_wireHitClusterizer
private

Instance of the hit cluster generator.

Definition at line 88 of file ClusterRefiner.h.

◆ m_wireHitRelationFilter

template<class AWireHitRelationFilter>
AWireHitRelationFilter m_wireHitRelationFilter
private

Wire hit neighborhood relation filter.

Definition at line 94 of file ClusterRefiner.h.

◆ m_wireHitRelations

template<class AWireHitRelationFilter>
std::vector<WeightedRelation<CDCWireHit> > m_wireHitRelations
private

Memory for the wire hit neighborhood in a super cluster.

Definition at line 91 of file ClusterRefiner.h.

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