Belle II Software  release-08-01-10
WholeWireHitRelationFilter Class Reference

Class mapping the neighborhood of wires to the neighborhood of wire hits. More...

#include <WholeWireHitRelationFilter.h>

Inheritance diagram for WholeWireHitRelationFilter:
Collaboration diagram for WholeWireHitRelationFilter:

Public Types

using Object = AObject
 Type of the object to be analysed.
 
using Interface = Filter< AObject >
 Mark this class as the basic interface.
 

Public Member Functions

 WholeWireHitRelationFilter (int neighborhoodDegree=2)
 Constructor form the default neighborhood degree.
 
 ~WholeWireHitRelationFilter ()
 Default destructor.
 
void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) final
 Expose the parameters to a module.
 
std::vector< CDCWireHit * > getPossibleTos (CDCWireHit *from, const std::vector< CDCWireHit * > &wireHits) const final
 Returns a vector containing the neighboring wire hits of the given wire hit out of the sorted range given by the two iterator other argumets.
 
virtual std::vector< CDCWireHit * > getPossibleTos (CDCWireHit *from, const std::vector< CDCWireHit * > &objects) const
 Selects the objects possibly related to the given one from the given pool of objects.
 
virtual Weight operator() (const CDCWireHit &from, const CDCWireHit &to)
 Main filter method returning the weight of the neighborhood relation. More...
 
Weight operator() (const Relation< CDCWireHit > &relation) override
 Main filter method overriding the filter interface method. More...
 
virtual Weight operator() (const Object &obj)
 Function to evaluate the object. More...
 
Weight operator() (const Object *obj)
 Function to evaluate the object. More...
 
virtual bool needsTruthInformation ()
 Indicates if the filter requires Monte Carlo information.
 
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 = ProcessingSignalListener
 Type of the base class.
 

Private Attributes

int m_param_degree = 2
 Degree of the neighbor extend.
 
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 happend before.
 
bool m_terminated = false
 Flag to keep track whether termination happend before.
 
std::string m_initializedAs
 Name of the type during initialisation.
 

Detailed Description

Class mapping the neighborhood of wires to the neighborhood of wire hits.

Definition at line 26 of file WholeWireHitRelationFilter.h.

Member Function Documentation

◆ operator()() [1/4]

Weight operator() ( const AObject &  from,
const AObject &  to 
)
virtualinherited

Main filter method returning the weight of the neighborhood relation.

Return always returns NAN to reject all segment neighbors.

Definition at line 44 of file RelationFilter.icc.h.

◆ operator()() [2/4]

◆ operator()() [3/4]

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 58 of file Filter.icc.h.

◆ operator()() [4/4]

Weight operator() ( const Relation< AObject > &  relation)
overrideinherited

Main filter method overriding the filter interface method.

Checks the validity of the pointers in the relation and unpacks the relation to the method implementing the rejection.

Definition at line 51 of file RelationFilter.icc.h.


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