#include "EnergyCorrectionsPlugin.h"

Collaboration diagram for pandora::EnergyCorrections:

[legend]

Public Member Functions
StatusCode	MakeEnergyCorrections (const Cluster *const pCluster, float &correctedElectromagneticEnergy, float &correctedHadronicEnergy) const
	Make an ordered list of energy corrections to a cluster.

Private Types
typedef std::vector< EnergyCorrectionPlugin * >	EnergyCorrectionPluginVector

typedef std::map< std::string, EnergyCorrectionPlugin * >	EnergyCorrectionPluginMap

Private Member Functions
	EnergyCorrections (const Pandora *const pPandora)
	Default constructor.

	~EnergyCorrections ()
	Destructor.

StatusCode	RegisterPlugin (const std::string &pluginName, const EnergyCorrectionType energyCorrectionType, EnergyCorrectionPlugin *const pEnergyCorrectionPlugin)
	Register an energy correction plugin.

StatusCode	InitializePlugins (const TiXmlHandle *const pXmlHandle)
	Initialize plugins.

StatusCode	InitializePlugin (const TiXmlHandle *const pXmlHandle, const std::string &xmlTagName, const EnergyCorrectionType energyCorrectionType, EnergyCorrectionPluginVector &energyCorrectionPluginVector)
	Read requested plugin names/labels from a specified xml tag and attempt to assign the plugin pointers as requested.

EnergyCorrectionPluginMap &	GetEnergyCorrectionPluginMap (const EnergyCorrectionType energyCorrectionType)
	Get the energy correction plugin map corresponding to the specified energy correction type.

StatusCode	ResetForNextEvent ()
	Call the reset callback in all managed plugins.

Private Attributes
const Pandora *const	m_pPandora
	Address of the associated pandora instance.

EnergyCorrectionPluginMap	m_hadEnergyCorrectionPluginMap
	The hadronic energy correction plugin map.

EnergyCorrectionPluginMap	m_emEnergyCorrectionPluginMap
	The electromagnetic energy correction plugin map.

EnergyCorrectionPluginVector	m_hadEnergyCorrectionPlugins
	The final hadronic energy correction plugin vector.

EnergyCorrectionPluginVector	m_emEnergyCorrectionPlugins
	The final electromagnetic energy correction plugin vector.

Friends
class	PandoraApiImpl

class	PluginManager

Detailed Description

EnergyCorrections class.

Definition at line 45 of file EnergyCorrectionsPlugin.h.

Member Typedef Documentation

◆ EnergyCorrectionPluginMap

typedef std::map<std::string, EnergyCorrectionPlugin *> pandora::EnergyCorrections::EnergyCorrectionPluginMap

private

Definition at line 100 of file EnergyCorrectionsPlugin.h.

◆ EnergyCorrectionPluginVector

typedef std::vector<EnergyCorrectionPlugin *> pandora::EnergyCorrections::EnergyCorrectionPluginVector

private

Definition at line 87 of file EnergyCorrectionsPlugin.h.

Constructor & Destructor Documentation

◆ EnergyCorrections()

pandora::EnergyCorrections::EnergyCorrections ( const Pandora *const pPandora )

private

Default constructor.

Parameters

pPandora address of the associated pandora instance

Definition at line 40 of file EnergyCorrectionsPlugin.cc.

◆ ~EnergyCorrections()

pandora::EnergyCorrections::~EnergyCorrections ( )

private

Destructor.

Definition at line 47 of file EnergyCorrectionsPlugin.cc.

Member Function Documentation

◆ GetEnergyCorrectionPluginMap()

EnergyCorrections::EnergyCorrectionPluginMap & pandora::EnergyCorrections::GetEnergyCorrectionPluginMap ( const EnergyCorrectionType energyCorrectionType )

private

Get the energy correction plugin map corresponding to the specified energy correction type.

Parameters

energyCorrectionType the energy correction type

Returns: reference to the relevant energy correction plugin map

Definition at line 137 of file EnergyCorrectionsPlugin.cc.

Here is the caller graph for this function:

◆ InitializePlugin()

StatusCode pandora::EnergyCorrections::InitializePlugin	(	const TiXmlHandle *const	pXmlHandle,
		const std::string &	xmlTagName,
		const EnergyCorrectionType	energyCorrectionType,
		EnergyCorrectionPluginVector &	energyCorrectionPluginVector
	)

private

Read requested plugin names/labels from a specified xml tag and attempt to assign the plugin pointers as requested.

Parameters

pXmlHandle	address of the relevant xml handle
xmlTagName	the xml tag name for a given energy correction type
energyCorrectionType	the energy correction type
energyCorrectionPluginVector	to receive the addresses of the energy correction plugins

Definition at line 110 of file EnergyCorrectionsPlugin.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ InitializePlugins()

StatusCode pandora::EnergyCorrections::InitializePlugins ( const TiXmlHandle *const pXmlHandle )

private

Initialize plugins.

Parameters

pXmlHandle address of the relevant xml handle

Definition at line 78 of file EnergyCorrectionsPlugin.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ MakeEnergyCorrections()

StatusCode pandora::EnergyCorrections::MakeEnergyCorrections	(	const Cluster *const	pCluster,
		float &	correctedElectromagneticEnergy,
		float &	correctedHadronicEnergy
	)		const

Make an ordered list of energy corrections to a cluster.

Parameters

pCluster	address of the cluster
correctedElectromagneticEnergy	to receive the corrected electromagnetic energy
correctedHadronicEnergy	to receive the corrected hadronic energy

Definition at line 18 of file EnergyCorrectionsPlugin.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ RegisterPlugin()

StatusCode pandora::EnergyCorrections::RegisterPlugin	(	const std::string &	pluginName,
		const EnergyCorrectionType	energyCorrectionType,
		EnergyCorrectionPlugin *const	pEnergyCorrectionPlugin
	)

private

Register an energy correction plugin.

Parameters

pluginName	the name/label associated with the energy correction plugin
energyCorrectionType	the energy correction type
energyCorrectionPlugin	pointer to an energy correction plugin

Definition at line 63 of file EnergyCorrectionsPlugin.cc.

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ResetForNextEvent()

StatusCode pandora::EnergyCorrections::ResetForNextEvent ( )

private

Call the reset callback in all managed plugins.

Definition at line 154 of file EnergyCorrectionsPlugin.cc.

Here is the caller graph for this function:

Friends And Related Symbol Documentation

◆ PandoraApiImpl

friend class PandoraApiImpl

friend

Definition at line 122 of file EnergyCorrectionsPlugin.h.

◆ PluginManager

friend class PluginManager

friend

Definition at line 123 of file EnergyCorrectionsPlugin.h.

Member Data Documentation

◆ m_emEnergyCorrectionPluginMap

EnergyCorrectionPluginMap pandora::EnergyCorrections::m_emEnergyCorrectionPluginMap

private

The electromagnetic energy correction plugin map.

Definition at line 118 of file EnergyCorrectionsPlugin.h.

◆ m_emEnergyCorrectionPlugins

EnergyCorrectionPluginVector pandora::EnergyCorrections::m_emEnergyCorrectionPlugins

private

The final electromagnetic energy correction plugin vector.

Definition at line 120 of file EnergyCorrectionsPlugin.h.

◆ m_hadEnergyCorrectionPluginMap

EnergyCorrectionPluginMap pandora::EnergyCorrections::m_hadEnergyCorrectionPluginMap

private

The hadronic energy correction plugin map.

Definition at line 117 of file EnergyCorrectionsPlugin.h.

◆ m_hadEnergyCorrectionPlugins

EnergyCorrectionPluginVector pandora::EnergyCorrections::m_hadEnergyCorrectionPlugins

private

The final hadronic energy correction plugin vector.

Definition at line 119 of file EnergyCorrectionsPlugin.h.

◆ m_pPandora

const Pandora* const pandora::EnergyCorrections::m_pPandora

private

Address of the associated pandora instance.

Definition at line 116 of file EnergyCorrectionsPlugin.h.

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

PandoraSDK/include/Plugins/EnergyCorrectionsPlugin.h
PandoraSDK/src/Plugins/EnergyCorrectionsPlugin.cc

Public Member Functions

Private Types

Private Member Functions

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ EnergyCorrectionPluginMap

◆ EnergyCorrectionPluginVector

Constructor & Destructor Documentation

◆ EnergyCorrections()

◆ ~EnergyCorrections()

Member Function Documentation

◆ GetEnergyCorrectionPluginMap()

◆ InitializePlugin()

◆ InitializePlugins()

◆ MakeEnergyCorrections()

◆ RegisterPlugin()

◆ ResetForNextEvent()

Friends And Related Symbol Documentation

◆ PandoraApiImpl

◆ PluginManager

Member Data Documentation

◆ m_emEnergyCorrectionPluginMap

◆ m_emEnergyCorrectionPlugins

◆ m_hadEnergyCorrectionPluginMap

◆ m_hadEnergyCorrectionPlugins

◆ m_pPandora