Links segments in the same super cluster by linking paths of segments in a cellular automaton. More...

#include <SegmentLinker.h>

Inheritance diagram for SegmentLinker:

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
	SegmentLinker ()
	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< CDCSegment2D > &inputSegment2Ds, std::vector< CDCSegment2D > &outputSegment2Ds) final
	Main algorithm.

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 = 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 = Findlet< const CDCSegment2D, CDCSegment2D >
	Type of the base class.

Private Attributes
bool	m_param_wholeSuperLayer = false
	Parameter : Switch to activate segment linking in the whole superlayer instead of only the super cluster.

bool	m_param_dealiasLinked = false
	Parameter : Switch to block hits that appear in linked segments such that unlinked reverse and aliases are excluded.

bool	m_param_onlyLinked = false
	Parameter : Switch to construct only segments that have a linked partner.

WeightedRelationCreator< const CDCSegment2D, ChooseableSegmentRelationFilter >	m_segment2DRelationCreator
	Creator of the segment relations for linking.

MultipassCellularPathFinder< const CDCSegment2D >	m_cellularPathFinder
	Instance of the cellular automaton path finder.

std::vector< WeightedRelation< const CDCSegment2D > >	m_segment2DRelations
	Memory for the relations between segments to be followed on linking.

std::vector< Path< const CDCSegment2D > >	m_segment2DPaths
	Memory for the segment paths generated from the graph.

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

Links segments in the same super cluster by linking paths of segments in a cellular automaton.

Definition at line 31 of file SegmentLinker.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 = Findlet<const CDCSegment2D, CDCSegment2D>

private

Type of the base class.

Definition at line 35 of file SegmentLinker.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ SegmentLinker()

SegmentLinker ( )

Constructor adding the filter as a subordinary processing signal listener.

Definition at line 23 of file SegmentLinker.cc.

{
  this->addProcessingSignalListener(&m_segment2DRelationCreator);
}

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	(	const std::vector< CDCSegment2D > &	inputSegment2Ds,
		std::vector< CDCSegment2D > &	outputSegment2Ds
	)

final

Main algorithm.

Definition at line 53 of file SegmentLinker.cc.

{
  if (m_param_wholeSuperLayer) {
    for (const CDCSegment2D& segment2D : inputSegment2Ds) {
      segment2D.setISuperCluster(-1);
    }
  }
 
  // Obtain the segments as pointers
  std::vector<const CDCSegment2D*> segment2DPtrs = as_pointers<const CDCSegment2D>(inputSegment2Ds);
 
  // Create linking relations
  m_segment2DRelations.clear();
  m_segment2DRelationCreator.apply(segment2DPtrs, m_segment2DRelations);
 
  // Find linking paths
  m_segment2DPaths.clear();
  m_cellularPathFinder.apply(segment2DPtrs, m_segment2DRelations, m_segment2DPaths);
 
  // Unmasked hits in case the blocking logic is requested
  const bool toHits = true;
  for (const CDCSegment2D& segment : inputSegment2Ds) {
    segment.unsetAndForwardMaskedFlag(toHits);
  }
 
  // Put the linked segments together
  std::vector<CDCSegment2D> tempOutputSegment2Ds;
  tempOutputSegment2Ds.reserve(m_segment2DPaths.size());
  for (const Path<const CDCSegment2D>& segment2DPath : m_segment2DPaths) {
    if (m_param_onlyLinked and segment2DPath.size() == 1) continue;
 
    // Do not use the single segments blocked in the dealiasing
    if (m_param_dealiasLinked and segment2DPath.size() == 1 and
        (*segment2DPath[0])->hasMaskedFlag()) {
      continue;
    }
 
    tempOutputSegment2Ds.push_back(CDCSegment2D::condense(segment2DPath));
 
    // If two segments are linked odds are that it is the correct alias
    // Block the used hits.
    if (m_param_dealiasLinked and segment2DPath.size() > 1) {
      tempOutputSegment2Ds.back().setAndForwardMaskedFlag(toHits);
      for (const CDCSegment2D& otherSegment : inputSegment2Ds) {
        otherSegment.receiveMaskedFlag(toHits);
      }
    }
 
  }
  outputSegment2Ds = std::move(tempOutputSegment2Ds);
}

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

◆ exposeParameters()

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

finalvirtual

Expose the parameters to a module.

Reimplemented from Findlet< const CDCSegment2D, CDCSegment2D >.

Definition at line 33 of file SegmentLinker.cc.

{
  m_segment2DRelationCreator.exposeParameters(moduleParamList, prefix);
 
  moduleParamList->addParameter(prefixed(prefix, "wholeSuperLayer"),
                                m_param_wholeSuperLayer,
                                "Link segment in the whole superlayer instead of inside the super cluster.",
                                m_param_wholeSuperLayer);
 
  moduleParamList->addParameter(prefixed(prefix, "dealiasLinked"),
                                m_param_dealiasLinked,
                                "Block hits that appear in linked segments such that unlinked reverse and aliases are excluded.",
                                m_param_dealiasLinked);
 
  moduleParamList->addParameter(prefixed(prefix, "onlyLinked"),
                                m_param_onlyLinked,
                                "Switch to construct only segments that have a linked partner.",
                                m_param_onlyLinked);
}

◆ getDescription()

std::string getDescription ( )

finalvirtual

Short description of the findlet.

Reimplemented from Findlet< const CDCSegment2D, CDCSegment2D >.

Definition at line 28 of file SegmentLinker.cc.

{
  return "Links segments by extraction of segment paths in a cellular automaton.";
}

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

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

MultipassCellularPathFinder<const CDCSegment2D> m_cellularPathFinder

private

Instance of the cellular automaton path finder.

Definition at line 67 of file SegmentLinker.h.

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

bool m_param_dealiasLinked = false

private

Parameter : Switch to block hits that appear in linked segments such that unlinked reverse and aliases are excluded.

Definition at line 57 of file SegmentLinker.h.

◆ m_param_onlyLinked

bool m_param_onlyLinked = false

private

Parameter : Switch to construct only segments that have a linked partner.

Definition at line 60 of file SegmentLinker.h.

◆ m_param_wholeSuperLayer

bool m_param_wholeSuperLayer = false

private

Parameter : Switch to activate segment linking in the whole superlayer instead of only the super cluster.

Definition at line 54 of file SegmentLinker.h.

◆ m_segment2DPaths

std::vector<Path<const CDCSegment2D> > m_segment2DPaths

private

Memory for the segment paths generated from the graph.

Definition at line 73 of file SegmentLinker.h.

◆ m_segment2DRelationCreator

WeightedRelationCreator<const CDCSegment2D, ChooseableSegmentRelationFilter> m_segment2DRelationCreator

private

Creator of the segment relations for linking.

Definition at line 64 of file SegmentLinker.h.

◆ m_segment2DRelations

std::vector<WeightedRelation<const CDCSegment2D> > m_segment2DRelations

private

Memory for the relations between segments to be followed on linking.

Definition at line 70 of file SegmentLinker.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 files:

tracking/trackFindingCDC/findlets/minimal/include/SegmentLinker.h
tracking/trackFindingCDC/findlets/minimal/src/SegmentLinker.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

◆ SegmentLinker()

Member Function Documentation

◆ addProcessingSignalListener()

◆ apply()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getDescription()

◆ getNProcessingSignalListener()

◆ initialize()

◆ terminate()

Member Data Documentation

◆ m_cellularPathFinder

◆ m_initialized

◆ m_initializedAs

◆ m_param_dealiasLinked

◆ m_param_onlyLinked

◆ m_param_wholeSuperLayer

◆ m_segment2DPaths

◆ m_segment2DRelationCreator

◆ m_segment2DRelations

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated