OnVarSet< AFilter > Class Template Reference

Filter adapter to make a filter work on a set of variables. More...

#include <FilterOnVarSet.dcl.h>

Inheritance diagram for OnVarSet< AFilter >:

Collaboration diagram for OnVarSet< AFilter >:

Public Types
using	Object = typename AFilter::Object
	Type of pbject to be filtered.

Public Member Functions
	OnVarSet (std::unique_ptr< AVarSet > varSet)
	Constructor from the variable set the filter should use.
	~OnVarSet ()
	Default destructor.
void	initialize () override
	No reassignment of variable set possible for now.
bool	needsTruthInformation () override
	Checks if any variables need Monte Carlo information.
Weight	operator() (const Object &obj) override
	Function extracting the variables of the object into the variable set.
std::unique_ptr< AVarSet >	releaseVarSet () &&
	Steal the set of variables form this filter - filter becomes disfunctional afterwards.

Protected Member Functions
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 = AFilter
	Type of the base class.
using	AVarSet = BaseVarSet< Object >
	Type of the variable set usedi in this filter.

Private Attributes
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::OnVarSet< AFilter >

Filter adapter to make a filter work on a set of variables.

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

Member Typedef Documentation

AVarSet

using AVarSet = BaseVarSet<Object>

private

Type of the variable set usedi in this filter.

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

Object

using Object = typename AFilter::Object

Type of pbject to be filtered.

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

Super

using Super = AFilter

private

Type of the base class.

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

Constructor & Destructor Documentation

OnVarSet()

OnVarSet ( std::unique_ptr< AVarSet >  varSet )

explicit

Constructor from the variable set the filter should use.

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

      : m_varSet(std::move(varSet))
    {
      B2ASSERT("Varset initialised as nullptr", m_varSet);
    }

Member Function Documentation

getVarSet()

auto getVarSet

protected

Getter for the set of variables.

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

    {
      return *m_varSet;
    }

initialize()

void initialize

override

No reassignment of variable set possible for now.

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

    {
      this->addProcessingSignalListener(m_varSet.get());
      Super::initialize();
    }

needsTruthInformation()

bool needsTruthInformation

override

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 )

override

Function extracting the variables of the object into the variable set.

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

    {
      Weight weight = Super::operator()(obj);
      if (std::isnan(weight)) return NAN;
      bool extracted = m_varSet->extract(&obj);
      return extracted ? weight : NAN;
    }

releaseVarSet()

auto releaseVarSet

(

)

&&

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);
    }

setVarSet()

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

protected

Setter for the set of variables.

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

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

Member Data Documentation

m_varSet

std::unique_ptr<AVarSet> m_varSet

private

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/FilterOnVarSet.dcl.h
• tracking/trackFindingCDC/filters/base/include/FilterOnVarSet.icc.h