#include <RootAsciiDumperAlgHandle.h>

Inheritance diagram for Athena::RootAsciiDumperAlgHandle:

Collaboration diagram for Athena::RootAsciiDumperAlgHandle:

Public Member Functions
virtual	~RootAsciiDumperAlgHandle ()=default
	Destructor:
virtual StatusCode	initialize ()
virtual StatusCode	execute ()
virtual StatusCode	finalize ()
	AthAlgorithm (const std::string &name, ISvcLocator *pSvcLocator)
	Inherited constructor.
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

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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
	RootAsciiDumperAlgHandle ()
	Default constructor:
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
StringProperty	m_ofname
	ASCII output file name.
int	m_ofd = -1
	file handle to the ASCII output file
uint64_t	m_nentries = 0
	number of entries processed so-far
SG::ReadHandleKey< uint32_t >	m_runnbr { this, "RunNumber", "RunNumber", "handle to the run-nbr in event (read)" }
	run number
SG::ReadHandleKey< uint32_t >	m_evtnbr { this, "EventNumber", "EventNumber", "handle to the evt-nbr in event (read)" }
	event number
SG::ReadHandleKey< int32_t >	m_el_n { this, "el_n", "el_n", "handle to the nbr of electrons in event (read)" }
	number of electrons
SG::ReadHandleKey< std::vector< float > >	m_el_eta { this, "el_eta", "el_eta", "handle to the eta of electrons in event (read)" }
	eta of electrons
SG::ReadHandleKey< std::vector< std::vector< float > > >	m_el_jetcone_dr { this, "el_jetcone_dr", "el_jetcone_dr", "handle to the jetcone-dR of electrons in event (read)" }
	jetcone dR
SG::ReadHandleKey< xAOD::EventInfo >	m_eiKey { this, "eiKey", "EventInfo", "" }
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

Definition at line 26 of file RootAsciiDumperAlgHandle.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

◆ ~RootAsciiDumperAlgHandle()

virtual Athena::RootAsciiDumperAlgHandle::~RootAsciiDumperAlgHandle ( )

virtualdefault

Destructor:

◆ RootAsciiDumperAlgHandle()

Athena::RootAsciiDumperAlgHandle::RootAsciiDumperAlgHandle ( )

private

Default constructor:

Member Function Documentation

◆ AthAlgorithm()

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

Inherited constructor.

Definition at line 51 of file AthAlgorithm.cxx.

                                                       :
  ::AthCommonDataStore<AthCommonMsg<Algorithm>>   ( name, pSvcLocator )
{
  // Set up to run AthAlgorithmDHUpdate in sysInitialize before
  // merging dependency lists.  This extends the output dependency
  // list with any symlinks implied by inheritance relations.
  m_updateDataHandles =
    std::make_unique<AthenaBaseComps::AthAlgorithmDHUpdate>
    (m_extendedExtraObjects,
     std::move (m_updateDataHandles));
}

◆ 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 Athena::RootAsciiDumperAlgHandle::execute ( )

virtual

Definition at line 87 of file RootAsciiDumperAlgHandle.cxx.

{  
  ATH_MSG_DEBUG ("Executing " << name() << "...");
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
 
  uint64_t nevts = m_nentries;
  m_nentries += 1;
 
  SG::ReadHandle<uint32_t> runnbr (m_runnbr, ctx);
  SG::ReadHandle<uint32_t> evtnbr (m_evtnbr, ctx);
 
  SG::ReadHandle<int32_t> el_n (m_el_n, ctx);
 
  SG::ReadHandle<xAOD::EventInfo> ei (m_eiKey, ctx);
  static const SG::ConstAccessor<std::string> tupleName ("tupleName");
  static const SG::ConstAccessor<std::string> collectionName ("collectionName");
  std::string collName = collectionName(*ei);
  std::string::size_type pos = collName.rfind ("/");
  if (pos != std::string::npos) {
    collName.erase (0, pos+1);
  }
 
  std::string buf = std::format(
        "{:03}.{} = {}\n"
        "{:03}.{} = {}\n"
        "{:03}.{} = {}\n"
        "{:03}.{} = {}\n"
        "{:03}.{} = {}\n",
        nevts, "collectionName", collName,
        nevts, "tupleName", tupleName(*ei),
        nevts, "RunNumber", *runnbr,
        nevts, "EventNumber", *evtnbr,
        nevts, "el_n", *el_n
  );
 
    if (buf.empty()) {
        throw std::runtime_error("Empty buffer in RootAsciiDumperAlgHandle::execute");
    }
 
    if (write(m_ofd, buf.data(), buf.size()) == -1) {
        throw std::runtime_error("Failed to write buffer to file descriptor");
    }
  
 
  if (*el_n > 0) {
    SG::ReadHandle<std::vector<float> > el_eta (m_el_eta, ctx);
    SG::ReadHandle<std::vector<std::vector<float> > > el_jetcone_dr (m_el_jetcone_dr, ctx);
    
    std::ostringstream bufv;
    for (int32_t ii = 0; ii < *el_n; ++ii) {
        bufv << (*el_eta)[ii];
        if (ii != (*el_n) - 1) {
            bufv << ", ";
        }
    }
 
    buf = std::format(
        "{:03}.{} = [{}]\n",
        nevts,
        "el_eta",
        bufv.str()
    );
 
    if (buf.empty()) {
        throw std::runtime_error("Empty buffer in RootAsciiDumperAlgHandle::execute");
    }
 
    if (write(m_ofd, buf.data(), buf.size()) == -1) {
        throw std::runtime_error("Failed to write buffer to file descriptor");
    }
    bufv.str("");//clear
    for (int32_t ii = 0; ii < *el_n; ++ii) {
        bufv << "[";
        for (std::size_t jj = 0; jj < (*el_jetcone_dr)[ii].size(); ++jj) {
            bufv << (*el_jetcone_dr)[ii][jj];
            if (jj + 1 < (*el_jetcone_dr)[ii].size()) {
                bufv << ", ";
            }
        }
        bufv << "]";
        if (ii + 1 < *el_n) {
            bufv << ", ";
        }
    }
 
    buf = std::format(
        "{:03}.{} = [{}]\n",
        nevts,
        "el_jetcone_dr",
        bufv.str()
    );
 
    if (write(m_ofd, buf.data(), buf.size()) == -1) {
        throw std::runtime_error("Failed to write buffer to file descriptor");
    }
  }
 
  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();
}

◆ finalize()

StatusCode Athena::RootAsciiDumperAlgHandle::finalize ( )

virtual

Definition at line 73 of file RootAsciiDumperAlgHandle.cxx.

{
  ATH_MSG_INFO ("Finalizing " << name() << "...");
 
  if (m_ofd > 0) {
    fflush(NULL);
    if (close(m_ofd) < 0) {
      ATH_MSG_WARNING("problem while closing [" << m_ofname << "]");
    }
  }
 
  return StatusCode::SUCCESS;
}

◆ initialize()

StatusCode Athena::RootAsciiDumperAlgHandle::initialize ( )

virtual

Definition at line 44 of file RootAsciiDumperAlgHandle.cxx.

{
  ATH_MSG_INFO ("Initializing " << name() << "...");
  ATH_CHECK( m_eiKey.initialize() );
  ATH_CHECK( m_el_jetcone_dr.initialize() );
  ATH_CHECK( m_el_n.initialize() );
  ATH_CHECK( m_el_eta.initialize() );
  ATH_CHECK( m_evtnbr.initialize() );
  ATH_CHECK( m_runnbr.initialize() );
 
  ATH_MSG_INFO("dumping data into file ["
               << m_ofname << "]...");
  if (m_ofname.empty()) {
    ATH_MSG_ERROR("cannot dump data into an empty file name!");
    return StatusCode::FAILURE;
  }
  m_ofd = open(m_ofname.value().c_str(), 
               O_WRONLY | O_CREAT | O_TRUNC,
               S_IRUSR | S_IWUSR | S_IRGRP | S_IROTH);
 
  if (m_ofd < 0) {
    ATH_MSG_ERROR("problem opening file [" << m_ofname << "] with "
                  "write permissions.");
    return StatusCode::FAILURE;
  }
 
  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.

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

SG::ReadHandleKey<xAOD::EventInfo> Athena::RootAsciiDumperAlgHandle::m_eiKey { this, "eiKey", "EventInfo", "" }

private

Definition at line 97 of file RootAsciiDumperAlgHandle.h.

98{ this, "eiKey", "EventInfo", "" };

◆ m_el_eta

SG::ReadHandleKey<std::vector<float> > Athena::RootAsciiDumperAlgHandle::m_el_eta { this, "el_eta", "el_eta", "handle to the eta of electrons in event (read)" }

private

eta of electrons

Definition at line 90 of file RootAsciiDumperAlgHandle.h.

91{ this, "el_eta", "el_eta", "handle to the eta of electrons in event (read)" };

◆ m_el_jetcone_dr

SG::ReadHandleKey<std::vector<std::vector<float> > > Athena::RootAsciiDumperAlgHandle::m_el_jetcone_dr { this, "el_jetcone_dr", "el_jetcone_dr", "handle to the jetcone-dR of electrons in event (read)" }

private

jetcone dR

Definition at line 94 of file RootAsciiDumperAlgHandle.h.

95{ this, "el_jetcone_dr", "el_jetcone_dr", "handle to the jetcone-dR of electrons in event (read)" };

◆ m_el_n

SG::ReadHandleKey<int32_t> Athena::RootAsciiDumperAlgHandle::m_el_n { this, "el_n", "el_n", "handle to the nbr of electrons in event (read)" }

private

number of electrons

Definition at line 86 of file RootAsciiDumperAlgHandle.h.

87{ this, "el_n", "el_n", "handle to the nbr of electrons in event (read)" };

◆ m_evtnbr

SG::ReadHandleKey<uint32_t> Athena::RootAsciiDumperAlgHandle::m_evtnbr { this, "EventNumber", "EventNumber", "handle to the evt-nbr in event (read)" }

private

event number

Definition at line 82 of file RootAsciiDumperAlgHandle.h.

83{ this, "EventNumber", "EventNumber", "handle to the evt-nbr in event (read)" };

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

uint64_t Athena::RootAsciiDumperAlgHandle::m_nentries = 0

private

number of entries processed so-far

Definition at line 75 of file RootAsciiDumperAlgHandle.h.

◆ m_ofd

int Athena::RootAsciiDumperAlgHandle::m_ofd = -1

private

file handle to the ASCII output file

Definition at line 72 of file RootAsciiDumperAlgHandle.h.

◆ m_ofname

StringProperty Athena::RootAsciiDumperAlgHandle::m_ofname

private

Initial value:

{ this, "AsciiFileName", "d3pd.ascii",
      "Name of the ascii file where the content of the "
      "ROOT n-tuple file will be dumped." }

ASCII output file name.

Definition at line 66 of file RootAsciiDumperAlgHandle.h.

    { this, "AsciiFileName", "d3pd.ascii",
      "Name of the ascii file where the content of the "
      "ROOT n-tuple file will be dumped." };

◆ m_runnbr

SG::ReadHandleKey<uint32_t> Athena::RootAsciiDumperAlgHandle::m_runnbr { this, "RunNumber", "RunNumber", "handle to the run-nbr in event (read)" }

private

run number

Definition at line 78 of file RootAsciiDumperAlgHandle.h.

79{ this, "RunNumber", "RunNumber", "handle to the run-nbr in event (read)" };

◆ 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

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ ~RootAsciiDumperAlgHandle()

◆ RootAsciiDumperAlgHandle()

Member Function Documentation

◆ AthAlgorithm()

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ finalize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_detStore

◆ m_eiKey

◆ m_el_eta

◆ m_el_jetcone_dr

◆ m_el_n

◆ m_evtnbr

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_nentries

◆ m_ofd

◆ m_ofname

◆ m_runnbr

◆ m_varHandleArraysDeclared

◆ m_vhka