Example usage code: Athena only: To configure the tool, add the following to your joboptions: myTool = CfgMgr.HFORSelectionTool("ToolInstanceName",Property=4.0) import ROOT myTool.ENumProperty = ROOT.HFORSelectionTool.Val2 To use the tool in your algorithm (can use regular ToolHandle or asg::AnaToolHandle): #include "HFORTools/IHFORSelectionTool.h" ToolHandle<IHFORSelectionTool> myTool("HFORSelectionTool/ToolInstanceName") CHECK( myTool.retrieve() ); myTool->isSelected(...); //or whatever methods are implemented in IHFORSelectionTool. More...

#include <HFORSelectionTool.h>

Inheritance diagram for HFORSelectionTool:

Collaboration diagram for HFORSelectionTool:

Public Member Functions
	HFORSelectionTool (const std::string &name)

virtual StatusCode	initialize () override
	Dummy implementation of the initialisation function. More...

virtual StatusCode	beginInputFile () override
	Function called when a new input file is opened. More...

virtual StatusCode	endInputFile () override
	Function called when the currently open input file got completely processed. More...

virtual bool	isSelected () override

HFORType	getSampleType () override

std::string	getSampleName () override

HFORType	getDecisionType () override

virtual StatusCode	sysInitialize ()
	Function initialising the tool in the correct way in Athena. More...

virtual void	print () const
	Print the state of the tool. 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

	ASG_TOOL_INTERFACE (IHFORSelectionTool) virtual bool isSelected()=0

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
StatusCode	setSampleType ()

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
double	m_matchCone

std::string	m_truthJetCollectionName

HFORType	m_sampleType

HFORType	m_decisionType

unsigned long int	m_sampleRunNumber

std::string	m_sampleName

unsigned long int	m_evtCounterAll

unsigned long int	m_evtCounterKilled

HFOR_Truth	m_hforTruth

std::string	m_runConfigFile

std::string	m_HFORStrategy

bool	m_isConfigured

MetaStore_t	m_inputMetaStore
	Object accessing the input metadata store. More...

MetaStore_t	m_outputMetaStore
	Object accessing the output metadata store. More...

bool	m_beginInputFileCalled
	Flag helping to discover when the tool misses the opening of the first input file. More...

bool	m_useIncidents

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

Callback functions helping in metadata reading/writing
void	setUseIncidents (const bool flag)

virtual void	handle (const Incident &inc)
	Function receiving incidents from IncidentSvc/TEvent. More...

virtual StatusCode	beginEvent ()
	Function called when a new events is loaded. More...

virtual StatusCode	metaDataStop ()
	Function called when the tool should write out its metadata. More...

Detailed Description

Example usage code: Athena only: To configure the tool, add the following to your joboptions: myTool = CfgMgr.HFORSelectionTool("ToolInstanceName",Property=4.0) import ROOT myTool.ENumProperty = ROOT.HFORSelectionTool.Val2 To use the tool in your algorithm (can use regular ToolHandle or asg::AnaToolHandle): #include "HFORTools/IHFORSelectionTool.h" ToolHandle<IHFORSelectionTool> myTool("HFORSelectionTool/ToolInstanceName") CHECK( myTool.retrieve() ); myTool->isSelected(...); //or whatever methods are implemented in IHFORSelectionTool.

Dual use: Alternative for c++ configuration and usage (with or without athena): #include "AsgTools/AnaToolHandle.h" #include "HFORTools/IHFORSelectionTool.h" asg::AnaToolHandle<IHFORSelectionTool> myTool("HFORSelectionTool/ToolInstanceName"); myTool.setProperty( "Property", 4.0 ); myTool.setProperty( "ENumProperty", myTool.initialize(); myTool->isSelected(....); //or whatever methods are implemented in IHFORSelectionTool

Definition at line 42 of file HFORSelectionTool.h.

Member Typedef Documentation

◆ MetaStore_t

typedef ServiceHandle< StoreGateSvc > asg::AsgMetadataTool::MetaStore_t

inherited

Type of the metadata store object in Athena.

Definition at line 66 of file AsgMetadataTool.h.

◆ MetaStorePtr_t

typedef const ServiceHandle< StoreGateSvc >& asg::AsgMetadataTool::MetaStorePtr_t

inherited

Type of the metadata store pointer in standalone mode.

Definition at line 68 of file AsgMetadataTool.h.

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ HFORSelectionTool()

HFORSelectionTool::HFORSelectionTool ( const std::string & name )

Definition at line 36 of file HFORSelectionTool.cxx.

   : asg::AsgMetadataTool( name ),
     m_sampleType (HFORType::noType),
     m_decisionType (HFORType::noType),
     m_sampleRunNumber (0),
     m_sampleName ("unknown"),
     m_evtCounterAll (0),
     m_evtCounterKilled (0),
     m_isConfigured (false) {
   declareProperty( "MatchCone",     m_matchCone = 0.4 );
   declareProperty( "runConfigFile", m_runConfigFile = "HFORTools/mc15_AlpgenPythia_2016.cfg" ) ;
   declareProperty( "HFORStrategy", m_HFORStrategy  = "DRBased" );
   declareProperty( "TruthJetCollectionName", m_truthJetCollectionName  = "AntiKt4TruthWZJets" );
 }

Member Function Documentation

◆ ASG_TOOL_INTERFACE()

IHFORSelectionTool::ASG_TOOL_INTERFACE ( IHFORSelectionTool )

pure virtualinherited

◆ beginEvent()

StatusCode asg::AsgMetadataTool::beginEvent ( )

protectedvirtualinherited

Function called when a new events is loaded.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in AsgElectronEfficiencyCorrectionTool, TrigConf::xAODConfigTool, TauAnalysisTools::TauSelectionTool, TauAnalysisTools::DiTauSelectionTool, TauAnalysisTools::CommonSmearingTool, TauAnalysisTools::DiTauEfficiencyCorrectionsTool, Trig::TrigDecisionTool, TauAnalysisTools::TauEfficiencyCorrectionsTool, Trig::TrigConfBunchCrossingTool, xAODMaker::TriggerMenuMetaDataTool, and Trig::xAODBunchCrossingTool.

Definition at line 196 of file AsgMetadataTool.cxx.

                                           {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

◆ beginInputFile()

StatusCode HFORSelectionTool::beginInputFile ( )

overridevirtual

Function called when a new input file is opened.

Dummy implementation that can be overridden by the derived tool.

Reimplemented from asg::AsgMetadataTool.

Definition at line 97 of file HFORSelectionTool.cxx.

                                              {
  
   //ATH_MSG_DEBUG( __PRETTY_FUNCTION__ << " File change detected, will check the sample type " ) ;
   //ATH_CHECK( setSampleType() ) ;
   m_isConfigured = false ;
  
   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());
   }

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

◆ endInputFile()

StatusCode HFORSelectionTool::endInputFile ( )

overridevirtual

Function called when the currently open input file got completely processed.

Dummy implementation that can be overridden by the derived tool.

Reimplemented from asg::AsgMetadataTool.

Definition at line 112 of file HFORSelectionTool.cxx.

                                            {
  
   ATH_MSG_DEBUG( __PRETTY_FUNCTION__ << " End Of File detected ");
   m_isConfigured = false ;
  
   if (m_evtCounterAll != 0) {
     ATH_MSG_DEBUG(" ") ;
     ATH_MSG_DEBUG("****************************************************************************") ;
     ATH_MSG_DEBUG(__PRETTY_FUNCTION__ << ": Sample type   : "  << m_sampleName ) ;
     ATH_MSG_DEBUG(__PRETTY_FUNCTION__ << ": Total  Events : " << m_evtCounterAll );
     ATH_MSG_DEBUG(__PRETTY_FUNCTION__ << ": Killed Events : " << m_evtCounterKilled <<
                   " (" << 100*float(m_evtCounterKilled)/float(m_evtCounterAll)  << "%)");
     ATH_MSG_DEBUG("****************************************************************************") ;
     ATH_MSG_DEBUG(" ") ;
   }
  
   //Reset the counters
   m_evtCounterAll = 0;
   m_evtCounterKilled = 0;
  
   return StatusCode::SUCCESS ;
 }

◆ 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

◆ getDecisionType()

HFORType HFORSelectionTool::getDecisionType ( )

overridevirtual

Implements IHFORSelectionTool.

Definition at line 296 of file HFORSelectionTool.cxx.

                                             {
   //TODO: Provide a method to return a string (like "isBB" etc.)
   return m_decisionType ;
 }

◆ getKey()

SG::sgkey_t asg::AsgTool::getKey ( const void * ptr ) const

inherited

Get the (hashed) key of an object that is in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the SG::sgkey_t key for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getName

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The hashed key of the object in the store. If not found, an invalid (zero) key.

Definition at line 119 of file AsgTool.cxx.

                                                     {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getKey( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       return ( proxy == nullptr ? 0 : proxy->sgkey() );
 #endif // XAOD_STANDALONE
    }

◆ getName()

const std::string & asg::AsgTool::getName ( const void * ptr ) const

inherited

Get the name of an object that is / should be in the event store.

This is a bit of a special one. StoreGateSvc and xAOD::TEvent both provide ways for getting the std::string name for an object that is in the store, based on a bare pointer. But they provide different interfaces for doing so.

In order to allow tools to efficiently perform this operation, they can use this helper function.

See also: asg::AsgTool::getKey

Parameters

ptr	The bare pointer to the object that the event store should know about

Returns: The string name of the object in the store. If not found, an empty string.

Definition at line 106 of file AsgTool.cxx.

                                                             {
  
 #ifdef XAOD_STANDALONE
       // In case we use @c xAOD::TEvent, we have a direct function call
       // for this.
       return evtStore()->event()->getName( ptr );
 #else
       const SG::DataProxy* proxy = evtStore()->proxy( ptr );
       static const std::string dummy = "";
       return ( proxy == nullptr ? dummy : proxy->name() );
 #endif // XAOD_STANDALONE
    }

◆ getProperty()

template<class T >

const T* asg::AsgTool::getProperty ( const std::string & name ) const

inherited

Get one of the tool's properties.

◆ getSampleName()

std::string HFORSelectionTool::getSampleName ( )

overridevirtual

Implements IHFORSelectionTool.

Definition at line 282 of file HFORSelectionTool.cxx.

                                            {
   if (! m_isConfigured) {
     ATH_CHECK( setSampleType(), "unknown" );
     m_isConfigured = true;
   }
   //Return a string with the type of the sample (bb, cc, c, light or unknown)
   return m_sampleName ;
 }

◆ getSampleType()

HFORType HFORSelectionTool::getSampleType ( )

overridevirtual

Implements IHFORSelectionTool.

Definition at line 269 of file HFORSelectionTool.cxx.

                                           {
   if (! m_isConfigured) {
     ATH_CHECK( setSampleType(), HFORType::noType );
     m_isConfigured = true;
   }
   //Return an enum object with the type of the sample
   return m_sampleType ;
 }

◆ handle()

void asg::AsgMetadataTool::handle ( const Incident & inc )

protectedvirtualinherited

Function receiving incidents from IncidentSvc/TEvent.

Reimplemented in Trig::TrigDecisionTool.

Definition at line 130 of file AsgMetadataTool.cxx.

                                                      {
  
       // Tell the user what's happening:
       ATH_MSG_VERBOSE( "Callback received with incident: " << inc.type() );
  
       // Call the appropriate member function:
       if( inc.type() == IncidentType::BeginInputFile ) {
         m_beginInputFileCalled = true;
         if( beginInputFile().isFailure() ) {
           ATH_MSG_FATAL( "Failed to call beginInputFile()" );
           throw std::runtime_error( "Couldn't call beginInputFile()" );
          }
       } else if( inc.type() == IncidentType::EndInputFile ) {
         if( endInputFile().isFailure() ) {
           ATH_MSG_FATAL( "Failed to call endInputFile()" );
           throw std::runtime_error( "Couldn't call endInputFile()" );
          }
       } else if( inc.type() == IncidentType::BeginEvent ) {
          // If the tool didn't catch the begin input file incident for the
          // first input file of the job, then call the appropriate function
          // now.
          if( ! m_beginInputFileCalled ) {
             m_beginInputFileCalled = true;
             if( beginInputFile().isFailure() ) {
                ATH_MSG_FATAL( "Failed to call beginInputFile()" );
                throw std::runtime_error( "Couldn't call beginInputFile()" );
             }
          }
          if( beginEvent().isFailure() ) {
             ATH_MSG_FATAL( "Failed to call beginEvent()" );
             throw std::runtime_error( "Couldn't call beginEvent()" );
          }
  
      #ifdef XAOD_STANDALONE
       } else if( inc.type() == IncidentType::MetaDataStop ) {
          if( metaDataStop().isFailure() ) {
             ATH_MSG_FATAL( "Failed to call metaDataStop()" );
             throw std::runtime_error( "Couldn't call metaDataStop()" );
          }
          
      #endif // XAOD_STANDALONE
       } else {
          ATH_MSG_WARNING( "Unknown incident type received in AsgMetaDataTool: " << inc.type() );
       }
  
       return;
    }

◆ initialize()

StatusCode HFORSelectionTool::initialize ( )

overridevirtual

Dummy implementation of the initialisation function.

It's here to allow the dual-use tools to skip defining an initialisation function. Since many are doing so...

Reimplemented from asg::AsgTool.

Definition at line 57 of file HFORSelectionTool.cxx.

                                          {
  
   // Greet the user:
   ATH_MSG_INFO( __PRETTY_FUNCTION__ << ": Starting tool initialization ..." );
   ATH_MSG_INFO( __PRETTY_FUNCTION__ << ": Using matching cone deltaR = " << m_matchCone );
   ATH_MSG_INFO(" ") ;
   ATH_MSG_INFO( __PRETTY_FUNCTION__ << " ************************************ " );
   ATH_MSG_INFO( __PRETTY_FUNCTION__ << " ** THIS TOOL IS UNDER DEVELOPMENT ** " );
   ATH_MSG_INFO( __PRETTY_FUNCTION__ << " ************************************ " );
   ATH_MSG_INFO(" ") ;
  
   //Initialize the Overlap Removal engine
   m_hforTruth = HFOR_Truth() ;
  
   if(m_HFORStrategy == "DRBased"){
     m_hforTruth.setAngularBasedHFOR();
     ATH_MSG_INFO( __PRETTY_FUNCTION__ << " ** Angular-Based HFOR ** " );
   } else if(m_HFORStrategy == "JetBased"){
     m_hforTruth.setJetBasedHFOR();
     ATH_MSG_INFO( __PRETTY_FUNCTION__ << " ** Jet-Based HFOR ** " );
   } else {
     ATH_MSG_ERROR( __PRETTY_FUNCTION__ << " ** HFORStrategy is not known! ** " );
     return StatusCode::FAILURE;
   }
  
   //FIXME: Check the return of this also ..
   std::string filename = PathResolverFindCalibFile(m_runConfigFile);
   m_hforTruth.readRunConfig(filename) ;
  
   ATH_MSG_INFO( __PRETTY_FUNCTION__ << ": Initialization done.");
   m_isConfigured = false ;
  
   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.

◆ inputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::inputMetaStore ( ) const

inherited

Accessor for the input metadata store.

Definition at line 88 of file AsgMetadataTool.cxx.

                                                                        {
  
 #ifdef XAOD_STANDALONE
       return &m_inputMetaStore;
 #else // XAOD_STANDALONE
       return m_inputMetaStore;
 #endif // XAOD_STANDALONE
    }

◆ isSelected()

bool HFORSelectionTool::isSelected ( )

overridevirtual

Definition at line 144 of file HFORSelectionTool.cxx.

                                     {
  
   if (! m_isConfigured) {
     ATH_CHECK( setSampleType(), false ) ;
     m_isConfigured = true ;
   }
  
   //This toll will tell if this event is to removed (returns 0) or kept
   //(returns 1)
   //In case of error (container not present) it returns -1
  
   bool selected = true ;
  
   m_decisionType = HFORType::noType ;
  
   // Only run this function on Monte Carlo
   const xAOD::EventInfo* eventInfo = nullptr;
   ATH_CHECK( evtStore()->retrieve(eventInfo, "EventInfo"), false );
   const bool isSim = eventInfo->eventType(xAOD::EventInfo::EventType::IS_SIMULATION);
   if ( !isSim ) {
     ATH_MSG_DEBUG (__PRETTY_FUNCTION__ << "It is a data event... nothing to be done...");
     return selected;
   }
  
  
   //===========================
   // Truth Event
   //===========================
   std::string truthCollectionName  = "TruthEvents" ;
   const xAOD::TruthEventContainer* truthEvent = nullptr ;
   ATH_CHECK ( evtStore()->retrieve(truthEvent, truthCollectionName ), false ) ;
  
   //=========================================
   // truth JET info (not needed for DR-HFOR)
   //=========================================
   const xAOD::JetContainer* jets = nullptr ;
   ATH_CHECK ( evtStore()->retrieve(jets, m_truthJetCollectionName ), false ) ;
  
   //=========================================================
   // Truth Event DeltaR based and Jet Based switched in init
   //=========================================================
   m_decisionType  =  m_hforTruth.findOverlap(*truthEvent, jets) ;
  
  
   ATH_MSG_DEBUG( __PRETTY_FUNCTION__ << " Event Type " << (unsigned int) m_decisionType) ;
  
   selected = m_decisionType != HFORType::kill ;
  
   //BookKeeping of how many kills/passed we have.
   //TODO: create a dictionary with key as sample type so we can count per type,
   //and per run. This allows for debugging
   m_evtCounterAll++ ;
   if (! selected) {
     m_evtCounterKilled++ ;
   }
  
   return selected ;
  
 }

◆ metaDataStop()

StatusCode asg::AsgMetadataTool::metaDataStop ( )

protectedvirtualinherited

Function called when the tool should write out its metadata.

Dummy implementation that can be overridden by the derived tool.

Reimplemented in xAODMaker::FileMetaDataTool, BookkeeperTool, BookkeeperDumperTool, xAODMaker::TriggerMenuMetaDataTool, and xAODMaker::TruthMetaDataTool.

Definition at line 204 of file AsgMetadataTool.cxx.

                                             {
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

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

◆ msg_level_name()

const std::string & asg::AsgTool::msg_level_name ( ) const

inherited

A deprecated function for getting the message level's name.

Instead of using this, weirdly named function, user code should get the string name of the current minimum message level (in case they really need it...), with:

MSG::name( msg().level() )

This function's name doesn't follow the ATLAS coding rules, and as such will be removed in the not too distant future.

Returns: The string name of the current minimum message level that's printed

Definition at line 101 of file AsgTool.cxx.

                                                   {
  
       return MSG::name( msg().level() );
    }

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

◆ outputMetaStore()

AsgMetadataTool::MetaStorePtr_t asg::AsgMetadataTool::outputMetaStore ( ) const

inherited

Accessor for the output metadata store.

Definition at line 97 of file AsgMetadataTool.cxx.

                                                                         {
  
 #ifdef XAOD_STANDALONE
       return &m_outputMetaStore;
 #else // XAOD_STANDALONE
       return m_outputMetaStore;
 #endif // XAOD_STANDALONE
    }

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

Reimplemented in JetRecTool, JetFinder, JetModifiedMassDrop, JetFromPseudojet, JetReclusterer, JetReclusteringTool, JetTruthLabelingTool, JetPileupLabelingTool, HI::HIPileupTool, top::TopObjectSelection, JetDumper, JetBottomUpSoftDrop, JetRecursiveSoftDrop, JetSoftDrop, JetConstituentsRetriever, JetSubStructureMomentToolsBase, JetSplitter, JetToolRunner, JetPruner, JetPseudojetRetriever, JetTrimmer, AsgHelloTool, and KtDeltaRTool.

Definition at line 131 of file AsgTool.cxx.

                              {
  
       ATH_MSG_INFO( "AsgTool " << name() << " @ " << this );
       return;
    }

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

◆ setSampleType()

StatusCode HFORSelectionTool::setSampleType ( )

private

Definition at line 215 of file HFORSelectionTool.cxx.

                                              {
  
   //Check what type of MC sample we have.
  
   //=============
   // Event Info
   //=============
   const xAOD::EventInfo* eventInfo = nullptr;
   ATH_CHECK( evtStore()->retrieve( eventInfo, "EventInfo" ) );
  
   // Only run this function on Monte Carlo
   const bool isSim = eventInfo->eventType(xAOD::EventInfo::EventType::IS_SIMULATION);
   if ( !isSim ) {
     ATH_MSG_DEBUG (__PRETTY_FUNCTION__ << "It is a data event... nothing to be done...");
     return StatusCode::SUCCESS;
   }
  
  
   //Derivations changes runNumber due to pileup reweight,
   //while  mcChannelNumber is 0 in Truth derivations
   m_sampleRunNumber = eventInfo->mcChannelNumber() ;
   if (m_sampleRunNumber == 0 ) {
     ATH_MSG_WARNING(__PRETTY_FUNCTION__ << "mcChannelNumber is 0, falling back to runNumber" ) ;
     m_sampleRunNumber = eventInfo->runNumber() ;
   }
  
   m_hforTruth.setSampleType(m_sampleRunNumber) ;
  
   //Some bookkeeping
   m_sampleType = m_hforTruth.getSampleType() ;
   m_sampleName = m_hforTruth.getSampleName() ;
  
   if (m_sampleType == HFORType::noType) {
     ATH_MSG_WARNING(__PRETTY_FUNCTION__ <<
                     ": This MC (Run " << m_sampleRunNumber <<
                     " ) is not an mc15 Alpgen+Pythia6 sample - this tool is useless ") ;
   }
   else {
     ATH_MSG_INFO(__PRETTY_FUNCTION__ <<
                  ": Good ! This is a valid Alpgen+Pythia6 sample ( " << m_sampleName << " )" ) ;
     ATH_MSG_INFO(__PRETTY_FUNCTION__ << ": MC Channel Number = " << eventInfo->mcChannelNumber()
                  << " ,  MC Run Number = "  << eventInfo->runNumber() );
   }
  
   //This routine never fails (unless it cannot get the container)
   //It may not identify the sample, in this case it will do nothing
   return StatusCode::SUCCESS;
 }

◆ setUseIncidents()

void asg::AsgMetadataTool::setUseIncidents ( const bool flag )

inlineprotectedinherited

Definition at line 132 of file AsgMetadataTool.h.

    {
       m_useIncidents = flag;
    }

◆ sysInitialize()

StatusCode asg::AsgMetadataTool::sysInitialize ( )

virtualinherited

Function initialising the tool in the correct way in Athena.

This function is used to set up the callbacks from IncidentSvc in Athena at the right time during initialisation, without the user having to do anything special in his/her code.

Reimplemented from AthCommonDataStore< AthCommonMsg< AlgTool > >.

Definition at line 110 of file AsgMetadataTool.cxx.

                                              {
  
 #ifndef XAOD_STANDALONE
       if (m_useIncidents) {
          // Connect to the IncidentSvc:
          ServiceHandle< IIncidentSvc > incSvc( "IncidentSvc", name() );
          ATH_CHECK( incSvc.retrieve() );
  
          // Set up the right callbacks: don't rethrow exceptions, any failure and we should end
          incSvc->addListener( this, IncidentType::BeginEvent, 0, false );
       }
       // Let the base class do its thing:
       ATH_CHECK( AlgTool::sysInitialize() );
  
 #endif // not XAOD_STANDALONE
  
       // Return gracefully:
       return StatusCode::SUCCESS;
    }

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

bool asg::AsgMetadataTool::m_beginInputFileCalled

privateinherited

Flag helping to discover when the tool misses the opening of the first input file.

Definition at line 126 of file AsgMetadataTool.h.

◆ m_decisionType

HFORType HFORSelectionTool::m_decisionType

private

Definition at line 82 of file HFORSelectionTool.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_evtCounterAll

unsigned long int HFORSelectionTool::m_evtCounterAll

private

Definition at line 86 of file HFORSelectionTool.h.

◆ m_evtCounterKilled

unsigned long int HFORSelectionTool::m_evtCounterKilled

private

Definition at line 87 of file HFORSelectionTool.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_HFORStrategy

std::string HFORSelectionTool::m_HFORStrategy

private

Definition at line 92 of file HFORSelectionTool.h.

◆ m_hforTruth

HFOR_Truth HFORSelectionTool::m_hforTruth

private

Definition at line 89 of file HFORSelectionTool.h.

◆ m_inputMetaStore

MetaStore_t asg::AsgMetadataTool::m_inputMetaStore

privateinherited

Object accessing the input metadata store.

Definition at line 119 of file AsgMetadataTool.h.

◆ m_isConfigured

bool HFORSelectionTool::m_isConfigured

private

Definition at line 93 of file HFORSelectionTool.h.

◆ m_matchCone

double HFORSelectionTool::m_matchCone

private

Definition at line 79 of file HFORSelectionTool.h.

◆ m_outputMetaStore

MetaStore_t asg::AsgMetadataTool::m_outputMetaStore

privateinherited

Object accessing the output metadata store.

Definition at line 121 of file AsgMetadataTool.h.

◆ m_runConfigFile

std::string HFORSelectionTool::m_runConfigFile

private

Definition at line 91 of file HFORSelectionTool.h.

◆ m_sampleName

std::string HFORSelectionTool::m_sampleName

private

Definition at line 84 of file HFORSelectionTool.h.

◆ m_sampleRunNumber

unsigned long int HFORSelectionTool::m_sampleRunNumber

private

Definition at line 83 of file HFORSelectionTool.h.

◆ m_sampleType

HFORType HFORSelectionTool::m_sampleType

private

Definition at line 81 of file HFORSelectionTool.h.

◆ m_truthJetCollectionName

std::string HFORSelectionTool::m_truthJetCollectionName

private

Definition at line 80 of file HFORSelectionTool.h.

◆ m_useIncidents

bool asg::AsgMetadataTool::m_useIncidents

privateinherited

Definition at line 128 of file AsgMetadataTool.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:

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Callback functions helping in metadata reading/writing

Detailed Description

Member Typedef Documentation

◆ MetaStore_t

◆ MetaStorePtr_t

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ HFORSelectionTool()

Member Function Documentation

◆ ASG_TOOL_INTERFACE()

◆ beginEvent()

◆ beginInputFile()

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

◆ endInputFile()

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ extraDeps_update_handler()

◆ getDecisionType()

◆ getKey()

◆ getName()

◆ getProperty()

◆ getSampleName()

◆ getSampleType()

◆ handle()

◆ initialize()

◆ inputHandles()

◆ inputMetaStore()

◆ isSelected()

◆ metaDataStop()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ outputMetaStore()

◆ print()

◆ renounce()

◆ renounceArray()

◆ setSampleType()

◆ setUseIncidents()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_beginInputFileCalled

◆ m_decisionType

◆ m_detStore

◆ m_evtCounterAll

◆ m_evtCounterKilled

◆ m_evtStore

◆ m_HFORStrategy

◆ m_hforTruth

◆ m_inputMetaStore

◆ m_isConfigured

◆ m_matchCone

◆ m_outputMetaStore

◆ m_runConfigFile

◆ m_sampleName

◆ m_sampleRunNumber

◆ m_sampleType

◆ m_truthJetCollectionName

◆ m_useIncidents

◆ m_varHandleArraysDeclared

◆ m_vhka