#include <McEventWeight.h>

Inheritance diagram for McEventWeight:

Collaboration diagram for McEventWeight:

Public Member Functions
	McEventWeight (const std::string &name)
	Create a proper constructor for Athena.
virtual	~McEventWeight ()
	Default destructor.
virtual double	evaluate (const xAOD::IParticle *part) const override
	returns: the value that was calculated from the xAOD::IParticle (composite built event object for instance)
virtual double	getWeight () const override
	returns: the value that was calculated from the usual Athena storegate
virtual StatusCode	initialize () override
	Usual initialize method of the framework.
virtual StatusCode	finalize () override
	Usual finalize method of the framework.
virtual void	print () const
	Print the state of the tool.
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	sysInitialize () override
	Perform system initialization for an algorithm.
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
Additional helper functions, not directly mimicking Athena
template<class T>
const T *	getProperty (const std::string &name) const
	Get one of the tool's properties.
const std::string &	msg_level_name () const __attribute__((deprecated))
	A deprecated function for getting the message level's name.
const std::string &	getName (const void *ptr) const
	Get the name of an object that is / should be in the event store.
SG::sgkey_t	getKey (const void *ptr) const
	Get the (hashed) key of an object that is in the event store.

Protected Member Functions
bool	addDecoration (const xAOD::EventInfo *evtInfo, float weight) const
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.

Protected Attributes
std::string	m_prefixWeightDecoration
std::string	m_weightName

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
unsigned int	m_McEventWeightIndex
std::string	m_eventInfoName
bool	m_useTruthEvents = false
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

Definition at line 20 of file McEventWeight.h.

Member Typedef Documentation

◆ StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

◆ McEventWeight()

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

Create a proper constructor for Athena.

The default constructor with the instance name of the tool class

Definition at line 12 of file McEventWeight.cxx.

  : WeightToolBase( name ),
    m_McEventWeightIndex(0),
    m_eventInfoName("EventInfo") {
  declareProperty( "McEventWeightIndex", m_McEventWeightIndex = 0);
  declareProperty("EventInfoName", m_eventInfoName = "EventInfo");
  declareProperty("UseTruthEvents",m_useTruthEvents=false,"To solve ATLASSIM-2989 we have to switch to using TruthEvents for weights");
}

◆ ~McEventWeight()

virtual McEventWeight::~McEventWeight ( )

inlinevirtual

Default destructor.

Definition at line 30 of file McEventWeight.h.

30{};

Member Function Documentation

◆ addDecoration()

bool WeightToolBase::addDecoration	(	const xAOD::EventInfo *	evtInfo,
		float	weight ) const

protectedinherited

Definition at line 42 of file WeightToolBase.cxx.

                                                                                   {
  if (!evtInfo) {
    ATH_MSG_ERROR("Cannot decorate empty EventInfo in "<< this->name());
    return false;
  }
  SG::Decorator< float > dec(m_weightName );
  if (! dec.isAvailable( *evtInfo ) )
    dec( *evtInfo ) = weight;
  return true;
}

◆ computeWeight()

double McEventWeight::computeWeight ( const xAOD::EventInfo * evtInfo ) const

private

Definition at line 32 of file McEventWeight.cxx.

                                                                      {
  // don't do anything for data
  if(!evtInfo->eventType(xAOD::EventInfo::IS_SIMULATION)){
    ATH_MSG_DEBUG (" Returning weight=1. for data.");
    return 1.;
  }
  
  
  if(m_useTruthEvents) {
    //access TruthEvents container instead
    const xAOD::TruthEventContainer* te = 0;
    if( evtStore()->retrieve( te, "TruthEvents" ).isFailure() ) {
      ATH_MSG_ERROR("TruthEvents could not be retrieved. Throwing exception");
      throw std::runtime_error("McEventWeight ASG Tool: TruthEvents could not be retrieved");
    }
    if( te->size() == 0 ) {
      ATH_MSG_ERROR("TruthEvents has no events in it. Throwing exception");
      throw std::runtime_error("McEventWeight ASG Tool: TruthEvents has no events in it");
    }
    if( te->at(0)->weights().size() <= m_McEventWeightIndex) {
      ATH_MSG_ERROR("TruthEvents first event has " << te->at(0)->weights().size() << " weights, but " 
            << m_McEventWeightIndex << " weight requested. Throwing exception");
      throw std::runtime_error("McEventWeight ASG Tool: TruthEvents has too few weights.");
    }
    const double weight = te->at(0)->weights()[m_McEventWeightIndex];
    ATH_MSG_DEBUG ("Got weight in McEventWeight::computeWeight() = " << weight << ".");
    return weight;
  }
  
  const double weight = evtInfo->mcEventWeight(m_McEventWeightIndex);
  ATH_MSG_DEBUG ("Got weight in McEventWeight::computeWeight() = " << weight << ".");
  return weight;
}

◆ declareGaudiProperty()

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

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evaluate()

double McEventWeight::evaluate ( const xAOD::IParticle * part ) const

overridevirtual

returns: the value that was calculated from the xAOD::IParticle (composite built event object for instance)

Implements IObservableTool.

Definition at line 24 of file McEventWeight.cxx.

{
  ATH_MSG_DEBUG ("Evaluating " << name() << "...");
 
  // Get the proper weight (from EventInfo)
  return this->getWeight();
}

◆ evtStore()

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

AthCommonDataStore< AthCommonMsg< AlgTool > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

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

◆ finalize()

StatusCode WeightToolBase::finalize ( )

overridevirtualinherited

Usual finalize method of the framework.

Definition at line 33 of file WeightToolBase.cxx.

{
  // Default implementation, such that users don't have to implement this any
  // more for the simplest use cases.
  ATH_MSG_DEBUG ("Finalizing " << name() << "...");
  return StatusCode::SUCCESS;
}

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

◆ getWeight()

double McEventWeight::getWeight ( ) const

overridevirtual

returns: the value that was calculated from the usual Athena storegate

Implements WeightToolBase.

Definition at line 66 of file McEventWeight.cxx.

                                      {
 //Retrieveing eventInfo
  const xAOD::EventInfo* evtInfo;
  StatusCode sc = evtStore()->retrieve( evtInfo, m_eventInfoName );
  if(sc.isFailure() || !evtInfo) {
    ATH_MSG_ERROR (" EventInfo could not be retrieved !!");
    return 0.;
  }
 
  double weight = this->computeWeight(evtInfo);
  ATH_MSG_VERBOSE ("     " << name() << " returning weight= " << weight << ".");
  return weight;
}

◆ initialize()

StatusCode WeightToolBase::initialize ( void )

overridevirtualinherited

Usual initialize method of the framework.

Reimplemented from asg::AsgTool.

Reimplemented in PDFWeight, and WeightsAgregator.

Definition at line 21 of file WeightToolBase.cxx.

                                      {
  // Default implementation, such that users don't have to implement this any
  // more for the simplest use cases.
  ATH_MSG_DEBUG ("Initializing " << name() << "...");
  //setting weight name for decoration
  m_weightName = m_prefixWeightDecoration + this->name();
  m_weightName.replace(m_weightName.find("ToolSvc."), std::string("ToolSvc.").length(), "");
 
  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.

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

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

◆ print()

void asg::AsgTool::print ( ) const

virtualinherited

Print the state of the tool.

Implements asg::IAsgTool.

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

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

◆ sysInitialize()

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

overridevirtualinherited

Perform system initialization for an algorithm.

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

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

◆ 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_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_eventInfoName

std::string McEventWeight::m_eventInfoName

private

Definition at line 45 of file McEventWeight.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_McEventWeightIndex

unsigned int McEventWeight::m_McEventWeightIndex

private

Definition at line 43 of file McEventWeight.h.

◆ m_prefixWeightDecoration

std::string WeightToolBase::m_prefixWeightDecoration

protectedinherited

Definition at line 61 of file WeightToolBase.h.

◆ m_useTruthEvents

bool McEventWeight::m_useTruthEvents = false

private

Definition at line 46 of file McEventWeight.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.

◆ m_weightName

std::string WeightToolBase::m_weightName

protectedinherited

Definition at line 62 of file WeightToolBase.h.

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

Public Member Functions

Protected Member Functions

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ McEventWeight()

◆ ~McEventWeight()

Member Function Documentation

◆ addDecoration()

◆ computeWeight()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evaluate()

◆ evtStore()

◆ extraDeps_update_handler()

◆ finalize()

◆ getKey()

◆ getName()

◆ getProperty()

◆ getWeight()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msg_level_name()

◆ msgLvl()

◆ outputHandles()

◆ print()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_eventInfoName

◆ m_evtStore

◆ m_McEventWeightIndex

◆ m_prefixWeightDecoration

◆ m_useTruthEvents

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ m_weightName