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 >:

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 dysfunctional 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.
virtual void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Forward prefixed parameters of this findlet to the module parameter list.

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

template<class AFilter>

using AVarSet = BaseVarSet<Object>

private

Type of the variable set usedi in this filter.

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

Object

template<class AFilter>

using Object = typename AFilter::Object

Type of pbject to be filtered.

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

Super

template<class AFilter>

using Super = AFilter

private

Type of the base class.

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

Constructor & Destructor Documentation

OnVarSet()

template<class AFilter>

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

exposeParameters()

template<class AFilter>

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

overrideprotectedvirtual

Forward prefixed parameters of this findlet to the module parameter list.

Reimplemented in ChoosableFromVarSet< AFilter >, ChoosableFromVarSet< Filter< ATruthVarSet::Object > >, ChoosableFromVarSet< Filter< PXDResultVarSet::Object > >, ChoosableFromVarSet< Filter< SVDResultVarSet::Object > >, ChoosableFromVarSet< Filter< typename ATruthVarSet::Object > >, ChoosableFromVarSet< Filter< typename ATruthVarSet::Object > >, MVA< AFilter >, MVA< BaseAxialSegmentPairFilter >, MVA< BaseAxialSegmentPairFilter >, MVA< BaseFacetFilter >, MVA< BaseFacetFilter >, MVA< BaseFacetRelationFilter >, MVA< BaseFacetRelationFilter >, MVA< BaseSegmentPairRelationFilter >, MVA< BaseSegmentPairRelationFilter >, MVA< BaseSegmentRelationFilter >, MVA< BaseSegmentRelationFilter >, MVA< BaseTrackRelationFilter >, MVA< BaseTrackRelationFilter >, MVA< Filter< AVarSet::Object > >, MVA< Filter< typename AVarSet::Object > >, MVA< Filter< typename AVarSet::Object > >, Recording< AFilter >, Recording< AFilterFactory::CreatedFilter >, Recording< Filter< AVarSet::Object > >, Recording< Filter< typename AVarSet::Object > >, Recording< Filter< typename AVarSet::Object > >, Sloppy< TruthVarFilter< ATruthVarSet > >, Sloppy< TruthVarFilter< ATruthVarSet > >, UnionRecording< AFilter >, UnionRecording< AFilterFactory::CreatedFilter >, UnionRecording< typename AFilterFactory::CreatedFilter >, and UnionRecording< typename AFilterFactory::CreatedFilter >.

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

    {
      Super::exposeParameters(moduleParamList, prefix);
      m_varSet->exposeParameters(moduleParamList, prefix);
    }

getVarSet()

template<class AFilter>

auto getVarSet ( ) const

protected

Getter for the set of variables.

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

    {
      return *m_varSet;
    }

initialize()

template<class AFilter>

void initialize ( )

override

No reassignment of variable set possible for now.

Reimplemented in Recording< Filter< AVarSet::Object > >, Recording< Filter< typename AVarSet::Object > >, and Recording< Filter< typename AVarSet::Object > >.

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

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

needsTruthInformation()

template<class AFilter>

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()()

template<class AFilter>

Weight operator() ( const Object & obj )

override

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

Reimplemented in Recording< Filter< typename AVarSet::Object > >.

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()

template<class AFilter>

auto releaseVarSet

(

)

&&

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

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

    {
      return std::move(m_varSet);
    }

setVarSet()

template<class AFilter>

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

protected

Setter for the set of variables.

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

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

Member Data Documentation

m_varSet

template<class AFilter>

std::unique_ptr<AVarSet> m_varSet

private

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

Definition at line 74 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