FilterVarSet< AFilter > Class Template Reference

Class to compute floating point variables from a filter response which can be recorded as a flat TNtuple or serve as input to a MVA method. More...

#include <FilterVarSet.dcl.h>

Inheritance diagram for FilterVarSet< AFilter >:

Collaboration diagram for FilterVarSet< AFilter >:

Public Types
using	Filter = AFilter
	Type of the filter.
using	Object = typename Filter::Object
	Type of the object from which the filter judgement should be extracted.

Public Member Functions
	FilterVarSet (const std::string &filterName="")
	Construct the varset making an instance of the template filter.
	FilterVarSet (const std::string &filterName, std::unique_ptr< Filter > ptrFilter)
	Construct the varset.
bool	extract (const Object *obj) final
	Generate filter weight variable from the object.
void	initialize () final
	Initialize the filter before event processing.
std::vector< Named< Float_t * > >	getNamedVariables (const std::string &prefix) override
	Getter for the named references to the individual variables Base implementaton returns empty vector.
MayBePtr< Float_t >	find (const std::string &varName) override
	Pointer to the variable with the given name. More...
std::vector< Named< Float_t * > >	getNamedVariables ()
	Getter for the named references to the individual variables.
virtual bool	extract (const Object *obj)
	Main method that extracts the variable values from the complex object. More...
bool	extract (const Object &obj)
	Method for extraction from an object instead of a pointer.
std::map< std::string, Float_t >	getNamedValues (const std::string &prefix) const
	Getter for a map of names to float values. More...
std::map< std::string, Float_t >	getNamedValues () const
	Getter for a map of names to float values.
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.

Public Attributes
double	m_cut = NAN
	The cut on the filter output.
std::string	m_filterName
	Name of the filter.
std::string	m_filterNamePrefix
	Prefix to be put in front of the filter variables.
std::unique_ptr< Filter >	m_ptrFilter
	Filter from which to generate weight as a variable set;.

Protected Member Functions
Float_t	get () const
	Getter for the value of the ith variable. Static version.
Float_t &	var ()
	Reference getter for the value of the ith variable. Static version.
AssignFinite< Float_t >	finitevar ()
	Reference getter for the value of the ith variable. Transforms non-finite values to finite value.
void	addProcessingSignalListener (ProcessingSignalListener *psl)
	Register a processing signal listener to be notified.
int	getNProcessingSignalListener ()
	Get the number of currently registered listeners.

Static Protected Member Functions
constexpr static int	named (const char *name)
	Getter for the index from the name. More...

Private Types
using	Super = VarSet< FilterVarNames< AFilter > >
	Type of the base class.

Private Attributes
FixedSizeNamedFloatTuple< FilterVarNames< AFilter > >	m_variables
	Memory for nVars floating point values.
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.

Static Private Attributes
static const size_t	nVars
	Number of floating point values represented by this class.

Detailed Description

template<class AFilter>
class Belle2::TrackFindingCDC::FilterVarSet< AFilter >

Class to compute floating point variables from a filter response which can be recorded as a flat TNtuple or serve as input to a MVA method.

The variables that are extracted from the filter response are the weight and a boolean whether the response was NaN.

Definition at line 47 of file FilterVarSet.dcl.h.

Member Function Documentation

extract()

virtual bool extract ( const Object *  obj )

inlinevirtualinherited

Main method that extracts the variable values from the complex object.

Returns indication whether the extraction could be completed successfully. Base implementation returns always true.

Parameters

obj	dummy object not used

Returns

: always true for the base implementation

Definition at line 50 of file BaseVarSet.h.

find()

MayBePtr< Float_t > find ( const std::string &  varName )

overridevirtual

Pointer to the variable with the given name.

Returns nullptr if not found.

Reimplemented from BaseVarSet< AVarNames::Object >.

Definition at line 108 of file FilterVarSet.icc.h.

    {
      if (varName.find(m_filterNamePrefix) == 0) {
        std::string varNameWithoutPrefix = varName.substr(m_filterNamePrefix.size());
        MayBePtr<Float_t> found = Super::find(varNameWithoutPrefix);
        if (found) return found;
      }
      return nullptr;
    }

getNamedValues()

std::map<std::string, Float_t> getNamedValues ( const std::string &  prefix ) const

inlineinherited

Getter for a map of names to float values.

Parameters

prefix

Name prefix to apply to all variable names.

Definition at line 83 of file BaseVarSet.h.

named()

constexpr static int named ( const char *  name )

inlinestaticconstexprprotectedinherited

Getter for the index from the name.

Looks through the associated names and returns the right index if found Returns nVars (one after the last element) if not found.

Parameters

name	Name of the sought variable

Returns

Index of the name, nVars if not found.

Definition at line 78 of file VarSet.h.

---

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

• tracking/trackFindingCDC/filters/base/include/FilterVarSet.dcl.h
• tracking/trackFindingCDC/filters/base/include/FilterVarSet.icc.h