GenBase Class Reference

Base class for common behaviour of MC truth algorithms. More...

#include <GenBase.h>

Inherits AthAlgorithm.

Inherited by CopyEventWeight, CountHepMC, DumpMC, EvtInclusiveDecay, FillFilterValues, FixHepMC, GenAnalysis, GenFilter, GenModule, HepMCReadFromFile, PrintHijingPars, PrintMC, SimTimeEstimate, TestHepMC, and WriteHepMC.

Collaboration diagram for GenBase:

Public Member Functions
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
Construction/destruction
	GenBase (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor.
virtual	~GenBase ()
	Virtual destructor.
Event loop algorithm methods
virtual StatusCode	initialize () override
virtual StatusCode	execute () override
Event collection accessors (const and non-const)
HepMC::GenEvent *event	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current signal event (first in the McEventCollection)
const HepMC::GenEvent *	event_const () const
	Access the current signal event (const)
McEventCollection *events	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current event's McEventCollection.
const McEventCollection *	events_const () const
	Access the current event's McEventCollection (const)
const McEventCollection *	events_const (const EventContext &ctx) const
Particle data accessors
const ServiceHandle< IPartPropSvc >	partPropSvc () const
	Access the particle property service.
const HepPDT::ParticleDataTable &	particleTable () const
	Get a particle data table.
const HepPDT::ParticleDataTable &	pdt () const
	Shorter alias to get a particle data table.
const HepPDT::ParticleData *	particleData (int pid) const
	Access an element in the particle data table.

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.

Protected Attributes
Properties
std::string	m_mcEventKey {}
	StoreGate key for the MC event collection (defaults to GEN_EVENT)
BooleanProperty	m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}
	Flag to determine if a new MC event collection should be made if it doesn't exist.

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

Utility event-mangling functions
Todo Replace with HepMC units when available
ServiceHandle< IPartPropSvc >	m_ppSvc {this, "PartPropSvc", "PartPropSvc"}
	Handle on the particle property service.
SG::ReadHandleKey< McEventCollection >	m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
	Const handle to the MC event collection.
void	GeVToMeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1000.
void	MeVToGeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1/1000.
void	cmTomm (HepMC::GenEvent *evt)
	Scale event lengths by x 10.
void	mmTocm (HepMC::GenEvent *evt)
	Scale event lengths by x 1/10.

Detailed Description

Base class for common behaviour of MC truth algorithms.

This class is the base class used to specify the behavior of all MC truth algorithms and is meant to capture the common behavior of these modules. GenBase inherits the AthAlgorithm interface. Event generator interfaces should inherit from the derived GenModule interface, which adds more generation-specific functionality.

The common behavior currently consists of:

• Standard access to the event collection and its first member
• Providing access to the HepPDT ParticleProperties Table
• Including standard HepMC and Athena framework headers and CMT uses

The following virtual methods should be overloaded in the child class:

Author

A. Buckley: Creating GenBase from GenModule, Nov 2013.

Definition at line 47 of file GenBase.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

GenBase()

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

Constructor.

Definition at line 11 of file GenBase.cxx.

  : AthAlgorithm(name, pSvcLocator)
{
}

~GenBase()

virtual GenBase::~GenBase ( )

inlinevirtual

Virtual destructor.

Definition at line 57 of file GenBase.h.

{ }

Member Function Documentation

ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

HepMC::GenEvent *event GenBase::ATLAS_NOT_CONST_THREAD_SAFE ( )

inline

Access the current signal event (first in the McEventCollection)

Note

This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

Definition at line 76 of file GenBase.h.

                                                      {
    if (events()->empty())
      ATH_MSG_ERROR("McEventCollection is empty during first event access");
    return *(events()->begin());
  }

ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

McEventCollection *events GenBase::ATLAS_NOT_CONST_THREAD_SAFE

(

)

Access the current event's McEventCollection.

Note

This function will make a new McEventCollection if there is not already a valid one and MakeMcEvent=True.

cmTomm()

void GenBase::cmTomm ( HepMC::GenEvent * evt )

protected

Scale event lengths by x 10.

Definition at line 78 of file GenBase.cxx.

                                       {
  for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
    const HepMC::FourVector fv((*vtx)->position().x() * 10,
                               (*vtx)->position().y() * 10,
                               (*vtx)->position().z() * 10,
                               (*vtx)->position().t() * 10);
    (*vtx)->set_position(fv);
  }
}

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.

{ return m_detStore; }

event_const()

const HepMC::GenEvent * GenBase::event_const ( ) const

inline

Access the current signal event (const)

Definition at line 83 of file GenBase.h.

                                           {
    if (events_const()->empty())
      ATH_MSG_ERROR("Const McEventCollection is empty during first event access");
    return *(events_const()->begin());
  }

events_const() [1/2]

const McEventCollection * GenBase::events_const ( ) const

inline

Access the current event's McEventCollection (const)

Definition at line 96 of file GenBase.h.

                                                {
    return events_const( getContext() );
  }

events_const() [2/2]

const McEventCollection * GenBase::events_const ( const EventContext & ctx ) const

inline

Definition at line 99 of file GenBase.h.

                                                                         {
    SG::ReadHandle<McEventCollection> ret = SG::makeHandle(m_mcevents_const, ctx);
    if (!ret.isValid())
      ATH_MSG_ERROR("No McEventCollection found in StoreGate with key " << m_mcevents_const.key());
    return ret.cptr();
  }

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.

{ return m_evtStore; }

execute()

virtual StatusCode GenBase::execute ( )

inlineoverridevirtual

Reimplemented in CopyEventWeight, CountHepMC, DumpMC, EvtInclusiveDecay, FillFilterValues, FixHepMC, GenAnalysis, GenFilter, GenModule, HepMCReadFromFile, PrintHijingPars, PrintMC, SimTimeEstimate, TestHepMC, and WriteHepMC.

Definition at line 65 of file GenBase.h.

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

GeVToMeV()

void GenBase::GeVToMeV ( HepMC::GenEvent * evt )

protected

Scale event energies/momenta by x 1000.

Todo

Add HepMC units awareness and do it differently when HepMC provides this functionality directly (and reference-based FourVector accessors)

Definition at line 58 of file GenBase.cxx.

                                         {
  for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
    const HepMC::FourVector fv((*p)->momentum().px() * 1000,
                               (*p)->momentum().py() * 1000,
                               (*p)->momentum().pz() * 1000,
                               (*p)->momentum().e()  * 1000);
    (*p)->set_momentum(fv);
    (*p)->set_generated_mass(1000 * (*p)->generated_mass());
  }
}

initialize()

StatusCode GenBase::initialize ( )

overridevirtual

Reimplemented in CopyEventWeight, CountHepMC, DumpMC, EvtInclusiveDecay, FillFilterValues, GenAnalysis, GenFilter, GenModule, HepMCReadFromFile, PrintHijingPars, PrintMC, TestHepMC, and WriteHepMC.

Definition at line 17 of file GenBase.cxx.

                               {
  ATH_CHECK( m_mcevents_const.initialize() );
  m_mcEventKey = m_mcevents_const.key();
 
  // Get the particle property service
  ATH_CHECK(m_ppSvc.retrieve());
  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.

MeVToGeV()

void GenBase::MeVToGeV ( HepMC::GenEvent * evt )

protected

Scale event energies/momenta by x 1/1000.

Definition at line 68 of file GenBase.cxx.

                                         {
  for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
    const HepMC::FourVector fv((*p)->momentum().px() / 1000,
                               (*p)->momentum().py() / 1000,
                               (*p)->momentum().pz() / 1000,
                               (*p)->momentum().e()  / 1000);
    (*p)->set_momentum(fv);
    (*p)->set_generated_mass((*p)->generated_mass() / 1000);
  }
}

mmTocm()

void GenBase::mmTocm ( HepMC::GenEvent * evt )

protected

Scale event lengths by x 1/10.

Definition at line 87 of file GenBase.cxx.

                                       {
  for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
    const HepMC::FourVector fv((*vtx)->position().x() / 10,
                               (*vtx)->position().y() / 10,
                               (*vtx)->position().z() / 10,
                               (*vtx)->position().t() / 10);
    (*vtx)->set_position(fv);
  }
}

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.

particleData()

const HepPDT::ParticleData * GenBase::particleData ( int pid ) const

inline

Access an element in the particle data table.

Definition at line 126 of file GenBase.h.

                                                        {
    return pdt().particle(HepPDT::ParticleID(std::abs(pid)));
  }

particleTable()

const HepPDT::ParticleDataTable & GenBase::particleTable ( ) const

inline

Get a particle data table.

Definition at line 118 of file GenBase.h.

                                                       {
    return *(m_ppSvc->PDT());
  }

partPropSvc()

const ServiceHandle< IPartPropSvc > GenBase::partPropSvc ( ) const

inline

Access the particle property service.

Definition at line 113 of file GenBase.h.

                                                        {
    return m_ppSvc;
  }

pdt()

const HepPDT::ParticleDataTable & GenBase::pdt ( ) const

inline

Shorter alias to get a particle data table.

Definition at line 123 of file GenBase.h.

{ return particleTable(); }

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_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_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_mcEventKey

std::string GenBase::m_mcEventKey {}

protected

StoreGate key for the MC event collection (defaults to GEN_EVENT)

Definition at line 137 of file GenBase.h.

{};

m_mcevents_const

SG::ReadHandleKey<McEventCollection> GenBase::m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }

private

Const handle to the MC event collection.

Definition at line 163 of file GenBase.h.

{ this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" };

m_mkMcEvent

BooleanProperty GenBase::m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}

protected

Flag to determine if a new MC event collection should be made if it doesn't exist.

Definition at line 139 of file GenBase.h.

{this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"};

m_ppSvc

ServiceHandle<IPartPropSvc> GenBase::m_ppSvc {this, "PartPropSvc", "PartPropSvc"}

private

Handle on the particle property service.

Definition at line 160 of file GenBase.h.

{this, "PartPropSvc", "PartPropSvc"};

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:

• GenBase.h
• GenBase.cxx