Implementation of the clustering Clusters elements of a given collection using the relations presented by a neighborhood. More...

#include <Clusterizer.h>

Inheritance diagram for Clusterizer< ACellHolder, ACluster >:

Public Types
using	IOTypes = std::tuple< AIOTypes... >
	Types that should be served to apply on invocation.

using	IOVectors = std::tuple< std::vector< AIOTypes >... >
	Vector types that should be served to apply on invocation.

Public Member Functions
void	apply (std::vector< ACellHolder * > const &cellHolders, std::vector< WeightedRelation< ACellHolder > > const &cellHolderRelations, std::vector< ACluster > &clusters) override
	Creates the clusters.

virtual std::string	getDescription ()
	Brief description of the purpose of the concrete findlet.

virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Forward prefixed parameters of this findlet to the module parameter list.

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
template<class T >
using	ToVector = typename ToVectorImpl< T >::Type
	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 = ProcessingSignalListener
	Type of the base class.

Private Member Functions
void	expandCluster (std::vector< WeightedRelation< ACellHolder > > const &cellHolderRelations, std::vector< ACellHolder * > &cluster) const
	Helper function. Starting a new cluster and iteratively expands it.

void	setCellState (ACellHolder *cellHolder, Weight cellState) const
	Setter for the cell state of a pointed object that holds an AutomatonCell.

Weight	getCellState (ACellHolder *cellHolder) const
	Getter for the cell state of a pointed object that holds an AutomatonCell.

void	setCellWeight (ACellHolder *cellHolder, Weight cellWeight) const
	Setter for the cell weight of a pointed object that holds an AutomatonCell.

Private Attributes
std::vector< ProcessingSignalListener * >	m_subordinaryProcessingSignalListeners
	References to subordinary signal processing listener contained in this findlet.

bool	m_initialized = false
	Flag to keep track whether initialization happened before.

bool	m_terminated = false
	Flag to keep track whether termination happened before.

std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

template<class ACellHolder, class ACluster = std::vector<ACellHolder*>>
class Belle2::TrackFindingCDC::Clusterizer< ACellHolder, ACluster >

Implementation of the clustering Clusters elements of a given collection using the relations presented by a neighborhood.

A cluster is essentially a connected subset of all cells that can reach each other by one more relations in a neighborhood. The algorithm is essentially an iterative expansion of the neighborhood relations keeping track of the already used cells by using the CellState of the AutomatonCell.

ACellHolder must therefore provide an AutomatonCell accessible by a getAutomatonCell() method. In case the objects you what to cluster do not contain an automaton cell already you may adopt it by using the WithAutomatonCell mixin.
ACluster can be anything that is default constructable and supports .insert(end(), ACellHolder*).

Definition at line 40 of file Clusterizer.h.

Member Typedef Documentation

◆ IOTypes

using IOTypes = std::tuple<AIOTypes...>

inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOVectors

using IOVectors = std::tuple< std::vector<AIOTypes>... >

inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ Super

using Super = ProcessingSignalListener

privateinherited

Type of the base class.

Definition at line 25 of file CompositeProcessingSignalListener.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Member Function Documentation

◆ addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener * psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 55 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

◆ apply()

void apply	(	std::vector< ACellHolder * > const &	cellHolders,
		std::vector< WeightedRelation< ACellHolder > > const &	cellHolderRelations,
		std::vector< ACluster > &	clusters
	)

inlineoverride

Creates the clusters.

Repeatedly expands a neighborhood of referenced objects that have an AutomatonCell. The CellState after the clusterization is the index of the generated cluster. The CellWeight is set to the total number of neighbors of each cell.

Parameters

	cellHolders	Pointers to objects that should be clustered.
	cellHolderRelations	Relations between the objects that should be clustered
[out]	clusters	Groups of connected objects in the neighborhood.

Definition at line 54 of file Clusterizer.h.

      {
        // Expect the relations to be sorted for lookup
        assert(std::is_sorted(cellHolderRelations.begin(),
                              cellHolderRelations.end()));
 
        // Prepare some output clusters
        clusters.reserve(30);
 
        // Prepare states
        for (ACellHolder* cellHolder : cellHolders) {
          setCellState(cellHolder, -1);
        }
 
        // Work horse cluster
        std::vector<ACellHolder*> cluster;
 
        // Go through each cell holder and start a cluster on each that is unassigned yet
        int iCluster = -1;
        for (ACellHolder* cellHolder : cellHolders) {
          if (getCellState(cellHolder) != -1) continue;
 
          cluster.clear();
 
          ++iCluster;
          setCellState(cellHolder, iCluster);
          cluster.push_back(cellHolder);
 
          expandCluster(cellHolderRelations, cluster);
 
          clusters.emplace_back(std::move(cluster));
          cluster.clear();
        }
      }

◆ beginEvent()

void beginEvent ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

Definition at line 31 of file CompositeProcessingSignalListener.cc.

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

◆ beginRun()

void beginRun ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

Reimplemented in LayerRelationFilter< AFilter >, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, and TrackCandidateResultRefiner.

Definition at line 23 of file CompositeProcessingSignalListener.cc.

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

◆ endRun()

void endRun ( )

overridevirtualinherited

Receive and dispatch signal for the end of the run.

Reimplemented from ProcessingSignalListener.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

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

◆ expandCluster()

void expandCluster	(	std::vector< WeightedRelation< ACellHolder > > const &	cellHolderRelations,
		std::vector< ACellHolder * > &	cluster
	)		const

inlineprivate

Helper function. Starting a new cluster and iteratively expands it.

Definition at line 93 of file Clusterizer.h.

      {
        ACellHolder* seedCellHolder = cluster.front();
        int iCluster = getCellState(seedCellHolder);
 
        // Grow the cluster iteratively
        std::vector<ACellHolder*> checkNow;
        std::vector<ACellHolder*> checkNext;
 
        checkNow.reserve(10);
        checkNext.reserve(10);
 
        checkNext.push_back(seedCellHolder);
 
        while (not checkNext.empty()) {
 
          checkNow.swap(checkNext);
          checkNext.clear();
 
          for (ACellHolder* cellHolder : checkNow) {
 
            ConstVectorRange<WeightedRelation<ACellHolder> > neighborRelations(
              std::equal_range(cellHolderRelations.begin(),
                               cellHolderRelations.end(),
                               cellHolder));
 
            // Setting the cell weight to the number of neighbors
            size_t nNeighbors = neighborRelations.size();
            setCellWeight(cellHolder, nNeighbors);
 
            for (const WeightedRelation<ACellHolder>& neighborRelation : neighborRelations) {
              ACellHolder* neighborCellHolder = neighborRelation.getTo();
 
              Weight neighborICluster = getCellState(neighborCellHolder);
              if (neighborICluster == -1) {
                // Neighbor not yet in cluster
                setCellState(neighborCellHolder, iCluster);
                cluster.push_back(neighborCellHolder);
 
                // Register neighbor for further expansion
                checkNext.push_back(neighborCellHolder);
                continue;
              }
 
              if (neighborICluster != iCluster) {
                B2WARNING("Clusterizer: Neighboring item was already assigned to different "
                          "cluster. Check if the neighborhood is symmetric.");
                continue;
              }
            }
          }
        }
      }

◆ exposeParameters()

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

inlinevirtualinherited

Forward prefixed parameters of this findlet to the module parameter list.

Definition at line 69 of file Findlet.h.

71 {

72 }

◆ getCellState()

Weight getCellState ( ACellHolder * cellHolder ) const

inlineprivate

Getter for the cell state of a pointed object that holds an AutomatonCell.

Definition at line 156 of file Clusterizer.h.

      {
        const AutomatonCell& automatonCell = cellHolder->getAutomatonCell();
        return automatonCell.getCellState();
      }

◆ getDescription()

virtual std::string getDescription ( )

inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

Definition at line 60 of file Findlet.h.

      {
        return "(no description)";
      }

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

◆ initialize()

void initialize ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

Definition at line 15 of file CompositeProcessingSignalListener.cc.

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

◆ setCellState()

void setCellState	(	ACellHolder *	cellHolder,
		Weight	cellState
	)		const

inlineprivate

Setter for the cell state of a pointed object that holds an AutomatonCell.

Definition at line 149 of file Clusterizer.h.

      {
        AutomatonCell& automatonCell = cellHolder->getAutomatonCell();
        automatonCell.setCellState(cellState);
      }

◆ setCellWeight()

void setCellWeight	(	ACellHolder *	cellHolder,
		Weight	cellWeight
	)		const

inlineprivate

Setter for the cell weight of a pointed object that holds an AutomatonCell.

Definition at line 163 of file Clusterizer.h.

      {
        AutomatonCell& automatonCell = cellHolder->getAutomatonCell();
        automatonCell.setCellWeight(cellWeight);
      }

◆ terminate()

void terminate ( )

overridevirtualinherited

Receive and dispatch Signal for termination of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, and StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >.

Definition at line 47 of file CompositeProcessingSignalListener.cc.

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

Member Data Documentation

◆ m_initialized

bool m_initialized = false

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 52 of file CompositeProcessingSignalListener.h.

◆ m_terminated

bool m_terminated = false

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 file:

tracking/trackFindingCDC/ca/include/Clusterizer.h

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ IOTypes

◆ IOVectors

◆ Super

◆ ToVector

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ expandCluster()

◆ exposeParameters()

◆ getCellState()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ setCellState()

◆ setCellWeight()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated