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

Findlet to exports CDCTracks as RecoTracks. More...

#include <TrackExporter.h>

Inheritance diagram for TrackExporter:
Findlet< 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
 Signal initialisation phase to register store array for export.
 
void apply (std::vector< CDCTrack > &tracks) final
 Write give tracks into track store array.
 
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< CDCTrack & >
 Type of the base class.
 

Private Attributes

bool m_param_exportTracks = true
 Parameter: Switch if a RecoTrack be generated for each track.
 
std::string m_param_exportTracksInto = ""
 Parameter: Name of the output StoreArray of the RecoTracks generated by this module.
 
bool m_param_discardCovarianceMatrix = false
 Parameter: Discard covariance matrix in favour of a hand written one.
 
double m_param_monopoleMomSeed = 0.0
 Parameter: If non-zero, estimate seeds as for monopoles and set the momentum magnitude as this value.
 
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

Findlet to exports CDCTracks as RecoTracks.

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

Type of the base class.

Definition at line 30 of file TrackExporter.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 ( std::vector< CDCTrack > &  tracks)
final

Write give tracks into track store array.

Definition at line 74 of file TrackExporter.cc.

75{
76 TMatrixDSym defaultCovSeed(6);
77 defaultCovSeed(0, 0) = 1e-3;
78 defaultCovSeed(1, 1) = 1e-3;
79 defaultCovSeed(2, 2) = 4e-3;
80 defaultCovSeed(3, 3) = 0.01e-3;
81 defaultCovSeed(4, 4) = 0.01e-3;
82 defaultCovSeed(5, 5) = 0.04e-3;
83
84 // Put code to generate gf track cands here if requested.
85 if (m_param_exportTracks) {
86 StoreArray<RecoTrack> storedRecoTracks(m_param_exportTracksInto);
87 for (const CDCTrack& track : tracks) {
88 RecoTrack* newRecoTrack;
89 if (m_param_monopoleMomSeed != 0.0)
90 newRecoTrack = RecoTrackUtil::storeInto(track, storedRecoTracks, m_param_monopoleMomSeed);
91 else
92 newRecoTrack = RecoTrackUtil::storeInto(track, storedRecoTracks);
93 if (newRecoTrack) {
94 newRecoTrack->setQualityIndicator(track.getQualityIndicator());
95 }
96 if (newRecoTrack and m_param_discardCovarianceMatrix) {
97 newRecoTrack->setSeedCovariance(defaultCovSeed);
98 }
99 }
100 }
101}
Belle2::RecoTrack
This is the Reconstruction Event-Data Model Track.
Definition: RecoTrack.h:79
Belle2::RecoTrack::setSeedCovariance
void setSeedCovariance(const TMatrixDSym &seedCovariance)
Set the covariance of the seed. ATTENTION: This is not the fitted covariance.
Definition: RecoTrack.h:614
Belle2::RecoTrack::setQualityIndicator
void setQualityIndicator(const float qualityIndicator)
Set the quality index attached to this RecoTrack. 0 means likely fake.
Definition: RecoTrack.h:847
Belle2::StoreArray
Accessor to arrays stored in the data store.
Definition: StoreArray.h:113
Belle2::TrackFindingCDC::CDCTrack
Class representing a sequence of three dimensional reconstructed hits.
Definition: CDCTrack.h:41
Belle2::TrackFindingCDC::TrackExporter::m_param_exportTracks
bool m_param_exportTracks
Parameter: Switch if a RecoTrack be generated for each track.
Definition: TrackExporter.h:47
Belle2::TrackFindingCDC::TrackExporter::m_param_exportTracksInto
std::string m_param_exportTracksInto
Parameter: Name of the output StoreArray of the RecoTracks generated by this module.
Definition: TrackExporter.h:50
Belle2::TrackFindingCDC::TrackExporter::m_param_discardCovarianceMatrix
bool m_param_discardCovarianceMatrix
Parameter: Discard covariance matrix in favour of a hand written one.
Definition: TrackExporter.h:53
Belle2::TrackFindingCDC::TrackExporter::m_param_monopoleMomSeed
double m_param_monopoleMomSeed
Parameter: If non-zero, estimate seeds as for monopoles and set the momentum magnitude as this value.
Definition: TrackExporter.h:56
Belle2::TrackFindingCDC::RecoTrackUtil::storeInto
static RecoTrack * storeInto(const CDCTrack &track, StoreArray< RecoTrack > &recoTracks, const double momentumSeedMagnitude)
For magnetic monopoles; estimates charge sign from all stereo hits, momentum direction from hits in c...
Definition: RecoTrackUtil.cc:39

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

Definition at line 31 of file TrackExporter.cc.

32{
33 moduleParamList->addParameter(prefixed(prefix, "RecoTracksStoreArrayName"),
34 m_param_exportTracksInto,
35 "Alias for exportTracksInto",
36 m_param_exportTracksInto);
37
38 moduleParamList->addParameter(prefixed(prefix, "WriteRecoTracks"),
39 m_param_exportTracks,
40 "Alias for exportTracks",
41 m_param_exportTracks);
42
43 moduleParamList->addParameter(prefixed(prefix, "exportTracks"),
44 m_param_exportTracks,
45 "Switch for the creation of reco tracks for each cdc track.",
46 m_param_exportTracks);
47
48 moduleParamList->addParameter(prefixed(prefix, "exportTracksInto"),
49 m_param_exportTracksInto,
50 "Name of the output StoreArray of RecoTracks.",
51 m_param_exportTracksInto);
52
53 moduleParamList->addParameter(prefixed(prefix, "discardCovarianceMatrix"),
54 m_param_discardCovarianceMatrix,
55 "Discard covariance matrix in favour of a hand written one.",
56 m_param_discardCovarianceMatrix);
57 moduleParamList->addParameter(prefixed(prefix, "monopoleMomSeed"),
58 m_param_monopoleMomSeed,
59 "If non-zero, estimate seeds as for monopoles and set the momentum magnitude as this value.",
60 m_param_monopoleMomSeed);
61}
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< CDCTrack & >.

Definition at line 26 of file TrackExporter.cc.

27{
28 return "Creates a RecoTrack from each CDCTrack.";
29}

◆ 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

Signal initialisation phase to register store array for export.

Reimplemented from ProcessingSignalListener.

Definition at line 63 of file TrackExporter.cc.

64{
65 // Output StoreArray
66 if (m_param_exportTracks) {
67 StoreArray<RecoTrack> storedRecoTracks(m_param_exportTracksInto);
68 storedRecoTracks.registerInDataStore(DataStore::c_ErrorIfAlreadyRegistered);
69 RecoTrack::registerRequiredRelations(storedRecoTracks);
70 }
71 Super::initialize();
72}
Belle2::DataStore::c_ErrorIfAlreadyRegistered
@ c_ErrorIfAlreadyRegistered
If the object/array was already registered, produce an error (aborting initialisation).
Definition: DataStore.h:72
Belle2::RecoTrack::registerRequiredRelations
static void registerRequiredRelations(StoreArray< RecoTrack > &recoTracks, std::string const &pxdHitsStoreArrayName="", std::string const &svdHitsStoreArrayName="", std::string const &cdcHitsStoreArrayName="", std::string const &bklmHitsStoreArrayName="", std::string const &eklmHitsStoreArrayName="", std::string const &recoHitInformationStoreArrayName="")
Convenience method which registers all relations required to fully use a RecoTrack.
Definition: RecoTrack.cc:53
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_discardCovarianceMatrix

bool m_param_discardCovarianceMatrix = false
private

Parameter: Discard covariance matrix in favour of a hand written one.

Definition at line 53 of file TrackExporter.h.

◆ m_param_exportTracks

bool m_param_exportTracks = true
private

Parameter: Switch if a RecoTrack be generated for each track.

Definition at line 47 of file TrackExporter.h.

◆ m_param_exportTracksInto

std::string m_param_exportTracksInto = ""
private

Parameter: Name of the output StoreArray of the RecoTracks generated by this module.

Definition at line 50 of file TrackExporter.h.

◆ m_param_monopoleMomSeed

double m_param_monopoleMomSeed = 0.0
private

Parameter: If non-zero, estimate seeds as for monopoles and set the momentum magnitude as this value.

Definition at line 56 of file TrackExporter.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.

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