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

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

#include <SegmentOrienter.h>

Inheritance diagram for SegmentOrienter:
Findlet< const TrackingUtilities::CDCSegment2D, TrackingUtilities::CDCSegment2D > CompositeProcessingSignalListener ProcessingSignalListener

Public Types

using IOTypes
 Types that should be served to apply on invocation.
 
using IOTypes
 Types that should be served to apply on invocation.
 
using IOVectors
 Vector types that should be served to apply on invocation.
 
using IOVectors
 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< TrackingUtilities::CDCSegment2D > &inputSegments, std::vector< TrackingUtilities::CDCSegment2D > &outputSegments) 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
 Short hand for ToRangeImpl.
 
using ToVector
 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 = TrackingUtilities::Findlet<const TrackingUtilities::CDCSegment2D, TrackingUtilities::CDCSegment2D>
 Type of the base class.
 

Private Attributes

std::string m_param_segmentOrientationString = ""
 Parameter: String that states the desired segment orientation.
 
EPreferredDirection m_segmentOrientation = EPreferredDirection::c_None
 Encoded desired segment orientation.
 
std::vector< ProcessingSignalListener * > m_subordinaryProcessingSignalListeners
 References to subordinary signal processing listener contained in this findlet.
 
bool m_initialized
 Flag to keep track whether initialization happened before.
 
bool m_terminated
 Flag to keep track whether termination happened before.
 
std::string m_initializedAs
 Name of the type during initialisation.
 

Detailed Description

Fixes the orientation of segments by a simple heuristic.

Definition at line 29 of file SegmentOrienter.h.

Member Typedef Documentation

◆ IOTypes [1/2]

using IOTypes
inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOTypes [2/2]

using IOTypes
inherited

Types that should be served to apply on invocation.

Definition at line 30 of file Findlet.h.

◆ IOVectors [1/2]

using IOVectors
inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ IOVectors [2/2]

using IOVectors
inherited

Vector types that should be served to apply on invocation.

Definition at line 53 of file Findlet.h.

◆ Super

using Super = TrackingUtilities::Findlet<const TrackingUtilities::CDCSegment2D, TrackingUtilities::CDCSegment2D>
private

Type of the base class.

Definition at line 33 of file SegmentOrienter.h.

◆ ToVector [1/2]

using ToVector
protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

◆ ToVector [2/2]

using ToVector
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 53 of file CompositeProcessingSignalListener.cc.

56{
57 m_subordinaryProcessingSignalListeners.push_back(psl);
58}
Belle2::TrackingUtilities::Findlet
Interface for a minimal algorithm part that wants to expose some parameters to a module.
Definition Findlet.h:26

◆ apply()

void apply ( const std::vector< TrackingUtilities::CDCSegment2D > & inputSegments,
std::vector< TrackingUtilities::CDCSegment2D > & outputSegments )
final

Main algorithm applying the adjustment of the orientation.

Copy segments to output fixing their orientation

Definition at line 53 of file SegmentOrienter.cc.

55{
57 if (m_segmentOrientation == EPreferredDirection::c_None) {
58 // Copy the segments unchanged.
59 outputSegments = inputSegments;
60
61 } else if (m_segmentOrientation == EPreferredDirection::c_Symmetric) {
62 outputSegments.reserve(2 * inputSegments.size());
63 for (const CDCSegment2D& segment : inputSegments) {
64 outputSegments.push_back(segment);
65 if (segment->hasReverseFlag()) continue; // Already a reverse found in the facet ca
66 outputSegments.back()->setReverseFlag();
67 outputSegments.push_back(segment.reversed());
68 outputSegments.back()->setReverseFlag();
69 }
70
71 } else if (m_segmentOrientation == EPreferredDirection::c_Curling) {
72 // Only make a copy for segments that are curling inside the CDC
73 // Others fix to flighing outwards
74 outputSegments.reserve(1.5 * inputSegments.size());
75 for (const CDCSegment2D& segment : inputSegments) {
76 if (segment->hasReverseFlag()) {
77 outputSegments.push_back(segment);
78 continue; // Already a reverse found in the facet ca
79 }
80 const CDCTrajectory2D& trajectory2D = segment.getTrajectory2D();
81 bool isFitted = trajectory2D.isFitted();
82 bool isCurler = trajectory2D.isCurler(1.1);
83 bool isOriginer = trajectory2D.isOriginer();
84 // Trajectory is leaving the CDC starting in the inner volume
85 bool isLeaver = isFitted and (not isCurler) and isOriginer;
86 if (isLeaver) {
87 // Fix to outwards flying
88 const CDCRecoHit2D& firstHit = segment.front();
89 const CDCRecoHit2D& lastHit = segment.back();
90 if (lastHit.getRecoPos2D().cylindricalR() < firstHit.getRecoPos2D().cylindricalR()) {
91 outputSegments.push_back(segment.reversed());
92 } else {
93 outputSegments.push_back(segment);
94 }
95 } else {
96 // Ambiguous keep both options
97 outputSegments.push_back(segment);
98 outputSegments.back()->setReverseFlag();
99 outputSegments.push_back(segment.reversed());
100 outputSegments.back()->setReverseFlag();
101 }
102 }
103
104 } else if (m_segmentOrientation == EPreferredDirection::c_Outwards) {
105 outputSegments.reserve(inputSegments.size());
106 for (const CDCSegment2D& segment : inputSegments) {
107 const CDCRecoHit2D& firstHit = segment.front();
108 const CDCRecoHit2D& lastHit = segment.back();
109 if (lastHit.getRecoPos2D().cylindricalR() < firstHit.getRecoPos2D().cylindricalR()) {
110 outputSegments.push_back(segment.reversed());
111 } else {
112 outputSegments.push_back(segment);
113 }
114 }
115 } else if (m_segmentOrientation == EPreferredDirection::c_Downwards) {
116 outputSegments.reserve(inputSegments.size());
117 for (const CDCSegment2D& segment : inputSegments) {
118 const CDCRecoHit2D& firstHit = segment.front();
119 const CDCRecoHit2D& lastHit = segment.back();
120 if (lastHit.getRecoPos2D().y() > firstHit.getRecoPos2D().y()) {
121 outputSegments.push_back(segment.reversed());
122 } else {
123 outputSegments.push_back(segment);
124 }
125 }
126
127 } else {
128 B2WARNING("Unexpected 'SegmentOrientation' parameter of segment finder module : '" <<
129 m_param_segmentOrientationString <<
130 "'. No segments are put out.");
131 }
132}
Belle2::TrackFindingCDC::SegmentOrienter::m_param_segmentOrientationString
std::string m_param_segmentOrientationString
Parameter: String that states the desired segment orientation.
Definition SegmentOrienter.h:54
Belle2::TrackFindingCDC::SegmentOrienter::m_segmentOrientation
EPreferredDirection m_segmentOrientation
Encoded desired segment orientation.
Definition SegmentOrienter.h:60
Belle2::TrackingUtilities::CDCRecoHit2D::getRecoPos2D
Vector2D getRecoPos2D() const
Getter for the position in the reference plane.
Definition CDCRecoHit2D.h:241
Belle2::TrackingUtilities::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:272
Belle2::TrackingUtilities::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:266
Belle2::TrackingUtilities::CDCTrajectory2D::isFitted
bool isFitted() const
Checks if the circle is already set to a valid value.
Definition CDCTrajectory2D.cc:84
Belle2::TrackingUtilities::Vector2D::cylindricalR
double cylindricalR() const
Gives the cylindrical radius of the vector. Same as norm()
Definition Vector2D.h:588
Belle2::TrackingUtilities::Vector2D::y
double y() const
Getter for the y coordinate.
Definition Vector2D.h:641

◆ beginEvent()

void beginEvent ( )
overrideinherited

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

Definition at line 36 of file CompositeProcessingSignalListener.cc.

32{
33 Super::beginEvent();
34 for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
35 psl->beginEvent();
36 }
37}
Belle2::TrackingUtilities::CompositeProcessingSignalListener::beginEvent
void beginEvent() override
Receive and dispatch signal for the start of a new event.
Definition CompositeProcessingSignalListener.cc:31
Belle2::TrackingUtilities::ProcessingSignalListener::beginEvent
virtual void beginEvent()
Receive signal for the start of a new event.
Definition ProcessingSignalListener.cc:45

◆ beginRun()

void beginRun ( )
overrideinherited

Receive and dispatch signal for the beginning of a new run.

Definition at line 33 of file CompositeProcessingSignalListener.cc.

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

◆ endRun()

void endRun ( )
overrideinherited

Receive and dispatch signal for the end of the run.

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::TrackingUtilities::CompositeProcessingSignalListener::endRun
void endRun() override
Receive and dispatch signal for the end of the run.
Definition CompositeProcessingSignalListener.cc:39
Belle2::TrackingUtilities::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 CompositeProcessingSignalListener.

Definition at line 27 of file SegmentOrienter.cc.

28{
29 moduleParamList->addParameter(prefixed(prefix, "SegmentOrientation"),
30 m_param_segmentOrientationString,
31 "Option which orientation of segments shall be generate. "
32 "Valid options are '' (default of the finder), "
33 "'none' (one orientation, algorithm dependent), "
34 "'symmetric', "
35 "'curling', "
36 "'outwards', "
37 "'downwards'.",
38 m_param_segmentOrientationString);
39}
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 TrackingUtilities::CDCSegment2D, TrackingUtilities::CDCSegment2D >.

Definition at line 21 of file SegmentOrienter.cc.

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

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )
protectedinherited

Get the number of currently registered listeners.

Definition at line 56 of file CompositeProcessingSignalListener.cc.

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

◆ initialize()

void initialize ( )
finalvirtual

Signals the beginning of the event processing.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 41 of file SegmentOrienter.cc.

42{
43 Super::initialize();
44 if (m_param_segmentOrientationString != std::string("")) {
45 try {
46 m_segmentOrientation = getPreferredDirection(m_param_segmentOrientationString);
47 } catch (std::invalid_argument& e) {
48 B2ERROR("Unexpected 'SegmentOrientation' parameter : '" << m_param_segmentOrientationString);
49 }
50 }
51}

◆ terminate()

void terminate ( )
overrideinherited

Receive and dispatch Signal for termination of the event processing.

Definition at line 42 of file CompositeProcessingSignalListener.cc.

48{
49 for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
50 psl->terminate();
51 }
52 Super::terminate();
53}
Belle2::TrackingUtilities::CompositeProcessingSignalListener::terminate
void terminate() override
Receive and dispatch Signal for termination of the event processing.
Definition CompositeProcessingSignalListener.cc:47
Belle2::TrackingUtilities::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
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_segmentOrientationString

std::string m_param_segmentOrientationString = ""
private

Parameter: String that states the desired segment orientation.

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

Definition at line 54 of file SegmentOrienter.h.

◆ m_segmentOrientation

EPreferredDirection m_segmentOrientation = EPreferredDirection::c_None
private

Encoded desired segment orientation.

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

Definition at line 60 of file SegmentOrienter.h.

◆ m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners
privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 60 of file CompositeProcessingSignalListener.h.

◆ m_terminated

bool m_terminated
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: