Filter adapter to make a filter work on a set of variables and record the observed instances on invokation. More...

#include <RecordingFilter.dcl.h>

Inheritance diagram for Recording< AFilter >:

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

Public Member Functions
	Recording (std::unique_ptr< AVarSet > varSet, const std::string &defaultRootFileName="records.root", const std::string &defaultTreeName="records")
	Constructor of the filter.

	~Recording ()
	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 recorder before event processing.

void	terminate () override
	Initialize the recorder after event processing.

Weight	operator() (const Object &obj) final
	Function to evaluate the cluster for its backgroundness.

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

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

Protected Member Functions
MayBePtr< AFilter >	getSkimFilter () const
	Getter for the skim filter to select objects to be recorded.

void	setSkimFilter (std::unique_ptr< AFilter > skimFilter)
	Setter for the skim filter to select objects to be recorded.

AVarSet &	getVarSet () const
	Getter for the set of variables.

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

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

using	AVarSet = BaseVarSet< Object >
	Type of the var set interface to be used.

Private Attributes
std::unique_ptr< Recorder >	m_recorder
	Recorder to write all variable sets of the encountered objects.

std::string	m_param_rootFileName
	Name of the ROOT file to which shall be written.

std::string	m_param_treeName
	Name of Tree to be written.

Weight	m_param_returnWeight
	Returns Weight when this filter is called.

std::unique_ptr< AFilter >	m_skimFilter = nullptr
	Skimming filter to select a subset of objects to be recorded.

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

Detailed Description

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

Filter adapter to make a filter work on a set of variables and record the observed instances on invokation.

Definition at line 34 of file RecordingFilter.dcl.h.

Member Typedef Documentation

◆ AVarSet

using AVarSet = BaseVarSet<Object>

private

Type of the var set interface to be used.

Definition at line 46 of file RecordingFilter.dcl.h.

◆ Object

using Object = typename AFilter::Object

Type of the object to be analysed.

Definition at line 42 of file RecordingFilter.dcl.h.

◆ Super

using Super = OnVarSet<AFilter>

private

Type of the base class.

Definition at line 38 of file RecordingFilter.dcl.h.

Constructor & Destructor Documentation

◆ Recording()

Recording	(	std::unique_ptr< AVarSet >	varSet,
		const std::string &	defaultRootFileName = `"records.root"`,
		const std::string &	defaultTreeName = `"records"`
	)

Constructor of the filter.

Definition at line 30 of file RecordingFilter.icc.h.

      : Super(std::move(varSet))
      , m_recorder(nullptr)
      , m_param_rootFileName(defaultRootFileName)
      , m_param_treeName(defaultTreeName)
      , m_param_returnWeight(NAN)
    {}

Member Function Documentation

◆ exposeParameters()

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

override

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

Definition at line 44 of file RecordingFilter.icc.h.

    {
      Super::exposeParameters(moduleParamList, prefix);
      moduleParamList->addParameter(prefixed(prefix, "rootFileName"),
                                    m_param_rootFileName,
                                    "Name of the ROOT file to be written",
                                    m_param_rootFileName);
 
      moduleParamList->addParameter(prefixed(prefix, "treeName"),
                                    m_param_treeName,
                                    "Name of the Tree to be written",
                                    m_param_treeName);
 
      moduleParamList->addParameter(prefixed(prefix, "returnWeight"),
                                    m_param_returnWeight,
                                    "Weight this filter should return when called. Defaults to NAN",
                                    m_param_returnWeight);
    }

◆ getSkimFilter()

MayBePtr< AFilter > getSkimFilter

protected

Getter for the skim filter to select objects to be recorded.

Definition at line 98 of file RecordingFilter.icc.h.

    {
      return m_skimFilter.get();
    }

◆ getVarSet()

auto getVarSet

protectedinherited

Getter for the set of variables.

Definition at line 80 of file FilterOnVarSet.icc.h.

    {
      return *m_varSet;
    }

◆ initialize()

void initialize

override

Initialize the recorder before event processing.

Definition at line 64 of file RecordingFilter.icc.h.

    {
      if (m_skimFilter) this->addProcessingSignalListener(m_skimFilter.get());
      Super::initialize();
      m_recorder.reset(new Recorder(Super::getVarSet().getNamedVariables(),
                                    m_param_rootFileName,
                                    m_param_treeName));
    }

◆ needsTruthInformation()

bool needsTruthInformation

overrideinherited

Checks if any variables need Monte Carlo information.

Definition at line 49 of file FilterOnVarSet.icc.h.

    {
      bool result = Super::needsTruthInformation();
      if (result) return true;
 
      const std::vector<Named<Float_t*>>& namedVariables = m_varSet->getNamedVariables();
      for (const Named<Float_t*>& namedVariable : namedVariables) {
        std::string name = namedVariable.getName();
        // If the name contains the word truth it is considered to have Monte carlo information.
        if (name.find("truth") != std::string::npos) {
          return true;
        }
      }
      return false;
    }

◆ operator()()

Weight operator() ( const Object & obj )

final

Function to evaluate the cluster for its backgroundness.

Definition at line 82 of file RecordingFilter.icc.h.

    {
      if (m_skimFilter) {
        Weight skimWeight = (*m_skimFilter)(obj);
        if (std::isnan(skimWeight)) return NAN;
      }
 
      Weight extracted = Super::operator()(obj);
      if (not std::isnan(extracted)) {
        m_recorder->capture();
      }
 
      return m_param_returnWeight;
    }

◆ releaseVarSet()

auto releaseVarSet ( ) &&

inherited

Steal the set of variables form this filter - filter becomes disfunctional afterwards.

Definition at line 75 of file FilterOnVarSet.icc.h.

                                                                      {
      return std::move(m_varSet);
    }

◆ setSkimFilter()

void setSkimFilter ( std::unique_ptr< AFilter > skimFilter )

protected

Setter for the skim filter to select objects to be recorded.

Definition at line 104 of file RecordingFilter.icc.h.

    {
      m_skimFilter = std::move(skimFilter);
    }

◆ setVarSet()

void setVarSet ( std::unique_ptr< AVarSet > varSet )

protectedinherited

Setter for the set of variables.

Definition at line 86 of file FilterOnVarSet.icc.h.

    {
      m_varSet = std::move(varSet);
    }

◆ terminate()

void terminate

override

Initialize the recorder after event processing.

Definition at line 74 of file RecordingFilter.icc.h.

    {
      m_recorder->write();
      m_recorder.reset();
      Super::terminate();
    }

Member Data Documentation

◆ m_param_returnWeight

Weight m_param_returnWeight

private

Returns Weight when this filter is called.

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

◆ m_param_rootFileName

std::string m_param_rootFileName

private

Name of the ROOT file to which shall be written.

Definition at line 82 of file RecordingFilter.dcl.h.

◆ m_param_treeName

std::string m_param_treeName

private

Name of Tree to be written.

Definition at line 85 of file RecordingFilter.dcl.h.

◆ m_recorder

std::unique_ptr<Recorder> m_recorder

private

Recorder to write all variable sets of the encountered objects.

Definition at line 79 of file RecordingFilter.dcl.h.

◆ m_skimFilter

std::unique_ptr<AFilter> m_skimFilter = nullptr

private

Skimming filter to select a subset of objects to be recorded.

Definition at line 91 of file RecordingFilter.dcl.h.

◆ m_varSet

std::unique_ptr<AVarSet> m_varSet

privateinherited

Instance of the variable set to be used in the filter.

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

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

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

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ AVarSet

◆ Object

◆ Super

Constructor & Destructor Documentation

◆ Recording()

Member Function Documentation

◆ exposeParameters()

◆ getSkimFilter()

◆ getVarSet()

◆ initialize()

◆ needsTruthInformation()

◆ operator()()

◆ releaseVarSet()

◆ setSkimFilter()

◆ setVarSet()

◆ terminate()

Member Data Documentation

◆ m_param_returnWeight

◆ m_param_rootFileName

◆ m_param_treeName

◆ m_recorder

◆ m_skimFilter

◆ m_varSet