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

Filter for the constuction of track relations based on MC information. More...

#include <MCTrackRelationFilter.h>

Inheritance diagram for MCTrackRelationFilter:
Collaboration diagram for MCTrackRelationFilter:

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

 MCTrackRelationFilter (bool allowReverse=false)
 Constructor also setting the switch , if the reversed version of a track relation (in comparision to MC truth) shall be accepted.
 
Weight operator() (const CDCTrack &fromTrack, const CDCTrack &toTrack) final
 Checks if a track relation is a good combination.
 
void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
 Expose the set of parameters of the filter to the module parameter list.
 
void initialize () override
 Initialize the before event processing.
 
void beginEvent () override
 Signal the beginning of a new event.
 
bool needsTruthInformation () final
 Indicates that the filter requires Monte Carlo information.
 
virtual void setAllowReverse (bool allowReverse)
 Setter for the allow reverse parameter.
 
bool getAllowReverse () const
 Getter for the allow reverse parameter.
 
std::vector< const CDCTrack * > getPossibleTos (const CDCTrack *from, const std::vector< const CDCTrack * > &tracks) const final
 Reenforce that the full range of tracks is possible as no particular default is applicable.
 
virtual std::vector< const CDCTrack * > getPossibleTos (const CDCTrack *from, const std::vector< const CDCTrack * > &objects) const
 Selects the objects possibly related to the given one from the given pool of objects.
 
virtual Weight operator() (const const CDCTrack &from, const const CDCTrack &to)
 Main filter method returning the weight of the neighborhood relation. More...
 
Weight operator() (const Relation< const CDCTrack > &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...
 
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 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 = MCSymmetric< BaseTrackRelationFilter >
 Type of the super class.
 

Private Attributes

bool m_param_allowReverse
 Switch to indicate if the reversed version of the object shall also be accepted (default is true).
 
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

Filter for the constuction of track relations based on MC information.

Definition at line 22 of file MCTrackRelationFilter.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: