SegmentCreatorFacetAutomaton Class Reference

Findlet that generates segments within clusters based on a cellular automaton on triples of hits. More...

#include <SegmentCreatorFacetAutomaton.h>

Inheritance diagram for SegmentCreatorFacetAutomaton:

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
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< CDCFacet > &inputFacets, const std::vector< WeightedRelation< const CDCFacet > > &inputFacetRelations, std::vector< CDCSegment2D > &outputSegments) final
	Main function of the segment finding by the cellular automaton.
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 CDCFacet, const WeightedRelation< const CDCFacet >, CDCSegment2D >
	Type of the base class.

Private Attributes
bool	m_param_searchReversed = false
	Parameter : Switch to construct the reversed segment if it is available in the facet graph as well.
bool	m_param_searchAlias = true
	Parameter : Switch to construct the alias segment if it is available in the facet graph as well.
bool	m_param_relaxSingleLayerSearch = true
	Parameter : Switch to relax the alias and reverse search for segments contained in a single layer.
bool	m_param_allSingleAliases = false
	Paraneter : Switch to activate the write out of all available orientations of single facet segments.
MultipassCellularPathFinder< const CDCFacet >	m_cellularPathFinder
	Instance of the cellular automaton path finder.
std::vector< Path< const CDCFacet > >	m_facetPaths
	Memory for the facet 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

Findlet that generates segments within clusters based on a cellular automaton on triples of hits.

Definition at line 31 of file SegmentCreatorFacetAutomaton.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 CDCFacet, const WeightedRelation<const CDCFacet>, CDCSegment2D>

private

Type of the base class.

Definition at line 36 of file SegmentCreatorFacetAutomaton.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 ( const std::vector< CDCFacet > &  inputFacets, const std::vector< WeightedRelation< const CDCFacet > > &  inputFacetRelations, std::vector< CDCSegment2D > &  outputSegments  )

final

Main function of the segment finding by the cellular automaton.

Definition at line 75 of file SegmentCreatorFacetAutomaton.cc.

{
  std::vector<ConstVectorRange<CDCFacet>> facetsByICluster =
                                         adjacent_groupby(inputFacets.begin(), inputFacets.end(), std::mem_fn(&CDCFacet::getICluster));
 
  for (const ConstVectorRange<CDCFacet>& facetsInCluster : facetsByICluster) {
    if (facetsInCluster.empty()) continue;
 
    B2ASSERT("Expect the facets to be sorted",
             std::is_sorted(std::begin(facetsInCluster), std::end(facetsInCluster)));
 
    // Obtain the facets as pointers
    std::vector<const CDCFacet*> facetPtrsInCluster = as_pointers<const CDCFacet>(facetsInCluster);
 
    // Cut out the chunk of relevant facet relations
    const CDCFacet& firstFacet = facetsInCluster.front();
    auto beginFacetRelationInCluster =
      std::lower_bound(inputFacetRelations.begin(), inputFacetRelations.end(), &firstFacet);
 
    const CDCFacet& lastFacet = facetsInCluster.back();
    auto endFacetRelationInCluster =
      std::upper_bound(inputFacetRelations.begin(), inputFacetRelations.end(), &lastFacet);
 
    const int iCluster = firstFacet.getICluster();
 
    std::vector<WeightedRelation<const CDCFacet>>
                                               facetRelationsInCluster(beginFacetRelationInCluster,
                                                   endFacetRelationInCluster);
 
    // Apply the cellular automaton in a multipass manner
    m_facetPaths.clear();
    m_cellularPathFinder.apply(facetPtrsInCluster, facetRelationsInCluster, m_facetPaths);
 
    // Helper function to check if a given reverse or alias segment is
    // also present in the graph of facets. Used in the search for
    // aliasing segments.
    auto getFacetPath = [&facetsInCluster,
                         &facetRelationsInCluster,
    &iCluster](const CDCSegment2D & segment, bool checkRelations = true) {
      CDCRLWireHitSegment rlWireHitSegment = segment.getRLWireHitSegment();
      CDCFacetSegment aliasFacetSegment = CDCFacetSegment::create(rlWireHitSegment);
      std::vector<const CDCFacet*> facetPath;
      for (CDCRLWireHitTriple& rlWireHitTriple : aliasFacetSegment) {
        // Do not forget to set the cluster id as it is a sorting criterion
        rlWireHitTriple.setICluster(iCluster);
 
        // Check whether the facet is a node in the graph
        auto itFacet = std::lower_bound(facetsInCluster.begin(), facetsInCluster.end(), rlWireHitTriple);
        if (itFacet == facetsInCluster.end()) break;
        if (not(*itFacet == rlWireHitTriple)) break;
        const CDCFacet* facet = &*itFacet;
 
        // Check whether there is a relation to this new facet
        if (not facetPath.empty() and checkRelations) {
          const CDCFacet* fromFacet = facetPath.back();
          auto relationsFromFacet = std::equal_range(facetRelationsInCluster.begin(),
                                                     facetRelationsInCluster.end(),
                                                     fromFacet);
          if (std::count_if(relationsFromFacet.first, relationsFromFacet.second, Second() == facet) == 0) break;
        }
        facetPath.push_back(facet);
      }
      return facetPath;
    };
 
    // Reserve enough space to prevent reallocation and invalidated references
    size_t additionalSpace = m_facetPaths.size();
    if (m_param_searchReversed) additionalSpace *= 2;
    if (m_param_searchAlias) additionalSpace *= 2;
    outputSegments.reserve(outputSegments.size() + additionalSpace);
 
    for (const std::vector<const CDCFacet*>& facetPath : m_facetPaths) {
      // If path is only a single facet long - forward all viable orientations if requested
      if (m_param_allSingleAliases and facetPath.size() == 1) {
        const CDCFacet& originalSingleFacet = *facetPath.front();
 
        int nSingleFacets = 0;
 
        // Helper object to construct other single facet paths
        std::vector<const CDCFacet*> singleFacetPath;
        singleFacetPath.reserve(1);
 
        std::array<int, 3> permIndices{0, 1, 2};
        CDCRLWireHitTriple rlWireHitTriple = originalSingleFacet;
 
        for (int iPerm = 0; iPerm < 6; ++iPerm) {
          setRLWireHit(rlWireHitTriple, permIndices[0], originalSingleFacet.getStartRLWireHit());
          setRLWireHit(rlWireHitTriple, permIndices[1], originalSingleFacet.getMiddleRLWireHit());
          setRLWireHit(rlWireHitTriple, permIndices[2], originalSingleFacet.getEndRLWireHit());
          std::next_permutation(permIndices.begin(), permIndices.end()); // Prepare for next round
 
          for (ERightLeft startRLInfo : {ERightLeft::c_Left, ERightLeft::c_Right}) {
            rlWireHitTriple.setStartRLInfo(startRLInfo);
            for (ERightLeft middleRLInfo : {ERightLeft::c_Left, ERightLeft::c_Right}) {
              rlWireHitTriple.setMiddleRLInfo(middleRLInfo);
              for (ERightLeft endRLInfo : {ERightLeft::c_Left, ERightLeft::c_Right}) {
                rlWireHitTriple.setEndRLInfo(endRLInfo);
 
                auto itFacet = std::lower_bound(facetsInCluster.begin(),
                                                facetsInCluster.end(),
                                                rlWireHitTriple);
 
                if (itFacet == facetsInCluster.end())continue;
                if (not(*itFacet == rlWireHitTriple)) continue;
 
                const CDCFacet* singleFacet = &*itFacet;
                singleFacetPath.clear();
                singleFacetPath.push_back(singleFacet);
                outputSegments.push_back(CDCSegment2D::condense(singleFacetPath));
                outputSegments.back()->setReverseFlag();
                outputSegments.back()->setAliasFlag();
                ++nSingleFacets;
              }
            }
          }
        }
        B2ASSERT("At least one single facet added", nSingleFacets > 0);
 
        // Skip the reset of the alias searches
        continue;
      }
 
      outputSegments.reserve(outputSegments.size() + 4);
      outputSegments.push_back(CDCSegment2D::condense(facetPath));
      const CDCSegment2D* segment = &outputSegments.back();
 
 
      // Check for the special situation where the segment is confined to one layer
      // Relax the alias search a bit to better capture the situation
      bool checkRelations = true;
      if (m_param_relaxSingleLayerSearch) {
        auto differentILayer = [](const CDCRecoHit2D & lhs, const CDCRecoHit2D & rhs) {
          return lhs.getWire().getILayer() != rhs.getWire().getILayer();
        };
        auto itLayerSwitch = std::adjacent_find(segment->begin(), segment->end(), differentILayer);
        const bool onlyOneLayer = itLayerSwitch == segment->end();
        checkRelations = not onlyOneLayer;
      }
 
      const CDCSegment2D* reverseSegment = nullptr;
      if (m_param_searchReversed) {
        std::vector<const CDCFacet*> reverseFacetPath = getFacetPath(segment->reversed(), checkRelations);
        if (reverseFacetPath.size() == facetPath.size()) {
          B2DEBUG(25, "Successful constructed REVERSE");
          outputSegments.push_back(CDCSegment2D::condense(reverseFacetPath));
          reverseSegment = &outputSegments.back();
 
          (*segment)->setReverseFlag(true);
          (*reverseSegment)->setReverseFlag(true);
        }
      }
 
      if (not m_param_searchAlias) continue;
 
      // Search for aliasing segment in the facet graph
      int nRLSwitches = segment->getNRLSwitches();
      if (nRLSwitches > 2) continue; // Segment is stable against aliases
 
      const CDCSegment2D* aliasSegment = nullptr;
      std::vector<const CDCFacet*> aliasFacetPath = getFacetPath(segment->getAlias(), checkRelations);
      if (aliasFacetPath.size() == facetPath.size()) {
        B2DEBUG(25, "Successful constructed alias");
        outputSegments.push_back(CDCSegment2D::condense(aliasFacetPath));
        aliasSegment = &outputSegments.back();
 
        (*segment)->setAliasFlag(true);
        (*aliasSegment)->setAliasFlag(true);
      }
 
      const CDCSegment2D* reverseAliasSegment = nullptr;
      if (m_param_searchReversed) {
        std::vector<const CDCFacet*> reverseAliasFacetPath =
          getFacetPath(segment->reversed().getAlias(), checkRelations);
        if (reverseAliasFacetPath.size() == facetPath.size()) {
          B2DEBUG(25, "Successful constructed REVERSE alias");
          outputSegments.push_back(CDCSegment2D::condense(reverseAliasFacetPath));
          reverseAliasSegment = &outputSegments.back();
          if (aliasSegment != nullptr) {
            (*aliasSegment)->setReverseFlag(true);
            (*reverseAliasSegment)->setReverseFlag(true);
          }
        }
      }
 
      if (reverseSegment != nullptr and reverseAliasSegment != nullptr) {
        (*reverseSegment)->setAliasFlag(true);
        (*reverseAliasSegment)->setAliasFlag(true);
      }
    }
  }
}

beginEvent()

void beginEvent ( )

overridevirtualinherited

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

Reimplemented from ProcessingSignalListener.

Reimplemented in SpacePointTagger< Belle2::CKFToPXDResult, Belle2::PXDCluster >, SpacePointTagger< Belle2::CKFToSVDResult, Belle2::SVDCluster >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, SharingHitsMatcher< Belle2::TrackFindingCDC::CDCTrack, Belle2::TrackFindingCDC::CDCSegment2D >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, RecoTrackStorer, ROIFinder, and SVDHoughTracking.

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 CDCFacet, const WeightedRelation< const CDCFacet >, CDCSegment2D >.

Definition at line 52 of file SegmentCreatorFacetAutomaton.cc.

{
  moduleParamList->addParameter(prefixed(prefix, "searchReversed"),
                                m_param_searchReversed,
                                "Switch to construct the reversed segment if it is available in the facet graph as well.",
                                m_param_searchReversed);
 
  moduleParamList->addParameter(prefixed(prefix, "searchAlias"),
                                m_param_searchAlias,
                                "Switch to construct the alias segment if it is available in the facet graph as well.",
                                m_param_searchAlias);
 
  moduleParamList->addParameter(prefixed(prefix, "relaxSingleLayerSearch"),
                                m_param_relaxSingleLayerSearch,
                                "Switch to relax the alias and reverse search for segments contained in a single layer.",
                                m_param_relaxSingleLayerSearch);
 
  moduleParamList->addParameter(prefixed(prefix, "allSingleAliases"),
                                m_param_allSingleAliases,
                                "Switch to activate the write out of all available orientations of single facet segments.",
                                m_param_allSingleAliases);
}

getDescription()

std::string getDescription ( )

finalvirtual

Short description of the findlet.

Reimplemented from Findlet< const CDCFacet, const WeightedRelation< const CDCFacet >, CDCSegment2D >.

Definition at line 47 of file SegmentCreatorFacetAutomaton.cc.

{
  return "Constructs segments by extraction of facet 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.

Reimplemented in UnionVarSet< AObject >, UnionVarSet< Object >, VariadicUnionVarSet< AVarSets >, ResultStorer< Belle2::CKFToPXDResult >, ResultStorer< Belle2::CKFToSVDResult >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >, OnVarSet< Filter< ATruthVarSet::Object > >, OnVarSet< Filter< AVarSet::Object > >, OnVarSet< BaseFacetFilter >, OnVarSet< BaseFacetRelationFilter >, OnVarSet< BaseAxialSegmentPairFilter >, OnVarSet< BaseSegmentRelationFilter >, OnVarSet< BaseTrackRelationFilter >, OnVarSet< BaseSegmentPairRelationFilter >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, StoreArrayLoader< const Belle2::SpacePoint >, StoreArrayLoader< DataStoreInputTypeRefType >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCFacet >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCWireHit, true >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegment2D >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCTrack >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentPair >, StoreVectorSwapper< Belle2::TrackFindingCDC::CDCSegmentTriple >, RelationVarSet< ABaseVarSet >, QualityIndicatorFilter, TwoHitVirtualIPQIFilter, MultiHoughSpaceFastInterceptFinder, RawTrackCandCleaner< AHit >, RawTrackCandCleaner< Belle2::vxdHoughTracking::VXDHoughState >, RecoTrackStorer, ROIFinder, SingleHoughSpaceFastInterceptFinder, SpacePointLoaderAndPreparer, TrackCandidateOverlapResolver, and TrackCandidateResultRefiner.

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 CDCFacet> m_cellularPathFinder

private

Instance of the cellular automaton path finder.

Definition at line 66 of file SegmentCreatorFacetAutomaton.h.

m_facetPaths

std::vector< Path<const CDCFacet> > m_facetPaths

private

Memory for the facet paths generated from the graph.

Definition at line 70 of file SegmentCreatorFacetAutomaton.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_allSingleAliases

bool m_param_allSingleAliases = false

private

Paraneter : Switch to activate the write out of all available orientations of single facet segments.

Definition at line 62 of file SegmentCreatorFacetAutomaton.h.

m_param_relaxSingleLayerSearch

bool m_param_relaxSingleLayerSearch = true

private

Parameter : Switch to relax the alias and reverse search for segments contained in a single layer.

Definition at line 59 of file SegmentCreatorFacetAutomaton.h.

m_param_searchAlias

bool m_param_searchAlias = true

private

Parameter : Switch to construct the alias segment if it is available in the facet graph as well.

Definition at line 56 of file SegmentCreatorFacetAutomaton.h.

m_param_searchReversed

bool m_param_searchReversed = false

private

Parameter : Switch to construct the reversed segment if it is available in the facet graph as well.

Definition at line 53 of file SegmentCreatorFacetAutomaton.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/SegmentCreatorFacetAutomaton.h
• tracking/trackFindingCDC/findlets/minimal/src/SegmentCreatorFacetAutomaton.cc