Base filter for CKF PXD results (on overlap check) More...

#include <SizePXDResultFilter.h>

Inheritance diagram for SizePXDResultFilter:

Public Types
using	Object
	Type of the filtered object.

using	Interface
	Mark this class as the basic interface.

Public Member Functions
void	exposeParameters (ModuleParamList *parameterList, const std::string &prefix) override
	Add the parameters of this filter to the given parameter list.

void	initialize () override
	Initialisation method sets up a reference to the value in the variable set to be returned.

Weight	operator() (const Object &object) override
	Returns the variable with the set requested name from 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.

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 dysfunctional afterwards.

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
	Type of the super class.

using	AVarSet
	Type of the variable set.

Private Attributes
std::string	m_param_varName
	Memory for the name of the variable selected as the return value of the filter.

Float_t *	m_variable
	Reference to the location of the value in the variable set to be returned.

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
	Flag to keep track whether initialization happened before.

bool	m_terminated
	Flag to keep track whether termination happened before.

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

Detailed Description

Base filter for CKF PXD results (on overlap check)

Definition at line 19 of file SizePXDResultFilter.h.

Member Typedef Documentation

◆ AVarSet

using AVarSet

privateinherited

Type of the variable set.

Definition at line 44 of file ChoosableFromVarSetFilter.dcl.h.

◆ Interface

using Interface

inherited

Mark this class as the basic interface.

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

◆ Object

using Object

inherited

Type of the filtered object.

Definition at line 84 of file ChoosableFromVarSetFilter.dcl.h.

◆ Super

using Super

privateinherited

Type of the super class.

Definition at line 80 of file ChoosableFromVarSetFilter.dcl.h.

Constructor & Destructor Documentation

◆ SizePXDResultFilter()

SizePXDResultFilter ( )

inline

Definition at line 21 of file SizePXDResultFilter.h.

21 : TrackFindingCDC::ChoosableFromVarSetFilter<PXDResultVarSet>("number_of_hits")

22 {

23

24 }

Member Function Documentation

◆ addProcessingSignalListener()

void addProcessingSignalListener ( ProcessingSignalListener * psl )

protectedinherited

Register a processing signal listener to be notified.

Definition at line 53 of file CompositeProcessingSignalListener.cc.

56{

57 m_subordinaryProcessingSignalListeners.push_back(psl);

58}

Belle2::TrackFindingCDC::Filter

Base class for filters on a generic object type.

Definition Filter.dcl.h:31

◆ beginEvent()

void beginEvent ( )

overrideinherited

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

Definition at line 36 of file CompositeProcessingSignalListener.cc.

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

◆ beginRun()

void beginRun ( )

overrideinherited

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

Definition at line 33 of file CompositeProcessingSignalListener.cc.

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

◆ endRun()

void endRun ( )

overrideinherited

Receive and dispatch signal for the end of the run.

Definition at line 39 of file CompositeProcessingSignalListener.cc.

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

◆ exposeParameters()

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

overridevirtualinherited

Add the parameters of this filter to the given parameter list.

Reimplemented from OnVarSet< Filter< PXDResultVarSet::Object > >.

Definition at line 57 of file ChoosableFromVarSetFilter.icc.h.

    {
      Super::exposeParameters(moduleParamList, prefix);
 
      if (m_param_varName == "") {
        // Make a forced parameter if no default variable name is present
        moduleParamList->addParameter(prefixed(prefix, "chosenVariable"),
                                      m_param_varName,
                                      "Choose the name of the variable "
                                      "that will be put out as a weight.");
      } else {
        // Normal unforced parameter if default name is present
        moduleParamList->addParameter(prefixed(prefix, "chosenVariable"),
                                      m_param_varName,
                                      "Choose the name of the variable "
                                      "that will be put out as a weight.",
                                      m_param_varName);
      }
    }

◆ getNProcessingSignalListener()

int getNProcessingSignalListener ( )

protectedinherited

Get the number of currently registered listeners.

Definition at line 56 of file CompositeProcessingSignalListener.cc.

61{

62 return m_subordinaryProcessingSignalListeners.size();

63}

◆ getVarSet()

auto getVarSet ( ) const

protectedinherited

Getter for the set of variables.

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

82 {

83 return *m_varSet;

84 }

◆ initialize()

void initialize ( )

overridevirtualinherited

Initialisation method sets up a reference to the value in the variable set to be returned.

Reimplemented from ProcessingSignalListener.

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

    {
      Super::initialize();
      MayBePtr<Float_t> foundVariable = Super::getVarSet().find(m_param_varName);
      if (not foundVariable) {
        B2ERROR("Could not find request variable name " << m_param_varName << " in variable set");
        B2INFO("Valid names are: ");
        std::vector<Named<Float_t*>> namedVariables = Super::getVarSet().getNamedVariables();
        for (const Named<Float_t*>& namedVariable : namedVariables) {
          std::string name = namedVariable.getName();
          B2INFO("* " << name);
        }
      }
      m_variable = foundVariable;
    }

◆ needsTruthInformation()

bool needsTruthInformation ( )

overrideinherited

Checks if any variables need Monte Carlo information.

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 & object )

overrideinherited

Returns the variable with the set requested name from the variable set.

Definition at line 63 of file ChoosableFromVarSetFilter.icc.h.

    {
      Weight extracted = Super::operator()(object);
      if (std::isnan(extracted)) {
        return NAN;
      } else {
        if (m_variable) {
          return *m_variable;
        } else {
          return NAN;
        }
      }
    }

◆ operator()() [2/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 59 of file Filter.icc.h.

47 {

48 return 1;

49 }

◆ 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 69 of file Filter.icc.h.

53 {

54 return obj ? operator()(*obj) : NAN;

55 }

◆ 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 77 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.

76 {

77 return std::move(m_varSet);

78 }

◆ setVarSet()

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

protectedinherited

Setter for the set of variables.

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

88 {

89 m_varSet = std::move(varSet);

90 }

◆ terminate()

void terminate ( )

overrideinherited

Receive and dispatch Signal for termination of the event processing.

Definition at line 42 of file CompositeProcessingSignalListener.cc.

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

Member Data Documentation

◆ m_initialized

bool m_initialized

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_param_varName

std::string m_param_varName

privateinherited

Memory for the name of the variable selected as the return value of the filter.

Definition at line 67 of file ChoosableFromVarSetFilter.dcl.h.

◆ m_subordinaryProcessingSignalListeners

std::vector<ProcessingSignalListener*> m_subordinaryProcessingSignalListeners

privateinherited

References to subordinary signal processing listener contained in this findlet.

Definition at line 60 of file CompositeProcessingSignalListener.h.

◆ m_terminated

bool m_terminated

privateinherited

Flag to keep track whether termination happened before.

Definition at line 55 of file ProcessingSignalListener.h.

◆ m_variable

Float_t* m_variable

privateinherited

Reference to the location of the value in the variable set to be returned.

Definition at line 70 of file ChoosableFromVarSetFilter.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 74 of file FilterOnVarSet.dcl.h.

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

tracking/ckf/pxd/filters/results/include/SizePXDResultFilter.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

◆ SizePXDResultFilter()

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_param_varName

◆ m_subordinaryProcessingSignalListeners

◆ m_terminated

◆ m_variable

◆ m_varSet