Belle II Software  release-05-02-19
MVAFacetRelationFilter Class Reference

Background facetRelation detection based on MVA. More...

#include <MVAFacetRelationFilter.h>

Inheritance diagram for MVAFacetRelationFilter:
Collaboration diagram for MVAFacetRelationFilter:

Public Types

using Object = typename BaseFacetRelationFilter ::Object
 Type of the object to be analysed.
 
using Interface = Filter< Relation< const CDCFacet > >
 Mark this class as the basic interface.
 

Public Member Functions

 MVAFacetRelationFilter ()
 Constructor initialising the MVAFilter with standard training name for this filter.
 
Weight predict (const Relation< const CDCFacet > &facetRelation) final
 Main filter method returning the weight of the facet relation. More...
 
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 const CDCFacet &from, const const CDCFacet &to)
 Main filter method returning the weight of the neighborhood relation. More...
 
Weight operator() (const Relation< const CDCFacet > &relation) override
 Main filter method overriding the filter interface method. 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.
 
std::vector< const CDCFacet * > getPossibleTos (const CDCFacet *from, const std::vector< const CDCFacet * > &facets) const final
 Returns the selection of facets covering the range of possible neighboring facets of the given facet out of the sorted range given by the two other argumets.
 
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< BaseFacetRelationFilter >
 Type of the base class.
 
using AVarSet = BaseVarSet< Object >
 Type of the variable set.
 

Private Attributes

double m_param_cut
 The cut on the MVA output.
 
std::string m_param_identifier
 Database identifier of the expert or weight file name.
 
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

Background facetRelation detection based on MVA.

Definition at line 40 of file MVAFacetRelationFilter.h.

Member Function Documentation

◆ operator()() [1/3]

virtual 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.

◆ operator()() [2/3]

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

◆ operator()() [3/3]

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 52 of file RelationFilter.icc.h.

◆ predict()

Weight predict ( const Relation< const CDCFacet > &  facetRelation)
final

Main filter method returning the weight of the facet relation.

The size of the facetRelation with a small penalty depending on the mva probability.

Definition at line 25 of file MVAFacetRelationFilter.cc.

26 {
27  return -2 - 0.2 * (1 - Super::predict(facetRelation));
28 }

The documentation for this class was generated from the following files:
Belle2::TrackFindingCDC::MVA< BaseFacetRelationFilter >::predict
virtual double predict(const Object &obj)
Evaluate the mva method.
Definition: MVAFilter.icc.h:98