Belle II Software  release-08-01-10
MVAFilter< AVarSet > Class Template Reference

Convience template to create a mva filter for a set of variables. More...

#include <MVAFilter.dcl.h>

Inheritance diagram for MVAFilter< AVarSet >:
Collaboration diagram for MVAFilter< AVarSet >:

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

 MVAFilter (const std::string &defaultTrainingName="", double defaultCut=NAN, const std::string &defaultDBObjectName="")
 Constructor of the filter.
 
 ~MVAFilter ()
 Default destructor.
 
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 expert before event processing.
 
void beginRun () override
 Signal to load new run parameters.
 
Weight operator() (const Object &obj) override
 Function to object for its signalness.
 
virtual Weight operator() (const Object &obj)
 Function to evaluate the object. More...
 
Weight operator() (const Object *obj)
 Function to evaluate the object. More...
 
virtual double predict (const Object &obj)
 Evaluate the mva method.
 
bool needsTruthInformation () override
 Checks if any variables need Monte Carlo information.
 
std::unique_ptr< AVarSetreleaseVarSet () &&
 Steal the set of variables form this filter - filter becomes disfunctional afterwards.
 
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

AVarSetgetVarSet () 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 = MVA< Filter< typename AVarSet::Object > >
 Type of the super class.
 
using AVarSet = BaseVarSet< Object >
 Type of the variable set.
 

Private Attributes

std::string m_identifier
 Database identifier of the expert or weight file name.
 
double m_cutValue
 The cut on the MVA output.
 
std::string m_DBPayloadName
 Name of the DB payload.
 
std::unique_ptr< MVAExpertm_mvaExpert
 MVA Expert to examine the object.
 
std::unique_ptr< AVarSetm_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::MVAFilter< AVarSet >

Convience template to create a mva filter for a set of variables.

Definition at line 92 of file MVAFilter.dcl.h.

Member Function Documentation

◆ operator()() [1/2]

◆ operator()() [2/2]

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.


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