Belle II Software  release-05-01-25
Filter< AObject > Class Template Reference

Base class for filters on a generic object type. More...

#include <Filter.dcl.h>

Inheritance diagram for Filter< AObject >:
Collaboration diagram for Filter< AObject >:

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

 Filter ()
 Default constructor.
 
virtual ~Filter ()
 Make destructor of interface class virtual.
 
virtual void exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
 Expose the set of parameters of the filter to the module parameter list. More...
 
virtual bool needsTruthInformation ()
 Indicates if the filter requires Monte Carlo information.
 
virtual Weight operator() (const Object &obj)
 Function to evaluate the object. More...
 
Weight operator() (const Object *obj)
 Function to evaluate the object. More...
 
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

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

template<class AObject>
class Belle2::TrackFindingCDC::Filter< AObject >

Base class for filters on a generic object type.

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

Member Function Documentation

◆ exposeParameters()

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

Expose the set of parameters of the filter to the module parameter list.

Note that not all filters have yet exposed their parameters in this way.

This method is deprecated as the exposeParams below uses a less compile heavy equivalent.

Reimplemented in ChoosableFromVarSet< Filter< ATruthVarSet::Object > >, ChoosableFromVarSet< Filter< PXDResultVarSet ::Object > >, ChoosableFromVarSet< Filter< SVDResultVarSet ::Object > >, Recording< Filter< AVarSet::Object > >, MVA< Filter< MVAFeasibleSegmentPairVarSet ::Object > >, MVA< BaseAxialSegmentPairFilter >, MVA< Filter< MVARealisticSegmentPairVarSet ::Object > >, MVA< BaseSegmentPairRelationFilter >, MVA< BaseTrackRelationFilter >, MVA< BaseSegmentRelationFilter >, MVA< Filter< BasicClusterVarSet ::Object > >, MVA< BaseFacetRelationFilter >, MVA< BaseFacetFilter >, MVA< Filter< AVarSet::Object > >, AdvanceFilter< AState, AnAdvancer >, DuplicateCDCPathPairFilter, BridgingWireHitRelationFilter, Chi2FacetRelationFilter, SimpleFacetRelationFilter, MCSymmetric< BaseAxialSegmentPairFilter >, MCSymmetric< BaseSegmentPairFilter >, MCSymmetric< BaseSegmentTripleRelationFilter >, MCSymmetric< BaseSegmentPairRelationFilter >, MCSymmetric< BaseTrackRelationFilter >, MCSymmetric< BaseSegmentTripleFilter >, MCSymmetric< BaseSegmentRelationFilter >, MCSymmetric< BaseFacetRelationFilter >, MCSymmetric< BaseFacetFilter >, LayerPXDRelationFilter< AFilter, APrefilter >, ExtrapolateAndUpdateCDCStateFilter, PhiTrackRelationFilter, PhiRecoTrackRelationFilter, RoughCDCfromEclStateFilter, RoughCDCStateFilter, ResidualSVDStateFilter, DistanceCDCStateFilter, LoosePXDPairFilter, SensorPXDPairFilter, LooseSVDPairFilter, SensorSVDPairFilter, Chi2FacetFilter, FeasibleRLFacetFilter, RealisticFacetFilter, SimpleFacetFilter, MCFacetRelationFilter, LayerSVDRelationFilter< AFilter, APrefilter >, MCSegmentTripleFilter, SectorMapBasedSVDPairFilter, WholeWireHitRelationFilter, MCAxialSegmentPairFilter, MCSegmentPairRelationFilter, MCSegmentRelationFilter, MCSegmentTripleRelationFilter, and MCSegmentPairFilter.

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

◆ operator()() [1/2]

virtual Weight operator() ( const Object obj)
virtual

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.

Reimplemented in RelationFilter< AObject >, MVA< Filter< MVAFeasibleSegmentPairVarSet ::Object > >, MVA< BaseAxialSegmentPairFilter >, MVA< Filter< MVARealisticSegmentPairVarSet ::Object > >, MVA< BaseSegmentPairRelationFilter >, MVA< BaseTrackRelationFilter >, MVA< BaseSegmentRelationFilter >, MVA< Filter< BasicClusterVarSet ::Object > >, MVA< BaseFacetRelationFilter >, MVA< BaseFacetFilter >, MVA< Filter< AVarSet::Object > >, OnVarSet< Filter< MVAFeasibleSegmentPairVarSet ::Object > >, OnVarSet< BaseAxialSegmentPairFilter >, OnVarSet< Filter< ATruthVarSet::Object > >, OnVarSet< Filter< PXDResultVarSet ::Object > >, OnVarSet< Filter< MVARealisticSegmentPairVarSet ::Object > >, OnVarSet< BaseSegmentPairRelationFilter >, OnVarSet< BaseTrackRelationFilter >, OnVarSet< BaseSegmentRelationFilter >, OnVarSet< Filter< SkimmedHitGapSegmentPairVarSet ::Object > >, OnVarSet< Filter< SVDResultVarSet ::Object > >, OnVarSet< Filter< BasicClusterVarSet ::Object > >, OnVarSet< BaseFacetRelationFilter >, OnVarSet< BaseFacetFilter >, OnVarSet< Filter< AVarSet::Object > >, Recording< Filter< AVarSet::Object > >, MCSegmentTripleFilter, SimpleSegmentTripleFilter, AllSegmentTripleFilter, MCSegmentPairFilter, SimpleSegmentPairFilter, AllSegmentPairFilter, AllSVDStateFilter, SimpleSVDStateFilter, ResidualSVDStateFilter, AllPXDStateFilter, SimplePXDStateFilter, ExtrapolateAndUpdateCDCStateFilter, RoughCDCfromEclStateFilter, RoughCDCStateFilter, MCTruthEclSeedFilter, DistanceCDCStateFilter, MCTruthCDCStateFilter, DuplicateCDCPathPairFilter, DistanceBasedCDCPathPairFilter, HitDistanceBasedCDCPathPairFilter, MCTruthCDCPathPairFilter, ArcLengthBasedCDCfromEclPathPairFilter, ArcLengthBasedCDCPathPairFilter, Chi2BasedCDCPathPairFilter, SeedChargeCDCPathFilter, and SizeCDCPathFilter.

◆ operator()() [2/2]

Weight operator() ( const Object obj)

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


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