Convenience template to create a filter operating on a specific set of variables. More...

#include <FilterOnVarSet.dcl.h>

Inheritance diagram for FilterOnVarSet< AVarSet >:

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

using	Interface = Filter< AVarSet::Object >
	Mark this class as the basic interface.

Public Member Functions
	FilterOnVarSet ()
	Constructor of the filter.

	~FilterOnVarSet ()
	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.

virtual Weight	operator() (const Object &obj)
	Function to evaluate the object.

Weight	operator() (const Object *obj)
	Function to evaluate the object.

virtual std::vector< float >	operator() (const std::vector< Object * > &objs)
	Function to evaluate a vector of objects Base implementation applies the function to each object.

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

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

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.

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.

void	addProcessingSignalListener (ProcessingSignalListener *psl)
	Register a processing signal listener to be notified.

int	getNProcessingSignalListener ()
	Get the number of currently registered listeners.

Private Types
using	Super = OnVarSet< Filter< typename AVarSet::Object > >
	Type of the super 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.

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 happened before.

bool	m_terminated = false
	Flag to keep track whether termination happened before.

std::string	m_initializedAs
	Name of the type during initialisation.

Detailed Description

template<class AVarSet>
class Belle2::TrackFindingCDC::FilterOnVarSet< AVarSet >

Convenience template to create a filter operating on a specific set of variables.

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

Member Typedef Documentation

◆ AVarSet

using AVarSet = BaseVarSet<Object>

privateinherited

Type of the variable set usedi in this filter.

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

◆ Interface

using Interface = Filter<AVarSet::Object >

inherited

Mark this class as the basic interface.

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

◆ Object

using Object = typename AVarSet::Object

Type of the object to be analysed.

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

◆ Super

using Super = OnVarSet<Filter<typename AVarSet::Object> >

private

Type of the super class.

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

Constructor & Destructor Documentation

◆ FilterOnVarSet()

FilterOnVarSet

Constructor of the filter.

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

      : Super(std::make_unique<AVarSet>())
    {
    }

Member Function Documentation

◆ addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener * psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 55 of file CompositeProcessingSignalListener.cc.

{
  m_subordinaryProcessingSignalListeners.push_back(psl);
}

◆ beginEvent()

void beginEvent ( )

overridevirtualinherited

Receive and dispatch signal for the start of a new event.

Reimplemented from ProcessingSignalListener.

Definition at line 31 of file CompositeProcessingSignalListener.cc.

{
  Super::beginEvent();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginEvent();
  }
}

◆ beginRun()

void beginRun ( )

overridevirtualinherited

Receive and dispatch signal for the beginning of a new run.

Reimplemented from ProcessingSignalListener.

Reimplemented in LayerRelationFilter< AFilter >, FourHitFilter, QualityIndicatorFilter, ThreeHitFilter, TwoHitVirtualIPFilter, TwoHitVirtualIPQIFilter, RecoTrackStorer, ROIFinder, SpacePointLoaderAndPreparer, and TrackCandidateResultRefiner.

Definition at line 23 of file CompositeProcessingSignalListener.cc.

{
  Super::beginRun();
  for (ProcessingSignalListener* psl : m_subordinaryProcessingSignalListeners) {
    psl->beginRun();
  }
}

◆ endRun()

void endRun ( )

overridevirtualinherited

Receive and dispatch signal for the end of the run.

Reimplemented from ProcessingSignalListener.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->endRun();
  }
  Super::endRun();
}

◆ exposeParameters()

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

virtualinherited

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

Note that not all filters have yet exposed their parameters in this way.

This method is deprecated as the exposeParams below uses a less compile heavy equivalent.

Definition at line 54 of file Filter.icc.h.

42 {

43 }

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 60 of file CompositeProcessingSignalListener.cc.

{
  return m_subordinaryProcessingSignalListeners.size();
}

◆ getVarSet()

auto getVarSet

protectedinherited

Getter for the set of variables.

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

    {
      return *m_varSet;
    }

◆ initialize()

void initialize

overridevirtualinherited

No reassignment of variable set possible for now.

Reimplemented from CompositeProcessingSignalListener.

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

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

◆ needsTruthInformation()

bool needsTruthInformation

overridevirtualinherited

Checks if any variables need Monte Carlo information.

Reimplemented from Filter< AVarSet::Object >.

Definition at line 52 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()() [1/4]

Weight operator() ( const Object & obj )

virtualinherited

Function to evaluate the object.

Base implementation accepts all objects.

Parameters

obj	The object to be accepted or rejected.

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

Definition at line 68 of file Filter.icc.h.

    {
      return 1;
    }

◆ operator()() [2/4]

Weight operator() ( const Object & obj )

overrideinherited

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

Definition at line 56 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;
    }

◆ operator()() [3/4]

Weight operator() ( const Object * obj )

inherited

Function to evaluate the object.

Base implementation accepts all objects, except nullptr.

Parameters

obj	The object to be accepted or rejected.

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

Definition at line 78 of file Filter.icc.h.

    {
      return obj ? operator()(*obj) : NAN;
    }

◆ operator()() [4/4]

std::vector< float > operator() ( const std::vector< Object * > & objs )

virtualinherited

Function to evaluate a vector of objects Base implementation applies the function to each object.

Can be optimized for MVA filters

Parameters

objs	A vector of pointers to objects

Returns: A vector of float or NAN values. See above

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

    {
      std::vector<float> out;
      for (const auto& obj : objs) {
        out.push_back(operator()(obj));
      }
      return out;
    }

◆ releaseVarSet()

auto releaseVarSet ( ) &&

inherited

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

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

                                                                      {
      return std::move(m_varSet);
    }

◆ setVarSet()

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

protectedinherited

Setter for the set of variables.

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

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

◆ terminate()

void terminate ( )

overridevirtualinherited

Receive and dispatch Signal for termination of the event processing.

Reimplemented from ProcessingSignalListener.

Reimplemented in StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::HyperHough >, StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::QuadraticLegendre >, and StereoHitTrackQuadTreeMatcher< Belle2::TrackFindingCDC::Z0TanLambdaLegendre >.

Definition at line 47 of file CompositeProcessingSignalListener.cc.

{
  for (ProcessingSignalListener* psl : reversedRange(m_subordinaryProcessingSignalListeners)) {
    psl->terminate();
  }
  Super::terminate();
}

Member Data Documentation

◆ m_initialized

bool m_initialized = false

privateinherited

Flag to keep track whether initialization happened before.

Definition at line 52 of file ProcessingSignalListener.h.

◆ m_initializedAs

std::string m_initializedAs

privateinherited

Name of the type during initialisation.

Definition at line 58 of file ProcessingSignalListener.h.

◆ m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 52 of file CompositeProcessingSignalListener.h.

◆ m_terminated

bool m_terminated = false

privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.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/FilterOnVarSet.dcl.h
tracking/trackFindingCDC/filters/base/include/FilterOnVarSet.icc.h

Public Types

Public Member Functions

Protected Member Functions

Private Types

Private Attributes

Detailed Description

Member Typedef Documentation

◆ AVarSet

◆ Interface

◆ Object

◆ Super

Constructor & Destructor Documentation

◆ FilterOnVarSet()

Member Function Documentation

◆ addProcessingSignalListener()

◆ beginEvent()

◆ beginRun()

◆ endRun()

◆ exposeParameters()

◆ getNProcessingSignalListener()

◆ getVarSet()

◆ initialize()

◆ needsTruthInformation()

◆ operator()() [1/4]

◆ operator()() [2/4]

◆ operator()() [3/4]

◆ operator()() [4/4]

◆ releaseVarSet()

◆ setVarSet()

◆ terminate()

Member Data Documentation

◆ m_initialized

◆ m_initializedAs

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_varSet