Belle II Software development
DATCONFPGAFindlet Class Referenceabstract

Findlet for performing the DATCON ROI calculation close to the implementation on FPGA. More...

#include <DATCONFPGAFindlet.h>

Inheritance diagram for DATCONFPGAFindlet:
Findlet<> 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

 DATCONFPGAFindlet ()
 Constructor for adding the subfindlets.
 
 ~DATCONFPGAFindlet ()
 Default destructor.
 
void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
 Expose the parameters of the sub findlets.
 
void apply () override
 Function to call all the sub-findlets.
 
void beginEvent () override
 Clear the object pools.
 
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 initialize () override
 Receive and dispatch signal before the start of the event processing.
 
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 = 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<>
 Parent class.
 

Private Attributes

SVDShaperDigitConverter m_digitConverter
 Findlets: Convert SVDShaperDigits into DATCONSVDDigits.
 
DATCONSVDClusterizer m_uClusterizer
 Cluster u-side strips.
 
DATCONSVDClusterizer m_vClusterizer
 Cluster v-side strips.
 
DATCONSVDClusterLoaderAndPreparer m_clusterLoaderAndPreparer
 Load DATCON SVDCluster (still the class is just a SVDCluster) created by the DATCONSVDClusterizer and calculate the quantities used in the Hough Trafo (intercept finding)
 
FastInterceptFinder2DFPGA m_uInterceptFinder
 Hough Space intercept finding for u-side.
 
FastInterceptFinder2DFPGA m_vInterceptFinder
 Hough Space intercept finding for v-side.
 
ToPXDExtrapolator m_toPXDExtrapolator
 Extrapolate found tracks to PXD sensors.
 
ROICalculator m_ROICalculator
 Calculate and store ROIs.
 
std::vector< DATCONSVDDigitm_uDigits
 vector containing u-side DATCONSVDDigits only
 
std::vector< DATCONSVDDigitm_vDigits
 vector containing v-side DATCONSVDDigits only
 
std::vector< SVDClusterm_uClusters
 vector containing u-side SVDClusters only
 
std::vector< SVDClusterm_vClusters
 vector containing v-side SVDClusters only
 
std::vector< std::pair< VxdID, std::pair< long, long > > > m_uHits
 vector containing the prepared u-side hits for intercept finding
 
std::vector< std::pair< VxdID, std::pair< long, long > > > m_vHits
 vector containing the prepared v-side hits for intercept finding
 
std::vector< std::pair< double, double > > m_uTracks
 u-side "tracks" from intercept finding, consisting of the x-y pair from the intercept in the 2D Hough Space
 
std::vector< std::pair< double, double > > m_vTracks
 v-side "tracks" from intercept finding, consisting of the x-y pair from the intercept in the 2D Hough Space
 
std::vector< std::pair< VxdID, long > > m_uExtrapolations
 Extrapolated hits in u direction.
 
std::vector< std::pair< VxdID, long > > m_vExtrapolations
 Extrapolated hits in v direction.
 
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 for performing the DATCON ROI calculation close to the implementation on FPGA.

Definition at line 35 of file DATCONFPGAFindlet.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 = TrackFindingCDC::Findlet<>
private

Parent class.

Definition at line 37 of file DATCONFPGAFindlet.h.

◆ ToVector

using ToVector = typename ToVectorImpl<T>::Type
protectedinherited

Short hand for ToRangeImpl.

Definition at line 49 of file Findlet.h.

Constructor & Destructor Documentation

◆ DATCONFPGAFindlet()

Constructor for adding the subfindlets.

Definition at line 18 of file DATCONFPGAFindlet.cc.

19{
28}
FastInterceptFinder2DFPGA m_uInterceptFinder
Hough Space intercept finding for u-side.
FastInterceptFinder2DFPGA m_vInterceptFinder
Hough Space intercept finding for v-side.
DATCONSVDClusterizer m_vClusterizer
Cluster v-side strips.
SVDShaperDigitConverter m_digitConverter
Findlets: Convert SVDShaperDigits into DATCONSVDDigits.
DATCONSVDClusterLoaderAndPreparer m_clusterLoaderAndPreparer
Load DATCON SVDCluster (still the class is just a SVDCluster) created by the DATCONSVDClusterizer and...
ToPXDExtrapolator m_toPXDExtrapolator
Extrapolate found tracks to PXD sensors.
DATCONSVDClusterizer m_uClusterizer
Cluster u-side strips.
ROICalculator m_ROICalculator
Calculate and store ROIs.
void addProcessingSignalListener(ProcessingSignalListener *psl)
Register a processing signal listener to be notified.

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 ( )
override

Function to call all the sub-findlets.

Definition at line 64 of file DATCONFPGAFindlet.cc.

65{
67 B2DEBUG(29, "m_uDigits.size(): " << m_uDigits.size() << " m_vDigits.size(): " << m_vDigits.size());
68
71 B2DEBUG(29, "m_uClusters.size(): " << m_uClusters.size() << " m_vClusters.size(): " << m_vClusters.size());
72
74 B2DEBUG(29, "m_uHits.size(): " << m_uHits.size() << " m_vHits.size(): " << m_vHits.size());
75
76 // hit vectors are empty in case of high occupancy, a warning is created in m_clusterLoader
77 if (m_uHits.empty() or m_vHits.empty()) {
78 return;
79 }
80
83
84 B2DEBUG(29, "m_uTracks.size(): " << m_uTracks.size() << " m_vTracks.size(): " << m_vTracks.size());
85
87
89
90 B2DEBUG(29, "Event statistics: uSVDDigits: " << m_uDigits.size() << " vSVDDigits: " << m_vDigits.size() << " uSVDClusters: " <<
91 m_uClusters.size() << " vSVDClusters: " << m_vClusters.size() << " uHits: " << m_uHits.size() << " vHits: " <<
92 m_vHits.size() << " uTracks: " << m_uTracks.size() << " vTracks: " << m_vTracks.size() <<
93 " uExtrapolations: " << m_uExtrapolations.size() << " vExtrapolations: " << m_vExtrapolations.size());
94}
std::vector< DATCONSVDDigit > m_uDigits
vector containing u-side DATCONSVDDigits only
std::vector< std::pair< double, double > > m_uTracks
u-side "tracks" from intercept finding, consisting of the x-y pair from the intercept in the 2D Hough...
std::vector< std::pair< VxdID, std::pair< long, long > > > m_uHits
vector containing the prepared u-side hits for intercept finding
std::vector< SVDCluster > m_uClusters
vector containing u-side SVDClusters only
std::vector< SVDCluster > m_vClusters
vector containing v-side SVDClusters only
std::vector< std::pair< VxdID, long > > m_vExtrapolations
Extrapolated hits in v direction.
std::vector< std::pair< VxdID, std::pair< long, long > > > m_vHits
vector containing the prepared v-side hits for intercept finding
std::vector< std::pair< VxdID, long > > m_uExtrapolations
Extrapolated hits in u direction.
std::vector< std::pair< double, double > > m_vTracks
v-side "tracks" from intercept finding, consisting of the x-y pair from the intercept in the 2D Hough...
std::vector< DATCONSVDDigit > m_vDigits
vector containing v-side DATCONSVDDigits only
void apply(const std::vector< SVDCluster > &uClusters, const std::vector< SVDCluster > &vClusters, std::vector< std::pair< VxdID, std::pair< long, long > > > &uHits, std::vector< std::pair< VxdID, std::pair< long, long > > > &vHits) override
Load the SVDClusters and create two vectors containing the hits prepared for intercept finding This f...
void apply(const std::vector< DATCONSVDDigit > &digits, std::vector< SVDCluster > &clusters) override
Load in the DATCONSVDDigits and create SVDClusters from them.
void apply(const std::vector< std::pair< VxdID, std::pair< long, long > > > &hits, std::vector< std::pair< double, double > > &tracks) override
Load in the prepared hits and create tracks for extrapolation to PXD.
void apply(const std::vector< std::pair< VxdID, long > > &uExtrapolations, const std::vector< std::pair< VxdID, long > > &vExtrapolations) override
Load in the prepared hits and create tracks for extrapolation to PXD.
void apply(std::vector< DATCONSVDDigit > &svdUDigits, std::vector< DATCONSVDDigit > &svdVDigits) override
Load in the reco tracks and the hits.
void apply(const std::vector< std::pair< double, double > > &uTracks, const std::vector< std::pair< double, double > > &vTracks, std::vector< std::pair< VxdID, long > > &uExtrapolations, std::vector< std::pair< VxdID, long > > &vExtrapolations) override
Load in the prepared hits and create tracks for extrapolation to PXD.

◆ beginEvent()

void beginEvent ( )
overridevirtual

Clear the object pools.

Reimplemented from ProcessingSignalListener.

Definition at line 47 of file DATCONFPGAFindlet.cc.

48{
50
51 m_uDigits.clear();
52 m_vDigits.clear();
53 m_uClusters.clear();
54 m_vClusters.clear();
55 m_uHits.clear();
56 m_vHits.clear();
57 m_uTracks.clear();
58 m_vTracks.clear();
59 m_uExtrapolations.clear();
60 m_vExtrapolations.clear();
61
62}
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.

◆ exposeParameters()

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

Expose the parameters of the sub findlets.

Reimplemented from Findlet<>.

Definition at line 30 of file DATCONFPGAFindlet.cc.

31{
32 Super::exposeParameters(moduleParamList, prefix);
33
34 m_digitConverter.exposeParameters(moduleParamList, prefix);
35 m_uClusterizer.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "uSide"));
36 m_vClusterizer.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "vSide"));
37
38 m_clusterLoaderAndPreparer.exposeParameters(moduleParamList, prefix);
39
40 m_uInterceptFinder.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "uSide"));
41 m_vInterceptFinder.exposeParameters(moduleParamList, TrackFindingCDC::prefixed(prefix, "vSide"));
42
43 m_toPXDExtrapolator.exposeParameters(moduleParamList, prefix);
44 m_ROICalculator.exposeParameters(moduleParamList, prefix);
45}
void exposeParameters(ModuleParamList *moduleParamList, const std::string &prefix) override
Expose the parameters of the sub findlets.
void exposeParameters(ModuleParamList *moduleParamList, const std::string &prefix) override
Expose the parameters of the sub findlets.
void exposeParameters(ModuleParamList *moduleParamList, const std::string &prefix) override
Expose the parameters of the sub findlets.
void exposeParameters(ModuleParamList *moduleParamList, const std::string &prefix) override
Expose the parameters of the sub findlets.
void exposeParameters(ModuleParamList *moduleParamList, const std::string &prefix) override
Expose the parameters of the sub findlets.
void exposeParameters(ModuleParamList *moduleParamList, const std::string &prefix) override
Expose the parameters of the sub findlets.
virtual void exposeParameters(ModuleParamList *moduleParamList, const std::string &prefix)
Forward prefixed parameters of this findlet to the module parameter list.
Definition: Findlet.h:69

◆ getDescription()

virtual std::string getDescription ( )
inlinevirtualinherited

Brief description of the purpose of the concrete findlet.

Reimplemented in CosmicsTrackMergerFindlet, TrackFinderCosmics, TrackFinder, TrackFinderAutomaton, and FindletStoreArrayInput< TWrappedFindlet >.

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}

◆ initialize()

void initialize ( )
overridevirtualinherited

Receive and dispatch signal before the start of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in UnionVarSet< AObject >, UnionVarSet< Object >, VariadicUnionVarSet< AVarSets >, ResultStorer< Belle2::CKFToPXDResult >, ResultStorer< Belle2::CKFToSVDResult >, BaseEventTimeExtractor< RecoTrack * >, BaseEventTimeExtractor< TrackFindingCDC::CDCWireHit & >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >, OnVarSet< Filter< ATruthVarSet::Object > >, OnVarSet< Filter< AVarSet::Object > >, OnVarSet< BaseFacetFilter >, OnVarSet< BaseFacetRelationFilter >, OnVarSet< BaseAxialSegmentPairFilter >, OnVarSet< BaseSegmentRelationFilter >, OnVarSet< BaseTrackRelationFilter >, OnVarSet< BaseSegmentPairRelationFilter >, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseFacetFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, StoreArrayLoader< const Belle2::SpacePoint >, StoreArrayLoader< DataStoreInputTypeRefType >, 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 >, RelationVarSet< ABaseVarSet >, QualityIndicatorFilter, TwoHitVirtualIPQIFilter, MultiHoughSpaceFastInterceptFinder, RawTrackCandCleaner< AHit >, RawTrackCandCleaner< Belle2::vxdHoughTracking::VXDHoughState >, RecoTrackStorer, ROIFinder, SingleHoughSpaceFastInterceptFinder, SpacePointLoaderAndPreparer, TrackCandidateOverlapResolver, and TrackCandidateResultRefiner.

Definition at line 15 of file CompositeProcessingSignalListener.cc.

16{
19 psl->initialize();
20 }
21}
virtual void initialize()
Receive signal before the start of the event processing.

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

DATCONSVDClusterLoaderAndPreparer m_clusterLoaderAndPreparer
private

Load DATCON SVDCluster (still the class is just a SVDCluster) created by the DATCONSVDClusterizer and calculate the quantities used in the Hough Trafo (intercept finding)

Definition at line 67 of file DATCONFPGAFindlet.h.

◆ m_digitConverter

SVDShaperDigitConverter m_digitConverter
private

Findlets: Convert SVDShaperDigits into DATCONSVDDigits.

Definition at line 58 of file DATCONFPGAFindlet.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_ROICalculator

ROICalculator m_ROICalculator
private

Calculate and store ROIs.

Definition at line 78 of file DATCONFPGAFindlet.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_toPXDExtrapolator

ToPXDExtrapolator m_toPXDExtrapolator
private

Extrapolate found tracks to PXD sensors.

Definition at line 75 of file DATCONFPGAFindlet.h.

◆ m_uClusterizer

DATCONSVDClusterizer m_uClusterizer
private

Cluster u-side strips.

Definition at line 61 of file DATCONFPGAFindlet.h.

◆ m_uClusters

std::vector<SVDCluster> m_uClusters
private

vector containing u-side SVDClusters only

Definition at line 88 of file DATCONFPGAFindlet.h.

◆ m_uDigits

std::vector<DATCONSVDDigit> m_uDigits
private

vector containing u-side DATCONSVDDigits only

Definition at line 83 of file DATCONFPGAFindlet.h.

◆ m_uExtrapolations

std::vector<std::pair<VxdID, long> > m_uExtrapolations
private

Extrapolated hits in u direction.

Definition at line 105 of file DATCONFPGAFindlet.h.

◆ m_uHits

std::vector<std::pair<VxdID, std::pair<long, long> > > m_uHits
private

vector containing the prepared u-side hits for intercept finding

Definition at line 93 of file DATCONFPGAFindlet.h.

◆ m_uInterceptFinder

FastInterceptFinder2DFPGA m_uInterceptFinder
private

Hough Space intercept finding for u-side.

Definition at line 70 of file DATCONFPGAFindlet.h.

◆ m_uTracks

std::vector<std::pair<double, double> > m_uTracks
private

u-side "tracks" from intercept finding, consisting of the x-y pair from the intercept in the 2D Hough Space

Definition at line 99 of file DATCONFPGAFindlet.h.

◆ m_vClusterizer

DATCONSVDClusterizer m_vClusterizer
private

Cluster v-side strips.

Definition at line 63 of file DATCONFPGAFindlet.h.

◆ m_vClusters

std::vector<SVDCluster> m_vClusters
private

vector containing v-side SVDClusters only

Definition at line 90 of file DATCONFPGAFindlet.h.

◆ m_vDigits

std::vector<DATCONSVDDigit> m_vDigits
private

vector containing v-side DATCONSVDDigits only

Definition at line 85 of file DATCONFPGAFindlet.h.

◆ m_vExtrapolations

std::vector<std::pair<VxdID, long> > m_vExtrapolations
private

Extrapolated hits in v direction.

Definition at line 107 of file DATCONFPGAFindlet.h.

◆ m_vHits

std::vector<std::pair<VxdID, std::pair<long, long> > > m_vHits
private

vector containing the prepared v-side hits for intercept finding

Definition at line 95 of file DATCONFPGAFindlet.h.

◆ m_vInterceptFinder

FastInterceptFinder2DFPGA m_vInterceptFinder
private

Hough Space intercept finding for v-side.

Definition at line 72 of file DATCONFPGAFindlet.h.

◆ m_vTracks

std::vector<std::pair<double, double> > m_vTracks
private

v-side "tracks" from intercept finding, consisting of the x-y pair from the intercept in the 2D Hough Space

Definition at line 102 of file DATCONFPGAFindlet.h.


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