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:

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< BridgingWireHitRelationFilter >	m_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

using Super = Findlet<CDCWireHit&, CDCWireHitCluster, CDCWireHitCluster>

private

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

ClusterPreparer ( )

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

Definition at line 15 of file ClusterPreparer.cc.

{
  this->addProcessingSignalListener(&m_superClusterCreator);
  this->addProcessingSignalListener(&m_clusterRefiner);
  this->addProcessingSignalListener(&m_clusterBackgroundDetector);
}

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

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.

{
  clusters.reserve(100);
  superClusters.reserve(50);
 
  m_superClusterCreator.apply(inputWireHits, superClusters);
  m_clusterRefiner.apply(superClusters, clusters);
  m_clusterBackgroundDetector.apply(clusters);
}

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

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.

{
  m_superClusterCreator.exposeParameters(moduleParamList, prefixed(prefix, "SuperCluster"));
  m_clusterRefiner.exposeParameters(moduleParamList, prefix);
  m_clusterBackgroundDetector.exposeParameters(moduleParamList, prefixed(prefix, "Cluster"));
}

◆ getDescription()

std::string getDescription ( )

finalvirtual

Short description of the findlet.

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

Definition at line 22 of file ClusterPreparer.cc.

{
  return "Clusters the wire hits in the CDC to form locally connected groups with two granularities.";
}

◆ 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_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:

tracking/trackFindingCDC/findlets/combined/include/ClusterPreparer.h
tracking/trackFindingCDC/findlets/combined/src/ClusterPreparer.cc

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Super

◆ ToVector

Constructor & Destructor Documentation

◆ ClusterPreparer()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_clusterBackgroundDetector

◆ m_clusterRefiner

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_superClusterCreator

◆ m_terminated