Belle II Software development
TruthAxialSegmentPairVarSet Class Reference

Class to compute floating point variables from an axial stereo segment pair which can be recorded as a flat TNtuple or serve as input to a MVA method. More...

#include <TruthAxialSegmentPairVarSet.h>

Inheritance diagram for TruthAxialSegmentPairVarSet:
VarSet< TruthAxialSegmentPairVarNames > BaseVarSet< AVarNames::Object > CompositeProcessingSignalListener ProcessingSignalListener

Public Types

using Object = typename Super::Object
 Type from which variables should be extracted.
 

Public Member Functions

void initialize () final
 Require the Monte Carlo information before the event processing starts.
 
void beginEvent () final
 Signal the begin of a new event.
 
bool extract (const CDCAxialSegmentPair *ptrAxialSegmentPair) final
 Generate and assign the contained variables.
 
std::vector< Named< Float_t * > > getNamedVariables (const std::string &prefix) override
 Getter for the named references to the individual variables Base implementaton returns empty vector.
 
std::vector< Named< Float_t * > > getNamedVariables ()
 Getter for the named references to the individual variables.
 
MayBePtr< Float_t > find (const std::string &varName) override
 Pointer to the variable with the given name.
 
virtual bool extract (const Object *obj)
 Main method that extracts the variable values from the complex object.
 
bool extract (const Object &obj)
 Method for extraction from an object instead of a pointer.
 
std::map< std::string, Float_t > getNamedValues (const std::string &prefix) const
 Getter for a map of names to float values.
 
std::map< std::string, Float_t > getNamedValues () const
 Getter for a map of names to float values.
 
void beginRun () override
 Receive and dispatch signal for the beginning of a new run.
 
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 Member Functions

Float_t get () const
 Getter for the value of the ith variable. Static version.
 
Float_t & var ()
 Reference getter for the value of the ith variable. Static version.
 
AssignFinite< Float_t > finitevar ()
 Reference getter for the value of the ith variable. Transforms non-finite values to finite value.
 
void addProcessingSignalListener (ProcessingSignalListener *psl)
 Register a processing signal listener to be notified.
 
int getNProcessingSignalListener ()
 Get the number of currently registered listeners.
 

Static Protected Member Functions

static constexpr int named (const char *name)
 Getter for the index from the name.
 

Private Types

using Super = VarSet< TruthAxialSegmentPairVarNames >
 Type of the base class.
 

Private Attributes

FixedSizeNamedFloatTuple< TruthAxialSegmentPairVarNamesm_variables
 Memory for nVars floating point values.
 
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.
 

Static Private Attributes

static const size_t nVars
 Number of floating point values represented by this class.
 

Detailed Description

Class to compute floating point variables from an axial stereo segment pair which can be recorded as a flat TNtuple or serve as input to a MVA method.

Definition at line 54 of file TruthAxialSegmentPairVarSet.h.

Member Typedef Documentation

◆ Object

using Object = typename Super::Object
inherited

Type from which variables should be extracted.

Definition at line 44 of file VarSet.h.

◆ Super

Type of the base class.

Definition at line 57 of file TruthAxialSegmentPairVarSet.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{
58}
std::vector< ProcessingSignalListener * > m_subordinaryProcessingSignalListeners
References to subordinary signal processing listener contained in this findlet.

◆ beginEvent()

void beginEvent ( )
finalvirtual

Signal the begin of a new event.

Reimplemented from ProcessingSignalListener.

Definition at line 35 of file TruthAxialSegmentPairVarSet.cc.

36{
39}
void fill()
Fill Monte Carlo look up maps from the DataStore.
static CDCMCManager & getInstance()
Getter for the singletone instance.
Definition: CDCMCManager.cc:74
void beginEvent() override
Receive and dispatch signal for the start of a new event.

◆ 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{
27 psl->beginRun();
28 }
29}
Interface for an algorithm part that needs to receive the module processing signals.
virtual void beginRun()
Receive signal for the beginning of a new run.

◆ 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{
42 psl->endRun();
43 }
45}
virtual void endRun()
Receive signal for the end of the run.

◆ extract() [1/3]

bool extract ( const CDCAxialSegmentPair ptrAxialSegmentPair)
final

Generate and assign the contained variables.

Definition at line 41 of file TruthAxialSegmentPairVarSet.cc.

42{
43 if (not ptrAxialSegmentPair) return false;
44
45 const CDCAxialSegmentPair& segmentPair = *ptrAxialSegmentPair;
46
47 const CDCSegment2D* ptrFromSegment = segmentPair.getStartSegment();
48 const CDCSegment2D* ptrToSegment = segmentPair.getEndSegment();
49
50 const CDCSegment2D& fromSegment = *ptrFromSegment;
51 const CDCSegment2D& toSegment = *ptrToSegment;
52
53 const CDCMCHitLookUp& mcHitLookUp = CDCMCHitLookUp::getInstance();
55 const CDCMCTrackStore& mcTrackStore = CDCMCTrackStore::getInstance();
56 const std::map<ITrackType, CDCMCTrackStore::CDCHitVector>& mcTracks =
57 mcTrackStore.getMCTracksByMCParticleIdx();
58
59 CDCTrajectory3D trueTrajectory = mcSegmentLookUp.getTrajectory3D(&toSegment);
60 var<named("truth_curv")>() = trueTrajectory.getCurvatureXY();
61 var<named("truth_tanl")>() = trueTrajectory.getTanLambda();
62 var<named("truth_z")>() = trueTrajectory.getSupport().z();
63
64 // Hits
65 const CDCRecoHit2D& fromLastHit = fromSegment.back();
66 const CDCRecoHit2D& toFirstHit = toSegment.front();
67
68 const CDCSimHit* fromSimHit = mcHitLookUp.getClosestPrimarySimHit(fromLastHit.getWireHit().getHit());
69 const CDCSimHit* toSimHit = mcHitLookUp.getClosestPrimarySimHit(toFirstHit.getWireHit().getHit());
70 if (fromSimHit and toSimHit) {
71 double truthFromAlpha = -fromSimHit->getPosTrack().DeltaPhi(fromSimHit->getMomentum());
72 double truthToAlpha = -toSimHit->getPosTrack().DeltaPhi(toSimHit->getMomentum());
73 var<named("truth_from_alpha")>() = truthFromAlpha;
74 var<named("truth_to_alpha")>() = truthToAlpha;
75 var<named("truth_delta_alpha")>() = AngleUtil::normalised(truthToAlpha - truthFromAlpha);
76 } else {
77 var<named("truth_from_alpha")>() = NAN;
78 var<named("truth_to_alpha")>() = NAN;
79 var<named("truth_delta_alpha")>() = NAN;
80 }
81
82 ITrackType fromTrackId = mcSegmentLookUp.getMCTrackId(&fromSegment);
83 double fromMCTrackSize = 0;
84 if (mcTracks.count(fromTrackId)) {
85 fromMCTrackSize = mcTracks.find(fromTrackId)->second.size();
86 }
87
88 ITrackType toTrackId = mcSegmentLookUp.getMCTrackId(&toSegment);
89 double toMCTrackSize = 0;
90 if (mcTracks.count(toTrackId)) {
91 toMCTrackSize = mcTracks.find(toTrackId)->second.size();
92 }
93
94 double trackFraction = fromSegment.size() / fromMCTrackSize + toSegment.size() / toMCTrackSize;
95 var<named("truth_track_fraction")>() = trackFraction;
96
97 double fromRLPurity = mcSegmentLookUp.getRLPurity(&fromSegment);
98 double toRLPurity = mcSegmentLookUp.getRLPurity(&toSegment);
99 if (fromRLPurity < 0.5) fromRLPurity = 0;
100 if (toRLPurity < 0.5) toRLPurity = 0;
101
102 EForwardBackward pairFBInfo = mcSegmentLookUp.areAlignedInMCTrack(&fromSegment, &toSegment);
103
104 // False combinations have always full weight - true combinations are down weighted for their rl purity
105 double weight = pairFBInfo != EForwardBackward::c_Invalid ? fromRLPurity * toRLPurity : 1;
106 var<named("__weight__")>() = weight;
107
108 return true;
109}
DataType DeltaPhi(const B2Vector3< DataType > &v) const
returns phi in the interval [-PI,PI)
Definition: B2Vector3.h:228
Example Detector.
Definition: CDCSimHit.h:21
B2Vector3D getPosTrack() const
The method to get position on the track.
Definition: CDCSimHit.h:217
B2Vector3D getMomentum() const
The method to get momentum.
Definition: CDCSimHit.h:193
Class representing a pair of reconstructed axial segements in adjacent superlayer.
const CDCAxialSegment2D * getEndSegment() const
Getter for the end segment.
const CDCAxialSegment2D * getStartSegment() const
Getter for the start segment.
ITrackType getMCTrackId(const ACDCHitCollection *ptrHits) const
Getter for the Monte Carlo track id matched to this collection of hits.
double getRLPurity(const ACDCHitCollection *ptrHits) const
Getter for the right left passge purity which respects the forward backward reconstruction.
CDCTrajectory3D getTrajectory3D(const ACDCHitCollection *ptrHits) const
Returns the trajectory of the collection of hits.
EForwardBackward areAlignedInMCTrack(const ACDCHitCollection *ptrFromHits, const ACDCHitCollection *ptrToHits) const
Returns if the second collection of hits follows the first collection of hits in their common Monte C...
Interface class to the Monte Carlo information for individual hits.
const CDCSimHit * getClosestPrimarySimHit(const CDCHit *ptrHit) const
Getter for the closest simulated hit of a primary particle to the given hit - may return nullptr of n...
static const CDCMCHitLookUp & getInstance()
Getter for the singletone instance.
Specialisation of the lookup for the truth values of two dimensional segments.
static const CDCMCSegment2DLookUp & getInstance()
Getter for the singletone instance.
Class to organize and present the monte carlo hit information.
static const CDCMCTrackStore & getInstance()
Getter for the singletone instance.
const std::map< ITrackType, Belle2::TrackFindingCDC::CDCMCTrackStore::CDCHitVector > & getMCTracksByMCParticleIdx() const
Getter for the stored Monte Carlo tracks ordered by their Monte Carlo Id.
Class representing a two dimensional reconstructed hit in the central drift chamber.
Definition: CDCRecoHit2D.h:47
const CDCWireHit & getWireHit() const
Getter for the wire hit assoziated with the reconstructed hit.
Definition: CDCRecoHit2D.h:193
A reconstructed sequence of two dimensional hits in one super layer.
Definition: CDCSegment2D.h:39
Particle full three dimensional trajectory.
double getCurvatureXY() const
Getter for the curvature as seen from the xy projection.
double getTanLambda() const
Getter for the slope of z over the transverse travel distance s.
Vector3D getSupport() const
Getter for the support point of the trajectory in global coordinates, where arcLength2D = 0.
const CDCHit * getHit() const
Getter for the CDCHit pointer into the StoreArray.
Definition: CDCWireHit.h:159
static constexpr int named(const char *name)
Getter for the index from the name.
Definition: VarSet.h:78
Float_t & var()
Reference getter for the value of the ith variable. Static version.
Definition: VarSet.h:93
double z() const
Getter for the z coordinate.
Definition: Vector3D.h:496
EForwardBackward
Enumeration to represent the distinct possibilities of the right left passage information.
static double normalised(const double angle)
Normalise an angle to lie in the range from [-pi, pi].
Definition: Angle.h:33

◆ extract() [2/3]

bool extract ( const Object obj)
inlineinherited

Method for extraction from an object instead of a pointer.

Definition at line 56 of file BaseVarSet.h.

57 {
58 return extract(&obj);
59 }
virtual bool extract(const Object *obj)
Main method that extracts the variable values from the complex object.
Definition: BaseVarSet.h:50

◆ extract() [3/3]

virtual bool extract ( const Object obj)
inlinevirtualinherited

Main method that extracts the variable values from the complex object.

Returns indication whether the extraction could be completed successfully. Base implementation returns always true.

Parameters
objdummy object not used
Returns
: always true for the base implementation

Definition at line 50 of file BaseVarSet.h.

51 {
52 return true;
53 }

◆ find()

MayBePtr< Float_t > find ( const std::string &  varName)
inlineoverridevirtualinherited

Pointer to the variable with the given name.

Returns nullptr if not found.

Reimplemented from BaseVarSet< AVarNames::Object >.

Definition at line 64 of file VarSet.h.

65 {
66 return m_variables.find(varName);
67 }
virtual MayBePtr< Float_t > find(std::string name)
Getter for a pointer to the value with the given name.
FixedSizeNamedFloatTuple< TruthAxialSegmentPairVarNames > m_variables
Memory for nVars floating point values.
Definition: VarSet.h:138

◆ finitevar()

AssignFinite< Float_t > finitevar ( )
inlineprotectedinherited

Reference getter for the value of the ith variable. Transforms non-finite values to finite value.

Definition at line 130 of file VarSet.h.

131 {
132 static_assert(I < nVars, "Requested variable index exceeds number of variables.");
133 return AssignFinite<Float_t>(m_variables[I]);
134 }
static const size_t nVars
Number of floating point values represented by this class.
Definition: VarSet.h:48

◆ get()

Float_t get ( ) const
inlineprotectedinherited

Getter for the value of the ith variable. Static version.

Definition at line 85 of file VarSet.h.

86 {
87 static_assert(I < nVars, "Requested variable index exceeds number of variables.");
88 return m_variables.get(I);
89 }
Float_t get() const
Getter for the ith value. Static index version.

◆ getNamedValues() [1/2]

std::map< std::string, Float_t > getNamedValues ( ) const
inlineinherited

Getter for a map of names to float values.

Definition at line 95 of file BaseVarSet.h.

96 {
97 const std::string prefix = "";
98 return this->getNamedValues(prefix);
99 }
std::map< std::string, Float_t > getNamedValues(const std::string &prefix) const
Getter for a map of names to float values.
Definition: BaseVarSet.h:83

◆ getNamedValues() [2/2]

std::map< std::string, Float_t > getNamedValues ( const std::string &  prefix) const
inlineinherited

Getter for a map of names to float values.

Parameters
prefixName prefix to apply to all variable names.

Definition at line 83 of file BaseVarSet.h.

84 {
85 std::map<std::string, Float_t> result;
86 std::vector<Named<Float_t*> > namedVariables = this->getNamedVariables(prefix);
87 for (const Named<Float_t*>& namedVariable : namedVariables) {
88 Float_t* variable = namedVariable;
89 result[namedVariable.getName()] = *variable;
90 }
91 return result;
92 }
virtual std::vector< Named< Float_t * > > getNamedVariables(const std::string &prefix)
Getter for the named references to the individual variables Base implementaton returns empty vector.
Definition: BaseVarSet.h:67

◆ getNamedVariables() [1/2]

std::vector< Named< Float_t * > > getNamedVariables ( )
inlineinherited

Getter for the named references to the individual variables.

Definition at line 73 of file BaseVarSet.h.

74 {
75 const std::string prefix = "";
76 return this->getNamedVariables(prefix);
77 }

◆ getNamedVariables() [2/2]

std::vector< Named< Float_t * > > getNamedVariables ( const std::string &  prefix)
inlineoverridevirtualinherited

Getter for the named references to the individual variables Base implementaton returns empty vector.

Reimplemented from BaseVarSet< AVarNames::Object >.

Definition at line 55 of file VarSet.h.

56 {
57 return m_variables.getNamedVariables(prefix);
58 }
std::vector< Named< Float_t * > > getNamedVariables(std::string prefix="")
Getter for named references to the variables in this tuple.

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )
protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

61{
63}

◆ initialize()

void initialize ( )
finalvirtual

Require the Monte Carlo information before the event processing starts.

Reimplemented from ProcessingSignalListener.

Definition at line 29 of file TruthAxialSegmentPairVarSet.cc.

30{
33}
void requireTruthInformation()
Require the mc information store arrays.
void initialize() override
Receive and dispatch signal before the start of the event processing.

◆ named()

static constexpr int named ( const char *  name)
inlinestaticconstexprprotectedinherited

Getter for the index from the name.

Looks through the associated names and returns the right index if found Returns nVars (one after the last element) if not found.

Parameters
nameName of the sought variable
Returns
Index of the name, nVars if not found.

Definition at line 78 of file VarSet.h.

79 {
80 return index<nVars>(AVarNames::getName, name);
81 }

◆ 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{
50 psl->terminate();
51 }
53}
virtual void terminate()
Receive Signal for termination of the event processing.

◆ var()

Float_t & var ( )
inlineprotectedinherited

Reference getter for the value of the ith variable. Static version.

Definition at line 93 of file VarSet.h.

94 {
95 static_assert(I < nVars, "Requested variable index exceeds number of variables.");
96 return m_variables[I];
97 }

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_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_variables

Memory for nVars floating point values.

Definition at line 138 of file VarSet.h.

◆ nVars

const size_t nVars
staticprivateinherited

Number of floating point values represented by this class.

Definition at line 48 of file VarSet.h.


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