GenericPlugin

Description

Generic plugin class.

If the DT::plugin has been provided in the options of a command, plugins inheriting from this class may be loaded using -p options. Several plugins may be given. Plugins are then called at the beginning and at the end (although before filling the tree, if applicable) of the loop:

• at the beginning, they are called in the same order as given in the command line;

• at the end, they are called in the reverse order.

  Todo:

  What happens if I use twice the same plugin? (e.g. one would like to fill the same histograms before and after applying a selection)

Typical use cases are:

• the creation of branches,
• the production of control plots,
• the application of an additional selection.

In case plugins are used, the options can only be given via the config file.

Note

Plugins for unfolding are handled separately.

If the DT::plugin has been provided in the options of a command, plugins inheriting from this class may be loaded using -p options. Several plugins may be given. Plugins are then called at the beginning and at the end (although before filling the tree, if applicable) of the loop:

• at the beginning, they are called in the same order as given in the command line;

• at the end, they are called in the reverse order.

  Todo:

  What happens if I use twice the same plugin? (e.g. one would like to fill the same histograms before and after applying a selection)

Typical use cases are:

• the creation of branches,
• the production of control plots,
• the application of an additional selection.

In case plugins are used, the options can only be given via the config file.

Note

Plugins for unfolding are handled separately.

#include <GenericPlugin.h>

Inheritance diagram for GenericPlugin:

Collaboration diagram for GenericPlugin:

Public Member Functions
	GenericPlugin ()=default
virtual	~GenericPlugin ()=default
virtual void	ExecuteAtBegin (const std::set< Darwin::Physics::Variation > &={Darwin::Physics::nominal})
virtual void	ExecuteAtEnd (const std::set< Darwin::Physics::Variation > &={Darwin::Physics::nominal})
virtual void	Write (TDirectory *)
	GenericPlugin ()=default
virtual	~GenericPlugin ()=default
virtual void	ExecuteAtBegin (const std::set< Darwin::Physics::Variation > &={Darwin::Physics::nominal})
virtual void	ExecuteAtEnd (const std::set< Darwin::Physics::Variation > &={Darwin::Physics::nominal})
virtual void	Write (TDirectory *)
Public Member Functions inherited from IPlugin
	IPlugin ()=default
virtual	~IPlugin ()
void	SetPath (const std::filesystem::path &file) noexcept
virtual void	Load (Darwin::Tools::Flow &, Darwin::Tools::MetaInfo &, int=0, const boost::property_tree::ptree &={})
	IPlugin ()=default
virtual	~IPlugin ()
void	SetPath (const std::filesystem::path &file) noexcept
virtual void	Load (Darwin::Tools::Flow &, Darwin::Tools::MetaInfo &, int=0, const boost::property_tree::ptree &={})

Additional Inherited Members
Protected Member Functions inherited from IPlugin
virtual int	GetParamsVeto () noexcept
virtual int	GetParamsVeto () noexcept
Protected Attributes inherited from IPlugin
int	steering = none
bool	isMC = false

Constructor & Destructor Documentation

GenericPlugin() [1/2]

GenericPlugin ( )

default

Trivial constructor.

~GenericPlugin() [1/2]

virtual ~GenericPlugin ( )

virtualdefault

Trivial destructor.

GenericPlugin() [2/2]

GenericPlugin ( )

default

Trivial constructor.

~GenericPlugin() [2/2]

virtual ~GenericPlugin ( )

virtualdefault

Trivial destructor.

Member Function Documentation

ExecuteAtBegin() [1/2]

virtual void ExecuteAtBegin ( const std::set< Darwin::Physics::Variation > &  = {Darwin::Physics::nominal} )

inlinevirtual

Operation to execute at the beginning of the event loop.

Reimplemented in PhysicsObjectFlattener< GenObject, RecObject >, PhysicsObjectFlattener< GenObject, RecObject >, PhysicsObjectFlattener< GenMuon, RecMuon >, PhysicsObjectFlattener< GenMuon, RecMuon >, PhysicsObjectFlattener< GenJet, RecJet >, and PhysicsObjectFlattener< GenJet, RecJet >.

{Darwin::Physics::nominal}) { };

ExecuteAtBegin() [2/2]

virtual void ExecuteAtBegin ( const std::set< Darwin::Physics::Variation > &  = {Darwin::Physics::nominal} )

inlinevirtual

Operation to execute at the beginning of the event loop.

Reimplemented in PhysicsObjectFlattener< GenObject, RecObject >, PhysicsObjectFlattener< GenObject, RecObject >, PhysicsObjectFlattener< GenMuon, RecMuon >, PhysicsObjectFlattener< GenMuon, RecMuon >, PhysicsObjectFlattener< GenJet, RecJet >, and PhysicsObjectFlattener< GenJet, RecJet >.

{Darwin::Physics::nominal}) { };

ExecuteAtEnd() [1/2]

virtual void ExecuteAtEnd ( const std::set< Darwin::Physics::Variation > &  = {Darwin::Physics::nominal} )

inlinevirtual

Operation to execute at the end of the event loop.

Reimplemented in PhysicsObjectFlattener< GenObject, RecObject >, PhysicsObjectFlattener< GenObject, RecObject >, PhysicsObjectFlattener< GenMuon, RecMuon >, PhysicsObjectFlattener< GenMuon, RecMuon >, PhysicsObjectFlattener< GenJet, RecJet >, and PhysicsObjectFlattener< GenJet, RecJet >.

{Darwin::Physics::nominal}) { };

ExecuteAtEnd() [2/2]

virtual void ExecuteAtEnd ( const std::set< Darwin::Physics::Variation > &  = {Darwin::Physics::nominal} )

inlinevirtual

Operation to execute at the end of the event loop.

Reimplemented in PhysicsObjectFlattener< GenObject, RecObject >, PhysicsObjectFlattener< GenObject, RecObject >, PhysicsObjectFlattener< GenMuon, RecMuon >, PhysicsObjectFlattener< GenMuon, RecMuon >, PhysicsObjectFlattener< GenJet, RecJet >, and PhysicsObjectFlattener< GenJet, RecJet >.

{Darwin::Physics::nominal}) { };

Write() [1/2]

virtual void Write ( TDirectory *  )

inlinevirtual

Any object to write to the output file.

{ };

Write() [2/2]

virtual void Write ( TDirectory *  )

inlinevirtual

Any object to write to the output file.

{ };

---

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

• /builds/cms-analysis/general/DasAnalysisSystem/Core/Installer/Darwin/interface/GenericPlugin.h