LumiMaskFilter Class Reference

Filters events based on a luminosity certification mask. More...

#include <LumiMaskFilter.hpp>

Inheritance diagram for LumiMaskFilter:

Public Member Functions
	LumiMaskFilter (std::string const &name, std::string const &lumiMaskFileName, bool rejectKnownEvent=true)
	Creates a plugin with the given name. More...
	LumiMaskFilter (std::string const &lumiMaskFileName, bool rejectKnownEvent=true)
	A short-cut for the above version with a default name "LumiMaskFilter".
	LumiMaskFilter (LumiMaskFilter const &)=default
	Default copy constructor.
	LumiMaskFilter (LumiMaskFilter &&)=default
	Default move constructor.
LumiMaskFilter &	operator= (LumiMaskFilter const &)=delete
	Assignment operator is deleted.
virtual	~LumiMaskFilter () noexcept
	Trivial destructor.
virtual void	BeginRun (Dataset const &) override
	Performs initialization for a new dataset. More...
virtual Plugin *	Clone () const override
	Creates a newly configured clone. More...
void	SetEventIDPluginName (std::string const &name)
	Changes name of the plugin that provides event ID.
Public Member Functions inherited from AnalysisPlugin
	AnalysisPlugin (std::string const &name)
	Constructor.
	AnalysisPlugin (AnalysisPlugin const &)=default
	Default copy constructor.
	AnalysisPlugin (AnalysisPlugin &&)=default
	Default move constructor.
AnalysisPlugin &	operator= (AnalysisPlugin const &)=default
	Default assignment operator.
virtual	~AnalysisPlugin ()
	Trivial destructor.
Public Member Functions inherited from Plugin
	Plugin (std::string const &name)
	Constructor.
	Plugin (Plugin const &)=default
	Default copy constructor.
	Plugin (Plugin &&)=default
	Default move constructor.
Plugin &	operator= (Plugin const &)=default
	Default assignment operator.
virtual	~Plugin ()
	Trivial destructor.
virtual void	EndRun ()
	Performs necessary actions needed after processing of a dataset is finished. More...
Processor const &	GetMaster () const
	Returns a reference to the master. More...
std::string const &	GetName () const
	Returns name of the plugin.
EventOutcome	ProcessEventToOutcome ()
	Processes a new event from the current dataset. More...
void	SetMaster (Processor const *processor)
	Provides a pointer to an instance of Processor class that owns the plugin. More...

Additional Inherited Members
Public Types inherited from Plugin
enum	EventOutcome { EventOutcome::Ok, EventOutcome::FilterFailed, EventOutcome::NoEvents }
	Outcome of processing of an event. More...
Protected Member Functions inherited from Plugin
Plugin const *	GetDependencyPlugin (std::string const &name) const
	Returns a pointer to a precedent plugin in the path with the given name. More...

Detailed Description

Filters events based on a luminosity certification mask.

This plugin checks events against a luminosity mask and, depending on the configuration, either keeps or rejects events that are comparible with the mask. The mask is provided in the standard JSON format.

The filter relies on the presence of a EventIDReader with a default name "EventID".

Constructor & Destructor Documentation

LumiMaskFilter::LumiMaskFilter	(	std::string const &	name,
		std::string const &	lumiMaskFileName,
		bool	rejectKnownEvent = true
	)

Creates a plugin with the given name.

The luminosity mask must be provided in the standard JSON format. An exception will be thrown if hte file cannot be parsed.

By default, this plugin rejects events that are compatible with the mask. This logic can be inverted using the last argument.

Member Function Documentation

void LumiMaskFilter::BeginRun ( Dataset const &  )

overridevirtual

Performs initialization for a new dataset.

Reimplemented from Plugin.

Reimplemented from Plugin.

Plugin * LumiMaskFilter::Clone ( ) const

overridevirtual

Creates a newly configured clone.

Implemented from Plugin.

Implements Plugin.

---

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

• include/mensura/extensions/LumiMaskFilter.hpp
• modules/extensions/src/LumiMaskFilter.cpp