ParticleDecayer Class Reference

#include <ParticleDecayer.h>

Inheritance diagram for ParticleDecayer:

Collaboration diagram for ParticleDecayer:

Public Member Functions
	ParticleDecayer (const std::string &name, ISvcLocator *pSvcLocator)
	~ParticleDecayer ()=default
StatusCode	genInitialize ()
	For initializing the generator, if required.
StatusCode	fillEvt (HepMC::GenEvent *)
	For filling the HepMC event object.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual bool	isClonable () const override
	Specify if the algorithm is clonable.
virtual StatusCode	sysExecute (const EventContext &ctx) override
	Execute an algorithm.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
virtual bool	filterPassed (const EventContext &ctx) const
	Get filter decision:
virtual void	setFilterPassed (bool state, const EventContext &ctx) const
	Set filter decision:
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
Event loop algorithm methods: not to be overloaded
StatusCode	initialize ()
StatusCode	execute (const EventContext &ctx)
	Execute method.
StatusCode	finalize ()
Gen-specific event loop methods: to be overloaded
virtual StatusCode	genuserInitialize ()
	For initialization of user code, if required. Called after genInitialize.
virtual StatusCode	callGenerator ()
	For calling the generator on each iteration of the event loop.
virtual StatusCode	genFinalize ()
	For finalising the generator, if required.
Event collection accessors (const and non-const)
HepMC::GenEvent *event	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current signal event (first in the McEventCollection).
McEventCollection *events	ATLAS_NOT_CONST_THREAD_SAFE ()
	Access the current event's McEventCollection.
const HepMC::GenEvent *	event_const (const EventContext &ctx) const
	Access the current signal event (const).
const McEventCollection *	events_const (const EventContext &ctx) const
	Access the current event's McEventCollection (const).
Particle data accessors
const ServiceHandle< IPartPropSvc >	partPropSvc () const
	Access the particle property service.
const HepPDT::ParticleDataTable &	particleTable () const
	Get a particle data table.
const HepPDT::ParticleDataTable &	pdt () const
	Shorter alias to get a particle data table.
const HepPDT::ParticleData *	particleData (int pid) const
	Access an element in the particle data table.

Protected Member Functions
virtual bool	isReEntrant () const override final
	Legacy algorithms are not thread-safe.
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
double	getParticleMass (int pdgID)
void	addParticle (HepMC::GenVertexPtr, int pdg, HepMC::FourVector, int statusCode)
double	rnd_ExpLifetime (CLHEP::HepRandomEngine *engine, double ct)
double	rnd_DoubleRange (CLHEP::HepRandomEngine *engine, double a, double b)
double	cosgen (CLHEP::HepRandomEngine *engine, int itype)
StatusCode	DFTwoBodyDecay (CLHEP::HepRandomEngine *engine, HepMC::GenParticlePtr, int)
StatusCode	setDecayPosition (CLHEP::HepRandomEngine *engine, HepMC::GenParticlePtr, HepMC::GenEvent *, bool doScalarDecay=false)
StatusCode	changeMass (HepMC::GenParticlePtr, double)
StatusCode	getDecayProducts (CLHEP::HepRandomEngine *engine, CLHEP::HepLorentzVector, double, std::vector< CLHEP::HepLorentzVector > &, int decayType=0)
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T, V, H > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey>

Private Attributes
std::string	m_truthParticleContainerName
int	m_LJType {}
int	m_scalarPDGID {}
double	m_scalarMass {}
double	m_particleMass {}
int	m_particleID {}
double	m_particleLifeTime {}
int	m_particlePDGID {}
int	m_particlePolarization {}
bool	m_oppositePolarization {}
double	m_BRElectron {}
double	m_BRMuon {}
double	m_BRPion {}
bool	m_doUniformDecay {}
bool	m_doExponentialDecay {}
bool	m_expDecayDoVariableLifetime {}
double	m_expDecayFractionToKeep {}
bool	m_expDecayDoTruncateLongDecays {}
bool	m_decayOnlyStable {}
double	m_barrelRadius
double	m_endCapDistance
double	m_thetaEndCapBarrel
HepPDT::ParticleDataTable *	m_particleTable {}
CLHEP::HepLorentzVector	m_boostLV
CLHEP::HepLorentzVector	m_posLV
CLHEP::HepLorentzVector	m_posLV1
CLHEP::HepLorentzVector	m_posLV2
int	m_eventCounter {}
DataObjIDColl	m_extendedExtraObjects
	Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.
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

Features for derived classes to use internally
ServiceHandle< IAthRNGSvc >	m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}
	Data members.
ServiceHandle< IIncidentSvc >	m_incidentSvc {this, "IncidentSvc", "IncidentSvc"}
	Handle on the incident service.
IntegerProperty	m_randomSeed {this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}
	Seed for random number engine.
BooleanProperty	m_isAfterburner {this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"}
	Flag for normal vs. afterburner generators.
std::shared_ptr< HepMC3::GenRunInfo >	m_runinfo {}
	The run info for HepMC3.
CLHEP::HepRandomEngine *	getRandomEngine (const std::string &streamName, const EventContext &ctx) const
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

Properties
ServiceHandle< IPartPropSvc >	m_ppSvc {this, "PartPropSvc", "PartPropSvc"}
	Handle on the particle property service.
SG::ReadHandleKey< McEventCollection >	m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
	Const handle to the MC event collection.
std::string	m_mcEventKey {}
	StoreGate key for the MC event collection (defaults to GEN_EVENT).
BooleanProperty	m_mkMcEvent {this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"}
	Flag to determine if a new MC event collection should be made if it doesn't exist.

Detailed Description

Definition at line 26 of file ParticleDecayer.h.

Member Typedef Documentation

StoreGateSvc_t

typedef ServiceHandle<StoreGateSvc> AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::StoreGateSvc_t

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

ParticleDecayer()

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

Definition at line 223 of file ParticleDecayer.cxx.

                                                                                : 
   GenModule(name, pSvcLocator),
   m_truthParticleContainerName("GEN_EVENT"),
   m_eventCounter(0)
{
  declareProperty("McEventCollection",     m_truthParticleContainerName);  
  declareProperty("LJType",                m_LJType = 1); //1 = one dark photon per LeptonJet, 2 = two dark photons per LeptonJet
  declareProperty("ScalarPDGID",           m_scalarPDGID); //new PDG ID of the scalar 
  declareProperty("ScalarMass",            m_scalarMass); //new mass of the scalar in MeV
  declareProperty("ParticleID",            m_particleID = 999); //PDG ID of the geantino
  declareProperty("ParticleMass",          m_particleMass = 400); //new mass of the dark photon in MeV (default 400 MeV)
  declareProperty("ParticleLifeTime",      m_particleLifeTime = 0); //ctau of the dark photon in mm (default prompt)
  declareProperty("ParticlePolarization",  m_particlePolarization = 0); //polarization of the dark photon (default 0 : isotropic decay, -1 : transverse, 1 : longitudinal)
  declareProperty("OppositePolarization",  m_oppositePolarization = false);//In case of LJType == 2 and opposite polarization for the two dark photons in the event
  declareProperty("ParticlePDGID",         m_particlePDGID = 700022); //new PDG ID of the dark photon (default 700022)
  declareProperty("DecayOnlyStable",       m_decayOnlyStable = false); 
  declareProperty("DecayBRElectrons",      m_BRElectron = 1.); //BR of dark photon decay to electrons  
  declareProperty("DecayBRMuons",          m_BRMuon = 0.); //BR of dark photon decay to muons 
  declareProperty("DecayBRPions",          m_BRPion = 0.); //BR of dark photon decay to pions 
 
  //Choose between the different types of displaced decays
  declareProperty("DoUniformDecay",               m_doUniformDecay = false);
  declareProperty("DoExponentialDecay",           m_doExponentialDecay = true );
  declareProperty("ExpDecayDoVariableLifetime",   m_expDecayDoVariableLifetime   = false );
  declareProperty("ExpDecayPercentageToKeep",     m_expDecayFractionToKeep       = 0.8   );
  declareProperty("ExpDecayDoTruncateLongDecays", m_expDecayDoTruncateLongDecays = false );
 
  //Dimensions within which to decay in case of non-prompt events
  declareProperty("BarrelRadius",                 m_barrelRadius         = 10.e3 );      // outer limit for decay radius
  declareProperty("EndCapDistance",               m_endCapDistance       = 15.e3 );      // outer limit along z for decays in endcap
  declareProperty("ThetaEndCapBarrel",            m_thetaEndCapBarrel    = 0.439067982); // theta if where to switch between barrel and endcap (default: eta = 1.5)
}

~ParticleDecayer()

ParticleDecayer::~ParticleDecayer ( )

default

Member Function Documentation

addParticle()

void ParticleDecayer::addParticle ( HepMC::GenVertexPtr prod_vtx, int pdg, HepMC::FourVector momentum, int statusCode )

private

Definition at line 452 of file ParticleDecayer.cxx.

                                                                                                               {
 
  double mass = 0.;
  if( pdg == m_particlePDGID)
     {
        mass = m_particleMass;
     }else
     {
        mass = getParticleMass(pdg);
     }
  double energy=std::sqrt(std::pow(momentum.x(),2)+std::pow(momentum.y(),2)+std::pow(momentum.z(),2)+mass*mass);   
HepMC::GenParticlePtr aParticle = HepMC::newGenParticlePtr (HepMC::FourVector(momentum.x(), momentum.y(), momentum.z(), energy), 
                                   pdg, statusCode);
 
  prod_vtx->add_particle_out(std::move(aParticle));
}

ATLAS_NOT_CONST_THREAD_SAFE() [1/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.

ATLAS_NOT_CONST_THREAD_SAFE() [2/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());
  }

callGenerator()

virtual StatusCode GenModule::callGenerator ( )

inlinevirtualinherited

For calling the generator on each iteration of the event loop.

Reimplemented in BeamHaloGeneratorAlg, CosmicGenerator, Epos4, Epos, Herwig7, Hijing, MultiParticleGunPileup, MultiPy8Pileup, Pythia8_i, Pythia8B_i, Sherpa_i, Starlight_i, and TrackRecordGenerator.

Definition at line 66 of file GenModule.h.

{ return StatusCode::SUCCESS; }

changeMass()

StatusCode ParticleDecayer::changeMass ( HepMC::GenParticlePtr genpart, double newMass )

private

Definition at line 94 of file ParticleDecayer.cxx.

{
   double e     = genpart->momentum().e(); 
   double theta = genpart->momentum().theta(); 
   double phi   = genpart->momentum().phi(); 
   //Sanity check 
   double p2 = e*e - newMass*newMass;
   if ( p2 < 0 ) {
      ATH_MSG_FATAL("ParticleDecayer::fillEvt:   -- you have generated a tachyon!");
      return StatusCode::FAILURE;
   }
   //At this point, we have e, theta, and phi.  Put them together to get the four-momentum.
   double p  = std::sqrt(p2);
   double px = p*std::sin(theta)*std::cos(phi);
   double py = p*std::sin(theta)*std::sin(phi);
   double pz = p*std::cos(theta);
   //Fill the four-momentum
   const CLHEP::HepLorentzVector updatedLV(px,py,pz,e);
   genpart->set_momentum(HepMC::FourVector(updatedLV.x(),updatedLV.y(),updatedLV.z(),updatedLV.e()));
   genpart->set_generated_mass(newMass);
   return StatusCode::SUCCESS;
}

cosgen()

double ParticleDecayer::cosgen ( CLHEP::HepRandomEngine * engine, int itype )

private

Definition at line 47 of file ParticleDecayer.cxx.

                                                                     {
  double x,fx,hit;
  x=0;  
 
  if(itype==0){  // flat
    x=rnd_DoubleRange(engine,-1.,1.);
    return x;
  }
    
  if(itype==1){  // f(cost)=1.5*cost^2
    hit=1.5;
    fx=0;
     while(hit>fx){
       x=rnd_DoubleRange(engine,-1.,1.);
       hit=rnd_DoubleRange(engine,0.,1.5);
       fx=1.5*x*x;
     }
    return x;
  }
 
  if(itype==2){    // f(cost)=0.375(1+cost^2)
    hit=0.75;
    fx=0;
    while(hit>fx){
      x=rnd_DoubleRange(engine,-1.,1.);
      hit=rnd_DoubleRange(engine,0.,0.75);
      fx=0.375*(1+x*x);
    }
    return x;
  }
 
  if(itype==3){      // f(cost)=0.75(1-cost^2)
    hit=1.5;
    fx=0;
    while(hit>fx){
      x=rnd_DoubleRange(engine,-1.,1.);
      hit=rnd_DoubleRange(engine,0.,1.5);
      fx=0.75*(1-x*x);
    }
    return x;
  }
 
  return x;
 
}

declareGaudiProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Gaudi::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< Gaudi::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< Gaudi::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; }

DFTwoBodyDecay()

StatusCode ParticleDecayer::DFTwoBodyDecay ( CLHEP::HepRandomEngine * engine, HepMC::GenParticlePtr genpart, int Polarization )

private

Definition at line 482 of file ParticleDecayer.cxx.

                                                                                                                        {
 
 
   ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- allow the two-body decay of the dark photon...");
 
   //create heplorentzvector from genpart's fourMomentum, as it is more useful
   CLHEP::HepLorentzVector boostDF( genpart->momentum().px(), genpart->momentum().py(), genpart->momentum().pz(), genpart->momentum().e() );
 
   //Given branching fractions, pick decay mode
   int ModeOfDecay;
   double unif = rnd_DoubleRange(engine, 0.,1.);
   if (unif<=m_BRElectron) {
      ModeOfDecay = 11;
   } else if (unif<=(m_BRElectron+m_BRMuon) && unif>m_BRElectron) {
      ModeOfDecay = 13;
   } else {
      ModeOfDecay = 211;
   }
   ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- decayMode = " << ModeOfDecay);
   
   //Now that we have a decay mode. get the associated particle mass
   double decayPartMass = getParticleMass(ModeOfDecay);
 
   //Choose how to decay
   //angular distribution handling, see pag.6 of http://arxiv.org/pdf/hep-ph/0605296v2.pdf
   int type = 0; //isotropic by default
   if(Polarization==0) {
      type = 0; //isotropic
   } else if(Polarization==-1 && (ModeOfDecay==11 || ModeOfDecay==13)) {
      type = 2; //transverse polarization of the dark photon + fermions
   } else if(Polarization==1 && (ModeOfDecay==11 || ModeOfDecay==13)) {
      type = 3;  //longitudinal polarization of the dark photon + fermions
   } else if(Polarization==-1 && ModeOfDecay==211) {
      type = 3;  //transverse polarization of the dark photon + scalars
   } else if(Polarization==1 && ModeOfDecay==211) {
      type = 1;  //longitudinal polarization of the dark photon + scalars
   } else {
      ATH_MSG_FATAL("ParticleDecayer::fillEvt:   -- wrong polarization value... please check!");
      return StatusCode::FAILURE;
   }
 
   //Now we are ready to decay the dark photon
   std::vector<CLHEP::HepLorentzVector> daughterLVs; 
   CHECK( getDecayProducts( engine, boostDF, decayPartMass, daughterLVs, type) );
   
   //Add the daughters to the pool file
   ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- Add the daughters to the pool file");
   auto end_vtx = genpart->end_vertex();
   auto v0=daughterLVs.at(0).vect();
   addParticle(end_vtx,  ModeOfDecay, HepMC::FourVector(v0.x(),v0.y(),v0.z(),0.0),    1);
   auto v1=daughterLVs.at(1).vect();
   addParticle(std::move(end_vtx), -ModeOfDecay, HepMC::FourVector(v1.x(),v1.y(),v1.z(),0.0),    1);
 
   return StatusCode::SUCCESS;
}

event_const()

const HepMC::GenEvent * GenBase::event_const ( const EventContext & ctx ) const

inlineinherited

Access the current signal event (const).

Definition at line 83 of file GenBase.h.

                                                                    {
    const McEventCollection* coll = events_const(ctx);
    if (coll->empty())
      ATH_MSG_ERROR("Const McEventCollection is empty during first event access");
    return *(coll->begin());
  }

events_const()

const McEventCollection * GenBase::events_const ( const EventContext & ctx ) const

inlineinherited

Access the current event's McEventCollection (const).

Definition at line 97 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()

ServiceHandle< StoreGateSvc > & AthCommonDataStore< AthCommonMsg< Gaudi::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 GenModule::execute ( const EventContext & ctx )

virtualinherited

Execute method.

Todo

Remove hard-coded alg name checking (already incomplete)

Reimplemented from GenBase.

Definition at line 70 of file GenModule.cxx.

                                                   {
  // Examples of how to retrieve the random number engine for a given
  // stream.
  // NB getRandomEngine should only be called once per event for a
  // given stream, as it causes the stream to be re-seeded each time
  // it is called.
 
  // Example 1 - seeded based on the current event number (+ slot, run, streamName)
  //CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine("MyStream", ctx);
 
  // Example 2 - seeded based on the m_randomSeed property (+ slot, run, streamName)
  //CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine("MyStream", m_randomSeed.value(), ctx);
 
  // Call the code that generates an event
  CHECK(this->callGenerator());
 
  // Create the MC event and send the GeneratorEvent stored in it to fillEvt
  HepMC::GenEvent* evt = HepMC::newGenEvent(1,1);
  CHECK(this->fillEvt(evt));
  HepMC::fillBarcodesAttribute(evt);
 
  // Add the event to the MC event collection
  if (events()) {
    // If this is an "afterburner" generator, replace the last event rather than add a new one
    if (m_isAfterburner.value() || name() == "Tauola" || name() == "Photos") {
      events()->pop_back();
    }
    // Add the event to the end of the collection
    events()->push_back(evt);
    ATH_MSG_DEBUG("MC event added to McEventCollection");
 
    // remove the empty event in case of ParticleDecayer
    if (name() == "ParticleDecayer") {
      events()->pop_back();
    }
  }
 
  // Call the incident service to notify that an event has been made
  m_incidentSvc->fireIncident( Incident(name(), "McEventGenerated") );
  return StatusCode::SUCCESS;
}

extraDeps_update_handler()

void AthCommonDataStore< AthCommonMsg< Gaudi::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 & AthCommonAlgorithm< Gaudi::Algorithm >::extraOutputDeps ( ) const

overridevirtualinherited

Return the list of extra output dependencies.

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

Definition at line 89 of file AthCommonAlgorithm.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 BaseAlg::extraOutputDeps();
}

fillEvt()

StatusCode ParticleDecayer::fillEvt ( HepMC::GenEvent * evt )

virtual

For filling the HepMC event object.

*** Now allow the two-body decay of the particle

*** Now allow the two-body decay of the scalar

Implements GenModule.

Definition at line 291 of file ParticleDecayer.cxx.

                                                        {
 
  ATH_MSG_DEBUG("ParticleDecayer::fillEvt: -- EventCounter: " << m_eventCounter);
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
  CLHEP::HepRandomEngine* engine = this->getRandomEngine("ParticleDecayer", ctx);
 
  StatusCode status = StatusCode::SUCCESS;
 
  // Extract the event from the TES
  McEventCollection* mcEvtColl = nullptr;
  if (evtStore()->contains<McEventCollection>(m_truthParticleContainerName) && evtStore()->retrieve(mcEvtColl, m_truthParticleContainerName).isSuccess() ) {
    ATH_MSG_DEBUG("ParticleDecayer::fillEvt: -- Found an McEventCollection for ParticleDecayer");
  } else {
    ATH_MSG_FATAL("TES is empty!!!!");
    status = StatusCode::FAILURE;  
    return status;  
  }
 
  event = mcEvtColl->back();
 
  if (event == NULL) {
    ATH_MSG_FATAL("ParticleDecayer::fillEvt: -- McEvent was not successfully created");
    status = StatusCode::FAILURE;  
    return status;  
  }
  
  for ( auto  genpart : *event) { 
 
     const bool hasRightPDG = (genpart->pdg_id() == m_particleID);
     const bool isStable    = (genpart->status() == 1);
     const bool hasEndVtx   = (genpart->end_vertex() != nullptr);
 
     if (!hasRightPDG) {
        continue;
     }
 
     if (m_decayOnlyStable) {
        if (!isStable || hasEndVtx) {
           ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- skip particle with PDG ID = "
                         << genpart->pdg_id()
                         << " status = " << genpart->status()
                         << " end_vertex = " << (hasEndVtx ? "yes" : "no"));
           continue;
        }
     }

     //    only one dark photon per LeptonJet    //
     if (m_LJType == 1) {
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt: -- only one dark photon per LeptonJet");
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- found MC particle with PDG ID = " << genpart->pdg_id());
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- assign the new mass of the dark photon, m = " << m_particleMass);
 
        //Change the mass of the parent particle ( set by user input + command )
        //Changes the magnitude of the spatial part of the 4-momentum such that the new 4-momentum has the desired inv mass
        CHECK( changeMass( genpart, m_particleMass ) ); 
 
        //Add decay position to the event
        CHECK( setDecayPosition( engine, genpart, event ) );
 
        //assign the new PDG_ID of the particle
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- set the new PDG ID =  " << m_particlePDGID);
        genpart->set_pdg_id(m_particlePDGID);  
           
        //set the new status (decayed) of the particle
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- set the new status = 2");
        genpart->set_status(2); 
           
        //set the new momentum of the particle
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- set the new momentum");
           
        CHECK( DFTwoBodyDecay( engine, std::move(genpart), m_particlePolarization ) );
 
     }else if (m_LJType == 2) {
        //      two dark photons per LeptonJet     //
 
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt: -- two dark photons per LeptonJet");
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- found MC particle with PDG ID = " << genpart->pdg_id());
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- assign the new mass of the dark scalar, m = " << m_scalarMass);
 
        //Get the mass of the parent particle ( set by user input + command )
        //Change the mass of the parent particle ( set by user input + command )
        //Changes the magnitude of the spatial part of the 4-momentum such that the new 4-momentum has the desired inv mass
           CHECK( changeMass( genpart, m_scalarMass ) ); 
 
        //set the new PDG_ID of the scalar
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- set the new PDG ID =  " << m_scalarPDGID);
        genpart->set_pdg_id(m_scalarPDGID);  
 
        //set the new status (decayed) of the scalar
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- set the new status = 2");
        genpart->set_status(2); 
 
        //set the decay vertex position of the scalar
        //Create a HepMC vertex at the decay position of the scalar 
        CHECK( setDecayPosition( engine, genpart, event, true ) );
           
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- allow the two-body decay of the dark scalar to dark photons...");
        ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- dark photon has PDG ID = " << m_particlePDGID);
 
        std::vector<CLHEP::HepLorentzVector> darkPhotonLVs; 
        CHECK( getDecayProducts( engine, CLHEP::HepLorentzVector( genpart->momentum().px(), genpart->momentum().py(), genpart->momentum().pz(), genpart->momentum().e() ),
                                 m_particleMass,
                                 darkPhotonLVs) );
 
        //add dark photon 1
        auto v0=darkPhotonLVs.at(0).vect();
        addParticle( genpart->end_vertex(), m_particlePDGID, HepMC::FourVector(v0.x(),v0.y(),v0.z(),0.0) , 2);
        //add dark photon 2
        auto v1=darkPhotonLVs.at(1).vect();
        addParticle( genpart->end_vertex(), m_particlePDGID, HepMC::FourVector(v1.x(),v1.y(),v1.z(),0.0), 2);
           
        //lifetime handling of the dark photons
        int polarizationSwitch = 1;
        const std::vector<HepMC::GenParticlePtr>& particlesOut = genpart->end_vertex()->particles_out();
        std::vector<HepMC::GenParticlePtr>::const_iterator pItBegin = particlesOut.begin();
        std::vector<HepMC::GenParticlePtr>::const_iterator pItEnd = particlesOut.end();
        for ( auto pIt=pItBegin ; pIt != pItEnd; ++pIt )
           {
               
              //Add decay position to the event
              CHECK( setDecayPosition( engine, *pIt, event ) );
              //And perform two-body decay
              ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- Now allow the two-body decay of the dark photons");
              CHECK( DFTwoBodyDecay( engine, *pIt, polarizationSwitch*m_particlePolarization ) );
              if(m_oppositePolarization)
                 {
                    polarizationSwitch = -polarizationSwitch;
                 }
           }
 
     }else
        {
           ATH_MSG_FATAL("LJType set to " << m_LJType );
           ATH_MSG_FATAL("LJType must be 1 or 2" );
           return StatusCode::FAILURE;
        }
  }
 
  //set the event number
  event->set_event_number(m_eventCounter);
  
  //Add a unit entry to the event weight vector if it's currently empty
  if (event->weights().empty()) {
     event->weights().push_back(1.); 
  }
  
  //increment the event counter
  m_eventCounter++;
  
  return status;
}

filterPassed()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::filterPassed ( const EventContext & ctx ) const

inlinevirtualinherited

Get filter decision:

Definition at line 93 of file AthCommonAlgorithm.h.

                                                           {
    return execState( ctx ).filterPassed();
  }

finalize()

StatusCode GenModule::finalize ( )

inlineinherited

Definition at line 55 of file GenModule.h.

{ return genFinalize(); }

genFinalize()

virtual StatusCode GenModule::genFinalize ( )

inlinevirtualinherited

For finalising the generator, if required.

Reimplemented in BeamHaloGeneratorAlg, CosmicGenerator, Epos4, Epos, Herwig7, Hijing, MultiParticleGunPileup, MultiPy8Pileup, Pythia8_i, Pythia8B_i, Sherpa_i, and Starlight_i.

Definition at line 70 of file GenModule.h.

{ return StatusCode::SUCCESS; }

genInitialize()

StatusCode ParticleDecayer::genInitialize ( )

virtual

For initializing the generator, if required.

Reimplemented from GenModule.

Definition at line 258 of file ParticleDecayer.cxx.

{
   // Check here if the tool has been configured correctly
   if(m_doUniformDecay && m_doExponentialDecay)
      {
         ATH_MSG_FATAL("Cannot configure exponential and uniform decay at the same time.");
         return StatusCode::FAILURE;
      }
 
   double TOTBR = m_BRElectron + m_BRMuon + m_BRPion;
   if (TOTBR>1.0000001) {
      ATH_MSG_FATAL("ParticleDecayer::genInitialize:   -- Branching Ratio sum is larger than 1!! Please check the values in your jobOption.");
      ATH_MSG_FATAL("ParticleDecayer::genInitialize:   -- Branching Ratio Electrons " << m_BRElectron);
      ATH_MSG_FATAL("ParticleDecayer::genInitialize:   -- Branching Ratio Muons     " << m_BRMuon);
      ATH_MSG_FATAL("ParticleDecayer::genInitialize:   -- Branching Ratio Pions     " << m_BRPion);
      ATH_MSG_FATAL("ParticleDecayer::genInitialize:   -- Total Branching Ratio     " << TOTBR);
      return StatusCode::FAILURE;
   }
 
   ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- daughters randomly produced: " << m_BRElectron << "% e, " << m_BRMuon << "% mu, " << m_BRPion << "% pi");
 
   if( m_LJType != 1 && m_LJType != 2 )
      {
         ATH_MSG_FATAL("LJType is set to " << m_LJType);
         ATH_MSG_FATAL("LJType has to be set to either 1 or 2");
         return StatusCode::FAILURE;
      }
   
 
   return StatusCode::SUCCESS;
}

genuserInitialize()

virtual StatusCode GenModule::genuserInitialize ( )

inlinevirtualinherited

For initialization of user code, if required. Called after genInitialize.

Reimplemented in Pythia8B_i.

Definition at line 64 of file GenModule.h.

{ return StatusCode::SUCCESS; }

getDecayProducts()

StatusCode ParticleDecayer::getDecayProducts ( CLHEP::HepRandomEngine * engine, CLHEP::HepLorentzVector parentLV, double decayPartMass, std::vector< CLHEP::HepLorentzVector > & daughterLVs, int decayType = 0 )

private

Definition at line 539 of file ParticleDecayer.cxx.

{
   double parentMass          = parentLV.m();
   CLHEP::Hep3Vector boostVec = parentLV.boostVector();
 
   if( decayPartMass > parentMass/2.)
      {
         ATH_MSG_FATAL("Decay particle has more than half the mass of parent.");
         return StatusCode::FAILURE;
      }
   //Get the angles in the rest frame
   double phi_rf   = rnd_DoubleRange(engine, -M_PI, M_PI);
   double ct_rf    = cosgen(engine, decayType);
   double theta_rf = std::acos(ct_rf);
 
   //construct p1 particle momentum in rest-frame (_rf)
   double p1_rf = std::sqrt(parentMass*parentMass/4. - decayPartMass*decayPartMass);
   double px_rf = p1_rf*std::cos(phi_rf)*std::sin(theta_rf);
   double py_rf = p1_rf*std::sin(phi_rf)*std::sin(theta_rf);
   double pz_rf = p1_rf*ct_rf;
   CLHEP::HepLorentzVector hlv1(  px_rf,  py_rf,  pz_rf, parentMass/2.);
   CLHEP::HepLorentzVector hlv2( -px_rf, -py_rf, -pz_rf, parentMass/2.);
 
   //Transform from the rotated frame to the (x,y,z) frame.
   hlv1.rotateUz((parentLV.vect()).unit());
   hlv2.rotateUz((parentLV.vect()).unit());
 
   //Now boost back to the lab-frame
   hlv1.boost(boostVec);
   hlv2.boost(boostVec);
 
   daughterLVs.push_back(hlv1);
   daughterLVs.push_back(hlv2);
 
   return StatusCode::SUCCESS;
}

getParticleMass()

double ParticleDecayer::getParticleMass ( int pdgID )

private

Definition at line 471 of file ParticleDecayer.cxx.

                                               {
  SmartIF<IPartPropSvc> partPropSvc(Gaudi::svcLocator()->service("PartPropSvc"));
  if (!partPropSvc) throw GaudiException("PartPropSvc error", "I_ParticleDecayer", StatusCode::FAILURE);
  m_particleTable = partPropSvc->PDT();
 
  const HepPDT::ParticleData* particle = m_particleTable->particle(HepPDT::ParticleID(std::abs(pid)));
  return particle->mass().value();
} 

getRandomEngine() [1/2]

CLHEP::HepRandomEngine * GenModule::getRandomEngine ( const std::string & streamName, const EventContext & ctx ) const

protectedinherited

Definition at line 34 of file GenModule.cxx.

{
  ATHRNG::RNGWrapper* rngWrapper = m_rndmSvc->getEngine(this, streamName);
  std::string rngName = name()+streamName;
  rngWrapper->setSeed( rngName, ctx );
  return rngWrapper->getEngine(ctx);
}

getRandomEngine() [2/2]

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

protectedinherited

Definition at line 44 of file GenModule.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 * GenModule::getRandomEngineDuringInitialize ( const std::string & streamName, unsigned long int randomSeedOffset, unsigned int conditionsRun = 1, unsigned int lbn = 1 ) const

protectedinherited

Definition at line 53 of file GenModule.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 GenModule::initialize ( )

virtualinherited

Reimplemented from GenBase.

Definition at line 21 of file GenModule.cxx.

                                 {
  // Base class initializations
  CHECK(GenBase::initialize());
  // Get the random number service
  CHECK(m_rndmSvc.retrieve());
  // Get the incident service
  CHECK(m_incidentSvc.retrieve());
  CHECK(genInitialize());
  CHECK(genuserInitialize());
  return StatusCode::SUCCESS;
}

inputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Gaudi::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.

isClonable()

virtual bool AthCommonAlgorithm< Gaudi::Algorithm >::isClonable ( ) const

inlineoverridevirtualinherited

Specify if the algorithm is clonable.

Only relevant for non-reentrant algorithms. Actual number of clones needs to be set via the "Cardinality" property.

Reimplemented in AFP_DigiTop, AlgB, AlgT, BCM_Digitization, CscDigitBuilder, CscDigitToCscRDO, G4AtlasAlg, G4RunAlg, HGTD_Digitization, HiveAlgBase, InDet::GNNSeedingTrackMaker, InDet::SCT_Clusterization, InDet::SiSPGNNTrackMaker, InDet::SiSPSeededTrackFinder, InDet::SiTrackerSpacePointFinder, ISF::SimKernelMT, ITk::StripDigitization, ITkPixelCablingAlg, ITkStripCablingAlg, LArHitEMapMaker, LArTTL1Maker, LUCID_DigiTop, LVL1::L1TopoSimulation, MergeCalibHits, MergeGenericMuonSimHitColl, MergeHijingPars, MergeMcEventCollection, MergeTrackRecordCollection, MergeTruthJets, MergeTruthParticles, MuonDigitizer, PileUpMTAlg, PixelDigitization, RoIBResultToxAOD, SCT_ByteStreamErrorsTestAlg, SCT_CablingCondAlgFromCoraCool, SCT_CablingCondAlgFromText, SCT_ConditionsParameterTestAlg, SCT_ConditionsSummaryTestAlg, SCT_ConfigurationConditionsTestAlg, SCT_Digitization, SCT_FlaggedConditionTestAlg, SCT_LinkMaskingTestAlg, SCT_MajorityConditionsTestAlg, SCT_ModuleVetoTestAlg, SCT_MonitorConditionsTestAlg, SCT_PrepDataToxAOD, SCT_RawDataToxAOD, SCT_ReadCalibChipDataTestAlg, SCT_ReadCalibDataTestAlg, SCT_RODVetoTestAlg, SCT_SensorsTestAlg, SCT_SiliconConditionsTestAlg, SCT_StripVetoTestAlg, SCT_TdaqEnabledTestAlg, SCT_TestCablingAlg, SCTEventFlagWriter, SCTRawDataProvider, SCTSiLorentzAngleTestAlg, SCTSiPropertiesTestAlg, SGInputLoader, Simulation::BeamEffectsAlg, TileHitVecToCnt, TileMuonFitter, TilePulseForTileMuonReceiver, TileRawChannelMaker, TRTDigitization, and ZDC_DigiTop.

Definition at line 68 of file AthCommonAlgorithm.h.

                                           {
    return true;
  }

isReEntrant()

virtual bool AthAlgorithm::isReEntrant ( ) const

inlinefinaloverrideprotectedvirtualinherited

Legacy algorithms are not thread-safe.

Definition at line 47 of file AthAlgorithm.h.

{ return false; }

msg()

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Gaudi::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< Gaudi::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 124 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 116 of file GenBase.h.

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

partPropSvc()

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

inlineinherited

Access the particle property service.

Definition at line 111 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 121 of file GenBase.h.

{ return particleTable(); }

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< Gaudi::Algorithm > >::renounce ( T & h )

inlineprotectedinherited

Definition at line 380 of file AthCommonDataStore.h.

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

renounceArray()

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

inlineprotectedinherited

remove all handles from I/O resolution

Definition at line 364 of file AthCommonDataStore.h.

                                                          {
    handlesArray.renounce();
  }

rnd_DoubleRange()

double ParticleDecayer::rnd_DoubleRange ( CLHEP::HepRandomEngine * engine, double a, double b )

private

Definition at line 39 of file ParticleDecayer.cxx.

                                                                                        {
  double r = engine->flat(); //< Return random num in [0,1]
  return a + r*(b-a);
}

rnd_ExpLifetime()

double ParticleDecayer::rnd_ExpLifetime ( CLHEP::HepRandomEngine * engine, double ct )

private

Definition at line 32 of file ParticleDecayer.cxx.

                                                                               {
  double r = engine->flat(); //< Return random num in [0,1]
  return ((-ct)*std::log(1.-r));
}

setDecayPosition()

StatusCode ParticleDecayer::setDecayPosition ( CLHEP::HepRandomEngine * engine, HepMC::GenParticlePtr genpart, HepMC::GenEvent * event, bool doScalarDecay = false )

private

Definition at line 118 of file ParticleDecayer.cxx.

{
   HepMC::GenVertexPtr vtxp = genpart->production_vertex();
   if(!vtxp) {
      ATH_MSG_FATAL("ParticleDecayer::fillEvt: -- no production vertex position found!");
      return StatusCode::FAILURE;
   }
   if ( doScalarDecay ) // scalar decay is prompt. decay vtx == scalar production vertex
      {
         HepMC::GenVertexPtr end_vtx = HepMC::newGenVertexPtr();
         end_vtx->set_position(vtxp->position());
         end_vtx->add_particle_in(std::move(genpart));
         event->add_vertex(std::move(end_vtx));
         return StatusCode::SUCCESS;
      }
 
   //lifetime handling
   double gamma = genpart->momentum().e()/genpart->momentum().m();
   double ctau  = 0.;
   double theta = genpart->momentum().theta();
 
   // Make sure theta is between 0 and pi
   while( theta > M_PI )
      {                                                                                                                
         theta -= M_PI;                                                                                           
      }                                                                                                                
   while( theta < 0 )                                                                                                  
      {                                                                                                                
         theta += M_PI;
      }
 
   if (m_doExponentialDecay)
      {
         if(m_expDecayDoVariableLifetime) // Variable proper lifetime distribution, such that fixed fraction of events decays within detector, independent of boost
            {
               double distanceToEdge = -999.;
               if ( theta < m_thetaEndCapBarrel || theta > ( M_PI - m_thetaEndCapBarrel) ) // Particle escapes through endcap
                  {
                     distanceToEdge = std::abs(m_endCapDistance/std::cos(theta));
                  }
               else // Particle escapes through barrel
                  {
                     distanceToEdge = m_barrelRadius/std::sin(theta);
                  }
               if ( gamma < 1. )
                  {
                     ATH_MSG_FATAL("Gamma factor cannot be smaller than 1" );
                     return StatusCode::FAILURE;
                  }
               double Limit  = distanceToEdge / gamma; // ctau is enhanced by factor gamma in lab frame
               double lambda = -1.*Limit/std::log(1. - m_expDecayFractionToKeep);
               ctau = rnd_ExpLifetime(engine,lambda);
               if (m_expDecayDoTruncateLongDecays)
                  {
                     while ( ctau > Limit )  // If decay is outside detector, let's sample again (Produces a truncated exponential)
                        {
                          ctau = rnd_ExpLifetime(engine, lambda);
                        }
                  }
            }
         else if( m_particleLifeTime > 0 ) // Fixed proper lifetime distribution. Note that if m_particleLifeTime <= 0. ctau remains 0
            {
               ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- set lifetime of the dark photon according to ctau = " << m_particleLifeTime);
               ctau = rnd_ExpLifetime(engine,m_particleLifeTime);
            }
      }else if (m_doUniformDecay)
      {         
         double decayRadius = -999.;
         if ( theta < m_thetaEndCapBarrel || theta > ( M_PI - m_thetaEndCapBarrel) ) // Particle escapes through endcap
            {
               double outerLength = std::abs(m_endCapDistance/std::cos(theta));
               double outerRadius = outerLength*std::sin(theta);
               decayRadius        = rnd_DoubleRange(engine,0., std::min(outerRadius, std::abs(m_barrelRadius)) );
            }else // Particle escapes through barrel
            {
               decayRadius = rnd_DoubleRange(engine,0., std::abs(m_barrelRadius));
            }
 
         double decayLength = decayRadius/std::sin(theta);
         ctau = decayLength/gamma;
      }else
      {
         ATH_MSG_FATAL("have to pick uniform or exponential decay distance");
         return StatusCode::FAILURE;
      }
   
   double ctg = gamma * ctau;
   double px = genpart->momentum().px();
   double py = genpart->momentum().py();
   double pz = genpart->momentum().pz();
   double p  = std::sqrt(px*px + py*py + pz*pz);
 
   const CLHEP::HepLorentzVector posLV(((ctg*px/p)+(vtxp->position().x())), ((ctg*py/p)+(vtxp->position().y())), ((ctg*pz/p)+(vtxp->position().z())), ((ctg)+(vtxp->position().t())));
 
   //set the decay vertex position of the particle
   //Create a HepMC vertex at the decay position of the particle 
   ATH_MSG_DEBUG("ParticleDecayer::fillEvt:   -- set the decay vertex");
   HepMC::GenVertexPtr end_vtx = HepMC::newGenVertexPtr();
   end_vtx->set_position(HepMC::FourVector(posLV.x(),posLV.y(),posLV.z(),posLV.t()));
   end_vtx->add_particle_in(std::move(genpart));
   event->add_vertex(std::move(end_vtx));
   return StatusCode::SUCCESS;
}

setFilterPassed()

virtual void AthCommonAlgorithm< Gaudi::Algorithm >::setFilterPassed ( bool state, const EventContext & ctx ) const

inlinevirtualinherited

Set filter decision:

Reimplemented in AthFilterAlgorithm.

Definition at line 99 of file AthCommonAlgorithm.h.

                                                                            {
    execState( ctx ).setFilterPassed( state );
  }

sysExecute()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::sysExecute ( const EventContext & ctx )

overridevirtualinherited

Execute an algorithm.

We override this in order to work around an issue with the Algorithm base class storing the event context in a member variable that can cause crashes in MT jobs.

Reimplemented in AthAnalysisAlgorithm.

Definition at line 80 of file AthCommonAlgorithm.cxx.

{
  return BaseAlg::sysExecute (ctx);
}

sysInitialize()

StatusCode AthCommonAlgorithm< Gaudi::Algorithm >::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< Gaudi::Algorithm > >.

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

Definition at line 60 of file AthCommonAlgorithm.cxx.

                                                      {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<BaseAlg>>::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< Gaudi::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< Gaudi::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_barrelRadius

double ParticleDecayer::m_barrelRadius

private

Definition at line 74 of file ParticleDecayer.h.

m_boostLV

CLHEP::HepLorentzVector ParticleDecayer::m_boostLV

private

Definition at line 93 of file ParticleDecayer.h.

m_BRElectron

double ParticleDecayer::m_BRElectron {}

private

Definition at line 61 of file ParticleDecayer.h.

{};

m_BRMuon

double ParticleDecayer::m_BRMuon {}

private

Definition at line 63 of file ParticleDecayer.h.

{};

m_BRPion

double ParticleDecayer::m_BRPion {}

private

Definition at line 65 of file ParticleDecayer.h.

{};

m_decayOnlyStable

bool ParticleDecayer::m_decayOnlyStable {}

private

Definition at line 72 of file ParticleDecayer.h.

{};

m_detStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_detStore

privateinherited

Pointer to StoreGate (detector store by default).

Definition at line 393 of file AthCommonDataStore.h.

m_doExponentialDecay

bool ParticleDecayer::m_doExponentialDecay {}

private

Definition at line 68 of file ParticleDecayer.h.

{};

m_doUniformDecay

bool ParticleDecayer::m_doUniformDecay {}

private

Definition at line 67 of file ParticleDecayer.h.

{};

m_endCapDistance

double ParticleDecayer::m_endCapDistance

private

Definition at line 75 of file ParticleDecayer.h.

m_eventCounter

int ParticleDecayer::m_eventCounter {}

private

Definition at line 101 of file ParticleDecayer.h.

{};  

m_evtStore

StoreGateSvc_t AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_evtStore

privateinherited

Pointer to StoreGate (event store by default).

Definition at line 390 of file AthCommonDataStore.h.

m_expDecayDoTruncateLongDecays

bool ParticleDecayer::m_expDecayDoTruncateLongDecays {}

private

Definition at line 71 of file ParticleDecayer.h.

{};

m_expDecayDoVariableLifetime

bool ParticleDecayer::m_expDecayDoVariableLifetime {}

private

Definition at line 69 of file ParticleDecayer.h.

{};

m_expDecayFractionToKeep

double ParticleDecayer::m_expDecayFractionToKeep {}

private

Definition at line 70 of file ParticleDecayer.h.

{};

m_extendedExtraObjects

DataObjIDColl AthCommonAlgorithm< Gaudi::Algorithm >::m_extendedExtraObjects

privateinherited

Extra output dependency collection, extended by AthAlgorithmDHUpdate to add symlinks.

Empty if no symlinks were found.

Definition at line 108 of file AthCommonAlgorithm.h.

m_incidentSvc

ServiceHandle<IIncidentSvc> GenModule::m_incidentSvc {this, "IncidentSvc", "IncidentSvc"}

privateinherited

Handle on the incident service.

Definition at line 99 of file GenModule.h.

{this, "IncidentSvc", "IncidentSvc"};

m_isAfterburner

BooleanProperty GenModule::m_isAfterburner {this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"}

protectedinherited

Flag for normal vs. afterburner generators.

Definition at line 87 of file GenModule.h.

{this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"};

m_LJType

int ParticleDecayer::m_LJType {}

private

Definition at line 42 of file ParticleDecayer.h.

{};

m_mcEventKey

std::string GenBase::m_mcEventKey {}

protectedinherited

StoreGate key for the MC event collection (defaults to GEN_EVENT).

Definition at line 134 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 145 of file GenBase.h.

{ this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" };

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 136 of file GenBase.h.

{this, "MakeMcEvent", false, "Create a new MC event collection if it doesn't exist"};

m_oppositePolarization

bool ParticleDecayer::m_oppositePolarization {}

private

Definition at line 58 of file ParticleDecayer.h.

{};

m_particleID

int ParticleDecayer::m_particleID {}

private

Definition at line 50 of file ParticleDecayer.h.

{};

m_particleLifeTime

double ParticleDecayer::m_particleLifeTime {}

private

Definition at line 52 of file ParticleDecayer.h.

{}; 

m_particleMass

double ParticleDecayer::m_particleMass {}

private

Definition at line 48 of file ParticleDecayer.h.

{};

m_particlePDGID

int ParticleDecayer::m_particlePDGID {}

private

Definition at line 54 of file ParticleDecayer.h.

{};

m_particlePolarization

int ParticleDecayer::m_particlePolarization {}

private

Definition at line 56 of file ParticleDecayer.h.

{}; 

m_particleTable

HepPDT::ParticleDataTable* ParticleDecayer::m_particleTable {}

private

Definition at line 78 of file ParticleDecayer.h.

{};

m_posLV

CLHEP::HepLorentzVector ParticleDecayer::m_posLV

private

Definition at line 95 of file ParticleDecayer.h.

m_posLV1

CLHEP::HepLorentzVector ParticleDecayer::m_posLV1

private

Definition at line 97 of file ParticleDecayer.h.

m_posLV2

CLHEP::HepLorentzVector ParticleDecayer::m_posLV2

private

Definition at line 99 of file ParticleDecayer.h.

m_ppSvc

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

privateinherited

Handle on the particle property service.

Definition at line 142 of file GenBase.h.

{this, "PartPropSvc", "PartPropSvc"};

m_randomSeed

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

protectedinherited

Seed for random number engine.

Definition at line 84 of file GenModule.h.

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

m_rndmSvc

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

privateinherited

Data members.

Definition at line 97 of file GenModule.h.

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

m_runinfo

std::shared_ptr<HepMC3::GenRunInfo> GenModule::m_runinfo {}

protectedinherited

The run info for HepMC3.

Definition at line 90 of file GenModule.h.

{};

m_scalarMass

double ParticleDecayer::m_scalarMass {}

private

Definition at line 46 of file ParticleDecayer.h.

{};

m_scalarPDGID

int ParticleDecayer::m_scalarPDGID {}

private

Definition at line 44 of file ParticleDecayer.h.

{};

m_thetaEndCapBarrel

double ParticleDecayer::m_thetaEndCapBarrel

private

Definition at line 76 of file ParticleDecayer.h.

m_truthParticleContainerName

std::string ParticleDecayer::m_truthParticleContainerName

private

Definition at line 40 of file ParticleDecayer.h.

m_varHandleArraysDeclared

bool AthCommonDataStore< AthCommonMsg< Gaudi::Algorithm > >::m_varHandleArraysDeclared

privateinherited

Definition at line 399 of file AthCommonDataStore.h.

m_vhka

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

privateinherited

Definition at line 398 of file AthCommonDataStore.h.

---

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

• ParticleDecayer.h
• ParticleDecayer.cxx