AthExThinning::CreateData Class Reference

algorithm to create dummy 4-momentum-like data classes: AthExParticle as well as dummy decays (AthExDecay) made up from 2 AthExParticle and a more involved class (AthExElephantino) holding 4 pointers to some elements of the AthExParticles container. More...

#include <CreateData.h>

Inheritance diagram for AthExThinning::CreateData:

Collaboration diagram for AthExThinning::CreateData:

Public Member Functions
	CreateData (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor with parameters:
virtual	~CreateData ()
	Destructor:
virtual StatusCode	initialize ()
virtual StatusCode	execute ()
virtual StatusCode	finalize ()
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
	CreateData ()
	Default constructor:
StatusCode	makeData (const std::string &testName)
	make data for a test
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
std::vector< std::string >	m_testNames
	list of test-names to create data for (default: test1,test2,test3)
StringProperty	m_particlesOutputName
	Particles output location.
UnsignedIntegerProperty	m_nbrParticles
	Number of particles to generate.
StringProperty	m_decayOutputName
	Decay object output location.
StringProperty	m_elephantinoOutputName
	Elephantino object output location.

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

Detailed Description

algorithm to create dummy 4-momentum-like data classes: AthExParticle as well as dummy decays (AthExDecay) made up from 2 AthExParticle and a more involved class (AthExElephantino) holding 4 pointers to some elements of the AthExParticles container.

Definition at line 32 of file CreateData.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

CreateData() [1/2]

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

Constructor with parameters:

Definition at line 41 of file CreateData.cxx.

                                         : 
  AthAlgorithm( name, pSvcLocator )
{
  //
  // Property declaration
  // 
  //declareProperty( "Property", m_nProperty );
 
  declareProperty( "ParticlesOutput", 
           m_particlesOutputName = "Particles",
           "Output location of the particles" );
 
  declareProperty( "NbrOfParticles",
           m_nbrParticles = 10,
           "Number of particles to create" );
 
  declareProperty( "DecayOutput",
           m_decayOutputName = "TwoBodyDecay",
           "Output location of a 2-body decay" );
 
  declareProperty( "ElephantinoOutput",
           m_elephantinoOutputName = "PinkElephantino",
           "Output location of an Elephantino with 4 legs" );
 
  declareProperty( "TestNames",
           m_testNames,
           "list of test-names to create data for "
           "(default: test1,test2,test3)" );
  m_testNames = std::vector<std::string>(3);
  m_testNames[0] = "test1";
  m_testNames[1] = "test2";
  m_testNames[2] = "test3";
}

~CreateData()

CreateData::~CreateData ( )

virtual

Destructor:

Definition at line 78 of file CreateData.cxx.

{}

CreateData() [2/2]

AthExThinning::CreateData::CreateData ( )

protected

Default constructor:

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.

{ return m_detStore; }

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

StatusCode CreateData::execute ( )

virtual

Definition at line 95 of file CreateData.cxx.

{  
  ATH_MSG_DEBUG ("Executing " << name() << "...");
 
  for ( std::vector<std::string>::const_iterator 
      itr  = m_testNames.begin(),
      iEnd = m_testNames.end();
    itr != iEnd;
    ++itr ) {
    ATH_MSG_INFO("Generating data for [" << *itr << "]...");
    if ( !makeData(*itr).isSuccess() ) {
      ATH_MSG_ERROR ("Could not generate data for [" << *itr << "] !!");
      return StatusCode::FAILURE;
    }
  }
 
  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 CreateData::finalize ( )

virtual

Definition at line 89 of file CreateData.cxx.

{
  ATH_MSG_INFO ("Finalizing " << name() << "...");
  return StatusCode::SUCCESS;
}

initialize()

StatusCode CreateData::initialize ( )

virtual

Definition at line 83 of file CreateData.cxx.

{
  ATH_MSG_INFO ("Initializing " << name() << "...");
  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.

makeData()

StatusCode CreateData::makeData ( const std::string & testName )

protected

make data for a test

Definition at line 114 of file CreateData.cxx.

{
  const std::string testName = "_"+test;
  const std::string particlesOutputName = m_particlesOutputName.value()
                                        + testName;
  // create particles
  AthExParticles * particles = new AthExParticles;
  if ( !evtStore()->record(particles, particlesOutputName).isSuccess() ) {
    ATH_MSG_ERROR("Could not store particles at ["
          << particlesOutputName << "]");
    delete particles;
    particles = 0;
    return StatusCode::RECOVERABLE;
  }
  if ( !evtStore()->setConst(particles).isSuccess() ) {
    ATH_MSG_WARNING("Could not setConst particles at ["
            << particlesOutputName << "]");
  }
 
  for ( unsigned int i = 0; i != m_nbrParticles.value(); ++i ) {
    AthExParticle * p = new AthExParticle( (i+1) * 10. * Gaudi::Units::GeV,
                       (i+1) * 10. * Gaudi::Units::GeV,
                       (i+1) * 10. * Gaudi::Units::GeV,
                       (i+2) * 10. * Gaudi::Units::GeV );
    particles->push_back(p);
  }
 
  ATH_MSG_DEBUG ("particles: " << particles->size() 
         << " [" << particles << "]");
 
  const std::string decayOutputName = m_decayOutputName.value() + testName;
  // create a dumb object from 2 particles
  AthExDecay * dcy = new AthExDecay;
  if ( !evtStore()->record(dcy, decayOutputName).isSuccess() ) {
    ATH_MSG_ERROR("Could not store Decay at [" << decayOutputName << "] !!");
    delete dcy;
    dcy = 0;
    return StatusCode::RECOVERABLE;
  }
  if ( !evtStore()->setConst(dcy).isSuccess() ) {
    ATH_MSG_WARNING("Could not setConst Decay at [" << decayOutputName << "]");
  }
  
  if ( particles->size() < 5 ) {
    ATH_MSG_WARNING("Not enough particles to make a Decay !!");
    return StatusCode::RECOVERABLE;
  }
 
  // we need to test all the possible states of ElementLinks
  //  -> created from an index
  const ElementLink<AthExParticles> p1( *particles, 0 );
  //  -> created from a pointer
  const ElementLink<AthExParticles> p2( (*particles)[4], *particles );
 
  //  -> created from an index
  const ElementLink<AthExParticles> l1( *particles, 1 );
  //  -> created from a pointer
  const ElementLink<AthExParticles> l2( (*particles)[9], *particles );
 
  dcy->setDecay( p1, p2, l1, l2 );
 
  const double igev = 1. / Gaudi::Units::GeV;
  ATH_MSG_INFO
    ("Created a Decay from :" << endmsg
     << " p1: px= " << dcy->p1()->px() * igev << endmsg
     << " p2: px= " << dcy->p2()->px() * igev << endmsg
     << " l1: px= " << dcy->l1()->px() * igev << endmsg
     << " l2: px= " << dcy->l2()->px() * igev
     );
 
  // create the elephantino
  const std::string elephantinoOutputName = m_elephantinoOutputName.value()
                                          + testName;
  AthExElephantino * eleph = new AthExElephantino;
  if ( !evtStore()->record(eleph, elephantinoOutputName).isSuccess() ) {
    ATH_MSG_ERROR("Could not store Elephantino at ["
          << elephantinoOutputName << "] !!");
    delete eleph;
    eleph = 0;
    return StatusCode::RECOVERABLE;
  }
  if ( !evtStore()->setConst(eleph).isSuccess() ) {
    ATH_MSG_WARNING("Could not setConst Elephantino at ["
            << elephantinoOutputName << "]");
  }
 
  {
    const AthExIParticles* iparticles = 0;
    if ( !evtStore()->symLink( particles, iparticles ).isSuccess() ) {
      ATH_MSG_WARNING("Could not symlink AthExParticles to AthExIParticles !!");
      return StatusCode::RECOVERABLE;
    }
  }
 
  const AthExIParticles* iparticles = 0;
  if ( !evtStore()->retrieve( iparticles, particlesOutputName).isSuccess() ||
       0 == iparticles ) {
    ATH_MSG_WARNING("Could not retrieve the (symlinked) AthExIParticles at ["
            << particlesOutputName << "] !!");
    return StatusCode::RECOVERABLE;
  }
 
  if ( iparticles->size() < 9 ) {
    ATH_MSG_WARNING("Not enough particles to make an Elephantino !!");
    return StatusCode::RECOVERABLE;
  }
 
  ATH_MSG_INFO("  particles: " <<  particles->size()
           << endmsg <<
           " iparticles: " << iparticles->size());
    
  if ( iparticles->size() != particles->size() ) {
    ATH_MSG_ERROR("Error performing the symlink !" << endmsg
          << " #iparticles: " << iparticles->size() << endmsg
          << "  #particles: " <<  particles->size() << endmsg
          << " @iparticles: " << iparticles << endmsg
          << "  @particles: " <<  particles << endmsg
          << "=== StoreGate content ===\n"
          << evtStore()->dump());
    return StatusCode::FAILURE;
  }
 
  // we need to test all the possible states of ElementLinks
  //  -> created from an index
  //  -> created from a pointer
  const ElementLink<AthExIParticles> ip1(  *iparticles,      0 );
  const ElementLink<AthExIParticles> ip2( (*iparticles)[4], *iparticles );
  const ElementLink<AthExIParticles> ip3(  *iparticles,      7 );
  const ElementLink<AthExIParticles> ip4( (*iparticles)[8], *iparticles );
 
  eleph->setLegs( ip1, ip2, ip3, ip4 );
 
  const ElementLink<AthExIParticles> ie1(  *iparticles,      1 );
  const ElementLink<AthExIParticles> ie2( (*iparticles)[9], *iparticles );
  eleph->setEars( ie1, ie2 );
 
  ATH_MSG_INFO("Created an Elephantino from :" << endmsg
           << " leg1: px= " << eleph->leg1()->px() * igev << endmsg
           << " leg2: px= " << eleph->leg2()->px() * igev << endmsg
           << " leg3: px= " << eleph->leg3()->px() * igev << endmsg
           << " leg4: px= " << eleph->leg4()->px() * igev << endmsg
           << " ear1: px= " << eleph->ear1()->px() * igev << endmsg
           << " ear2: px= " << eleph->ear2()->px() * igev);
 
  return StatusCode::SUCCESS;
}

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_decayOutputName

StringProperty AthExThinning::CreateData::m_decayOutputName

protected

Decay object output location.

Definition at line 84 of file CreateData.h.

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_elephantinoOutputName

StringProperty AthExThinning::CreateData::m_elephantinoOutputName

protected

Elephantino object output location.

Definition at line 87 of file CreateData.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_nbrParticles

UnsignedIntegerProperty AthExThinning::CreateData::m_nbrParticles

protected

Number of particles to generate.

Definition at line 81 of file CreateData.h.

m_particlesOutputName

StringProperty AthExThinning::CreateData::m_particlesOutputName

protected

Particles output location.

Definition at line 78 of file CreateData.h.

m_testNames

std::vector<std::string> AthExThinning::CreateData::m_testNames

protected

list of test-names to create data for (default: test1,test2,test3)

Definition at line 73 of file CreateData.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:

• CreateData.h
• CreateData.cxx