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

Findlet that generates segments from wire hits using the mc truth information. More...

#include <SegmentCreatorMCTruth.h>

Inheritance diagram for SegmentCreatorMCTruth:
Findlet< const TrackingUtilities::CDCWireHit, 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

void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
 Expose the parameters to a module.
 
std::string getDescription () final
 Short description of the findlet.
 
void initialize () final
 Initialize the Module before event processing.
 
void beginEvent () final
 Start processing the current event.
 
void apply (const std::vector< TrackingUtilities::CDCWireHit > &inputWireHits, std::vector< TrackingUtilities::CDCSegment2D > &outputSegments) final
 Main function of the segment finding by the cellular automaton.
 
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 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::CDCWireHit, TrackingUtilities::CDCSegment2D>
 Type of the base class.
 

Private Attributes

bool m_param_reconstructedDriftLength = false
 Parameter : Setup the drift length as it can be estimated from two dimensional information.
 
bool m_param_reconstructedPositions = false
 Parameter : Switch to reconstruct the positions in the segments imitating the facet ca picking up all correct hits.
 
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

Findlet that generates segments from wire hits using the mc truth information.

Definition at line 29 of file SegmentCreatorMCTruth.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::CDCWireHit, TrackingUtilities::CDCSegment2D>
private

Type of the base class.

Definition at line 34 of file SegmentCreatorMCTruth.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::CDCWireHit > & inputWireHits,
std::vector< TrackingUtilities::CDCSegment2D > & outputSegments )
final

Main function of the segment finding by the cellular automaton.

Definition at line 71 of file SegmentCreatorMCTruth.cc.

73{
74 const CDCMCTrackStore& mcTrackStore = CDCMCTrackStore::getInstance();
75 const CDCSimHitLookUp& simHitLookUp = CDCSimHitLookUp::getInstance();
76
77 using CDCHitVector = CDCMCTrackStore::CDCHitVector;
78
79 const std::map<ITrackType, std::vector<CDCHitVector>>& mcSegmentsByMCParticleIdx =
80 mcTrackStore.getMCSegmentsByMCParticleIdx();
81
82 std::size_t nSegments = 0;
83 for (const std::pair<ITrackType, std::vector<CDCHitVector>> mcSegmentsAndMCParticleIdx : mcSegmentsByMCParticleIdx) {
84 const std::vector<CDCHitVector>& mcSegments = mcSegmentsAndMCParticleIdx.second;
85 nSegments += mcSegments.size();
86 }
87
88 outputSegments.reserve(outputSegments.size() + nSegments);
89 for (const std::pair<ITrackType, std::vector<CDCHitVector>> mcSegmentsAndMCParticleIdx : mcSegmentsByMCParticleIdx) {
90
91 const std::vector<CDCHitVector>& mcSegments = mcSegmentsAndMCParticleIdx.second;
92 for (const CDCHitVector& mcSegment : mcSegments) {
93 outputSegments.push_back(CDCSegment2D());
94 CDCSegment2D& segment2D = outputSegments.back();
95 for (const CDCHit* ptrHit : mcSegment) {
96 const CDCWireHit* wireHit = simHitLookUp.getWireHit(ptrHit, inputWireHits);
97 if (not wireHit) continue;
98
99 CDCRecoHit2D recoHit2D = simHitLookUp.getClosestPrimaryRecoHit2D(ptrHit, inputWireHits);
100 segment2D.push_back(recoHit2D);
101 }
102 if (segment2D.size() < 3) outputSegments.pop_back();
103 }
104 }
105
106 CDC::RealisticTDCCountTranslator tdcCountTranslator;
107 for (CDCSegment2D& segment : outputSegments) {
108 for (CDCRecoHit2D& recoHit2D : segment) {
109 ROOT::Math::XYVector flightDirection = recoHit2D.getFlightDirection2D();
110 ROOT::Math::XYVector recoPos2D = recoHit2D.getRecoPos2D();
111 double alpha = ROOT::Math::VectorUtil::DeltaPhi(recoPos2D, flightDirection);
112
113 const CDCWire& wire = recoHit2D.getWire();
114 const CDCHit* hit = recoHit2D.getWireHit().getHit();
115 const bool rl = recoHit2D.getRLInfo() == ERightLeft::c_Right;
116
117 double driftLength = recoHit2D.getRefDriftLength();
118 if (m_param_reconstructedDriftLength) {
119 // Setup the drift length such that only information
120 // that would be present in two dimensional reconstruction is used
121 const double beta = 1;
122 double flightTimeEstimate = 0;
123 FlightTimeEstimator::instance().getFlightTime2D(recoPos2D, alpha, beta);
124
125 driftLength =
126 tdcCountTranslator.getDriftLength(hit->getTDCCount(),
127 wire.getWireID(),
128 flightTimeEstimate,
129 rl,
130 wire.getRefZ(),
131 alpha);
132 } else {
133 // In case the true drift length should be kept at least smear it with its variance.
134 double driftLengthVariance = tdcCountTranslator.getDriftLengthResolution(driftLength,
135 wire.getWireID(),
136 rl,
137 wire.getRefZ(),
138 alpha);
139
140 driftLength += gRandom->Gaus(0, std::sqrt(driftLengthVariance));
141 }
142 bool snapRecoPos = true;
143 recoHit2D.setRefDriftLength(driftLength, snapRecoPos);
144 }
145 }
146
147 if (m_param_reconstructedPositions) {
148 for (CDCSegment2D& segment : outputSegments) {
149 if (segment.size() > 1) {
150 CDCRLWireHitSegment rlWireHitSegment = segment.getRLWireHitSegment();
151 segment = CDCSegment2D::reconstructUsingFacets(rlWireHitSegment);
152 }
153 }
154 }
155
156 for (CDCSegment2D& segment : outputSegments) {
157 segment.receiveISuperCluster();
158 }
159 std::sort(outputSegments.begin(), outputSegments.end());
160}
Belle2::CDCHit::getTDCCount
short getTDCCount() const
Getter for TDC count.
Definition CDCHit.h:219
Belle2::CDC::CDCWire::getWireID
const WireID & getWireID() const
Getter for the wire id.
Definition CDCWire.h:114
Belle2::CDC::CDCWire::getRefZ
double getRefZ() const
Getter for the wire reference z coordinate Gives the wire's reference z coordinate.
Definition CDCWire.h:228
Belle2::CDC::RealisticTDCCountTranslator::getDriftLength
double getDriftLength(unsigned short tdcCount, const WireID &wireID=WireID(), double timeOfFlightEstimator=0, bool leftRight=false, double z=0, double alpha=0, double theta=static_cast< double >(TMath::Pi()/2.), unsigned short adcCount=0) override
Get Drift length.
Definition RealisticTDCCountTranslator.cc:97
Belle2::CDC::RealisticTDCCountTranslator::getDriftLengthResolution
double getDriftLengthResolution(double driftLength, const WireID &wireID=WireID(), bool leftRight=false, double z=0, double alpha=0, double=static_cast< double >(TMath::Pi()/2.)) override
Get position resolution^2 corresponding to the drift length from getDriftLength of this class.
Definition RealisticTDCCountTranslator.cc:131
Belle2::TrackFindingCDC::CDCMCTrackStore::getInstance
static const CDCMCTrackStore & getInstance()
Getter for the singletone instance.
Definition CDCMCTrackStore.cc:31
Belle2::TrackFindingCDC::CDCMCTrackStore::CDCHitVector
std::vector< const CDCHit * > CDCHitVector
Type for an ordered sequence of pointers to the CDCHit.
Definition CDCMCTrackStore.h:32
Belle2::TrackFindingCDC::CDCMCTrackStore::getMCSegmentsByMCParticleIdx
const std::map< ITrackType, std::vector< Belle2::TrackFindingCDC::CDCMCTrackStore::CDCHitVector > > & getMCSegmentsByMCParticleIdx() const
Getter for the stored Monte Carlo segments ordered by their Monte Carlo Id.
Definition CDCMCTrackStore.h:64
Belle2::TrackFindingCDC::CDCSimHitLookUp::getInstance
static const CDCSimHitLookUp & getInstance()
Getter for the singletone instance.
Definition CDCSimHitLookUp.cc:33
Belle2::TrackFindingCDC::CDCSimHitLookUp::getClosestPrimaryRecoHit2D
TrackingUtilities::CDCRecoHit2D getClosestPrimaryRecoHit2D(const CDCHit *ptrHit, const std::vector< TrackingUtilities::CDCWireHit > &wireHits) const
Construct an TrackingUtilities::CDCRecoHit2D from the closest primary CDCSimHit information related t...
Definition CDCSimHitLookUp.cc:354
Belle2::TrackFindingCDC::CDCSimHitLookUp::getWireHit
const TrackingUtilities::CDCWireHit * getWireHit(const CDCHit *ptrHit, const std::vector< TrackingUtilities::CDCWireHit > &wireHits) const
Retrieve the wire hit the given CDCHit form the given wire hits.
Definition CDCSimHitLookUp.cc:303
Belle2::TrackFindingCDC::FlightTimeEstimator::instance
static const FlightTimeEstimator & instance(std::unique_ptr< FlightTimeEstimator > replacement=nullptr)
Getter for the instance.
Definition FlightTimeEstimator.cc:22
Belle2::TrackFindingCDC::FlightTimeEstimator::getFlightTime2D
virtual double getFlightTime2D(const ROOT::Math::XYVector &, double, double=1) const
Default estimator for the flight time.
Definition FlightTimeEstimator.h:37
Belle2::TrackFindingCDC::SegmentCreatorMCTruth::m_param_reconstructedDriftLength
bool m_param_reconstructedDriftLength
Parameter : Setup the drift length as it can be estimated from two dimensional information.
Definition SegmentCreatorMCTruth.h:55
Belle2::TrackFindingCDC::SegmentCreatorMCTruth::m_param_reconstructedPositions
bool m_param_reconstructedPositions
Parameter : Switch to reconstruct the positions in the segments imitating the facet ca picking up all...
Definition SegmentCreatorMCTruth.h:58
Belle2::TrackingUtilities::CDCRecoHit2D::getWireHit
const CDCWireHit & getWireHit() const
Getter for the wire hit associated with the reconstructed hit.
Definition CDCRecoHit2D.h:199
Belle2::TrackingUtilities::CDCRecoHit2D::setRefDriftLength
void setRefDriftLength(double driftLength, bool snapRecoPos)
Setter for the drift length at the wire reference position.
Definition CDCRecoHit2D.cc:110
Belle2::TrackingUtilities::CDCRecoHit2D::getRefDriftLength
double getRefDriftLength() const
Getter for the drift length at the wire reference position.
Definition CDCRecoHit2D.h:223
Belle2::TrackingUtilities::CDCRecoHit2D::getFlightDirection2D
ROOT::Math::XYVector getFlightDirection2D() const
Getter for the direction of flight.
Definition CDCRecoHit2D.h:262
Belle2::TrackingUtilities::CDCRecoHit2D::getRecoPos2D
ROOT::Math::XYVector getRecoPos2D() const
Getter for the position in the reference plane.
Definition CDCRecoHit2D.h:244
Belle2::TrackingUtilities::CDCRecoHit2D::getWire
const CDC::CDCWire & getWire() const
Getter for the wire the reconstructed hit associated to.
Definition CDCRecoHit2D.h:181
Belle2::TrackingUtilities::CDCRecoHit2D::getRLInfo
ERightLeft getRLInfo() const
Getter for the right left passage information.
Definition CDCRecoHit2D.h:211
Belle2::TrackingUtilities::CDCSegment2D::reconstructUsingFacets
static CDCSegment2D reconstructUsingFacets(const CDCRLWireHitSegment &rlWireHitSegment)
Reconstruct from wire hits with attached right left passage hypotheses by constructing facets between...
Definition CDCSegment2D.cc:297
Belle2::TrackingUtilities::CDCWireHit::getHit
const CDCHit * getHit() const
Getter for the CDCHit pointer into the StoreArray.
Definition CDCWireHit.h:160

◆ beginEvent()

void beginEvent ( )
finalvirtual

Start processing the current event.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 65 of file SegmentCreatorMCTruth.cc.

66{
67 CDCMCManager::getInstance().fill();
68 Super::beginEvent();
69}
Belle2::TrackFindingCDC::CDCMCManager::fill
void fill()
Fill Monte Carlo look up maps from the DataStore.
Definition CDCMCManager.cc:135
Belle2::TrackFindingCDC::CDCMCManager::getInstance
static CDCMCManager & getInstance()
Getter for the singleton instance.
Definition CDCMCManager.cc:74

◆ 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 37 of file SegmentCreatorMCTruth.cc.

38{
39 moduleParamList->addParameter(prefixed(prefix, "reconstructedDriftLength"),
40 m_param_reconstructedDriftLength,
41 "Switch to assign the reconstructed drift length to each hit, "
42 "as it can be estimated from two dimensional information only.",
43 m_param_reconstructedDriftLength);
44
45 moduleParamList->addParameter(prefixed(prefix, "reconstructedPositions"),
46 m_param_reconstructedPositions,
47 "Switch to reconstruct the positions in the segments "
48 "imitating the facet ca picking up all correct hits.",
49 m_param_reconstructedPositions);
50}
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::CDCWireHit, TrackingUtilities::CDCSegment2D >.

Definition at line 52 of file SegmentCreatorMCTruth.cc.

53{
54 return "Constructs segments from wire hits using the mc truth information.";
55}

◆ 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

Initialize the Module before event processing.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 58 of file SegmentCreatorMCTruth.cc.

59{
60 CDCMCManager::getInstance().requireTruthInformation();
61 Super::initialize();
62}
Belle2::TrackFindingCDC::CDCMCManager::requireTruthInformation
void requireTruthInformation()
Require the MC information store arrays.
Definition CDCMCManager.cc:115

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

bool m_param_reconstructedDriftLength = false
private

Parameter : Setup the drift length as it can be estimated from two dimensional information.

Definition at line 55 of file SegmentCreatorMCTruth.h.

◆ m_param_reconstructedPositions

bool m_param_reconstructedPositions = false
private

Parameter : Switch to reconstruct the positions in the segments imitating the facet ca picking up all correct hits.

Definition at line 58 of file SegmentCreatorMCTruth.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: