This Algorithm provides an easy interface to Tauola C++ interface. More...

#include <TauolaPP.h>

Inheritance diagram for TauolaPP:

Collaboration diagram for TauolaPP:

Public Member Functions
	TauolaPP (const std::string &name, ISvcLocator *pSvcLocator)
	Constructor.
virtual StatusCode	initialize () override
	Initialization of Tauola++ and setting of JO configurables.
virtual StatusCode	execute () override
	Pass each event in the McEventCollection to Tauola to (re)decay the taus.
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

Static Public Attributes
static CLHEP::HepRandomEngine *	p_rndmEngine = nullptr

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
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
Variables used to configure Tauola
IntegerProperty	m_decay_particle {this, "decay_particle", 15}
	PDG ID of particle to study.
IntegerProperty	m_decay_mode_same {this, "decay_mode_same", 1}
	TAUOLA decay mode of particles with same charge as "decay_particle".
IntegerProperty	m_decay_mode_opp {this, "decay_mode_opposite", 2}
	TAUOLA decay mode of particles with opposite charge as "decay_particle".
DoubleProperty	m_tau_mass {this, "tau_mass", 1.77684}
	tau mass to be taken by TAUOLA
BooleanProperty	m_spin_correlation {this, "spin_correlation", true}
	TAUOLA switch for spin effects.
BooleanProperty	m_setRadiation {this, "setRadiation", true}
	TAUOLA switch for radiative corrections for leptonic tau decays.
DoubleProperty	m_setRadiationCutOff {this, "setRadiationCutOff", 0.01}
	TAUOLA cut-off for radiative corrections.

Features for derived classes to use internally
StringProperty	m_key {this, "McEventKey", "GEN_EVENT"}
	Event record container key - FIXME should be using Read/WriteHandles here.
ServiceHandle< IAthRNGSvc >	m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}
IntegerProperty	m_dsid {this, "Dsid", 999999}
IntegerProperty	m_randomSeed {this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}
	Seed for random number engine.
void	reseedRandomEngine (const std::string &streamName, const EventContext &ctx)
CLHEP::HepRandomEngine *	getRandomEngine (const std::string &streamName, unsigned long int randomSeedOffset, const EventContext &ctx) const
CLHEP::HepRandomEngine *	getRandomEngineDuringInitialize (const std::string &streamName, unsigned long int randomSeedOffset, unsigned int conditionsRun=1, unsigned int lbn=1) const

Detailed Description

This Algorithm provides an easy interface to Tauola C++ interface.

Author: Nadia Davidson, Marcin Wolter

Todo: Convert to use standard GenModule base class

Definition at line 23 of file TauolaPP.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

◆ TauolaPP()

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

Constructor.

Definition at line 38 of file TauolaPP.cxx.

  : AthAlgorithm(name, pSvcLocator)
{
}

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 TauolaPP::execute ( )

overridevirtual

Pass each event in the McEventCollection to Tauola to (re)decay the taus.

Definition at line 115 of file TauolaPP.cxx.

                             {
 
  //Re-seed the random number stream
  const EventContext& ctx = Gaudi::Hive::currentContext();
  reseedRandomEngine("TAUOLAPP", ctx);
 
  // Load HepMC info
  // FIXME should be using Read/WriteHandles here
  const McEventCollection* mcCollptr_const;
  ATH_CHECK( evtStore()->retrieve(mcCollptr_const, m_key) );
  // Const_cast to make an event possible to update
  McEventCollection* mcCollptr =  const_cast<McEventCollection*>(mcCollptr_const);
 
  // Loop over all events in McEventCollection
  for (HepMC::GenEvent* evt : *mcCollptr) {
    // Convert event record to format readable by tauola interface
    auto t_event = new Tauolapp::TauolaHepMCEvent(evt);
 
    // remove tau decays first
      t_event->undecayTaus();
    // decay taus
      t_event->decayTaus();
    // t_event->getEvent()->print();
  }
 
  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();
}

◆ getRandomEngine()

CLHEP::HepRandomEngine * TauolaPP::getRandomEngine	(	const std::string &	streamName,
		unsigned long int	randomSeedOffset,
		const EventContext &	ctx ) const

private

Definition at line 89 of file TauolaPP.cxx.

{
  ATHRNG::RNGWrapper* rngWrapper = m_rndmSvc->getEngine(this, streamName);
  rngWrapper->setSeed( streamName, ctx.slot(), randomSeedOffset, ctx.eventID().run_number() );
  return rngWrapper->getEngine(ctx);
}

◆ getRandomEngineDuringInitialize()

CLHEP::HepRandomEngine * TauolaPP::getRandomEngineDuringInitialize	(	const std::string &	streamName,
		unsigned long int	randomSeedOffset,
		unsigned int	conditionsRun = 1,
		unsigned int	lbn = 1 ) const

private

Definition at line 98 of file TauolaPP.cxx.

{
  const size_t slot=0;
  EventContext ctx;
  ctx.setSlot( slot );
  ctx.setEventID (EventIDBase (conditionsRun,
               EventIDBase::UNDEFEVT,  // event
               EventIDBase::UNDEFNUM,  // timestamp
               EventIDBase::UNDEFNUM,  // timestamp ns
               lbn));
  Atlas::setExtendedEventContext(ctx,
                                 Atlas::ExtendedEventContext( evtStore()->hiveProxyDict(),
                                                              conditionsRun) );
  return getRandomEngine(streamName, randomSeedOffset, ctx);
}

◆ initialize()

StatusCode TauolaPP::initialize ( )

overridevirtual

Initialization of Tauola++ and setting of JO configurables.

Definition at line 44 of file TauolaPP.cxx.

                               {
 
  ATH_CHECK(m_rndmSvc.retrieve());
  p_rndmEngine = getRandomEngineDuringInitialize("TAUOLAPP_INIT", m_randomSeed, m_dsid);
  const long*  sip  =  p_rndmEngine->getSeeds();
 
  // Setup and intialise Tauola Interface
  using Tauolapp::Tauola;
  Tauola::setSameParticleDecayMode(m_decay_mode_same);
  Tauola::setOppositeParticleDecayMode(m_decay_mode_opp);
  // etc.... see Tauola.h for the full list of configurables
  // Note: some need to be set before (or after) calling Tauola::initialize();
 
  // Tauola::setHiggsScalarPseudoscalarMixingAngle(atof(argv[5]));
  // Tauola::setHiggsScalarPseudoscalarPDG(25);
 
  Tauola::initialize();
 
  Tauola::setEtaK0sPi(1,0,1); // switches to decay eta K0_S and pi0 1/0 on/off.
  Tauola::spin_correlation.setAll(m_spin_correlation);
  Tauola::setRadiation(m_setRadiation);
  Tauola::setRadiationCutOff(m_setRadiationCutOff);
 
  //call RanLux generator for ++ part of Tauola
  Tauola::setRandomGenerator(AthenaRandomGenerator);
 
  //seeding tauola-fortran generator
  // See tauola.f: the first parameter should be positive int <900000000
  Tauola::setSeed(int(std::abs(sip[0])%(900000000)),0,0);
 
  //setting tau mass
  Tauolapp::parmas_.amtau=m_tau_mass;
 
  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();
  }

◆ reseedRandomEngine()

void TauolaPP::reseedRandomEngine	(	const std::string &	streamName,
		const EventContext &	ctx )

private

Definition at line 81 of file TauolaPP.cxx.

{
  long seeds[7];
  ATHRNG::calculateSeedsMC21(seeds, streamName,  ctx.eventID().event_number(), m_dsid, m_randomSeed);
  p_rndmEngine->setSeeds(seeds, 0); // NOT THREAD-SAFE
}

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

IntegerProperty TauolaPP::m_decay_mode_opp {this, "decay_mode_opposite", 2}

private

TAUOLA decay mode of particles with opposite charge as "decay_particle".

Definition at line 68 of file TauolaPP.h.

68{this, "decay_mode_opposite", 2};

◆ m_decay_mode_same

IntegerProperty TauolaPP::m_decay_mode_same {this, "decay_mode_same", 1}

private

TAUOLA decay mode of particles with same charge as "decay_particle".

Definition at line 65 of file TauolaPP.h.

65{this, "decay_mode_same", 1};

◆ m_decay_particle

IntegerProperty TauolaPP::m_decay_particle {this, "decay_particle", 15}

private

PDG ID of particle to study.

Definition at line 62 of file TauolaPP.h.

62{this, "decay_particle", 15};

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

IntegerProperty TauolaPP::m_dsid {this, "Dsid", 999999}

private

Definition at line 53 of file TauolaPP.h.

53{this, "Dsid", 999999};

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

StringProperty TauolaPP::m_key {this, "McEventKey", "GEN_EVENT"}

private

Event record container key - FIXME should be using Read/WriteHandles here.

Definition at line 47 of file TauolaPP.h.

47{this, "McEventKey", "GEN_EVENT"};

◆ m_randomSeed

IntegerProperty TauolaPP::m_randomSeed {this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}

private

Seed for random number engine.

Definition at line 56 of file TauolaPP.h.

56{this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}; // FIXME make this into an unsigned long int?

◆ m_rndmSvc

ServiceHandle<IAthRNGSvc> TauolaPP::m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}

private

Definition at line 50 of file TauolaPP.h.

50{this, "RndmSvc", "AthRNGSvc"};

◆ m_setRadiation

BooleanProperty TauolaPP::m_setRadiation {this, "setRadiation", true}

private

TAUOLA switch for radiative corrections for leptonic tau decays.

Definition at line 77 of file TauolaPP.h.

77{this, "setRadiation", true};

◆ m_setRadiationCutOff

DoubleProperty TauolaPP::m_setRadiationCutOff {this, "setRadiationCutOff", 0.01}

private

TAUOLA cut-off for radiative corrections.

Definition at line 80 of file TauolaPP.h.

80{this, "setRadiationCutOff", 0.01};

◆ m_spin_correlation

BooleanProperty TauolaPP::m_spin_correlation {this, "spin_correlation", true}

private

TAUOLA switch for spin effects.

Definition at line 74 of file TauolaPP.h.

74{this, "spin_correlation", true};

◆ m_tau_mass

DoubleProperty TauolaPP::m_tau_mass {this, "tau_mass", 1.77684}

private

tau mass to be taken by TAUOLA

Definition at line 71 of file TauolaPP.h.

71{this, "tau_mass", 1.77684};

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

◆ p_rndmEngine

CLHEP::HepRandomEngine * TauolaPP::p_rndmEngine = nullptr

static

Definition at line 35 of file TauolaPP.h.

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

Public Member Functions

Static Public Attributes

Protected Member Functions

Private Types

Private Member Functions

Private Attributes

Features for derived classes to use internally

Detailed Description

Member Typedef Documentation

◆ StoreGateSvc_t

Constructor & Destructor Documentation

◆ TauolaPP()

Member Function Documentation

◆ declareGaudiProperty()

◆ declareProperty()

◆ detStore()

◆ evtStore()

◆ execute()

◆ extraDeps_update_handler()

◆ extraOutputDeps()

◆ getRandomEngine()

◆ getRandomEngineDuringInitialize()

◆ initialize()

◆ inputHandles()

◆ msg()

◆ msgLvl()

◆ outputHandles()

◆ renounce()

◆ renounceArray()

◆ reseedRandomEngine()

◆ sysInitialize()

◆ sysStart()

◆ updateVHKA()

Member Data Documentation

◆ m_decay_mode_opp

◆ m_decay_mode_same

◆ m_decay_particle

◆ m_detStore

◆ m_dsid

◆ m_evtStore

◆ m_extendedExtraObjects

◆ m_key

◆ m_randomSeed

◆ m_rndmSvc

◆ m_setRadiation

◆ m_setRadiationCutOff

◆ m_spin_correlation

◆ m_tau_mass

◆ m_varHandleArraysDeclared

◆ m_vhka

◆ p_rndmEngine