Filter can delegate to a filter chosen and set up at run time by parameters. More...

#include <ChooseableFilter.dcl.h>

Inheritance diagram for Chooseable< AFilter >:

Collaboration diagram for Chooseable< AFilter >:

[legend]

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

Public Member Functions
	Chooseable (std::unique_ptr< FilterFactory< AFilter >> filterFactory)
	Setup the chooseable filter with available choices from the factory.

	Chooseable (std::unique_ptr< FilterFactory< AFilter >> filterFactory, const std::string &filterName)
	Setup the chooseable filter with available choices from the factory and a default name.

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

void	initialize () override
	Initialize before event processing. More...

bool	needsTruthInformation () override
	Indicates if the filter requires Monte Carlo information.

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

Weight	operator() (const Object &object) const
	Const version of operator.

std::string	getFilterName () const
	Return name of the selected filter.

Private Types
using	Super = AFilter
	Type of the base class.

Private Attributes
std::string	m_param_filterName
	Parameters : Name of the selected filter.

FilterParamMap	m_param_filterParameters
	Parameter: Parameter keys and values to be forwarded to the chosen filter.

std::unique_ptr< FilterFactory< AFilter > >	m_filterFactory
	Filter factor to construct a chosen filter.

std::unique_ptr< AFilter >	m_filter
	Chosen filter.

Detailed Description

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

Filter can delegate to a filter chosen and set up at run time by parameters.

Definition at line 29 of file ChooseableFilter.dcl.h.

Member Function Documentation

◆ exposeParameters()

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

final

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

Make a force parameter in case no default was given

Make a normal parameter in case default is known

Definition at line 48 of file ChooseableFilter.icc.h.

     {
       Super::exposeParameters(moduleParamList, prefix);
       if (m_param_filterName == "") {
         moduleParamList->addParameter(prefixed(prefix, "filter"),
                                       m_param_filterName,
                                       m_filterFactory->createFiltersNameDescription());
       } else {
         moduleParamList->addParameter(prefixed(prefix, "filter"),
                                       m_param_filterName,
                                       m_filterFactory->createFiltersNameDescription(),
                                       m_param_filterName);
       }
  
       m_param_filterParameters.addParameter(moduleParamList,
                                             prefixed(prefix, "filterParameters"),
                                             m_filterFactory->createFiltersParametersDescription());
     }

◆ initialize()

void initialize ( void )

override

Initialize before event processing.

Transfer parameters

Definition at line 70 of file ChooseableFilter.icc.h.

◆ operator()()

Weight operator() ( const Object & object )

final

Function to evaluate the object.

Delegates to the filter chosen by module parameters.

Parameters

object The object to be accepted or rejected.

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

Definition at line 94 of file ChooseableFilter.icc.h.

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

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

Public Types

Public Member Functions

Private Types