#include <DerivationKernel.h>

Inheritance diagram for DerivationFramework::DerivationKernel:

Collaboration diagram for DerivationFramework::DerivationKernel:

Public Member Functions
	DerivationKernel (const std::string &name, ISvcLocator *pSvcLocator)

StatusCode	initialize ()

StatusCode	execute ()

StatusCode	finalize ()

virtual StatusCode	sysInitialize () override
	Initialization method invoked by the framework. More...

virtual void	setFilterPassed (bool state) const
	Set the filter passed flag to the specified state. More...

void	setFilterDescription (const std::string &descr)
	helper method to ease the setting of this filter's description in derived classes Note that this method should be called in the c-tor of derived classes More...

ServiceHandle< ICutFlowSvc > &	cutFlowSvc ()
	return a handle to an `ICutFlowSvc` instance More...

CutIdentifier	cutID ()
	return the `CutIdentifier` corresponding to the top-level cut of this filter algorithm More...

const SG::ReadHandleKey< xAOD::EventInfo > &	eventInfoKey () const
	EventInfo key for use in derived classes. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. 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	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

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< ICutFlowSvc >	ICutFlowSvc_t

typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
void	doNotResetSelfDescription (Gaudi::Details::PropertyBase &)

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
ToolHandleArray< ISkimmingTool >	m_skimmingTools

ToolHandleArray< IThinningTool >	m_thinningTools

ToolHandleArray< IAugmentationTool >	m_augmentationTools

ServiceHandle< IChronoStatSvc >	m_chronoSvc

int	m_eventCounter

int	m_acceptCntr

bool	m_runSkimmingFirst

Gaudi::Property< bool >	m_doChronoStat {this,"doChronoStat",true,"use ChronoStatSvc (only in serial jobs)"}

CutIdentifier	m_cutID
	The CutIdentifier for this filter algorithm. More...

ICutFlowSvc_t	m_cutFlowSvc
	handle to the service holding tables of cut-flows for filtering algs. More...

std::string	m_filterDescr
	filter description: describes what this filter does. More...

bool	m_resetSelfDescription

SG::ReadHandleKey< xAOD::EventInfo >	m_eventInfoKey { this, "EventInfoKey", "EventInfo", "" }

DataObjIDColl	m_extendedExtraObjects

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 23 of file DerivationKernel.h.

Member Typedef Documentation

◆ ICutFlowSvc_t

typedef ServiceHandle<ICutFlowSvc> AthFilterAlgorithm::ICutFlowSvc_t

privateinherited

Definition at line 84 of file AthFilterAlgorithm.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ DerivationKernel()

DerivationFramework::DerivationKernel::DerivationKernel	(	const std::string &	name,
		ISvcLocator *	pSvcLocator
	)

Definition at line 59 of file DerivationKernel.cxx.

                                                                                                      :
 AthFilterAlgorithm(name, pSvcLocator),
 m_chronoSvc("ChronoStatSvc", name),
 m_runSkimmingFirst(false)
 {
     // ------- Python changeable properties -------
     declareProperty("SkimmingTools",         m_skimmingTools);
     declareProperty("ThinningTools",         m_thinningTools);
     declareProperty("AugmentationTools",     m_augmentationTools);
     declareProperty("RunSkimmingFirst",      m_runSkimmingFirst);
     //declareProperty("PrintCutFlow",          m_printCutFlow);
     //declareProperty("PrintMemoryAndCPU",     m_printMemCPU)
     //---------------------------------------------
     
     // Counters
     m_eventCounter = 0;
     m_acceptCntr = 0;
 }

Member Function Documentation

◆ cutFlowSvc()

ServiceHandle< ICutFlowSvc > & AthFilterAlgorithm::cutFlowSvc ( )

inlineinherited

return a handle to an ICutFlowSvc instance

Definition at line 108 of file AthFilterAlgorithm.h.

 {
   return m_cutFlowSvc;
 }

◆ cutID()

CutIdentifier AthFilterAlgorithm::cutID ( )

inlineinherited

return the CutIdentifier corresponding to the top-level cut of this filter algorithm

Definition at line 116 of file AthFilterAlgorithm.h.

 {
   return m_cutID;
 }

◆ declareGaudiProperty() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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< Algorithm > >::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());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Algorithm > >::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; }

◆ doNotResetSelfDescription()

void AthFilterAlgorithm::doNotResetSelfDescription ( Gaudi::Details::PropertyBase & )

inlineprivateinherited

Definition at line 124 of file AthFilterAlgorithm.h.

 { 
   m_resetSelfDescription=false; 
 }

◆ eventInfoKey()

const SG::ReadHandleKey< xAOD::EventInfo > & AthFilterAlgorithm::eventInfoKey ( ) const

inherited

EventInfo key for use in derived classes.

Definition at line 134 of file AthFilterAlgorithm.cxx.

 {
   return m_eventInfoKey;
 }

◆ evtStore() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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; }

◆ execute()

StatusCode DerivationFramework::DerivationKernel::execute ( )

Definition at line 176 of file DerivationKernel.cxx.

                                                         {
  
   IChronoSvc* cSvc=m_chronoSvc.get(); //Might be null ... 
   // On your marks.... get set.... (but only if not in MT)
   Chrono chrono( cSvc , name() ); 
     // GO!!!
  
     ATH_MSG_DEBUG(name() << " is processing next event...");
     
     // Increment the event counter
     m_eventCounter++;
   
     //=============================================================================
     // AUGMENTATION ===============================================================
     //=============================================================================
  
     if (!m_runSkimmingFirst) {
         ToolHandleArray<IAugmentationTool>::iterator augmentationTool(m_augmentationTools.begin());
         ToolHandleArray<IAugmentationTool>::iterator endOfAugmentationTools(m_augmentationTools.end());
         while (augmentationTool != endOfAugmentationTools) {
             ATH_MSG_DEBUG("Entering " << (**augmentationTool).name());
             if ( (**augmentationTool).addBranches().isFailure() ) {
                     ATH_MSG_ERROR("Augmentation failed!");
                     return StatusCode::FAILURE;
             }
             ++augmentationTool;
         }
     }    
  
     //=============================================================================
     //SKIMMING ===================================================================
     //=============================================================================
  
     // Set master flag to true
     bool acceptEvent(true);
  
     // Loop over the filters
     ToolHandleArray<ISkimmingTool>::iterator skimmingTool(m_skimmingTools.begin());
     ToolHandleArray<ISkimmingTool>::iterator endOfSkimmingTools(m_skimmingTools.end());
     while (skimmingTool != endOfSkimmingTools) {
         ATH_MSG_DEBUG("Entering " << (**skimmingTool).name());
         if (!((**skimmingTool).eventPassesFilter())) {
             acceptEvent=false;
             ATH_MSG_DEBUG("This event failed the " << (**skimmingTool).name() << " filter. Therefore it will not be recorded.");
             break;
         }
         ++skimmingTool;
     }
  
     // Increment local counters if event to be accepted
     if (acceptEvent) ++m_acceptCntr;
     
     // Set the setFilterPassed flag 
     setFilterPassed(acceptEvent);
  
     // Return if event didn't pass
     if (!acceptEvent) return StatusCode::SUCCESS;
  
     // If user requested skimming first, run augmentation now...
     if (m_runSkimmingFirst) {
         ToolHandleArray<IAugmentationTool>::iterator augmentationTool(m_augmentationTools.begin());
         ToolHandleArray<IAugmentationTool>::iterator endOfAugmentationTools(m_augmentationTools.end());
         while (augmentationTool != endOfAugmentationTools) {
             ATH_MSG_DEBUG("Entering " << (**augmentationTool).name());
             if ( (**augmentationTool).addBranches().isFailure() ) {
                     ATH_MSG_ERROR("Augmentation failed!");
                     return StatusCode::FAILURE;
             }
             ++augmentationTool;
         }
     }
  
  
     //=============================================================================
     // THINNING ===================================================================
     //=============================================================================
  
     ToolHandleArray<IThinningTool>::iterator thinningTool(m_thinningTools.begin());
     ToolHandleArray<IThinningTool>::iterator endOfThinningTools(m_thinningTools.end());
     while (thinningTool != endOfThinningTools) {
     ATH_MSG_DEBUG("Entering " << (**thinningTool).name());
     if ( (**thinningTool).doThinning().isFailure() ) {
         ATH_MSG_ERROR("Thinning failed!");
                 return StatusCode::FAILURE;
     }
     ++thinningTool;
     }
  
  
     return StatusCode::SUCCESS;
     
 }

◆ extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

This list is extended to include symlinks implied by inheritance relations.

Definition at line 50 of file AthAlgorithm.cxx.

 {
   // If we didn't find any symlinks to add, just return the collection
   // from the base class.  Otherwise, return the extended collection.
   if (!m_extendedExtraObjects.empty()) {
     return m_extendedExtraObjects;
   }
   return Algorithm::extraOutputDeps();
 }

◆ finalize()

StatusCode DerivationFramework::DerivationKernel::finalize ( )

Definition at line 271 of file DerivationKernel.cxx.

                                                          {
     
     ATH_MSG_INFO( "============================================================================");
     ATH_MSG_INFO( "|| SUMMARY OF THE DERIVATION FRAMEWORK KERNEL WITH NAME " << name() << " || ");
     ATH_MSG_INFO( "============================================================================");
     ATH_MSG_INFO( "============================================================================");
     ATH_MSG_INFO( "Events analyzed: " << m_eventCounter);
     ATH_MSG_INFO( "Events accepted: " << m_acceptCntr);
     ATH_MSG_INFO( "============================================================================");
     
     return StatusCode::SUCCESS;
     
 }

◆ initialize()

StatusCode DerivationFramework::DerivationKernel::initialize ( )

Definition at line 80 of file DerivationKernel.cxx.

                                                            {
     
     ATH_MSG_INFO("Initializing the derivation framework kernel " << name());
     
     // get the tool service
     IToolSvc* toolSvc;
     StatusCode sc = service("ToolSvc",toolSvc);
     if (StatusCode::SUCCESS != sc) {
         ATH_MSG_FATAL("Unable to retrieve ToolSvc");
         return StatusCode::FAILURE;
     }
     
     // get the skimming tools
     if( m_skimmingTools.retrieve().isFailure() ) {
         ATH_MSG_FATAL("Failed to retrieve skimming tools");
         return StatusCode::FAILURE;
     } else {
         ATH_MSG_INFO("The following skimming tools will be applied....");
         ATH_MSG_INFO(m_skimmingTools);
     }
     // get the thinning tools
     if( m_thinningTools.retrieve().isFailure() ) {
         ATH_MSG_FATAL("Failed to retrieve thinning tools");
         return StatusCode::FAILURE;
     } else {
         ATH_MSG_INFO("The following thinning tools will be applied");
         ATH_MSG_INFO(m_thinningTools);
     }
     // get the augmentation tools
     if( m_augmentationTools.retrieve().isFailure() ) {
         ATH_MSG_FATAL("Failed to retrieve augmentation tools");
         return StatusCode::FAILURE;
     } else {
         ATH_MSG_INFO("The following augmentation tools will be applied....");
         ATH_MSG_INFO(m_augmentationTools);
     }
  
     if (m_doChronoStat) {
       //get the chrono auditor
       ATH_CHECK(m_chronoSvc.retrieve());
     }
    
     if (m_runSkimmingFirst) {
     ATH_MSG_INFO("Skimming will be run before augmentation. Make sure your skimming does not depend on variables calculated in the augmentation step!");
     }
  
     std::unordered_set<std::string> outputs;
     std::vector<const DataObjID *> output_ids;
     auto output_collector = [&outputs, &output_ids](IAlgTool *a_tool_interface) {
        const AlgTool *alg_tool = dynamic_cast<AlgTool *>(a_tool_interface);
        if (alg_tool) {
           collectOutputs(outputs,output_ids, alg_tool);
        }
     };
     auto renounce_and_collect_outputs = [&outputs, &output_ids](IAlgTool *a_tool_interface) {
        AlgTool *alg_tool = dynamic_cast<AlgTool *>(a_tool_interface);
        if (alg_tool) {
           renounceInputs(outputs,output_ids, alg_tool);
           collectOutputs(outputs,output_ids, alg_tool);
        }
     };
     auto renouncer = [&outputs, &output_ids](IAlgTool *a_tool_interface) {
        AlgTool *alg_tool = dynamic_cast<AlgTool *>(a_tool_interface);
        if (alg_tool) {
           renounceInputs(outputs,output_ids, alg_tool);
        }
     };
  
     // collection and renouncing has to happen in the order the tools are called
     // during execute.
     if (m_runSkimmingFirst) {
        for (ToolHandle<ISkimmingTool> &a_tool_handle : m_skimmingTools ) {
           visitTools(*a_tool_handle, output_collector);
        }
        for (ToolHandle<IAugmentationTool> &a_tool_handle : m_augmentationTools ) {
           visitTools(*a_tool_handle, renounce_and_collect_outputs);
        }
     }
     else {
        for (ToolHandle<IAugmentationTool> &a_tool_handle : m_augmentationTools ) {
           visitTools(*a_tool_handle, output_collector);
        }
        for (ToolHandle<ISkimmingTool> &a_tool_handle : m_skimmingTools ) {
           visitTools(*a_tool_handle, renounce_and_collect_outputs);
        }
     }
     for (ToolHandle<IThinningTool> &a_tool_handle : m_thinningTools ) {
        visitTools(*a_tool_handle, renouncer);
     }
  
    
     return StatusCode::SUCCESS;
 }

◆ inputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Algorithm > >::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.

◆ msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::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< Algorithm > >::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< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

◆ renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                           {
     handlesArray.renounce();
   }

◆ setFilterDescription()

void AthFilterAlgorithm::setFilterDescription ( const std::string & descr )

inherited

helper method to ease the setting of this filter's description in derived classes Note that this method should be called in the c-tor of derived classes

helper function to ease the setting of this filter's description in derived classes

Definition at line 118 of file AthFilterAlgorithm.cxx.

 {
   if( cutFlowSvc()==0 ){
     m_filterDescr = descr;
   }
   else if( m_resetSelfDescription and cutID() ){
     cutFlowSvc()->setFilterDescription(cutID(),descr);
   }
   else{
     ATH_MSG_INFO("problem setting filter description with cutflow-svc");
   }
  
   return;
 }

◆ setFilterPassed()

void AthFilterAlgorithm::setFilterPassed ( bool state ) const

virtualinherited

Set the filter passed flag to the specified state.

Definition at line 99 of file AthFilterAlgorithm.cxx.

 {
   AthAlgorithm::setFilterPassed(state);
  
   if (state) {
     const EventContext& ctx = Gaudi::Hive::currentContext();
     SG::ReadHandle<xAOD::EventInfo> evtInfo (m_eventInfoKey, ctx);
     // Only try to access the mcEventWeight if we are running on Monte Carlo, duhhh!
     if ( evtInfo->eventType(xAOD::EventInfo::IS_SIMULATION) ) {
       m_cutFlowSvc->addEvent(m_cutID, evtInfo->mcEventWeights());
     } else {
       m_cutFlowSvc->addEvent(m_cutID, 1.0);
     }
   }
 }

◆ sysInitialize()

StatusCode AthFilterAlgorithm::sysInitialize ( )

overridevirtualinherited

Initialization method invoked by the framework.

This method is responsible for any bookkeeping of initialization required by the framework itself. It will in turn invoke the initialize() method of the derived algorithm, and of any sub-algorithms which it creates.

Reimplemented from AthAlgorithm.

Definition at line 65 of file AthFilterAlgorithm.cxx.

 {
   // ---- stolen from GaudiKernel/Algorithm::sysInitialize -------
   // Bypass the initialization if the algorithm
   // has already been initialized.
   if ( Gaudi::StateMachine::INITIALIZED <= FSMState() ) return StatusCode::SUCCESS;
  
   // Set the Algorithm's properties
   bindPropertiesTo( serviceLocator()->getOptsSvc() );
  
   // Bypass the initialization if the algorithm is disabled.
   // Need to do this after bindPropertiesTo.
   if ( !isEnabled( ) ) return StatusCode::SUCCESS;
  
   // ---- stolen from GaudiKernel/Algorithm::sysInitialize ------- END ---
  
   // register ourselves with the cutFlowSvc
   if ( cutFlowSvc().retrieve().isSuccess()) {
     m_cutID = cutFlowSvc()->registerFilter(this->name(), m_filterDescr, false);
     if (0 == m_cutID) {
       ATH_MSG_INFO("problem registering myself with cutflow-svc");
     } else {
       ATH_MSG_VERBOSE("registered with cutflow-svc");
     }
   }
  
   ATH_CHECK( m_eventInfoKey.initialize() );
  
   // re-direct to base class...
   return AthAlgorithm::sysInitialize();
 }

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::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< Algorithm > >::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_acceptCntr

int DerivationFramework::DerivationKernel::m_acceptCntr

private

Definition at line 39 of file DerivationKernel.h.

◆ m_augmentationTools

ToolHandleArray<IAugmentationTool> DerivationFramework::DerivationKernel::m_augmentationTools

private

Definition at line 34 of file DerivationKernel.h.

◆ m_chronoSvc

ServiceHandle<IChronoStatSvc> DerivationFramework::DerivationKernel::m_chronoSvc

private

Definition at line 35 of file DerivationKernel.h.

◆ m_cutFlowSvc

ICutFlowSvc_t AthFilterAlgorithm::m_cutFlowSvc

privateinherited

handle to the service holding tables of cut-flows for filtering algs.

Definition at line 86 of file AthFilterAlgorithm.h.

◆ m_cutID

CutIdentifier AthFilterAlgorithm::m_cutID

privateinherited

The CutIdentifier for this filter algorithm.

Definition at line 82 of file AthFilterAlgorithm.h.

◆ m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default)

Definition at line 393 of file AthCommonDataStore.h.

◆ m_doChronoStat

Gaudi::Property<bool> DerivationFramework::DerivationKernel::m_doChronoStat {this,"doChronoStat",true,"use ChronoStatSvc (only in serial jobs)"}

private

Definition at line 42 of file DerivationKernel.h.

◆ m_eventCounter

int DerivationFramework::DerivationKernel::m_eventCounter

private

Definition at line 38 of file DerivationKernel.h.

◆ m_eventInfoKey

SG::ReadHandleKey<xAOD::EventInfo> AthFilterAlgorithm::m_eventInfoKey { this, "EventInfoKey", "EventInfo", "" }

privateinherited

Definition at line 96 of file AthFilterAlgorithm.h.

◆ m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default)

Definition at line 390 of file AthCommonDataStore.h.

◆ m_extendedExtraObjects

DataObjIDColl AthAlgorithm::m_extendedExtraObjects

privateinherited

Definition at line 79 of file AthAlgorithm.h.

◆ m_filterDescr

std::string AthFilterAlgorithm::m_filterDescr

privateinherited

filter description: describes what this filter does.

this is usually pushed to the ICutFlowSvc

Definition at line 90 of file AthFilterAlgorithm.h.

◆ m_resetSelfDescription

bool AthFilterAlgorithm::m_resetSelfDescription

privateinherited

Definition at line 93 of file AthFilterAlgorithm.h.

◆ m_runSkimmingFirst

bool DerivationFramework::DerivationKernel::m_runSkimmingFirst

private

Definition at line 40 of file DerivationKernel.h.

◆ m_skimmingTools

ToolHandleArray<ISkimmingTool> DerivationFramework::DerivationKernel::m_skimmingTools

private

Definition at line 32 of file DerivationKernel.h.

◆ m_thinningTools

ToolHandleArray<IThinningTool> DerivationFramework::DerivationKernel::m_thinningTools

private

Definition at line 33 of file DerivationKernel.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ ICutFlowSvc_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ DerivationKernel()

Member Function Documentation

◆ cutFlowSvc()

◆ cutID()

◆ 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]

◆ detStore()

◆ doNotResetSelfDescription()

◆ eventInfoKey()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ setFilterDescription()

◆ setFilterPassed()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_acceptCntr

◆ m_augmentationTools

◆ m_chronoSvc

◆ m_cutFlowSvc

◆ m_cutID

◆ m_detStore

◆ m_doChronoStat

◆ m_eventCounter

◆ m_eventInfoKey

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_filterDescr

◆ m_resetSelfDescription

◆ m_runSkimmingFirst

◆ m_skimmingTools

◆ m_thinningTools

◆ m_varHandleArraysDeclared

◆ m_vhka