Belle II Software development
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Types | Private Attributes | List of all members
TrackOrienter Class Referenceabstract

Fixes the orientation of tracks by a simple heuristic. More...

#include <TrackOrienter.h>

Inheritance diagram for TrackOrienter:
Findlet< const CDCTrack, CDCTrack > CompositeProcessingSignalListener ProcessingSignalListener

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 initialize () final
 Signals the beginning of the event processing.
 
void apply (const std::vector< CDCTrack > &inputTracks, std::vector< CDCTrack > &outputTracks) final
 Main algorithm applying the adjustment of the orientation.
 
virtual void apply (ToVector< AIOTypes > &... ioVectors)=0
 Main function executing the algorithm.
 
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 CDCTrack, CDCTrack >
 Type of the base class.
 

Private Attributes

std::string m_param_trackOrientationString = ""
 Parameter: String that states the desired track orientation.
 
EPreferredDirection m_trackOrientation = EPreferredDirection::c_None
 Encoded desired track orientation.
 
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

Fixes the orientation of tracks by a simple heuristic.

Definition at line 26 of file TrackOrienter.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 CDCTrack, CDCTrack>
private

Type of the base class.

Definition at line 30 of file TrackOrienter.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.

56{
57 m_subordinaryProcessingSignalListeners.push_back(psl);
58}
Belle2::TrackFindingCDC::CompositeProcessingSignalListener::m_subordinaryProcessingSignalListeners
std::vector< ProcessingSignalListener * > m_subordinaryProcessingSignalListeners
References to subordinary signal processing listener contained in this findlet.
Definition: CompositeProcessingSignalListener.h:52

◆ apply()

void apply ( const std::vector< CDCTrack > &  inputTracks,
std::vector< CDCTrack > &  outputTracks 
)
final

Main algorithm applying the adjustment of the orientation.

Copy tracks to output fixing their orientation

Definition at line 52 of file TrackOrienter.cc.

54{
56 if (m_trackOrientation == EPreferredDirection::c_None) {
57 // Copy the tracks unchanged.
58 outputTracks = inputTracks;
59
60 } else if (m_trackOrientation == EPreferredDirection::c_Symmetric) {
61 outputTracks.reserve(2 * inputTracks.size());
62 for (const CDCTrack& track : inputTracks) {
63 outputTracks.push_back(track.reversed());
64 outputTracks.push_back(track);
65 }
66
67 } else if (m_trackOrientation == EPreferredDirection::c_Curling) {
68 // Only make a copy for tracks that are curling inside the CDC
69 // Others fix to flighing outwards
70 outputTracks.reserve(1.5 * inputTracks.size());
71 for (const CDCTrack& track : inputTracks) {
72 const CDCTrajectory3D& startTrajectory3D = track.getStartTrajectory3D();
73 const CDCTrajectory2D startTrajectory2D = startTrajectory3D.getTrajectory2D();
74
75 const CDCTrajectory3D& endTrajectory3D = track.getEndTrajectory3D();
76 const CDCTrajectory2D endTrajectory2D = endTrajectory3D.getTrajectory2D();
77 bool isFitted = startTrajectory2D.isFitted() and endTrajectory2D.isFitted();
78 bool isStartLeaver = (not endTrajectory2D.isCurler(1.1)) and startTrajectory2D.isOriginer();
79 bool isEndLeaver = (not startTrajectory2D.isCurler(1.1)) and endTrajectory2D.isOriginer();
80 // Trajectory is leaving the CDC starting in the inner volume
81 bool isLeaver = isFitted and (isStartLeaver or isEndLeaver);
82 if (isLeaver) {
83 // Fix to outwards flying
84 const CDCRecoHit3D& firstHit = track.front();
85 const CDCRecoHit3D& lastHit = track.back();
86 if (lastHit.getRecoPos2D().cylindricalR() < firstHit.getRecoPos2D().cylindricalR()) {
87 outputTracks.push_back(track.reversed());
88 } else {
89 outputTracks.push_back(track);
90 }
91 } else {
92 // Ambiguous keep both options
93 outputTracks.push_back(track);
94 outputTracks.push_back(track.reversed());
95 }
96 }
97
98 } else if (m_trackOrientation == EPreferredDirection::c_Outwards) {
99 outputTracks.reserve(inputTracks.size());
100 for (const CDCTrack& track : inputTracks) {
101 const CDCRecoHit3D& firstHit = track.front();
102 const CDCRecoHit3D& lastHit = track.back();
103 if (lastHit.getRecoPos2D().cylindricalR() < firstHit.getRecoPos2D().cylindricalR()) {
104 outputTracks.push_back(track.reversed());
105 } else {
106 outputTracks.push_back(track);
107 }
108 }
109
110 } else if (m_trackOrientation == EPreferredDirection::c_Downwards) {
111 outputTracks.reserve(inputTracks.size());
112 for (const CDCTrack& track : inputTracks) {
113 const CDCRecoHit3D& firstHit = track.front();
114 const CDCRecoHit3D& lastHit = track.back();
115 if (lastHit.getRecoPos2D().y() > firstHit.getRecoPos2D().y()) {
116 outputTracks.push_back(track.reversed());
117 } else {
118 outputTracks.push_back(track);
119 }
120 }
121
122 } else {
123 B2WARNING("Unexpected 'TrackOrientation' parameter of track finder module : '" <<
124 m_param_trackOrientationString <<
125 "'. No tracks are put out.");
126 }
127}
Belle2::TrackFindingCDC::CDCRecoHit3D
Class representing a three dimensional reconstructed hit.
Definition: CDCRecoHit3D.h:52
Belle2::TrackFindingCDC::CDCRecoHit3D::getRecoPos2D
const Vector2D & getRecoPos2D() const
Getter for the 2d position of the hit.
Definition: CDCRecoHit3D.h:297
Belle2::TrackFindingCDC::CDCTrack
Class representing a sequence of three dimensional reconstructed hits.
Definition: CDCTrack.h:41
Belle2::TrackFindingCDC::CDCTrajectory2D
Particle trajectory as it is seen in xy projection represented as a circle.
Definition: CDCTrajectory2D.h:36
Belle2::TrackFindingCDC::CDCTrajectory2D::isOriginer
bool isOriginer(double factor=1) const
Checks if the trajectory intersects with the inner radius of the CDC time the given tolerance factor.
Definition: CDCTrajectory2D.cc:271
Belle2::TrackFindingCDC::CDCTrajectory2D::isCurler
bool isCurler(double factor=1) const
Checks if the trajectory leaves the outer radius of the CDC times the given tolerance factor.
Definition: CDCTrajectory2D.cc:265
Belle2::TrackFindingCDC::CDCTrajectory2D::isFitted
bool isFitted() const
Checks if the circle is already set to a valid value.
Definition: CDCTrajectory2D.cc:83
Belle2::TrackFindingCDC::CDCTrajectory3D
Particle full three dimensional trajectory.
Definition: CDCTrajectory3D.h:45
Belle2::TrackFindingCDC::CDCTrajectory3D::getTrajectory2D
CDCTrajectory2D getTrajectory2D() const
Getter for the two dimensional trajectory.
Definition: CDCTrajectory3D.cc:333
Belle2::TrackFindingCDC::TrackOrienter::m_trackOrientation
EPreferredDirection m_trackOrientation
Encoded desired track orientation.
Definition: TrackOrienter.h:56
Belle2::TrackFindingCDC::TrackOrienter::m_param_trackOrientationString
std::string m_param_trackOrientationString
Parameter: String that states the desired track orientation.
Definition: TrackOrienter.h:50
Belle2::TrackFindingCDC::Vector2D::cylindricalR
double cylindricalR() const
Gives the cylindrical radius of the vector. Same as norm()
Definition: Vector2D.h:557
Belle2::TrackFindingCDC::Vector2D::y
double y() const
Getter for the y coordinate.
Definition: Vector2D.h:605

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

32{
33 Super::beginEvent();
34 for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
35 psl->beginEvent();
36 }
37}
Belle2::TrackFindingCDC::ProcessingSignalListener
Interface for an algorithm part that needs to receive the module processing signals.
Definition: ProcessingSignalListener.h:20
Belle2::TrackFindingCDC::ProcessingSignalListener::beginEvent
virtual void beginEvent()
Receive signal for the start of a new event.
Definition: ProcessingSignalListener.cc:45

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

24{
25 Super::beginRun();
26 for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
27 psl->beginRun();
28 }
29}
Belle2::TrackFindingCDC::ProcessingSignalListener::beginRun
virtual void beginRun()
Receive signal for the beginning of a new run.
Definition: ProcessingSignalListener.cc:38

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

40{
41 for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
42 psl->endRun();
43 }
44 Super::endRun();
45}
Belle2::TrackFindingCDC::ProcessingSignalListener::endRun
virtual void endRun()
Receive signal for the end of the run.
Definition: ProcessingSignalListener.cc:52

◆ exposeParameters()

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

Expose the parameters to a module.

Reimplemented from Findlet< const CDCTrack, CDCTrack >.

Definition at line 26 of file TrackOrienter.cc.

27{
28 moduleParamList->addParameter(prefixed(prefix, "TrackOrientation"),
29 m_param_trackOrientationString,
30 "Option which orientation of tracks shall be generate. "
31 "Valid options are '' (default of the finder), "
32 "'none' (one orientation, algorithm dependent), "
33 "'symmetric', "
34 "'curling', "
35 "'outwards', "
36 "'downwards'.",
37 m_param_trackOrientationString);
38}
Belle2::ModuleParamList::addParameter
void addParameter(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module list.
Definition: ModuleParamList.templateDetails.h:28

◆ getDescription()

std::string getDescription ( )
finalvirtual

Short description of the findlet.

Reimplemented from Findlet< const CDCTrack, CDCTrack >.

Definition at line 21 of file TrackOrienter.cc.

22{
23 return "Fixes the flight direction of tracks to a preferred orientation by simple heuristics.";
24}

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )
protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

61{
62 return m_subordinaryProcessingSignalListeners.size();
63}

◆ initialize()

void initialize ( )
finalvirtual

Signals the beginning of the event processing.

Reimplemented from ProcessingSignalListener.

Definition at line 40 of file TrackOrienter.cc.

41{
42 Super::initialize();
43 if (m_param_trackOrientationString != std::string("")) {
44 try {
45 m_trackOrientation = getPreferredDirection(m_param_trackOrientationString);
46 } catch (std::invalid_argument& e) {
47 B2ERROR("Unexpected 'TrackOrientation' parameter : '" << m_param_trackOrientationString);
48 }
49 }
50}
Belle2::TrackFindingCDC::CompositeProcessingSignalListener::initialize
void initialize() override
Receive and dispatch signal before the start of the event processing.
Definition: CompositeProcessingSignalListener.cc:15

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

48{
49 for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
50 psl->terminate();
51 }
52 Super::terminate();
53}
Belle2::TrackFindingCDC::ProcessingSignalListener::terminate
virtual void terminate()
Receive Signal for termination of the event processing.
Definition: ProcessingSignalListener.cc:59

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_param_trackOrientationString

std::string m_param_trackOrientationString = ""
private

Parameter: String that states the desired track orientation.

Valid orientations are "none" (unchanged), "outwards", "downwards", "symmetric", "curling"

Definition at line 50 of file TrackOrienter.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_trackOrientation

EPreferredDirection m_trackOrientation = EPreferredDirection::c_None
private

Encoded desired track orientation.

Valid orientations are "c_None" (unchanged), "c_Outwards", "c_Downwards", "c_Symmetric", "c_Curling",

Definition at line 56 of file TrackOrienter.h.

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