SegmentTrackAdderWithNormalization Class Reference

Add the matched segments to the tracks and normalize the tracks afterwards. More...

#include <SegmentTrackAdderWithNormalization.h>

Inheritance diagram for SegmentTrackAdderWithNormalization:

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

Public Member Functions
	SegmentTrackAdderWithNormalization ()
	Constructor for registering the sub-findlets.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the parameters of the sub-findlets.
std::string	getDescription () override
	Short description of the findlet.
void	apply (std::vector< WeightedRelation< CDCTrack, const CDCSegment2D > > &relations, std::vector< CDCTrack > &tracks, const std::vector< CDCSegment2D > &segment) override
	Apply the findlet.
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< WeightedRelation< CDCTrack, const CDCSegment2D > &, CDCTrack &, const CDCSegment2D >
	Type of the base class.

Private Attributes
bool	m_param_removeUnmatchedSegments = true
	Parameter : Swtich to remove hits in segments that have no matching track from all tracks.
SingleMatchSelector< CDCTrack, CDCRecoHit3D, HitComperator >	m_singleHitSelector
	The selector for finding the track each hit should belong to.
TrackNormalizer	m_trackNormalizer
	Findlet for performing the normalization of the tracks afterwards.
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 happend before.
bool	m_terminated = false
	Flag to keep track whether termination happend before.
std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

Add the matched segments to the tracks and normalize the tracks afterwards.

Also deletes all hits from the tracks, that are part of segments, that were not matched to these tracks.

Definition at line 34 of file SegmentTrackAdderWithNormalization.h.

Member Typedef Documentation

IOTypes

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

inherited

Types that should be served to apply on invokation.

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 invokation.

Definition at line 53 of file Findlet.h.

Super

using Super = Findlet<WeightedRelation<CDCTrack, const CDCSegment2D>&, CDCTrack&, const CDCSegment2D>

private

Type of the base class.

Definition at line 39 of file SegmentTrackAdderWithNormalization.h.

ToVector

using ToVector = typename ToVectorImpl<T>::Type

protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

SegmentTrackAdderWithNormalization()

SegmentTrackAdderWithNormalization

(

)

Constructor for registering the sub-findlets.

Definition at line 22 of file SegmentTrackAdderWithNormalization.cc.

  : Super()
{
  addProcessingSignalListener(&m_trackNormalizer);
  addProcessingSignalListener(&m_singleHitSelector);
}

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< WeightedRelation< CDCTrack, const CDCSegment2D > > &  relations, std::vector< CDCTrack > &  tracks, const std::vector< CDCSegment2D > &  segment  )

override

Apply the findlet.

Definition at line 45 of file SegmentTrackAdderWithNormalization.cc.

{
  // Storage space for the hits
  // Important to reserve enough space as otherwise references to the elements used by the
  // `WeightedRelations` in the vector `trackHitRelations` are not valid anymore
  // !!! We cannot use a deque or list as these do not guarantee valid pointer comparisons as
  // used by `std::sort` below !!!
  std::vector<CDCRecoHit3D> recoHits3D;
  int hit_size = 0;
  for (const auto& relation : relations) {
    hit_size += relation.getTo()->size();
  }
  for (const CDCSegment2D& segment : segments) {
    hit_size += segment.size();
  }
  for (CDCTrack& track : tracks) {
    hit_size += track.size();
  }
  recoHits3D.reserve(hit_size);
 
  // Relations for the matching tracks
  std::vector<WeightedRelation<CDCTrack, const CDCRecoHit3D>> trackHitRelations;
  trackHitRelations.reserve(2500);
 
  // We construct track hit relations denoting to which track each hit should belong from 3 sources
  // 1. From the given track segment matches with the weight of the match
  // 2. From the unmatch, untaken segments schedule the hits for removal with lower weight
  // 3. From the original track content with lowest weight
  // Hence if a hit is mentioned in source 1. it takes precedence over 2. and 3. to so on.
 
  // 1. Add the relations for the matched segments with the match weight
  for (const auto& relation : relations) {
    CDCTrack* track = relation.getFrom();
    const CDCSegment2D& segment = *(relation.getTo());
    const Weight weight = relation.getWeight();
    const CDCTrajectory3D& trajectory3D = track->getStartTrajectory3D();
 
    for (const CDCRecoHit2D& recoHit : segment) {
 
      // In case the hit is already in the matched track - keep its reconstructed position
      MayBePtr<const CDCRecoHit3D> ptrRecoHit3D = track->find(recoHit.getWireHit());
      if (ptrRecoHit3D != nullptr) {
        recoHits3D.push_back(*ptrRecoHit3D);
        trackHitRelations.push_back({track, weight, &recoHits3D.back()});
        continue;
      }
 
      // Otherwise reconstruct the position into the third dimension
      CDCRecoHit3D recoHit3D = CDCRecoHit3D::reconstruct(recoHit, trajectory3D);
      if (std::isnan(recoHit3D.getArcLength2D())) {
        B2DEBUG(25, "Had to skip a NAN hit");
        continue;
      }
      recoHits3D.push_back(recoHit3D);
      trackHitRelations.push_back({track, weight, &recoHits3D.back()});
    }
    segment->setTakenFlag();
  }
 
  // 2. Add also those segments, that have no track-partner and schedule them for removal
  if (m_param_removeUnmatchedSegments) {
    for (const CDCSegment2D& segment : segments) {
 
      // Skip segment already used in the steps before or marked outside as already taken.
      if (segment->hasTakenFlag()) continue;
 
      // Add hit with destination track nullptr
      for (const CDCRecoHit2D& recoHit : segment) {
        recoHits3D.push_back({recoHit.getRLWireHit(), Vector3D(recoHit.getRecoPos2D()), 0});
        trackHitRelations.push_back({nullptr, 0, &recoHits3D.back()});
      }
    }
  }
 
  // 3. Add the original hit content of the track with lowest priority
  for (CDCTrack& track : tracks) {
    for (const CDCRecoHit3D& recoHit3D : track) {
      recoHits3D.push_back(recoHit3D);
      // cppcheck-suppress invalidContainer
      trackHitRelations.push_back({&track, -INFINITY, &recoHits3D.back()});
    }
  }
 
  // Thin out the weighted relations by selecting only the best matching track for each hit.
  std::sort(trackHitRelations.begin(), trackHitRelations.end());
  m_singleHitSelector.apply(trackHitRelations);
 
  // Remove all hits from the tracks in order to rebuild them completely
  for (CDCTrack& track : tracks) {
    for (const CDCRecoHit3D& recoHit3D : track) {
      recoHit3D.getWireHit()->unsetTakenFlag();
    }
    track.clear();
  }
 
  // Now add the hits to their destination tracks
  for (const auto& trackHitRelation : trackHitRelations) {
    CDCTrack* track = trackHitRelation.getFrom();
    const CDCRecoHit3D* recoHit3D = trackHitRelation.getTo();
 
    if (track == nullptr) continue;
 
    track->push_back(*recoHit3D);
    recoHit3D->getWireHit()->setTakenFlag();
  }
 
  // Drop tracks which have no hits
  TrackFindingCDC::erase_remove_if(tracks, [](const CDCTrack & track) { return track.empty(); });
 
  // Establish the ordering
  for (CDCTrack& track : tracks) {
    track.sortByArcLength2D();
    CDCTrajectory3D startTrajectory = track.getStartTrajectory3D();
    startTrajectory.setLocalOrigin(track.front().getRecoPos3D());
    track.setStartTrajectory3D(startTrajectory);
 
    CDCTrajectory3D endTrajectory = track.getEndTrajectory3D();
    endTrajectory.setLocalOrigin(track.back().getRecoPos3D());
    track.setEndTrajectory3D(endTrajectory);
  }
 
  // Normalize the trajectory and hit contents of the tracks
  m_trackNormalizer.apply(tracks);
}

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  )

overridevirtual

Expose the parameters of the sub-findlets.

Reimplemented from Findlet< WeightedRelation< CDCTrack, const CDCSegment2D > &, CDCTrack &, const CDCSegment2D >.

Definition at line 29 of file SegmentTrackAdderWithNormalization.cc.

{
  m_singleHitSelector.exposeParameters(moduleParamList, prefixed(prefix, "hitSelector"));
  moduleParamList->addParameter(prefixed(prefix, "removeUnmatchedSegments"),
                                m_param_removeUnmatchedSegments,
                                "Swtich to remove hits in segments that have no matching track from all tracks",
                                m_param_removeUnmatchedSegments);
 
}

getDescription()

std::string getDescription ( )

overridevirtual

Short description of the findlet.

Reimplemented from Findlet< WeightedRelation< CDCTrack, const CDCSegment2D > &, CDCTrack &, const CDCSegment2D >.

Definition at line 39 of file SegmentTrackAdderWithNormalization.cc.

{
  return "Add the matched segments to the tracks and normalize the tracks afterwards. Also deletes all "
         "hits from tracks, that are now part in another track (or should not be part in any).";
}

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_initialized

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happend 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_removeUnmatchedSegments

bool m_param_removeUnmatchedSegments = true

private

Parameter : Swtich to remove hits in segments that have no matching track from all tracks.

Definition at line 58 of file SegmentTrackAdderWithNormalization.h.

m_singleHitSelector

SingleMatchSelector<CDCTrack, CDCRecoHit3D, HitComperator> m_singleHitSelector

private

The selector for finding the track each hit should belong to.

Definition at line 62 of file SegmentTrackAdderWithNormalization.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 happend before.

Definition at line 55 of file ProcessingSignalListener.h.

m_trackNormalizer

TrackNormalizer m_trackNormalizer

private

Findlet for performing the normalization of the tracks afterwards.

Definition at line 65 of file SegmentTrackAdderWithNormalization.h.

---

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

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