A testing algorithm for the dual-use event cleaning tool in Athena. More...

#include <EventCleaningTestAlg.h>

Inheritance diagram for EventCleaningTestAlg:

Collaboration diagram for EventCleaningTestAlg:

Public Member Functions
	EventCleaningTestAlg (const std::string &name, ISvcLocator *svcLoc)
	Standard algorithm constructor.
virtual StatusCode	initialize () override
	Initialize the algorithm.
virtual StatusCode	execute () override
	Execute the algorithm.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ToolHandle< ECUtils::IEventCleaningTool >	m_ecTool {this, "EventCleaningTool","ECUtils::EventCleaningTool/EventCleaningTool" }
SG::ReadHandleKey< xAOD::JetContainer >	m_jetKey
SG::ReadHandleKey< xAOD::EventInfo >	m_evtKey
Gaudi::Property< std::string >	m_prefix
	Configuration.
Gaudi::Property< std::string >	m_cleaningLevel
Gaudi::Property< bool >	m_doEvent {this, "doEvent" , true, "Decorate the EventInfo"}
SG::WriteDecorHandleKey< xAOD::EventInfo >	m_evtInfoDecor {this, "EvtDecorKey", "" , "Will be overwritten in initialze"}
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

A testing algorithm for the dual-use event cleaning tool in Athena.

Author: Julia Gonski j.gon.nosp@m.ski@.nosp@m.cern..nosp@m.ch

Definition at line 25 of file EventCleaningTestAlg.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ EventCleaningTestAlg()

EventCleaningTestAlg::EventCleaningTestAlg	(	const std::string &	name,
		ISvcLocator *	svcLoc )

Standard algorithm constructor.

Definition at line 15 of file EventCleaningTestAlg.cxx.

17 : AthAlgorithm(name, svcLoc) {}

AthAlgorithm::AthAlgorithm

AthAlgorithm()

Default constructor:

Member Function Documentation

◆ declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T, V, H > &	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());
 
  }

◆ declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & 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; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode EventCleaningTestAlg::execute ( )

overridevirtual

Execute the algorithm.

Definition at line 46 of file EventCleaningTestAlg.cxx.

{
  const EventContext& ctx = Gaudi::Hive::currentContext();
  // Jets
  SG::ReadHandle<xAOD::JetContainer> jets{m_jetKey, ctx};
  if (!jets.isValid()) {
    ATH_MSG_FATAL("Failed to retrieve jet collection "<<m_jetKey.fullKey());
    return StatusCode::FAILURE;
  }
  // Apply the event cleaning
  bool result = m_ecTool->acceptEvent(jets.cptr());
 
  //Decorate event
  if(m_doEvent){
    SG::WriteDecorHandle<xAOD::EventInfo, char> eventInfo{m_evtInfoDecor, ctx};
    if (!eventInfo.isValid()){
       ATH_MSG_FATAL("Failed to retrieve the event info "<<m_evtKey.fullKey());
       return StatusCode::FAILURE;
    }
    eventInfo(*eventInfo) = result;
  }
 
  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();
}

◆ initialize()

StatusCode EventCleaningTestAlg::initialize ( )

overridevirtual

Initialize the algorithm.

Definition at line 22 of file EventCleaningTestAlg.cxx.

{
  ATH_MSG_INFO("Initialize");
 
  // Try to retrieve the tool
  ATH_CHECK( m_ecTool.retrieve() );
  ATH_CHECK( m_jetKey.initialize());
  ATH_CHECK( m_evtKey.initialize() );
  // Create the decorator
  // Use an if statement to leave a legacy 
  auto labelString = m_cleaningLevel;
  if (m_jetKey.key() == "AntiKt4EMTopoJets") {
    labelString = m_cleaningLevel + "_EMTopo";
  }
  else {}
 
  m_evtInfoDecor = m_evtKey.key() + "." + m_prefix + "eventClean_"+labelString;
  ATH_CHECK(m_evtInfoDecor.initialize(m_doEvent));
  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()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ 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();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

Loop through all output handles, and if they're WriteCondHandles, automatically register them and this Algorithm with the CondSvc

Scan through all outputHandles, and if they're WriteCondHandles, register them with the CondSvc

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

Reimplemented in AthAnalysisAlgorithm, AthFilterAlgorithm, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

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

Gaudi::Property<std::string> EventCleaningTestAlg::m_cleaningLevel

private

Initial value:

{this, "CleaningLevel" , "LooseBad",

"Input cleaning level"}

Definition at line 50 of file EventCleaningTestAlg.h.

50 {this, "CleaningLevel" , "LooseBad",

51 "Input cleaning level"};

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

Gaudi::Property<bool> EventCleaningTestAlg::m_doEvent {this, "doEvent" , true, "Decorate the EventInfo"}

private

Definition at line 52 of file EventCleaningTestAlg.h.

52{this, "doEvent" , true, "Decorate the EventInfo"};

◆ m_ecTool

ToolHandle<ECUtils::IEventCleaningTool> EventCleaningTestAlg::m_ecTool {this, "EventCleaningTool","ECUtils::EventCleaningTool/EventCleaningTool" }

private

Definition at line 41 of file EventCleaningTestAlg.h.

41{this, "EventCleaningTool","ECUtils::EventCleaningTool/EventCleaningTool" };

◆ m_evtInfoDecor

SG::WriteDecorHandleKey<xAOD::EventInfo> EventCleaningTestAlg::m_evtInfoDecor {this, "EvtDecorKey", "" , "Will be overwritten in initialze"}

private

Definition at line 54 of file EventCleaningTestAlg.h.

54{this, "EvtDecorKey", "" , "Will be overwritten in initialze"};

◆ m_evtKey

SG::ReadHandleKey<xAOD::EventInfo> EventCleaningTestAlg::m_evtKey

private

Initial value:

{this, "EventInfoKey",

"EventInfo"}

Definition at line 45 of file EventCleaningTestAlg.h.

45 {this, "EventInfoKey",

46 "EventInfo"};

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

SG::ReadHandleKey<xAOD::JetContainer> EventCleaningTestAlg::m_jetKey

private

Initial value:

{this, "JetCollectionName", "AntiKt4EMPFlowJets",

"Jet collection name"}

Definition at line 43 of file EventCleaningTestAlg.h.

43 {this, "JetCollectionName", "AntiKt4EMPFlowJets",

44 "Jet collection name"};

◆ m_prefix

Gaudi::Property<std::string> EventCleaningTestAlg::m_prefix

private

Initial value:

{this, "EventCleanPrefix" , "",

"Input name of event cleaning decorator prefix" }

Configuration.

Definition at line 48 of file EventCleaningTestAlg.h.

48 {this, "EventCleanPrefix" , "",

49 "Input name of event cleaning decorator prefix" };

◆ 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

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ EventCleaningTestAlg()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_cleaningLevel

◆ m_detStore

◆ m_doEvent

◆ m_ecTool

◆ m_evtInfoDecor

◆ m_evtKey

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_jetKey

◆ m_prefix

◆ m_varHandleArraysDeclared

◆ m_vhka