Base class for evgen-level analyses. More...

#include <GenAnalysis.h>

Inheritance diagram for GenAnalysis:

Collaboration diagram for GenAnalysis:

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

virtual	~GenAnalysis ()

StatusCode	initialize ()
	Setup analysis tools and call user-supplied init() More...

StatusCode	execute ()
	Per-event analysis routine: calls user-supplied analyze() More...

virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...

virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...

ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard `StoreGateSvc` (event store) Returns (kind of) a pointer to the `StoreGateSvc`. More...

const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard `StoreGateSvc/DetectorStore` Returns (kind of) a pointer to the `StoreGateSvc`. More...

virtual StatusCode	sysStart () override
	Handle START transition. More...

virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...

virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...

Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...

Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...

void	updateVHKA (Gaudi::Details::PropertyBase &)

MsgStream &	msg () const

MsgStream &	msg (const MSG::Level lvl) const

bool	msgLvl (const MSG::Level lvl) const

Methods for user implementation
virtual StatusCode	init ()

virtual StatusCode	analyze ()=0

virtual StatusCode	finalize ()

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

StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...

StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...

std::vector< SG::VarHandleKeyArray * >	m_vhka

bool	m_varHandleArraysDeclared

Histogramming
std::string	m_histkey
	Container name for the MC event collection to be analysed. More...

ServiceHandle< ITHistSvc >	m_histSvc

TH1D *	bookHisto1D (const std::string &name, const std::string &title, const std::vector< double > &binedges, const std::string &xtitle="", const std::string &ytitle="")

TH1D *	bookHisto1D (const std::string &name, const std::string &title, size_t numbins, double low, double high, const std::string &xtitle="", const std::string &ytitle="")

TProfile *	bookProfile1D (const std::string &name, const std::string &title, const std::vector< double > &binedges, const std::string &xtitle="", const std::string &ytitle="")

TProfile *	bookProfile1D (const std::string &name, const std::string &title, size_t numbins, double low, double high, const std::string &xtitle="", const std::string &ytitle="")

TH2D *	bookHisto2D (const std::string &name, const std::string &title, const std::vector< double > &binedgesx, const std::vector< double > &binedgesy, const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")

TH2D *	bookHisto2D (const std::string &name, const std::string &title, size_t numbinsx, double xlow, double xhigh, size_t numbinsy, double ylow, double yhigh, const std::string &xtitle="", const std::string &ytitle="", const std::string &ztitle="")

std::string	fullhistopath (const std::string &localpath)
	Get a histogram's full path, given the name local to the analysis. More...

TH1 *	histo (const std::string &key)
	Retrieve a histogram (as TH1* base class pointer) More...

TProfile *	profile (const std::string &key)
	Retrieve a profile histogram. More...

const ServiceHandle< ITHistSvc >	histSvc () const
	Directly access the histogram service. More...

Utility event-mangling functions
Todo: Replace with HepMC units when available
ServiceHandle< IPartPropSvc >	m_ppSvc {this, "PartPropSvc", "PartPropSvc"}
	Handle on the particle property service. More...

SG::ReadHandleKey< McEventCollection >	m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
	Const handle to the MC event collection. More...

void	GeVToMeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1000. More...

void	MeVToGeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1/1000. More...

void	cmTomm (HepMC::GenEvent *evt)
	Scale event lengths by x 10. More...

void	mmTocm (HepMC::GenEvent *evt)
	Scale event lengths by x 1/10. More...

Detailed Description

Base class for evgen-level analyses.

Author: Andy Buckley

GenAnalysis is a base class which provides convenient access to functions used to make a compact, correct and robust analysis of truth-level data.

The following virtual methods are to be overloaded in the child class: StatusCode init() [optional] StatusCode execute() [mandatory] StatusCode finalize() [optional]

Definition at line 27 of file GenAnalysis.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

◆ GenAnalysis()

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

Definition at line 11 of file GenAnalysis.cxx.

   : GenBase(name, pSvcLocator),
     m_histSvc("THistSvc", name)
 {
   declareProperty("HistKey", m_histkey="genanalysis");
   declareProperty("THistSvc", m_histSvc);
 }

◆ ~GenAnalysis()

virtual GenAnalysis::~GenAnalysis ( )

inlinevirtual

Definition at line 31 of file GenAnalysis.h.

31 { }

Member Function Documentation

◆ analyze()

virtual StatusCode GenAnalysis::analyze ( )

pure virtual

◆ ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

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

inlineinherited

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

inherited

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.

◆ bookHisto1D() [1/2]

TH1D * GenAnalysis::bookHisto1D	(	const std::string &	name,
		const std::string &	title,
		const std::vector< double > &	binedges,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)

protected

Todo:: Use shorter names (aliases?) like bookH1D, bookP1D, and histo -> hist (or getH1D / getP1D)

Definition at line 39 of file GenAnalysis.cxx.

                                                                                  {
   TH1D* h = new TH1D(path.c_str(), title.c_str(), binedges.size()-1, &binedges.front());
   h->Sumw2();
   h->SetXTitle(xtitle.c_str());
   h->SetYTitle(ytitle.c_str());
   StatusCode st = histSvc()->regHist(fullhistopath(path), h);
   if (st.isFailure()) return 0;
   return h;
 }

◆ bookHisto1D() [2/2]

TH1D * GenAnalysis::bookHisto1D	(	const std::string &	name,
		const std::string &	title,
		size_t	numbins,
		double	low,
		double	high,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)

protected

Definition at line 50 of file GenAnalysis.cxx.

                                                                                  {
   TH1D* h = new TH1D(path.c_str(), title.c_str(), numbins, low, high);
   h->Sumw2();
   h->SetXTitle(xtitle.c_str());
   h->SetYTitle(ytitle.c_str());
   StatusCode st = histSvc()->regHist(fullhistopath(path), h);
   if (st.isFailure()) return 0;
   return h;
 }

◆ bookHisto2D() [1/2]

TH2D * GenAnalysis::bookHisto2D	(	const std::string &	name,
		const std::string &	title,
		const std::vector< double > &	binedgesx,
		const std::vector< double > &	binedgesy,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`,
		const std::string &	ztitle = `""`
	)

protected

Definition at line 85 of file GenAnalysis.cxx.

                                                                                                           {
   TH2D* h = new TH2D(path.c_str(), title.c_str(), binedgesx.size()-1, &*binedgesx.begin(), binedgesy.size()-1, &binedgesy.front());
   h->Sumw2();
   h->SetXTitle(xtitle.c_str());
   h->SetYTitle(ytitle.c_str());
   h->SetZTitle(ztitle.c_str());
   StatusCode st = histSvc()->regHist(fullhistopath(path), h);
   if (st.isFailure()) return 0;
   return h;
 }

◆ bookHisto2D() [2/2]

TH2D * GenAnalysis::bookHisto2D	(	const std::string &	name,
		const std::string &	title,
		size_t	numbinsx,
		double	xlow,
		double	xhigh,
		size_t	numbinsy,
		double	ylow,
		double	yhigh,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`,
		const std::string &	ztitle = `""`
	)

protected

Definition at line 98 of file GenAnalysis.cxx.

                                                                                                           {
   TH2D* h = new TH2D(path.c_str(), title.c_str(), numbinsx, xlow, xhigh, numbinsy, ylow, yhigh);
   h->Sumw2();
   h->SetXTitle(xtitle.c_str());
   h->SetYTitle(ytitle.c_str());
   h->SetZTitle(ztitle.c_str());
   StatusCode st = histSvc()->regHist(fullhistopath(path), h);
   if (st.isFailure()) return 0;
   return h;
 }

◆ bookProfile1D() [1/2]

TProfile * GenAnalysis::bookProfile1D	(	const std::string &	name,
		const std::string &	title,
		const std::vector< double > &	binedges,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)

protected

Definition at line 62 of file GenAnalysis.cxx.

                                                                                        {
   TProfile* h = new TProfile(path.c_str(), title.c_str(), binedges.size()-1, &binedges.front());
   h->Sumw2();
   h->SetXTitle(xtitle.c_str());
   h->SetYTitle(ytitle.c_str());
   StatusCode st = histSvc()->regHist(fullhistopath(path), h);
   if (st.isFailure()) return 0;
   return h;
 }

◆ bookProfile1D() [2/2]

TProfile * GenAnalysis::bookProfile1D	(	const std::string &	name,
		const std::string &	title,
		size_t	numbins,
		double	low,
		double	high,
		const std::string &	xtitle = `""`,
		const std::string &	ytitle = `""`
	)

protected

Definition at line 73 of file GenAnalysis.cxx.

                                                                                        {
   TProfile* h = new TProfile(path.c_str(), title.c_str(), numbins, low, high);
   h->Sumw2();
   h->SetXTitle(xtitle.c_str());
   h->SetYTitle(ytitle.c_str());
   StatusCode st = histSvc()->regHist(fullhistopath(path), h);
   if (st.isFailure()) return 0;
   return h;
 }

◆ cmTomm()

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

protectedinherited

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() [1/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyArrayType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKeyArray>

Definition at line 170 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleKeyType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleKey>

Definition at line 156 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
  
   }

◆ declareGaudiProperty() [3/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	hndl,
		const SG::VarHandleType &
	)

inlineprivateinherited

specialization for handling Gaudi::Property<SG::VarHandleBase>

Definition at line 184 of file AthCommonDataStore.h.

   {
     return *AthCommonDataStore<PBASE>::declareProperty(hndl.name(),
                                                        hndl.value(), 
                                                        hndl.documentation());
   }

◆ declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty	(	Gaudi::Property< T > &	t,
		const SG::NotHandleType &
	)

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(t);
   }

◆ declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleBase &	hndl,
		const std::string &	doc,
		const SG::VarHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

   {
     this->declare(hndl.vhKey());
     hndl.vhKey().setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKey &	hndl,
		const std::string &	doc,
		const SG::VarHandleKeyType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

   {
     this->declare(hndl);
     hndl.setOwner(this);
  
     return PBASE::declareProperty(name,hndl,doc);
   }

◆ declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		SG::VarHandleKeyArray &	hndArr,
		const std::string &	doc,
		const SG::VarHandleKeyArrayType &
	)

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

   {
  
     // std::ostringstream ost;
     // ost << Algorithm::name() << " VHKA declareProp: " << name 
     //     << " size: " << hndArr.keys().size() 
     //     << " mode: " << hndArr.mode() 
     //     << "  vhka size: " << m_vhka.size()
     //     << "\n";
     // debug() << ost.str() << endmsg;
  
     hndArr.setOwner(this);
     m_vhka.push_back(&hndArr);
  
     Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
     if (p != 0) {
       p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
     } else {
       ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                     << name);
     }
  
     return p;
  
   }

◆ declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc,
		const SG::NotHandleType &
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

   {
     return PBASE::declareProperty(name, property, doc);
   }

◆ declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty	(	const std::string &	name,
		T &	property,
		const std::string &	doc = `"none"`
	)

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

   {
     typedef typename SG::HandleClassifier<T>::type htype;
     return declareProperty (name, property, doc, htype());
   }

◆ declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                  {
     typedef typename SG::HandleClassifier<T>::type htype;
     return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
   }

◆ detStore()

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Algorithm > >::detStore ( ) const

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

95 { return m_detStore; }

◆ event_const()

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

inlineinherited

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

inlineinherited

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

inlineinherited

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() [1/2]

ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( )

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 85 of file AthCommonDataStore.h.

85 { return m_evtStore; }

◆ evtStore() [2/2]

const ServiceHandle<StoreGateSvc>& AthCommonDataStore< AthCommonMsg< Algorithm > >::evtStore ( ) const

inlineinherited

The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 90 of file AthCommonDataStore.h.

90 { return m_evtStore; }

◆ execute()

StatusCode GenAnalysis::execute ( )

virtual

Per-event analysis routine: calls user-supplied analyze()

Reimplemented from GenBase.

Definition at line 27 of file GenAnalysis.cxx.

                                 {
   if (events()->empty()) {
     ATH_MSG_ERROR("No events found in McEventCollection");
     return StatusCode::FAILURE;
   }
   return analyze();
 }

◆ extraDeps_update_handler()

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

protectedinherited

Add StoreName to extra input/output deps as needed.

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

◆ extraOutputDeps()

const DataObjIDColl & AthAlgorithm::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 50 of file AthAlgorithm.cxx.

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

◆ finalize()

virtual StatusCode GenAnalysis::finalize ( )

inlinevirtual

Definition at line 42 of file GenAnalysis.h.

42 { return StatusCode::SUCCESS; }

◆ fullhistopath()

std::string GenAnalysis::fullhistopath ( const std::string & localpath )

inlineprotected

Get a histogram's full path, given the name local to the analysis.

Definition at line 72 of file GenAnalysis.h.

                                                       {
     return "/" + m_histkey + "/" + name() + "/" + localpath;
   }

◆ GeVToMeV()

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

protectedinherited

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

◆ histo()

TH1 * GenAnalysis::histo ( const std::string & key )

protected

Retrieve a histogram (as TH1* base class pointer)

Definition at line 114 of file GenAnalysis.cxx.

                                             {
   TH1* h = 0;
   StatusCode st = histSvc()->getHist(fullhistopath(key), h);
   if (st.isFailure()) ATH_MSG_WARNING("No histogram with key " << key);
   return h;
 }

◆ histSvc()

const ServiceHandle<ITHistSvc> GenAnalysis::histSvc ( ) const

inlineprotected

Directly access the histogram service.

Definition at line 83 of file GenAnalysis.h.

                                                  {
     return m_histSvc;
   }

◆ init()

virtual StatusCode GenAnalysis::init ( )

inlinevirtual

Definition at line 40 of file GenAnalysis.h.

40 { return StatusCode::SUCCESS; }

◆ initialize()

StatusCode GenAnalysis::initialize ( )

virtual

Setup analysis tools and call user-supplied init()

Reimplemented from GenBase.

Definition at line 20 of file GenAnalysis.cxx.

                                    {
   CHECK(GenBase::initialize());
   CHECK(m_histSvc.retrieve());
   return init();
 }

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

protectedinherited

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 )

protectedinherited

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() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                 {
     return this->msgStream();
   }

◆ msg() [2/2]

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

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                   {
     return this->msgStream(lvl);
   }

◆ msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                                {
     return this->msgLevel(lvl);
   }

◆ outputHandles()

virtual std::vector<Gaudi::DataHandle*> AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

◆ particleData()

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

inlineinherited

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

inlineinherited

Get a particle data table.

Definition at line 118 of file GenBase.h.

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

◆ partPropSvc()

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

inlineinherited

Access the particle property service.

Definition at line 113 of file GenBase.h.

                                                         {
     return m_ppSvc;
   }

◆ pdt()

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

inlineinherited

Shorter alias to get a particle data table.

Definition at line 123 of file GenBase.h.

123 { return particleTable(); }

◆ profile()

TProfile * GenAnalysis::profile ( const std::string & key )

protected

Retrieve a profile histogram.

Definition at line 121 of file GenAnalysis.cxx.

                                                    {
   TH1* h = 0;
   StatusCode st = histSvc()->getHist(fullhistopath(key), h);
   if (st.isFailure()) ATH_MSG_WARNING("No histogram with key " << key);
   return dynamic_cast<TProfile*>(h);
 }

◆ 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, PyAthena::Alg, and AthHistogramAlgorithm.

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_histkey

std::string GenAnalysis::m_histkey

private

Container name for the MC event collection to be analysed.

Definition at line 93 of file GenAnalysis.h.

◆ m_histSvc

ServiceHandle<ITHistSvc> GenAnalysis::m_histSvc

private

Definition at line 94 of file GenAnalysis.h.

◆ m_mcEventKey

std::string GenBase::m_mcEventKey {}

protectedinherited

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

privateinherited

Const handle to the MC event collection.

Definition at line 163 of file GenBase.h.

◆ m_mkMcEvent

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

protectedinherited

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.

◆ m_ppSvc

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

privateinherited

Handle on the particle property service.

Definition at line 160 of file GenBase.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

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

Public Member Functions

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Histogramming

Utility event-mangling functions

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ GenAnalysis()

◆ ~GenAnalysis()

Member Function Documentation

◆ analyze()

◆ ATLAS_NOT_CONST_THREAD_SAFE() [1/2]

◆ ATLAS_NOT_CONST_THREAD_SAFE() [2/2]

◆ bookHisto1D() [1/2]

◆ bookHisto1D() [2/2]

◆ bookHisto2D() [1/2]

◆ bookHisto2D() [2/2]

◆ bookProfile1D() [1/2]

◆ bookProfile1D() [2/2]

◆ cmTomm()

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

◆ event_const()

◆ events_const() [1/2]

◆ events_const() [2/2]

◆ evtStore() [1/2]

◆ evtStore() [2/2]

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ fullhistopath()

◆ GeVToMeV()

◆ histo()

◆ histSvc()

◆ init()

◆ initialize()

◆ inputHandles()

◆ MeVToGeV()

◆ mmTocm()

◆ msg() [1/2]

◆ msg() [2/2]

◆ msgLvl()

◆ outputHandles()

◆ particleData()

◆ particleTable()

◆ partPropSvc()

◆ pdt()

◆ profile()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_histkey

◆ m_histSvc

◆ m_mcEventKey

◆ m_mcevents_const

◆ m_mkMcEvent

◆ m_ppSvc

◆ m_varHandleArraysDeclared

◆ m_vhka