SizeSVDResultFilter Class Reference

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

#include <SizeSVDResultFilter.h>

Inheritance diagram for SizeSVDResultFilter:

Public Types
using	Object = typename ATruthVarSet::Object
	Type of the filtered object.

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.
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
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 = ChoosableFromVarSet< Filter< typename ATruthVarSet::Object > >
	Type of the super class.
using	AVarSet = BaseVarSet< Object >
	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.

Detailed Description

Base filter for CKF SVD results (on overlap check)

Definition at line 19 of file SizeSVDResultFilter.h.

Member Typedef Documentation

AVarSet

using AVarSet = BaseVarSet<Object>

privateinherited

Type of the variable set.

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

Object

using Object = typename ATruthVarSet::Object

inherited

Type of the filtered object.

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

Super

using Super = ChoosableFromVarSet<Filter<typename ATruthVarSet::Object> >

privateinherited

Type of the super class.

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

Constructor & Destructor Documentation

SizeSVDResultFilter()

SizeSVDResultFilter ( )

inline

Definition at line 21 of file SizeSVDResultFilter.h.

                          : TrackFindingCDC::ChoosableFromVarSetFilter<SVDResultVarSet>("number_of_hits")
    {
 
    }

Member Function Documentation

exposeParameters()

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

overrideinherited

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

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

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

overrideinherited

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

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

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

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

Member Data Documentation

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_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 71 of file FilterOnVarSet.dcl.h.

---

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

• tracking/ckf/svd/filters/results/include/SizeSVDResultFilter.h