MCSymmetric< AFilter > Class Template Reference

Mixin for filters that use Monte Carlo information. More...

#include <MCSymmetricFilter.dcl.h>

Inheritance diagram for MCSymmetric< AFilter >:

Public Member Functions
	MCSymmetric (bool allowReverse=true)
	Constructor.
	~MCSymmetric ()
	Default destructor.
void	exposeParameters (ModuleParamList *moduleParamList, const std::string &prefix) override
	Expose the set of parameters of the filter to the module parameter list.
void	initialize () override
	Initialize the before event processing.
void	beginEvent () override
	Signal the beginning of a new event.
bool	needsTruthInformation () final
	Indicates that the filter requires Monte Carlo information.
virtual void	setAllowReverse (bool allowReverse)
	Setter for the allow reverse parameter.
bool	getAllowReverse () const
	Getter for the allow reverse parameter.

Private Types
using	Super = AFilter
	Type of the super class.

Private Attributes
bool	m_param_allowReverse
	Switch to indicate if the reversed version of the object shall also be accepted (default is true).

Detailed Description

template<class AFilter>
class Belle2::TrackFindingCDC::MCSymmetric< AFilter >

Mixin for filters that use Monte Carlo information.

Definition at line 23 of file MCSymmetricFilter.dcl.h.

Member Typedef Documentation

Super

using Super = AFilter

private

Type of the super class.

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

Constructor & Destructor Documentation

MCSymmetric()

MCSymmetric ( bool  allowReverse = true )

explicit

Constructor.

Definition at line 28 of file MCSymmetricFilter.icc.h.

      : Super()
      , m_param_allowReverse(allowReverse)
    {
    }

Member Function Documentation

beginEvent()

void beginEvent

override

Signal the beginning of a new event.

Definition at line 56 of file MCSymmetricFilter.icc.h.

    {
      CDCMCManager::getInstance().fill();
      Super::beginEvent();
    }

exposeParameters()

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

override

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

Definition at line 38 of file MCSymmetricFilter.icc.h.

    {
      Super::exposeParameters(moduleParamList, prefix);
      moduleParamList->addParameter(prefixed(prefix, "allowReverse"),
                                    m_param_allowReverse,
                                    "Indication whether the reverse to the truth is accepted"
                                    "preserving the propagation reversal symmetry.",
                                    m_param_allowReverse);
    }

getAllowReverse()

bool getAllowReverse

Getter for the allow reverse parameter.

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

    {
      return m_param_allowReverse;
    }

initialize()

void initialize

override

Initialize the before event processing.

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

    {
      CDCMCManager::getInstance().requireTruthInformation();
      Super::initialize();
    }

needsTruthInformation()

bool needsTruthInformation

final

Indicates that the filter requires Monte Carlo information.

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

    {
      return true;
    }

setAllowReverse()

void setAllowReverse ( bool  allowReverse )

virtual

Setter for the allow reverse parameter.

Reimplemented in MCSegmentPairRelationFilter, MCFacetRelationFilter, MCSegmentTripleFilter, and MCSegmentTripleRelationFilter.

Definition at line 69 of file MCSymmetricFilter.icc.h.

    {
      m_param_allowReverse = allowReverse;
    }

Member Data Documentation

m_param_allowReverse

bool m_param_allowReverse

private

Switch to indicate if the reversed version of the object shall also be accepted (default is true).

Definition at line 57 of file MCSymmetricFilter.dcl.h.

---

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

• tracking/trackFindingCDC/filters/base/include/MCSymmetricFilter.dcl.h
• tracking/trackFindingCDC/filters/base/include/MCSymmetricFilter.icc.h