ClusterCreator< AWireHitRelationFilter > Class Template Reference

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

#include <ClusterCreator.h>

Inheritance diagram for ClusterCreator< AWireHitRelationFilter >:

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
	ClusterCreator ()
	Constructor adding the filter as a subordinary processing signal listener.
std::string	getDescription () final
	Short description of the findlet.
void	apply (std::vector< CDCWireHit > &inputWireHits, 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.
virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Expose the set of parameters of the filter to the module parameter list.

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>
	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 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 = WholeWireHitRelationFilter>
class Belle2::TrackFindingCDC::ClusterCreator< AWireHitRelationFilter >

Refines the clustering of wire hits from clusters to clusters.

Definition at line 35 of file ClusterCreator.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 = WholeWireHitRelationFilter>

using Super = Findlet<CDCWireHit, CDCWireHitCluster>

private

Type of the base class.

Definition at line 39 of file ClusterCreator.h.

ToVector

using ToVector

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

ClusterCreator()

template<class AWireHitRelationFilter = WholeWireHitRelationFilter>

ClusterCreator ( )

inline

Constructor adding the filter as a subordinary processing signal listener.

Definition at line 43 of file ClusterCreator.h.

      {
        this->addProcessingSignalListener(&m_wireHitRelationFilter);
      }

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);
}

apply()

template<class AWireHitRelationFilter = WholeWireHitRelationFilter>

void apply ( std::vector< CDCWireHit > & inputWireHits, std::vector< CDCWireHitCluster > & outputClusters )

inlinefinal

Main algorithm applying the cluster refinement.

Definition at line 55 of file ClusterCreator.h.

                                                                     {
 
        // Obtain the wire hits as pointers.
        const std::vector<CDCWireHit*> wireHitPtrs = as_pointers<CDCWireHit>(inputWireHits);
 
        // create the neighborhood
        m_wireHitRelations.clear();
        RelationFilterUtil::appendUsing(m_wireHitRelationFilter, wireHitPtrs, m_wireHitRelations);
 
        B2ASSERT("Expect wire hit neighborhood to be symmetric ",
        WeightedRelationUtil<CDCWireHit>::areSymmetric(m_wireHitRelations));
 
        // Compose the clusters
        m_wirehitClusterizer.apply(wireHitPtrs, m_wireHitRelations, outputClusters);
      }

beginEvent()

void beginEvent ( )

overrideinherited

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

Definition at line 36 of file CompositeProcessingSignalListener.cc.

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

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

exposeParameters()

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

inlinevirtualinherited

Expose the set of parameters of the filter to the module parameter list.

Parameters

moduleParamList	Module parameter list to add the new parameters to
prefix	Prefix (or sometimes postfix) to be added to all nely added parameters.

Definition at line 47 of file CompositeProcessingSignalListener.h.

      {};

getDescription()

template<class AWireHitRelationFilter = WholeWireHitRelationFilter>

std::string getDescription ( )

inlinefinalvirtual

Short description of the findlet.

Reimplemented from Findlet< CDCWireHit &, CDCWireHitCluster >.

Definition at line 49 of file ClusterCreator.h.

                                       {
        return "Groups the wire hits into super by expanding the given wire hit relation";
      }

getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 56 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

initialize()

void initialize ( )

overrideinherited

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

Definition at line 30 of file CompositeProcessingSignalListener.cc.

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

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

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 = WholeWireHitRelationFilter>

Clusterizer<CDCWireHit, CDCWireHitCluster> m_wirehitClusterizer

private

Instance of the hit cluster generator.

Definition at line 74 of file ClusterCreator.h.

m_wireHitRelationFilter

template<class AWireHitRelationFilter = WholeWireHitRelationFilter>

AWireHitRelationFilter m_wireHitRelationFilter

private

Wire hit neighborhood relation filter.

Definition at line 80 of file ClusterCreator.h.

m_wireHitRelations

template<class AWireHitRelationFilter = WholeWireHitRelationFilter>

std::vector<WeightedRelation<CDCWireHit> > m_wireHitRelations

private

Memory for the wire hit neighborhood in a cluster.

Definition at line 77 of file ClusterCreator.h.

---

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

• tracking/trackFindingCDC/findlets/minimal/include/ClusterCreator.h