Belle II Software development
StoreArrayMerger Class Referenceabstract

This findlet has helper function to. More...

#include <StoreArrayMerger.h>

Inheritance diagram for StoreArrayMerger:
Findlet< RecoTrack *, RecoTrack * > 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

void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
 Expose the parameters of the findlet.
 
void initialize () override
 Require/register the store arrays.
 
void apply (std::vector< RecoTrack * > &cdcRecoTrackVector, std::vector< RecoTrack * > &vxdRecoTrackVector) override
 Fetch the RecoTracks from the two input Store Arrays and fill them into two vectors.
 
void removeCDCRecoTracksWithPartner (std::vector< RecoTrack * > &tracks)
 Helper function to remove all tracks, which have a related VXD track from the vector.
 
void removeVXDRecoTracksWithPartner (std::vector< RecoTrack * > &tracks)
 Helper function to remove all tracks, which have a related CDC track from the vector.
 
const std::string & getVXDStoreArrayName ()
 Get the name of the VXD StoreArray<RecoTrack>
 
const std::string & getCDCStoreArrayName ()
 Get the name of the CDC StoreArray<RecoTrack>
 
virtual std::string getDescription ()
 Brief description of the purpose of the concrete findlet.
 
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 = TrackFindingCDC::Findlet< RecoTrack *, RecoTrack * >
 The parent class.
 

Private Member Functions

void removeRecoTracksWithPartner (std::vector< RecoTrack * > &tracks, const std::string &partnerStoreArrayName)
 Helper function to remove all element in a std::vector, which have already a relation to the given store array.
 

Private Attributes

std::string m_param_vxdRecoTrackStoreArrayName
 StoreArray name of the VXD Track Store Array.
 
std::string m_param_cdcRecoTrackStoreArrayName
 StoreArray name of the CDC Track Store Array.
 
StoreArray< RecoTrackm_cdcRecoTracks
 CDC Reco Tracks Store Array.
 
StoreArray< RecoTrackm_vxdRecoTracks
 VXD Reco Tracks Store Array.
 
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

This findlet has helper function to.

  • remove all tracks which have already a related partner from a std::vector of CDC tracks
  • ... and of VXD tracks
  • fetch the RecoTracks from a StoreArray and write their pointers into two std::vectors

Definition at line 27 of file StoreArrayMerger.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

The parent class.

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

◆ apply()

void apply ( std::vector< RecoTrack * > &  cdcRecoTrackVector,
std::vector< RecoTrack * > &  vxdRecoTrackVector 
)
override

Fetch the RecoTracks from the two input Store Arrays and fill them into two vectors.

Definition at line 40 of file StoreArrayMerger.cc.

41{
42 cdcRecoTrackVector.reserve(m_cdcRecoTracks.getEntries());
43 vxdRecoTrackVector.reserve(m_vxdRecoTracks.getEntries());
44
45 for (RecoTrack& recoTrack : m_cdcRecoTracks) {
46 cdcRecoTrackVector.push_back(&recoTrack);
47 }
48
49 for (RecoTrack& recoTrack : m_vxdRecoTracks) {
50 vxdRecoTrackVector.push_back(&recoTrack);
51 }
52}
This is the Reconstruction Event-Data Model Track.
Definition: RecoTrack.h:79
StoreArray< RecoTrack > m_vxdRecoTracks
VXD Reco Tracks Store Array.
StoreArray< RecoTrack > m_cdcRecoTracks
CDC Reco Tracks Store Array.
int getEntries() const
Get the number of objects in the array.
Definition: StoreArray.h:216

◆ 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{
35 psl->beginEvent();
36 }
37}
Interface for an algorithm part that needs to receive the module processing signals.
virtual void beginEvent()
Receive 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}
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.

◆ exposeParameters()

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

Expose the parameters of the findlet.

Reimplemented from Findlet< RecoTrack *, RecoTrack * >.

Definition at line 17 of file StoreArrayMerger.cc.

18{
19 Super::exposeParameters(moduleParamList, prefix);
20
21 // CDC input tracks
22 moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "CDCRecoTrackStoreArrayName"), m_param_cdcRecoTrackStoreArrayName,
23 "StoreArray name of the CDC Track Store Array", m_param_cdcRecoTrackStoreArrayName);
24 // VXD input tracks
25 moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "VXDRecoTrackStoreArrayName"), m_param_vxdRecoTrackStoreArrayName,
26 "StoreArray name of the VXD Track Store Array", m_param_vxdRecoTrackStoreArrayName);
27}
std::string m_param_cdcRecoTrackStoreArrayName
StoreArray name of the CDC Track Store Array.
std::string m_param_vxdRecoTrackStoreArrayName
StoreArray name of the VXD Track Store Array.
virtual void exposeParameters(ModuleParamList *moduleParamList, const std::string &prefix)
Forward prefixed parameters of this findlet to the module parameter list.
Definition: Findlet.h:69
void addParameter(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module list.

◆ getCDCStoreArrayName()

const std::string & getCDCStoreArrayName ( )
inline

Get the name of the CDC StoreArray<RecoTrack>

Definition at line 49 of file StoreArrayMerger.h.

◆ getDescription()

virtual std::string getDescription ( )
inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

Definition at line 60 of file Findlet.h.

61 {
62 return "(no description)";
63 }

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )
protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

61{
63}

◆ getVXDStoreArrayName()

const std::string & getVXDStoreArrayName ( )
inline

Get the name of the VXD StoreArray<RecoTrack>

Definition at line 47 of file StoreArrayMerger.h.

◆ initialize()

void initialize ( )
overridevirtual

Require/register the store arrays.

Reimplemented from ProcessingSignalListener.

Definition at line 29 of file StoreArrayMerger.cc.

30{
33
36
38}
bool isRequired(const std::string &name="")
Ensure this array/object has been registered previously.
bool registerRelationTo(const StoreArray< TO > &toArray, DataStore::EDurability durability=DataStore::c_Event, DataStore::EStoreFlags storeFlags=DataStore::c_WriteOut, const std::string &namedRelation="") const
Register a relation to the given StoreArray.
Definition: StoreArray.h:140
void initialize() override
Receive and dispatch signal before the start of the event processing.

◆ removeCDCRecoTracksWithPartner()

void removeCDCRecoTracksWithPartner ( std::vector< RecoTrack * > &  tracks)

Helper function to remove all tracks, which have a related VXD track from the vector.

Definition at line 54 of file StoreArrayMerger.cc.

55{
57}
void removeRecoTracksWithPartner(std::vector< RecoTrack * > &tracks, const std::string &partnerStoreArrayName)
Helper function to remove all element in a std::vector, which have already a relation to the given st...

◆ removeRecoTracksWithPartner()

void removeRecoTracksWithPartner ( std::vector< RecoTrack * > &  tracks,
const std::string &  partnerStoreArrayName 
)
private

Helper function to remove all element in a std::vector, which have already a relation to the given store array.

Definition at line 64 of file StoreArrayMerger.cc.

65{
66 const auto& trackHasAlreadyRelations = [&partnerStoreArrayName](const RecoTrack * recoTrack) {
67 return recoTrack->getRelated<RecoTrack>(partnerStoreArrayName) != nullptr;
68 };
69
70 TrackFindingCDC::erase_remove_if(tracks, trackHasAlreadyRelations);
71}

◆ removeVXDRecoTracksWithPartner()

void removeVXDRecoTracksWithPartner ( std::vector< RecoTrack * > &  tracks)

Helper function to remove all tracks, which have a related CDC track from the vector.

Definition at line 59 of file StoreArrayMerger.cc.

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

Member Data Documentation

◆ m_cdcRecoTracks

StoreArray<RecoTrack> m_cdcRecoTracks
private

CDC Reco Tracks Store Array.

Definition at line 60 of file StoreArrayMerger.h.

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

std::string m_param_cdcRecoTrackStoreArrayName
private

StoreArray name of the CDC Track Store Array.

Definition at line 56 of file StoreArrayMerger.h.

◆ m_param_vxdRecoTrackStoreArrayName

std::string m_param_vxdRecoTrackStoreArrayName
private

StoreArray name of the VXD Track Store Array.

Definition at line 54 of file StoreArrayMerger.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_vxdRecoTracks

StoreArray<RecoTrack> m_vxdRecoTracks
private

VXD Reco Tracks Store Array.

Definition at line 62 of file StoreArrayMerger.h.


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