Convience template to create a filter operating on a specific set of variables. More...

#include <FilterOnVarSet.dcl.h>

Inheritance diagram for FilterOnVarSet< AVarSet >:

[legend]

Collaboration diagram for FilterOnVarSet< AVarSet >:

[legend]

Public Types
using	Object = typename AVarSet::Object
	Type of the object to be analysed.

using	Interface = Filter< AObject >
	Mark this class as the basic interface.

Public Member Functions
	FilterOnVarSet ()
	Constructor of the filter.

	~FilterOnVarSet ()
	Default destructor.

void	initialize () override
	No reassignment of variable set possible for now.

bool	needsTruthInformation () override
	Checks if any variables need Monte Carlo information.

Weight	operator() (const Object &obj) override
	Function extracting the variables of the object into the variable set.

virtual Weight	operator() (const Object &obj)
	Function to evaluate the object. More...

Weight	operator() (const Object *obj)
	Function to evaluate the object. More...

std::unique_ptr< AVarSet >	releaseVarSet () &&
	Steal the set of variables form this filter - filter becomes disfunctional afterwards.

virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix)
	Expose the set of parameters of the filter to the module parameter list. More...

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
AVarSet &	getVarSet () const
	Getter for the set of variables.

void	setVarSet (std::unique_ptr< AVarSet > varSet)
	Setter for the set of variables.

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 = OnVarSet< Filter< typename AVarSet::Object > >
	Type of the super class.

using	AVarSet = BaseVarSet< Object >
	Type of the variable set usedi in this filter.

Private Attributes
std::unique_ptr< AVarSet >	m_varSet
	Instance of the variable set to be used in the filter.

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 AVarSet>
class Belle2::TrackFindingCDC::FilterOnVarSet< AVarSet >

Convience template to create a filter operating on a specific set of variables.

Definition at line 88 of file FilterOnVarSet.dcl.h.

Member Function Documentation

◆ exposeParameters()

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

virtualinherited

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.

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

◆ operator()() [1/2]

Weight operator() ( const Object & obj )

virtualinherited

Function to evaluate the object.

Base implementation accepts all objects.

Parameters

obj	The object to be accepted or rejected.

Returns: A finite float value if the object is accepted. NAN if the object is rejected.

Reimplemented in AllSVDStateFilter, SimpleSVDStateFilter, ResidualSVDStateFilter, AllPXDStateFilter, SimplePXDStateFilter, TwoHitVirtualIPQIFilter, TwoHitVirtualIPFilter, ThreeHitFilter, QualityIndicatorFilter, FourHitFilter, FiveHitFilter, RoughCDCStateFilter, RoughCDCfromEclStateFilter, MCTruthEclSeedFilter, MCTruthCDCStateFilter, ExtrapolateAndUpdateCDCStateFilter, DistanceCDCStateFilter, MCTruthCDCPathPairFilter, HitDistanceBasedCDCPathPairFilter, DuplicateCDCPathPairFilter, DistanceBasedCDCPathPairFilter, Chi2BasedCDCPathPairFilter, ArcLengthBasedCDCPathPairFilter, ArcLengthBasedCDCfromEclPathPairFilter, SizeCDCPathFilter, and SeedChargeCDCPathFilter.

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

◆ operator()() [2/2]

Weight operator() ( const Object * obj )

inherited

Function to evaluate the object.

Base implementation accepts all objects, except nullptr.

Parameters

obj	The 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.

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

tracking/trackFindingCDC/filters/base/include/FilterOnVarSet.dcl.h
tracking/trackFindingCDC/filters/base/include/FilterOnVarSet.icc.h

Public Types

Public Member Functions

Protected Member Functions

Private Types