Algorithm to create a D3PD tree. More...

#include <MakerAlg.h>

Inheritance diagram for D3PD::MakerAlg:

Collaboration diagram for D3PD::MakerAlg:

Public Member Functions
	MakerAlg (const std::string &name, ISvcLocator *svcloc)
	Standard Gaudi algorithm constructor.
virtual StatusCode	initialize ()
	Standard Gaudi `initialize` method.
virtual StatusCode	finalize ()
	Standard Gaudi `finalize` method.
virtual StatusCode	execute ()
	Standard Gaudi `execute` method.
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
implement IAlgorithm
bool	isEventAccepted () const
	Test whether this event should be output.

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
StringArrayProperty	m_acceptNames
	Vector of names of Algorithms that this stream accepts.
StringArrayProperty	m_requireNames
	Vector of names of Algorithms that this stream requires.
StringArrayProperty	m_vetoNames
	Vector of names of Algorithms that this stream is vetoed by.
ServiceHandle< IDecisionSvc >	m_decSvc

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
StatusCode	fillToolWithAuditor (IObjFillerTool &tool)
	Call fill() on a tool with an auditor.
StatusCode	fillToolWithoutAuditor (IObjFillerTool &tool)
	Cakk fill on a tool without an auditor.
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
ServiceHandle< ID3PDSvc >	m_d3pdSvc
	Property: The D3PD creation service.
ToolHandleArray< IObjFillerTool >	m_tools
	Property: List of object filler tools to run.
ToolHandleArray< IMetadataTool >	m_metadataTools
	Property: List of metadata tools to run.
bool	m_audit
	Property: Audit the tools with PerfMon or not?
std::string	m_tuplePath
	Property: The tuple name.
ID3PD *	m_d3pd
	The created tuple. Note: we don't take ownership.
bool	m_booked
	Flag that we've called book().
StatusCode(D3PD::MakerAlg::*	m_fillFunction )(IObjFillerTool &)
	Pointer to the fill function to be used.
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Detailed Description

Algorithm to create a D3PD tree.

This algorithm creates one D3PD tree. It's given a list of IObjFillerTool instances to then run on each event. Most of the actual work is done by the separate D3PDSvc.

Properties: D3PDSvc - The D3PD creation service. Tools - List of IObjFillerTool instances to run. TuplePath - The name of the tuple. The interpretation of this depends on the D3PDSvc.

Definition at line 44 of file MakerAlg.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

◆ MakerAlg()

D3PD::MakerAlg::MakerAlg	(	const std::string &	name,
		ISvcLocator *	svcloc )

Standard Gaudi algorithm constructor.

Parameters

name	The algorithm name.
svcloc	The service locator.

Definition at line 26 of file MakerAlg.cxx.

  : FilteredAlgorithm (name, svcloc),
    m_d3pdSvc ("D3PD::RootD3PDSvc", name),
    m_tools (this),
    m_metadataTools (this),
    m_audit (false),
    m_d3pd (0),
    m_booked (false),
    m_fillFunction (0)
{
  declareProperty ("D3PDSvc", m_d3pdSvc,
                   "The D3PD creation service.");
  declareProperty ("Tools", m_tools,
                   "List of IObjFillerTool instances to run.");
  declareProperty ("MetadataTools", m_metadataTools,
                   "List of IMetadataTool instances to run.");
  declareProperty ("TuplePath", m_tuplePath,
                   "The name of the tuple.  The interpretation of this "
                   "depends on the D3PDSvc.");
  declareProperty ("Audit", m_audit,
                   "Audit the tools using PerfMon?");
}

Member Function Documentation

◆ declareGaudiProperty()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

◆ declareProperty()

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

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

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

◆ detStore()

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

inlineinherited

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

Definition at line 95 of file AthCommonDataStore.h.

95{ return m_detStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_detStore

StoreGateSvc_t m_detStore

Definition AthCommonDataStore.h:393

◆ evtStore()

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

85{ return m_evtStore; }

AthCommonDataStore< AthCommonMsg< Algorithm > >::m_evtStore

StoreGateSvc_t m_evtStore

Definition AthCommonDataStore.h:390

◆ execute()

StatusCode D3PD::MakerAlg::execute ( )

virtual

Standard Gaudi execute method.

Reimplemented from FilteredAlgorithm.

Definition at line 108 of file MakerAlg.cxx.

{
  if (!m_booked) {
    m_booked = true;
    // This check also only has to be done once. So no reason to do it
    // in a more complicated way.
    if (m_audit) {
       for (size_t i = 0; i < m_tools.size(); i++) {
          Gaudi::Guards::AuditorGuard auditor( m_tools[ i ]->name() +
                                               ":book", auditorSvc(), "evt" );
          CHECK( m_tools[i]->book() );
       }
    } else {
       for (size_t i = 0; i < m_tools.size(); i++) {
          CHECK( m_tools[i]->book() );
       }
    }
  }
 
  // Only write out "accepted" events:
  if( ! isEventAccepted() ) return StatusCode::SUCCESS;
 
  CHECK( m_d3pd->clear() );
 
  // Call fill() on the tools with the pre-configured function. Notice that
  // no if statements are put into the code here...
  for (size_t i = 0; i < m_tools.size(); i++) {
     CHECK( ( this->*m_fillFunction )( *m_tools[i] ) );
  }
 
  CHECK( m_d3pd->capture() );
 
  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();
}

◆ fillToolWithAuditor()

StatusCode D3PD::MakerAlg::fillToolWithAuditor ( IObjFillerTool & tool )

private

Call fill() on a tool with an auditor.

This function is used to call fill() on the object filler tools when PerfMon auditing is turned on.

Parameters

tool	The tool to call the `fill()` function on

Returns: The result of calling the fill() function

Definition at line 151 of file MakerAlg.cxx.

{
   Gaudi::Guards::AuditorGuard auditor( tool.name() +
                                        ":fill", auditorSvc(), "evt" );
   return tool.fill();
}

◆ fillToolWithoutAuditor()

StatusCode D3PD::MakerAlg::fillToolWithoutAuditor ( IObjFillerTool & tool )

private

Cakk fill on a tool without an auditor.

This function is used to call fill() on the object filler tools when PerfMon auditing is turned off.

Parameters

tool	The tool to call the `fill()` function on

Returns: The result of calling the fill() function

Definition at line 166 of file MakerAlg.cxx.

{
   return tool.fill();
}

◆ finalize()

StatusCode D3PD::MakerAlg::finalize ( )

virtual

Standard Gaudi finalize method.

Reimplemented from FilteredAlgorithm.

Definition at line 94 of file MakerAlg.cxx.

{
  // Run metadata tools.
  for (size_t i = 0; i < m_metadataTools.size(); i++)
    CHECK( m_metadataTools[i]->writeMetadata (m_d3pd) );
 
  CHECK( FilteredAlgorithm::finalize() );
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode D3PD::MakerAlg::initialize ( )

virtual

Standard Gaudi initialize method.

Reimplemented from FilteredAlgorithm.

Definition at line 54 of file MakerAlg.cxx.

{
  CHECK( FilteredAlgorithm::initialize() );
  CHECK( m_d3pdSvc.retrieve() );
  CHECK( m_tools.retrieve() );
  CHECK( m_metadataTools.retrieve() );
 
  // Create the tuple.
  CHECK( m_d3pdSvc->make (m_tuplePath, m_d3pd) );
 
  // Configure each tool. Since the check on m_audit only has to be
  // done once in the job, it's enough to implement it like this.
  if (m_audit) {
     for (size_t i = 0; i < m_tools.size(); i++) {
        Gaudi::Guards::AuditorGuard auditor( m_tools[ i ]->name() +
                                             ":cfg", auditorSvc(), "ini" );
        CHECK( m_tools[i]->configureD3PD (m_d3pd) );
     }
  } else {
     for (size_t i = 0; i < m_tools.size(); i++) {
        CHECK( m_tools[i]->configureD3PD (m_d3pd) );
     }
  }
 
  // Decide which fill function is to be used later on. This way the
  // if statement is only executed once, and not in every execute()
  // function.
  if (m_audit) {
     m_fillFunction = &MakerAlg::fillToolWithAuditor;
  } else {
     m_fillFunction = &MakerAlg::fillToolWithoutAuditor;
  }
 
  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.

◆ isEventAccepted()

bool FilteredAlgorithm::isEventAccepted ( ) const

inherited

Test whether this event should be output.

Definition at line 113 of file FilteredAlgorithm.cxx.

{
  bool result = true;
  const EventContext& ctx = this->getContext();
  if (ctx.valid()) {
    result = m_decSvc->isEventAccepted(this->name(),ctx);
    //ATH_MSG_DEBUG("res=" << result << " n=" << this->name() << " sl=" << ctx.slot() << " evt=" << ctx.eventID().event_number());
  } else {
    ATH_MSG_DEBUG("Not a threaded app");
    result = m_decSvc->isEventAccepted(this->name());
  }
 
  return result;
}

◆ msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

◆ msgLvl()

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

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

◆ outputHandles()

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

overridevirtualinherited

Return this algorithm's output handles.

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

◆ renounce()

std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void > AthCommonDataStore< AthCommonMsg< Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

  {
    h.renounce();
    PBASE::renounce (h);
  }

◆ renounceArray()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::renounceArray ( SG::VarHandleKeyArray & handlesArray )

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

◆ sysInitialize()

StatusCode AthAlgorithm::sysInitialize ( )

overridevirtualinherited

Override sysInitialize.

Override sysInitialize from the base class.

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

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

Reimplemented from AthCommonDataStore< AthCommonMsg< Algorithm > >.

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

Definition at line 66 of file AthAlgorithm.cxx.

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

◆ sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

◆ updateVHKA()

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

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

◆ m_acceptNames

StringArrayProperty FilteredAlgorithm::m_acceptNames

protectedinherited

Initial value:

{this, "AcceptAlgs", {},

"Filters which if any are passed enable output"}

Vector of names of Algorithms that this stream accepts.

Definition at line 33 of file FilteredAlgorithm.h.

33 {this, "AcceptAlgs", {},

34 "Filters which if any are passed enable output"};

◆ m_audit

bool D3PD::MakerAlg::m_audit

private

Property: Audit the tools with PerfMon or not?

Definition at line 87 of file MakerAlg.h.

◆ m_booked

bool D3PD::MakerAlg::m_booked

private

Flag that we've called book().

Definition at line 96 of file MakerAlg.h.

◆ m_d3pd

ID3PD* D3PD::MakerAlg::m_d3pd

private

The created tuple. Note: we don't take ownership.

Definition at line 93 of file MakerAlg.h.

◆ m_d3pdSvc

ServiceHandle<ID3PDSvc> D3PD::MakerAlg::m_d3pdSvc

private

Property: The D3PD creation service.

Definition at line 78 of file MakerAlg.h.

◆ m_decSvc

ServiceHandle<IDecisionSvc> FilteredAlgorithm::m_decSvc

protectedinherited

Initial value:

{this, "decSvc", "DecisionSvc/DecisionSvc",

"Handle to DecisionSvc"}

Definition at line 42 of file FilteredAlgorithm.h.

42 {this, "decSvc", "DecisionSvc/DecisionSvc",

43 "Handle to DecisionSvc"};

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

StatusCode(D3PD::MakerAlg::* D3PD::MakerAlg::m_fillFunction) (IObjFillerTool &)

private

Pointer to the fill function to be used.

Definition at line 99 of file MakerAlg.h.

◆ m_metadataTools

ToolHandleArray<IMetadataTool> D3PD::MakerAlg::m_metadataTools

private

Property: List of metadata tools to run.

Definition at line 84 of file MakerAlg.h.

◆ m_requireNames

StringArrayProperty FilteredAlgorithm::m_requireNames

protectedinherited

Initial value:

{this, "RequireAlgs", {},

"Filters which must all be passed to enable output"}

Vector of names of Algorithms that this stream requires.

Definition at line 36 of file FilteredAlgorithm.h.

36 {this, "RequireAlgs", {},

37 "Filters which must all be passed to enable output"};

◆ m_tools

ToolHandleArray<IObjFillerTool> D3PD::MakerAlg::m_tools

private

Property: List of object filler tools to run.

Definition at line 81 of file MakerAlg.h.

◆ m_tuplePath

std::string D3PD::MakerAlg::m_tuplePath

private

Property: The tuple name.

Definition at line 90 of file MakerAlg.h.

◆ m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

◆ m_vetoNames

StringArrayProperty FilteredAlgorithm::m_vetoNames

protectedinherited

Initial value:

{this, "VetoAlgs", {},

"Filters which if any are passed disable output"}

Vector of names of Algorithms that this stream is vetoed by.

Definition at line 39 of file FilteredAlgorithm.h.

39 {this, "VetoAlgs", {},

40 "Filters which if any are passed disable output"};

◆ 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

Protected Attributes

Private Types

Private Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ MakerAlg()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ fillToolWithAuditor()

◆ fillToolWithoutAuditor()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ isEventAccepted()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_acceptNames

◆ m_audit

◆ m_booked

◆ m_d3pd

◆ m_d3pdSvc

◆ m_decSvc

◆ m_detStore

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_fillFunction

◆ m_metadataTools

◆ m_requireNames

◆ m_tools

◆ m_tuplePath

◆ m_varHandleArraysDeclared

◆ m_vetoNames

◆ m_vhka