Belle II Software development
SensorSVDPairFilter Class Reference

Base filter for CKF SVD states. More...

#include <SensorSVDPairFilter.h>

Inheritance diagram for SensorSVDPairFilter:
Filter< std::pair< const CKFToSVDState *, const CKFToSVDState * > > CompositeProcessingSignalListener ProcessingSignalListener

Public Types

using Object
 Type of the object to be analysed.
 
using Object
 Type of the object to be analysed.
 
using Interface
 Mark this class as the basic interface.
 
using Interface
 Mark this class as the basic interface.
 

Public Member Functions

TrackFindingCDC::Weight operator() (const std::pair< const CKFToSVDState *, const CKFToSVDState * > &relation) override
 Return the weight based on layer.
 
void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
 Expose the parameters.
 
virtual bool needsTruthInformation ()
 Indicates if the filter requires Monte Carlo information.
 
virtual bool needsTruthInformation ()
 Indicates if the filter requires Monte Carlo information.
 
virtual Weight operator() (const Object &obj)
 Function to evaluate the object.
 
Weight operator() (const Object *obj)
 Function to evaluate the object.
 
virtual std::vector< float > operator() (const std::vector< Object * > &objs)
 Function to evaluate a vector of objects Base implementation applies the function to each object.
 
virtual Weight operator() (const Object &obj)
 Function to evaluate the object.
 
Weight operator() (const Object *obj)
 Function to evaluate the object.
 
virtual std::vector< float > operator() (const std::vector< Object * > &objs)
 Function to evaluate a vector of objects Base implementation applies the function to each object.
 
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 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 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
 Type of the base class.
 

Private Attributes

double m_param_PhiRecoTrackToHitCut = 0.5
 Pre-filter relations in phi between seed states and hit states.
 
double m_param_PhiHitHitCut = 1.14159265359
 Pre-filter relations in theta between hit states.
 
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

Base filter for CKF SVD states.

Definition at line 19 of file SensorSVDPairFilter.h.

Member Typedef Documentation

◆ Interface [1/2]

using Interface
inherited

Mark this class as the basic interface.

Definition at line 38 of file Filter.dcl.h.

◆ Interface [2/2]

using Interface
inherited

Mark this class as the basic interface.

Definition at line 38 of file Filter.dcl.h.

◆ Object [1/2]

using Object
inherited

Type of the object to be analysed.

Definition at line 35 of file Filter.dcl.h.

◆ Object [2/2]

using Object
inherited

Type of the object to be analysed.

Definition at line 35 of file Filter.dcl.h.

◆ Super

using Super
privateinherited

Type of the base class.

Definition at line 26 of file CompositeProcessingSignalListener.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{
58}
Base class for filters on a generic object type.
Definition Filter.dcl.h:31

◆ beginEvent()

void beginEvent ( )
overrideinherited

Receive and dispatch signal for the start of a new event.

Definition at line 36 of file CompositeProcessingSignalListener.cc.

32{
35 psl->beginEvent();
36 }
37}
void beginEvent() override
Receive and dispatch signal for the start of a new event.
virtual void beginEvent()
Receive signal for the start of a new event.

◆ beginRun()

void beginRun ( )
overrideinherited

Receive and dispatch signal for the beginning of a new run.

Definition at line 33 of file CompositeProcessingSignalListener.cc.

24{
27 psl->beginRun();
28 }
29}
void beginRun() override
Receive and dispatch signal for the beginning of a new run.
virtual void beginRun()
Receive signal for the beginning of a new run.

◆ endRun()

void endRun ( )
overrideinherited

Receive and dispatch signal for the end of the run.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

40{
42 psl->endRun();
43 }
45}
void endRun() override
Receive and dispatch signal for the end of the run.
virtual void endRun()
Receive signal for the end of the run.

◆ exposeParameters()

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

Expose the parameters.

Reimplemented from CompositeProcessingSignalListener.

Definition at line 76 of file SensorSVDPairFilter.cc.

77{
78 moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "phiRecoTrackToHitCut"), m_param_PhiRecoTrackToHitCut,
79 "Cut in phi for the difference between RecoTrack (seed) mSoP and current hit-based state.", m_param_PhiRecoTrackToHitCut);
80 moduleParamList->addParameter(TrackFindingCDC::prefixed(prefix, "phiHitHitCut"), m_param_PhiHitHitCut,
81 "Cut in phi between two hit-based states.", m_param_PhiHitHitCut);
82}
double m_param_PhiHitHitCut
Pre-filter relations in theta between hit states.
double m_param_PhiRecoTrackToHitCut
Pre-filter relations in phi between seed states and hit states.
void addParameter(const std::string &name, T &paramVariable, const std::string &description, const T &defaultValue)
Adds a new parameter to the module list.

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )
protectedinherited

Get the number of currently registered listeners.

Definition at line 56 of file CompositeProcessingSignalListener.cc.

61{
63}

◆ initialize()

void initialize ( )
overrideinherited

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

Definition at line 30 of file CompositeProcessingSignalListener.cc.

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

◆ needsTruthInformation()

bool needsTruthInformation ( )
virtualinherited

Indicates if the filter requires Monte Carlo information.

Definition at line 48 of file Filter.icc.h.

41 {
42 return false;
43 }

◆ operator()() [1/7]

TrackFindingCDC::Weight operator() ( const std::pair< const CKFToSVDState *, const CKFToSVDState * > & relation)
override

Return the weight based on layer.

Definition at line 20 of file SensorSVDPairFilter.cc.

21{
22 const CKFToSVDState& fromState = *(relation.first);
23 const CKFToSVDState& toState = *(relation.second);
24
25 const CKFToSVDState::stateCache& fromStateCache = fromState.getStateCache();
26 const CKFToSVDState::stateCache& toStateCache = toState.getStateCache();
27
28 B2ASSERT("You have filled the wrong states into this!", toStateCache.isHitState);
29
30 if (not fromStateCache.isHitState) {
31 // We are coming from a CDC track, so we can use its position to only look for matching ladders
32 // This is done with the sensorCenterPhi, using the state's phi (and/or theta) wouldn't be a SensorFilter anymore.
33 float phiDiff = fromStateCache.phi - toStateCache.sensorCenterPhi;
34 while (phiDiff > M_PI) phiDiff -= 2. * M_PI;
35 while (phiDiff < -M_PI) phiDiff += 2. * M_PI;
36
37 if (fabs(phiDiff) < static_cast<float>(m_param_PhiRecoTrackToHitCut)) {
38 return 1.0;
39 }
40 // If the current state (fromState) is a RecoTrack-based state, but no relations could be created
41 // don't proceed but return
42 return NAN;
43 }
44
45 // On same layer we already know from LayerSVDRelationFilter, that we only deal with overlaps in r-phi.
46 // So it's sufficient here to check for same layer number to accept states in the overlap region.
47 if (fromStateCache.geoLayer == toStateCache.geoLayer and
48 fromStateCache.sensorID.getSensorNumber() == toStateCache.sensorID.getSensorNumber()) {
49 // TODO: Also check for sensors?
50 return 1.0;
51 }
52
53 // Next layer is not an overlap one, so we can just return all hits of the next layer(s)
54 // that are close enough in phi. No cut in theta here since this is the SensorSVXDPairFilter,
55 // a cut in theta is used in the DistanceSVDPairFilter
56 const int sensorNumberDifference =
57 static_cast<int>(fromStateCache.sensorID.getSensorNumber()) - static_cast<int>(toStateCache.sensorID.getSensorNumber());
58 const int layerNumberDifference =
59 static_cast<int>(fromStateCache.geoLayer) - static_cast<int>(toStateCache.geoLayer);
60
61 if ((abs(sensorNumberDifference) > 1 and layerNumberDifference == 1) or (abs(sensorNumberDifference) > 2)) {
62 return NAN;
63 }
64
65 float phiDiff = fromStateCache.sensorCenterPhi - toStateCache.sensorCenterPhi;
66 while (phiDiff > M_PI) phiDiff -= 2. * M_PI;
67 while (phiDiff < -M_PI) phiDiff += 2. * M_PI;
68
69 if (fabs(phiDiff) < static_cast<float>(m_param_PhiHitHitCut)) {
70 return 1.0;
71 }
72
73 return NAN;
74}
const struct stateCache & getStateCache() const
Get the cached data of this state.

◆ operator()() [2/7]

virtual Weight operator() ( const Object & obj)
virtualinherited

Function to evaluate the object.

Base implementation accepts all objects.

Parameters
objThe object to be accepted or rejected.
Returns
A finite float value if the object is accepted. NAN if the object is rejected.

◆ operator()() [3/7]

Weight operator() ( const Object & obj)
virtualinherited

Function to evaluate the object.

Base implementation accepts all objects.

Parameters
objThe object to be accepted or rejected.
Returns
A finite float value if the object is accepted. NAN if the object is rejected.

Definition at line 59 of file Filter.icc.h.

47 {
48 return 1;
49 }

◆ operator()() [4/7]

Weight operator() ( const Object * obj)
inherited

Function to evaluate the object.

Base implementation accepts all objects, except nullptr.

Parameters
objThe object to be accepted or rejected.
Returns
A finit float value if the object is accepted. NAN if the object is rejected. Nullptr is always rejected.

◆ operator()() [5/7]

Weight operator() ( const Object * obj)
inherited

Function to evaluate the object.

Base implementation accepts all objects, except nullptr.

Parameters
objThe object to be accepted or rejected.
Returns
A finit float value if the object is accepted. NAN if the object is rejected. Nullptr is always rejected.

Definition at line 69 of file Filter.icc.h.

53 {
54 return obj ? operator()(*obj) : NAN;
55 }

◆ operator()() [6/7]

virtual std::vector< float > operator() ( const std::vector< Object * > & objs)
virtualinherited

Function to evaluate a vector of objects Base implementation applies the function to each object.

Can be optimized for MVA filters

Parameters
objsA vector of pointers to objects
Returns
A vector of float or NAN values. See above

◆ operator()() [7/7]

std::vector< float > operator() ( const std::vector< Object * > & objs)
virtualinherited

Function to evaluate a vector of objects Base implementation applies the function to each object.

Can be optimized for MVA filters

Parameters
objsA vector of pointers to objects
Returns
A vector of float or NAN values. See above

Definition at line 77 of file Filter.icc.h.

59 {
60 std::vector<float> out;
61 for (const auto& obj : objs) {
62 out.push_back(operator()(obj));
63 }
64 return out;
65 }

◆ terminate()

void terminate ( )
overrideinherited

Receive and dispatch Signal for termination of the event processing.

Definition at line 42 of file CompositeProcessingSignalListener.cc.

48{
50 psl->terminate();
51 }
53}
void terminate() override
Receive and dispatch Signal for termination of the event processing.
virtual void terminate()
Receive Signal for termination of the event processing.

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_PhiHitHitCut

double m_param_PhiHitHitCut = 1.14159265359
private

Pre-filter relations in theta between hit states.

Definition at line 30 of file SensorSVDPairFilter.h.

◆ m_param_PhiRecoTrackToHitCut

double m_param_PhiRecoTrackToHitCut = 0.5
private

Pre-filter relations in phi between seed states and hit states.

Definition at line 28 of file SensorSVDPairFilter.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: