FacetCreator Class Reference

Class providing construction combinatorics for the facets. More...

#include <FacetCreator.h>

Inheritance diagram for FacetCreator:

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
	FacetCreator ()
	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< CDCWireHitCluster > &inputClusters, std::vector< CDCFacet > &facets) final
	Central function creating the hit triplets from the clusters.
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 CDCWireHitCluster, CDCFacet >
	Type of the base class.

Private Member Functions
void	createFacets (const std::vector< CDCWireHit * > &wireHits, const std::vector< WeightedRelation< CDCWireHit > > &wireHitRelations, std::vector< CDCFacet > &facets)
	Generates facets on the given wire hits generating neighboring triples of hits.
void	createFacetsForHitTriple (const CDCWireHit &startWireHit, const CDCWireHit &middleWireHit, const CDCWireHit &endWireHit, std::vector< CDCFacet > &facets)
	Generates reconstruted facets on the three given wire hits by hypothesizing over the 8 left right passage combinations.

Private Attributes
bool	m_param_feasibleRLOnly = true
	Parameter : Switch to apply the rl feasibility cut.
bool	m_param_updateDriftLength = true
	Parameter : Switch to reestimate the drift length.
bool	m_param_leastSquareFit = false
	Parameter : Switch to fit the facet with least square method for the drift length update.
BridgingWireHitRelationFilter	m_wireHitRelationFilter
	The filter for the hit neighborhood.
FeasibleRLFacetFilter	m_feasibleRLFacetFilter
	The feasibility filter for the right left passage information.
ChooseableFacetFilter	m_facetFilter
	The filter to be used for the facet generation.
DriftLengthEstimator	m_driftLengthEstimator
	Instance of the drift length estimator to be used.
std::vector< WeightedRelation< CDCWireHit > >	m_wireHitRelations
	Memory for the wire hit neighborhood in within a cluster.
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

Class providing construction combinatorics for the facets.

Definition at line 35 of file FacetCreator.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 CDCWireHitCluster, CDCFacet>

private

Type of the base class.

Definition at line 39 of file FacetCreator.h.

ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

FacetCreator()

FacetCreator

(

)

Constructor adding the filter as a subordinary processing signal listener.

Definition at line 29 of file FacetCreator.cc.

{
  this->addProcessingSignalListener(&m_wireHitRelationFilter);
  this->addProcessingSignalListener(&m_facetFilter);
}

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< CDCWireHitCluster > &  inputClusters, std::vector< CDCFacet > &  facets  )

final

Central function creating the hit triplets from the clusters.

Hit triplets are always contained within one cluster and the output hit triplets follow the order of the input clusters such that the triplets of the same cluster remain close to each other.

Definition at line 58 of file FacetCreator.cc.

{
  int iCluster = -1;
  for (const CDCWireHitCluster& cluster : inputClusters) {
    ++iCluster;
    // Skip clusters that have been detected as background
    if (cluster.getBackgroundFlag()) {
      continue;
    }
    B2ASSERT("Expect the clusters to be sorted", std::is_sorted(cluster.begin(), cluster.end()));
 
    // Obtain the set of wire hits as references
    const std::vector<CDCWireHit*>& wireHits = cluster;
 
    // Create the neighborhood of wire hits on the cluster
    m_wireHitRelations.clear();
    RelationFilterUtil::appendUsing(m_wireHitRelationFilter, wireHits, m_wireHitRelations);
 
    B2ASSERT("Wire neighborhood is not symmetric. Check the geometry.",
             WeightedRelationUtil<CDCWireHit>::areSymmetric(m_wireHitRelations));
 
    // Create the facets
    std::size_t nBefore = facets.size();
    createFacets(cluster, m_wireHitRelations, facets);
    std::size_t nAfter = facets.size();
 
    VectorRange<CDCFacet> facetsInCluster(facets.begin() + nBefore, facets.begin() + nAfter);
    // Sort the facets in their cluster
    std::sort(facetsInCluster.begin(), facetsInCluster.end());
 
    B2ASSERT("Expected all facets to be different",
             std::adjacent_find(facetsInCluster.begin(), facetsInCluster.end()) ==
             facetsInCluster.end());
 
    for (CDCFacet& facet : facetsInCluster) {
      facet.setICluster(iCluster);
    }
  }
}

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

createFacets()

void createFacets ( const std::vector< CDCWireHit * > &  wireHits, const std::vector< WeightedRelation< CDCWireHit > > &  wireHitRelations, std::vector< CDCFacet > &  facets  )

private

Generates facets on the given wire hits generating neighboring triples of hits.

Inserts the result to the end of the GenericFacetCollection.

Definition at line 98 of file FacetCreator.cc.

{
  for (const CDCWireHit* ptrMiddleWireHit : wireHits) {
    if (not ptrMiddleWireHit) continue;
    const CDCWireHit& middleWireHit = *ptrMiddleWireHit;
    if (middleWireHit->hasTakenFlag()) continue;
 
    const auto neighbors = asRange(
                             std::equal_range(wireHitRelations.begin(), wireHitRelations.end(), ptrMiddleWireHit));
 
    for (const WeightedRelation<CDCWireHit>& startWireHitRelation : neighbors) {
      const CDCWireHit* ptrStartWireHit(startWireHitRelation.getTo());
 
      if (not ptrStartWireHit) continue;
      const CDCWireHit& startWireHit = *ptrStartWireHit;
      if (startWireHit->hasTakenFlag()) continue;
 
      for (const WeightedRelation<CDCWireHit>& endWireHitRelation : neighbors) {
        const CDCWireHit* ptrEndWireHit(endWireHitRelation.getTo());
 
        if (not ptrEndWireHit) continue;
        const CDCWireHit& endWireHit = *ptrEndWireHit;
        if (endWireHit->hasTakenFlag()) continue;
 
        // Skip combinations where the facet starts and ends on the same wire
        if (ptrStartWireHit->isOnWire(ptrEndWireHit->getWire())) continue;
 
        createFacetsForHitTriple(startWireHit, middleWireHit, endWireHit, facets);
      } // end for itEndWireHit
    } // end for itStartWireHit
  } // end for itMiddleWireHit
}

createFacetsForHitTriple()

void createFacetsForHitTriple ( const CDCWireHit &  startWireHit, const CDCWireHit &  middleWireHit, const CDCWireHit &  endWireHit, std::vector< CDCFacet > &  facets  )

private

Generates reconstruted facets on the three given wire hits by hypothesizing over the 8 left right passage combinations.

Inserts the result to the end of the GenericFacetCollection.

Prepare a facet - without fitted tangent lines.

Definition at line 133 of file FacetCreator.cc.

{
  CDCRLWireHit startRLWireHit(&startWireHit, ERightLeft::c_Left);
  CDCRLWireHit middleRLWireHit(&middleWireHit, ERightLeft::c_Left);
  CDCRLWireHit endRLWireHit(&endWireHit, ERightLeft::c_Left);
  CDCFacet facet(startRLWireHit, middleRLWireHit, endRLWireHit, UncertainParameterLine2D());
 
  for (ERightLeft startRLInfo : {ERightLeft::c_Left, ERightLeft::c_Right}) {
    facet.setStartRLInfo(startRLInfo);
    for (ERightLeft middleRLInfo : {ERightLeft::c_Left, ERightLeft::c_Right}) {
      facet.setMiddleRLInfo(middleRLInfo);
      for (ERightLeft endRLInfo : {ERightLeft::c_Left, ERightLeft::c_Right}) {
        facet.setEndRLInfo(endRLInfo);
 
        // Reset the lines
        // The filter shall do the fitting of the tangent lines if it wants to.
        // He should set them if he accepts the facet.
        facet.invalidateFitLine();
 
        if (m_param_feasibleRLOnly) {
          Weight feasibleWeight = m_feasibleRLFacetFilter(facet);
          if (std::isnan(feasibleWeight)) continue;
        }
 
        if (m_param_updateDriftLength) {
 
          // Reset drift length
          facet.getStartRLWireHit().setRefDriftLength(startWireHit.getRefDriftLength());
          facet.getMiddleRLWireHit().setRefDriftLength(middleWireHit.getRefDriftLength());
          facet.getEndRLWireHit().setRefDriftLength(endWireHit.getRefDriftLength());
 
          if (m_param_leastSquareFit) {
            /*double chi2 =*/FacetFitter::fit(facet);
          } else {
            facet.adjustFitLine();
          }
 
          // Update drift length
          m_driftLengthEstimator.updateDriftLength(facet);
        }
 
        Weight weight = m_facetFilter(facet);
 
        if (not std::isnan(weight)) {
          facet.getAutomatonCell().setCellWeight(weight);
          facets.insert(facets.end(), facet);
        }
      } // end for endRLWireHit
    } // end for middleRLWireHit
  } // end for startRLWireHit
}

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 CDCWireHitCluster, CDCFacet >.

Definition at line 40 of file FacetCreator.cc.

{
  m_wireHitRelationFilter.exposeParameters(moduleParamList, prefix);
  m_feasibleRLFacetFilter.exposeParameters(moduleParamList, prefix);
  m_facetFilter.exposeParameters(moduleParamList, prefix);
 
  moduleParamList->addParameter(prefixed(prefix, "updateDriftLength"),
                                m_param_updateDriftLength,
                                "Switch to reestimate the drift length",
                                m_param_updateDriftLength);
 
  moduleParamList->addParameter(prefixed(prefix, "leastSquareFit"),
                                m_param_leastSquareFit,
                                "Switch to fit the facet with the least square method "
                                "for drift length estimation",
                                m_param_leastSquareFit);
}

getDescription()

std::string getDescription ( )

finalvirtual

Short description of the findlet.

Reimplemented from Findlet< const CDCWireHitCluster, CDCFacet >.

Definition at line 35 of file FacetCreator.cc.

{
  return "Creates hit triplet (facets) from each cluster filtered by a acceptance criterion.";
}

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_driftLengthEstimator

DriftLengthEstimator m_driftLengthEstimator

private

Instance of the drift length estimator to be used.

Definition at line 99 of file FacetCreator.h.

m_facetFilter

ChooseableFacetFilter m_facetFilter

private

The filter to be used for the facet generation.

Definition at line 96 of file FacetCreator.h.

m_feasibleRLFacetFilter

FeasibleRLFacetFilter m_feasibleRLFacetFilter

private

The feasibility filter for the right left passage information.

Definition at line 93 of file FacetCreator.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_feasibleRLOnly

bool m_param_feasibleRLOnly = true

private

Parameter : Switch to apply the rl feasibility cut.

Definition at line 80 of file FacetCreator.h.

m_param_leastSquareFit

bool m_param_leastSquareFit = false

private

Parameter : Switch to fit the facet with least square method for the drift length update.

Definition at line 86 of file FacetCreator.h.

m_param_updateDriftLength

bool m_param_updateDriftLength = true

private

Parameter : Switch to reestimate the drift length.

Definition at line 83 of file FacetCreator.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.

m_wireHitRelationFilter

BridgingWireHitRelationFilter m_wireHitRelationFilter

private

The filter for the hit neighborhood.

Definition at line 90 of file FacetCreator.h.

m_wireHitRelations

std::vector<WeightedRelation<CDCWireHit> > m_wireHitRelations

private

Memory for the wire hit neighborhood in within a cluster.

Definition at line 103 of file FacetCreator.h.

---

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

• tracking/trackFindingCDC/findlets/minimal/include/FacetCreator.h
• tracking/trackFindingCDC/findlets/minimal/src/FacetCreator.cc