#include <GainDecorator.h>

Inheritance diagram for DerivationFramework::GainDecorator:

Collaboration diagram for DerivationFramework::GainDecorator:

Classes
struct	calculation

Public Member Functions
	GainDecorator (const std::string &t, const std::string &n, const IInterface *p)

	~GainDecorator ()

StatusCode	initialize ()

StatusCode	finalize ()

virtual StatusCode	addBranches () const
	Pass the thinning service More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysInitialize () override
	Perform system initialization for an algorithm. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Static Public Member Functions
static int	getLayer (const CaloCell *cell)

static const InterfaceID &	interfaceID ()
	AlgTool interface methods. More...

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)

void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed. More...

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
calculation	decorateObject (const xAOD::Egamma *&egamma) const

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...

Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
SG::ReadHandleKey< xAOD::EgammaContainer >	m_SGKey_photons { this, "SGKey_photons", "", "SG key of photon container" }

SG::ReadHandleKey< xAOD::EgammaContainer >	m_SGKey_electrons

std::string	m_decorationPattern

std::map< int, std::string >	m_gainNames

std::vector< unsigned int >	m_layers

std::map< std::pair< int, int >, std::string >	m_names_E

std::map< std::pair< int, int >, std::string >	m_names_rnoW

std::map< std::pair< int, int >, std::string >	m_names_nCells

SG::WriteDecorHandleKeyArray< xAOD::EgammaContainer >	m_SGKey_photons_decorations

SG::WriteDecorHandleKeyArray< xAOD::EgammaContainer >	m_SGKey_electrons_decorations

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Detailed Description

Definition at line 27 of file GainDecorator.h.

Member Typedef Documentation

◆ StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< AlgTool > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ GainDecorator()

DerivationFramework::GainDecorator::GainDecorator	(	const std::string &	t,
		const std::string &	n,
		const IInterface *	p
	)

Definition at line 22 of file GainDecorator.cxx.

   : AthAlgTool(t, n, p)
 {
   declareInterface<DerivationFramework::IAugmentationTool>(this);
   declareProperty("decoration_pattern",
                   m_decorationPattern = "{info}_Lr{layer}_{gain}G");
   declareProperty("gain_names",
                   m_gainNames = { { CaloGain::LARHIGHGAIN, "Hi" },
                                   { CaloGain::LARMEDIUMGAIN, "Med" },
                                   { CaloGain::LARLOWGAIN, "Low" } });
   declareProperty("layers", m_layers = { 0, 1, 2, 3 });
  
   // Define the names for the decorations
   for (const auto& kv : m_gainNames)
     for (const auto layer : m_layers) {
       std::string name = m_decorationPattern;
       name.replace(name.find("{layer}"),
                    std::string("{layer}").size(),
                    std::to_string(layer));
       name.replace(
         name.find("{gain}"), std::string("{gain}").size(), kv.second);
       std::string name_E(name), name_rnoW(name), name_nCells(name);
       name_E.replace(name_E.find("{info}"), std::string("{info}").size(), "E");
       name_rnoW.replace(name_rnoW.find("{info}"), std::string("{info}").size(), "rnoW");
       name_nCells.replace(
         name_nCells.find("{info}"), std::string("{info}").size(), "nCells");
  
       std::pair<int, int> key(kv.first, layer);
       m_names_E[key] = name_E;
       m_names_rnoW[key] = name_rnoW;
       m_names_nCells[key] = name_nCells;
     }
  
   for (const auto& kv : m_names_E) {
     ATH_MSG_DEBUG("Decorating (layer, gain): " << kv.first << " " << kv.second);
   }
   for (const auto& kv : m_names_nCells) {
     ATH_MSG_DEBUG("Decorating (layer, gain): " << kv.first << " " << kv.second);
   }
 }

◆ ~GainDecorator()

DerivationFramework::GainDecorator::~GainDecorator ( )

default

Member Function Documentation

◆ addBranches()

StatusCode DerivationFramework::GainDecorator::addBranches ( ) const

virtual

Pass the thinning service

Implements DerivationFramework::IAugmentationTool.

Definition at line 130 of file GainDecorator.cxx.

 {
   const EventContext& ctx = Gaudi::Hive::currentContext();
  
   // Photon decorations
  
   if (!m_SGKey_photons.key().empty()) {
  
     // Retrieve photon container
     SG::ReadHandle<xAOD::EgammaContainer> photonContainer(m_SGKey_photons, ctx);
     const xAOD::EgammaContainer* importedPhotons = photonContainer.ptr();
  
     // Setup vectors of photon decorations
     std::vector<SG::WriteDecorHandle<xAOD::EgammaContainer, float>>
       decorations_E;
     std::vector<SG::WriteDecorHandle<xAOD::EgammaContainer, float>>
       decorations_rnoW;
     std::vector<SG::WriteDecorHandle<xAOD::EgammaContainer, char>>
       decorations_nCells;
     int i(0);
     for (const auto& kv : m_gainNames) {
       for (const auto layer : m_layers) {
         std::pair<int, int> key(kv.first, layer);
         decorations_E.emplace_back(
           
             m_SGKey_photons_decorations[i * 3], ctx);
         decorations_rnoW.emplace_back(
           
             m_SGKey_photons_decorations[i * 3 + 1], ctx);
         decorations_nCells.emplace_back(
           
             m_SGKey_photons_decorations[i * 3 + 2], ctx);
         i++;
       }
     }
  
     // Decorate photons
     for (const auto* photon : *importedPhotons) {
       DerivationFramework::GainDecorator::calculation res =
         decorateObject(photon);
       i = 0;
       for (const auto& kv : m_gainNames) {
         for (const auto layer : m_layers) {
           std::pair<int, int> key(kv.first, layer);
           decorations_E[i](*photon) = res.E[key];
           decorations_rnoW[i](*photon) =
         res.EnoW[key] != 0 ? res.E[key]/res.EnoW[key] : 1;
           decorations_nCells[i](*photon) = res.nCells[key];
           i++;
         }
       }
     }
   }
  
   // Electron decorations
  
   if (!m_SGKey_electrons.key().empty()) {
  
     // Retrieve electron container
     SG::ReadHandle<xAOD::EgammaContainer> electronContainer(m_SGKey_electrons,
                                                             ctx);
     const xAOD::EgammaContainer* importedElectrons = electronContainer.ptr();
  
     // Setup vectors of electron decorations
     std::vector<SG::WriteDecorHandle<xAOD::EgammaContainer, float>>
       decorations_E;
     std::vector<SG::WriteDecorHandle<xAOD::EgammaContainer, float>>
       decorations_rnoW;
     std::vector<SG::WriteDecorHandle<xAOD::EgammaContainer, char>>
       decorations_nCells;
     int i(0);
     for (const auto& kv : m_gainNames) {
       for (const auto layer : m_layers) {
         std::pair<int, int> key(kv.first, layer);
         decorations_E.emplace_back(
           
             m_SGKey_electrons_decorations[i * 3], ctx);
         decorations_rnoW.emplace_back(
           
             m_SGKey_electrons_decorations[i * 3 + 1], ctx);
         decorations_nCells.emplace_back(
           
             m_SGKey_electrons_decorations[i * 3 + 2], ctx);
         i++;
       }
     }
  
     // Decorate electrons
     for (const auto* electron : *importedElectrons) {
       DerivationFramework::GainDecorator::calculation res =
         decorateObject(electron);
       i = 0;
       for (const auto& kv : m_gainNames) {
         for (const auto layer : m_layers) {
           std::pair<int, int> key(kv.first, layer);
           decorations_E[i](*electron) = res.E[key];
           decorations_rnoW[i](*electron) =
         res.EnoW[key] != 0 ? res.E[key]/res.EnoW[key] : 1;
           decorations_nCells[i](*electron) = res.nCells[key];
           i++;
         }
       }
     }
   }
  
   return StatusCode::SUCCESS;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< AlgTool > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ decorateObject()

DerivationFramework::GainDecorator::calculation DerivationFramework::GainDecorator::decorateObject ( const xAOD::Egamma *& egamma ) const

private

Definition at line 239 of file GainDecorator.cxx.

 {
  
   // Compute energy and number of cells per gain per layer
   // Set the initial values to 0 (needed?)
   DerivationFramework::GainDecorator::calculation result;
   for (const auto& kv : m_names_E) {
     result.E[kv.first] = 0.;
     result.EnoW[kv.first] = 0.;
     result.nCells[kv.first] = 0;
   }
  
   // Skip the computation for missing cell links (like topo-seeded photons)
   // but decorate anyway
   const CaloClusterCellLink* cellLinks =
     egamma->caloCluster() ? egamma->caloCluster()->getCellLinks() : nullptr;
   if (cellLinks) {
     CaloClusterCellLink::const_iterator it = cellLinks->begin(),
       itE = cellLinks->end();
     for (; it != itE; ++it) {
       const CaloCell *cell = *it;
       if (!cell)
         continue;
       std::pair<int, int> key(static_cast<int>(cell->gain()), getLayer(cell));
       // Increment the corresponding entry (not important if it is not
       // initialised)
       double weight = it.weight();
       result.E[key] += cell->energy()*weight;
       result.EnoW[key] += cell->energy();
       result.nCells[key]++;
     }
   }
  
   return result;
 }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< AlgTool > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::extraDeps_update_handler ( Gaudi::Details::PropertyBase & ExtraDeps )

protectedinherited

Add StoreName to extra input/output deps as needed.

use the logic of the VarHandleKey to parse the DataObjID keys supplied via the ExtraInputs and ExtraOuputs Properties to add the StoreName if it's not explicitly given

◆ finalize()

StatusCode DerivationFramework::GainDecorator::finalize ( )

Definition at line 122 of file GainDecorator.cxx.

 {
  
   return StatusCode::SUCCESS;
 }

◆ getLayer()

int DerivationFramework::GainDecorator::getLayer ( const CaloCell * cell )

static

Definition at line 277 of file GainDecorator.cxx.

 {
   int sampling =
     (cell && cell->caloDDE() ? cell->caloDDE()->getSampling() : -1);
   if (sampling == CaloSampling::PreSamplerB ||
       sampling == CaloSampling::PreSamplerE)
     return 0;
   if (sampling == CaloSampling::EMB1 || sampling == CaloSampling::EME1)
     return 1;
   if (sampling == CaloSampling::EMB2 || sampling == CaloSampling::EME2)
     return 2;
   if (sampling == CaloSampling::EMB3 || sampling == CaloSampling::EME3)
     return 3;
   return -1;
 }

◆ initialize()

StatusCode DerivationFramework::GainDecorator::initialize ( )

Definition at line 70 of file GainDecorator.cxx.

 {
   ATH_MSG_VERBOSE("initialize() ...");
  
   if (m_SGKey_photons.key().empty() && m_SGKey_electrons.key().empty()) {
     ATH_MSG_FATAL("No e-gamma collection provided for thinning. At least one "
                   "egamma collection (photons/electrons) must be provided!");
     return StatusCode::FAILURE;
   }
  
   if (!m_SGKey_electrons.key().empty()) {
     ATH_MSG_DEBUG("Using " << m_SGKey_electrons << " for electrons");
     ATH_CHECK(m_SGKey_electrons.initialize());
  
     const std::string containerKey = m_SGKey_electrons.key();
     for (const auto& kv : m_gainNames) {
       for (const auto layer : m_layers) {
         std::pair<int, int> key(kv.first, layer);
         m_SGKey_electrons_decorations.emplace_back(containerKey + "." +
                                                    m_names_E[key]);
         m_SGKey_electrons_decorations.emplace_back(containerKey + "." +
                                                    m_names_rnoW[key]);
         m_SGKey_electrons_decorations.emplace_back(containerKey + "." +
                                                    m_names_nCells[key]);
       }
     }
     ATH_CHECK(m_SGKey_electrons_decorations.initialize());
   }
  
   if (!m_SGKey_photons.key().empty()) {
     ATH_MSG_DEBUG("Using " << m_SGKey_photons << " for photons");
     ATH_CHECK(m_SGKey_photons.initialize());
  
     const std::string containerKey = m_SGKey_photons.key();
     for (const auto& kv : m_gainNames) {
       for (const auto layer : m_layers) {
         std::pair<int, int> key(kv.first, layer);
         m_SGKey_photons_decorations.emplace_back(containerKey + "." +
                                                  m_names_E[key]);
         m_SGKey_photons_decorations.emplace_back(containerKey + "." +
                                                  m_names_rnoW[key]);
         m_SGKey_photons_decorations.emplace_back(containerKey + "." +
                                                  m_names_nCells[key]);
       }
     }
     ATH_CHECK(m_SGKey_photons_decorations.initialize());
   }
  
   return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::inputHandles ( ) const

overridevirtualinherited

Return this algorithm's input handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ interfaceID()

static const InterfaceID& DerivationFramework::IAugmentationTool::interfaceID ( )

inlinestaticinherited

AlgTool interface methods.

Definition at line 31 of file IAugmentationTool.h.

31 { return IID_IAugmentationTool; }

◆ msg() [1/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( ) const

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

MsgStream& AthCommonMsg< AlgTool >::msg ( const MSG::Level lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< AlgTool >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< AlgTool > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ renounce()

std::enable_if_t<std::is_void_v<std::result_of_t<decltype(&T::renounce)(T)> > && !std::is_base_of_v<SG::VarHandleKeyArray, T> && std::is_base_of_v<Gaudi::DataHandle, T>, void> AthCommonDataStore< AthCommonMsg< AlgTool > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

   {
     h.renounce();
     PBASE::renounce (h);
   }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ sysInitialize()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysInitialize ( )

overridevirtualinherited

Perform system initialization for an algorithm.

We override this to declare all the elements of handle key arrays at the end of initialization. See comments on updateVHKA.

Reimplemented in DerivationFramework::CfAthAlgTool, AthCheckedComponent< AthAlgTool >, AthCheckedComponent<::AthAlgTool >, and asg::AsgMetadataTool.

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< AlgTool > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

void AthCommonDataStore< AthCommonMsg< AlgTool > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                                {
     // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
     //         << "  size: " << m_vhka.size() << endmsg;
     for (auto &a : m_vhka) {
       std::vector<SG::VarHandleKey*> keys = a->keys();
       for (auto k : keys) {
         k->setOwner(this);
       }
     }
   }

Member Data Documentation

◆ m_decorationPattern

std::string DerivationFramework::GainDecorator::m_decorationPattern

private

Definition at line 59 of file GainDecorator.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_gainNames

std::map<int, std::string> DerivationFramework::GainDecorator::m_gainNames

private

Definition at line 60 of file GainDecorator.h.

◆ m_layers

std::vector<unsigned int> DerivationFramework::GainDecorator::m_layers

private

Definition at line 61 of file GainDecorator.h.

◆ m_names_E

std::map<std::pair<int, int>, std::string> DerivationFramework::GainDecorator::m_names_E

private

Definition at line 64 of file GainDecorator.h.

◆ m_names_nCells

std::map<std::pair<int, int>, std::string> DerivationFramework::GainDecorator::m_names_nCells

private

Definition at line 66 of file GainDecorator.h.

◆ m_names_rnoW

std::map<std::pair<int, int>, std::string> DerivationFramework::GainDecorator::m_names_rnoW

private

Definition at line 65 of file GainDecorator.h.

◆ m_SGKey_electrons

SG::ReadHandleKey<xAOD::EgammaContainer> DerivationFramework::GainDecorator::m_SGKey_electrons

private

Initial value:

{
    this,
    "SGKey_electrons",
    "",
    "SG key of electron container"
  }

Definition at line 52 of file GainDecorator.h.

◆ m_SGKey_electrons_decorations

SG::WriteDecorHandleKeyArray<xAOD::EgammaContainer> DerivationFramework::GainDecorator::m_SGKey_electrons_decorations

private

Initial value:

{
      this,
      "SGKey_electrons_decorations_noConf",
      {},
      "SG keys for electrons decorations not really configurable"
    }

Definition at line 77 of file GainDecorator.h.

◆ m_SGKey_photons

SG::ReadHandleKey<xAOD::EgammaContainer> DerivationFramework::GainDecorator::m_SGKey_photons { this, "SGKey_photons", "", "SG key of photon container" }

private

Definition at line 50 of file GainDecorator.h.

◆ m_SGKey_photons_decorations

SG::WriteDecorHandleKeyArray<xAOD::EgammaContainer> DerivationFramework::GainDecorator::m_SGKey_photons_decorations

private

Initial value:

{
      this,
      "SGKey_photons_decorations_noConf",
      {},
      "SG keys for photon decorations not really configurable"
    }

Definition at line 69 of file GainDecorator.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< AlgTool > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

std::vector<SG::VarHandleKeyArray*> AthCommonDataStore< AthCommonMsg< AlgTool > >::m_vhka

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Classes

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ GainDecorator()

◆ ~GainDecorator()

Member Function Documentation

◆ addBranches()

◆ declareGaudiProperty() [1/4]

◆ declareGaudiProperty() [2/4]

◆ declareGaudiProperty() [3/4]

◆ declareGaudiProperty() [4/4]

◆ declareProperty() [1/6]

◆ declareProperty() [2/6]

◆ declareProperty() [3/6]

◆ declareProperty() [4/6]

◆ declareProperty() [5/6]

◆ declareProperty() [6/6]

◆ decorateObject()

◆ detStore()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ finalize()

◆ getLayer()

◆ initialize()

◆ inputHandles()

◆ interfaceID()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_decorationPattern

◆ m_detStore

◆ m_evtStore

◆ m_gainNames

◆ m_layers

◆ m_names_E

◆ m_names_nCells

◆ m_names_rnoW

◆ m_SGKey_electrons

◆ m_SGKey_electrons_decorations

◆ m_SGKey_photons

◆ m_SGKey_photons_decorations

◆ m_varHandleArraysDeclared

◆ m_vhka