BeamHaloGeneratorAlg Class Reference

A GenModule algorithm to produce beam halo HepMC records from input ASCII files produced with MARS or FLUKA beam background simulations. More...

#include <BeamHaloGeneratorAlg.h>

Inheritance diagram for BeamHaloGeneratorAlg:

Collaboration diagram for BeamHaloGeneratorAlg:

Public Member Functions
	BeamHaloGeneratorAlg (const std::string &name, ISvcLocator *svcLocator)
virtual	~BeamHaloGeneratorAlg ()=default
virtual StatusCode	genInitialize ()
	For initializing the generator, if required. More...
virtual StatusCode	genFinalize ()
	For finalising the generator, if required. More...
virtual StatusCode	callGenerator ()
	Read one event from the selected input and convert it into GenEvent format. More...
virtual StatusCode	fillEvt (HepMC::GenEvent *evt)
	Fill the GenEvent pointer with the contents of the GenEvent cache. More...
virtual StatusCode	sysInitialize () override
	Override sysInitialize. More...
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies. More...
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	evtStore () const
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc. More...
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc. More...
virtual StatusCode	sysStart () override
	Handle START transition. More...
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles. More...
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles. More...
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T > &t)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKey &hndl, const std::string &doc, const SG::VarHandleKeyType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleBase &hndl, const std::string &doc, const SG::VarHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, SG::VarHandleKeyArray &hndArr, const std::string &doc, const SG::VarHandleKeyArrayType &)
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc, const SG::NotHandleType &)
	Declare a new Gaudi property. More...
Gaudi::Details::PropertyBase *	declareProperty (const std::string &name, T &property, const std::string &doc="none")
	Declare a new Gaudi property. More...
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
MsgStream &	msg (const MSG::Level lvl) const
bool	msgLvl (const MSG::Level lvl) const

Protected Member Functions
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution More...
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. More...

Private Types
enum	validationPlotsEnum {   PRI_R, PRI_Z, PRI_Z_TCT, SP_R_ALL,   SP_E_ALL, SP_PZ_ALL, SP_PT_ALL, SP_R_PROTONS,   SP_E_PROTONS, SP_PZ_PROTONS, SP_PT_PROTONS, SP_R_MUONS,   SP_E_MUONS, SP_PZ_MUONS, SP_PT_MUONS, NPLOTS }
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

Private Member Functions
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyType &)
	specialization for handling Gaudi::Property<SG::VarHandleKey> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleKeyArrayType &)
	specialization for handling Gaudi::Property<SG::VarHandleKeyArray> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &hndl, const SG::VarHandleType &)
	specialization for handling Gaudi::Property<SG::VarHandleBase> More...
Gaudi::Details::PropertyBase &	declareGaudiProperty (Gaudi::Property< T > &t, const SG::NotHandleType &)
	specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray> More...

Private Attributes
StringProperty	m_inputTypeStr {this, "inputType", "MARS-NM"}
	Input file type and therefore associated beam halo generator that should be used. More...
StringProperty	m_inputFile {this, "inputFile", "bgi-b2l1.1"}
	Input file name. More...
DoubleProperty	m_interfacePlane {this, "interfacePlane", 20850.0}
	The position of the interface plane in mm. More...
BooleanProperty	m_enableFlip {this, "enableFlip", false}
	Flag for flipping event. More...
FloatProperty	m_flipProbability {this, "flipProbability", 0.0}
	Flip probability. More...
BooleanProperty	m_enableSampling {this, "enableSampling", false}
	Flag to enable or disable sampling. More...
StringProperty	m_bufferFileName {this, "bufferFileName", "BinaryBuffer.bin"}
	The name of the binary buffer file, needed for sampling from a converted file. More...
StringArrayProperty	m_generatorSettings {this, "generatorSettings", {}, "A set of cuts to be applied to generated particles."}
	A vector of strings defining generator settings. More...
BooleanProperty	m_doMonitoringPlots {this, "doMonitoringPlots", false}
	A flag to allow monitoring plots to be turned on or off. More...
ServiceHandle< ITHistSvc >	m_tHistSvc {this, "THistSvc", "THistSvc"}
	A pointer to the THist service for validation plots. More...
StringProperty	m_randomStream {this, "randomStream", "BeamHalo"}
	Name of the random number stream. More...
BeamHaloGenerator *	m_beamHaloGenerator {}
	A pointer to the beam halo generator. More...
HepMC::GenEvent	m_evt {}
	An empty GenEvent to cache the generate output between callGenerator and fillEvt. More...
TH1F *	m_validationPlots [NPLOTS]
	An array of TH1F pointers for validation plots. More...
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default) More...
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default) More...
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

Utility event-mangling functions
Todo: Replace with HepMC units when available
ServiceHandle< IPartPropSvc >	m_ppSvc {this, "PartPropSvc", "PartPropSvc"}
	Handle on the particle property service. More...
SG::ReadHandleKey< McEventCollection >	m_mcevents_const { this, "McEventKey", "GEN_EVENT", "StoreGate key of the MC event collection" }
	Const handle to the MC event collection. More...
void	GeVToMeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1000. More...
void	MeVToGeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1/1000. More...
void	cmTomm (HepMC::GenEvent *evt)
	Scale event lengths by x 10. More...
void	mmTocm (HepMC::GenEvent *evt)
	Scale event lengths by x 1/10. More...

Features for derived classes to use internally
ServiceHandle< IAthRNGSvc >	m_rndmSvc {this, "RndmSvc", "AthRNGSvc"}
	Data members. More...
ServiceHandle< IIncidentSvc >	m_incidentSvc {this, "IncidentSvc", "IncidentSvc"}
	Handle on the incident service. More...
IntegerProperty	m_randomSeed {this, "RandomSeed", 1234567, "Random seed for the built-in random engine"}
	Seed for random number engine. More...
BooleanProperty	m_isAfterburner {this, "IsAfterburner", false, "Set true if generator modifies existing events rather than creating new ones"}
	Flag for normal vs. afterburner generators. More...
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

Detailed Description

A GenModule algorithm to produce beam halo HepMC records from input ASCII files produced with MARS or FLUKA beam background simulations.

Author

W. H. Bell W.Bel.nosp@m.l@ce.nosp@m.rn.ch

Definition at line 26 of file BeamHaloGeneratorAlg.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Member Enumeration Documentation

validationPlotsEnum

enum BeamHaloGeneratorAlg::validationPlotsEnum

private

Enumerator
PRI_R
PRI_Z
PRI_Z_TCT
SP_R_ALL
SP_E_ALL
SP_PZ_ALL
SP_PT_ALL
SP_R_PROTONS
SP_E_PROTONS
SP_PZ_PROTONS
SP_PT_PROTONS
SP_R_MUONS
SP_E_MUONS
SP_PZ_MUONS
SP_PT_MUONS
NPLOTS

Definition at line 87 of file BeamHaloGeneratorAlg.h.

                           {
    PRI_R,
    PRI_Z,
    PRI_Z_TCT, 
    SP_R_ALL,
    SP_E_ALL,
    SP_PZ_ALL,
    SP_PT_ALL,
    SP_R_PROTONS,
    SP_E_PROTONS,
    SP_PZ_PROTONS,
    SP_PT_PROTONS,
    SP_R_MUONS,
    SP_E_MUONS,
    SP_PZ_MUONS,
    SP_PT_MUONS,
    NPLOTS};

Constructor & Destructor Documentation

BeamHaloGeneratorAlg()

BeamHaloGeneratorAlg::BeamHaloGeneratorAlg	(	const std::string &	name,
		ISvcLocator *	svcLocator
	)

Definition at line 17 of file BeamHaloGeneratorAlg.cxx.

  : GenModule(name,svcLocator)
{
  for (int i=0;i<NPLOTS;i++) {
    m_validationPlots[i] = nullptr;
  }
}

~BeamHaloGeneratorAlg()

virtual BeamHaloGeneratorAlg::~BeamHaloGeneratorAlg ( )

virtualdefault

Member Function Documentation

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

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

callGenerator()

StatusCode BeamHaloGeneratorAlg::callGenerator ( )

virtual

Read one event from the selected input and convert it into GenEvent format.

If the end of file is reached the status code returned will not be success.

Reimplemented from GenModule.

Definition at line 148 of file BeamHaloGeneratorAlg.cxx.

                                               {
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
  CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine(m_randomStream, ctx);
 
 
  // Clear the event ready for it to be filled with the next beam halo event.
  m_evt.clear();
 
  // Fill an event with particles from the converted ASCII input file.
  // (If the end of file has already been reached this will return a
  // non-zero value.)
  if(m_beamHaloGenerator->fillEvt(&m_evt, rndmEngine) != 0) return StatusCode::FAILURE;
 
  // Fill monitoring plots if requested
  if(m_doMonitoringPlots) {
    auto weightContainer = m_evt.weights();
    if(weightContainer.size() != 5) {
      ATH_MSG_WARNING("The number of weights for this event is not equal to 5.");
      return StatusCode::SUCCESS;
    }
    double weight = weightContainer[0];
    HepMC::FourVector primaryPosition(weightContainer[1],weightContainer[2],weightContainer[3],weightContainer[4]);
    m_validationPlots[PRI_R]->Fill(primaryPosition.perp()/1000.0,weight);
    m_validationPlots[PRI_Z]->Fill(weightContainer[3]/1000.0,weight);
    m_validationPlots[PRI_Z_TCT]->Fill(std::fabs(weightContainer[3]/1000.0),weight);
 
    double values[4];
    int pdgId;
    for (auto hepmc_part: m_evt) {
      auto prodVertex = hepmc_part->production_vertex();
      if(!prodVertex) continue;
      
      // Store the values for use in the if conditions that follow
      values[0] = prodVertex->position().perp()/1000.; 
      values[1] = hepmc_part->momentum().e()/1000.;
      values[2] = hepmc_part->momentum().pz()/1000.;
      values[3] = hepmc_part->momentum().perp()/1000.;
 
      pdgId = hepmc_part->pdg_id(); if(pdgId<0) pdgId = -pdgId; 
      m_validationPlots[SP_R_ALL]->Fill(values[0],weight);
      m_validationPlots[SP_E_ALL]->Fill(values[1],weight);
      m_validationPlots[SP_PZ_ALL]->Fill(values[2],weight);
      m_validationPlots[SP_PT_ALL]->Fill(values[3],weight); 
      if(pdgId == 2212) {
        m_validationPlots[SP_R_PROTONS]->Fill(values[0],weight);
        m_validationPlots[SP_E_PROTONS]->Fill(values[1],weight);
        m_validationPlots[SP_PZ_PROTONS]->Fill(values[2],weight);
        m_validationPlots[SP_PT_PROTONS]->Fill(values[3],weight);
      }
      else if(pdgId == 13) {
        m_validationPlots[SP_R_MUONS]->Fill(values[0],weight);
        m_validationPlots[SP_E_MUONS]->Fill(values[1],weight);
        m_validationPlots[SP_PZ_MUONS]->Fill(values[2],weight);
        m_validationPlots[SP_PT_MUONS]->Fill(values[3],weight); 
      } 
    }
  } 
 
  return StatusCode::SUCCESS;
}

cmTomm()

void GenBase::cmTomm ( HepMC::GenEvent *  evt )

protectedinherited

Scale event lengths by x 10.

Definition at line 78 of file GenBase.cxx.

                                       {
  for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
    const HepMC::FourVector fv((*vtx)->position().x() * 10,
                               (*vtx)->position().y() * 10,
                               (*vtx)->position().z() * 10,
                               (*vtx)->position().t() * 10);
    (*vtx)->set_position(fv);
  }
}

declareGaudiProperty() [1/4]

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

inlineprivateinherited

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

Definition at line 170 of file AthCommonDataStore.h.

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

declareGaudiProperty() [2/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  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());
 
  }

declareGaudiProperty() [3/4]

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

inlineprivateinherited

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

Definition at line 184 of file AthCommonDataStore.h.

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

declareGaudiProperty() [4/4]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareGaudiProperty ( Gaudi::Property< T > &  t, const SG::NotHandleType &    )

inlineprivateinherited

specialization for handling everything that's not a Gaudi::Property<SG::VarHandleKey> or a <SG::VarHandleKeyArray>

Definition at line 199 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(t);
  }

declareProperty() [1/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleBase &  hndl, const std::string &  doc, const SG::VarHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleBase. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 245 of file AthCommonDataStore.h.

  {
    this->declare(hndl.vhKey());
    hndl.vhKey().setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [2/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleKey &  hndl, const std::string &  doc, const SG::VarHandleKeyType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
hndl	Object holding the property value.
doc	Documentation string for the property.

This is the version for types that derive from SG::VarHandleKey. The property value object is put on the input and output lists as appropriate; then we forward to the base class.

Definition at line 221 of file AthCommonDataStore.h.

  {
    this->declare(hndl);
    hndl.setOwner(this);
 
    return PBASE::declareProperty(name,hndl,doc);
  }

declareProperty() [3/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, SG::VarHandleKeyArray &  hndArr, const std::string &  doc, const SG::VarHandleKeyArrayType &    )

inlineinherited

Definition at line 259 of file AthCommonDataStore.h.

  {
 
    // std::ostringstream ost;
    // ost << Algorithm::name() << " VHKA declareProp: " << name 
    //     << " size: " << hndArr.keys().size() 
    //     << " mode: " << hndArr.mode() 
    //     << "  vhka size: " << m_vhka.size()
    //     << "\n";
    // debug() << ost.str() << endmsg;
 
    hndArr.setOwner(this);
    m_vhka.push_back(&hndArr);
 
    Gaudi::Details::PropertyBase* p =  PBASE::declareProperty(name, hndArr, doc);
    if (p != 0) {
      p->declareUpdateHandler(&AthCommonDataStore<PBASE>::updateVHKA, this);
    } else {
      ATH_MSG_ERROR("unable to call declareProperty on VarHandleKeyArray " 
                    << name);
    }
 
    return p;
 
  }

declareProperty() [4/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc, const SG::NotHandleType &    )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This is the generic version, for types that do not derive from SG::VarHandleKey. It just forwards to the base class version of declareProperty.

Definition at line 333 of file AthCommonDataStore.h.

  {
    return PBASE::declareProperty(name, property, doc);
  }

declareProperty() [5/6]

Gaudi::Details::PropertyBase* AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( const std::string &  name, T &  property, const std::string &  doc = "none"  )

inlineinherited

Declare a new Gaudi property.

Parameters

name	Name of the property.
property	Object holding the property value.
doc	Documentation string for the property.

This dispatches to either the generic declareProperty or the one for VarHandle/Key/KeyArray.

Definition at line 352 of file AthCommonDataStore.h.

  {
    typedef typename SG::HandleClassifier<T>::type htype;
    return declareProperty (name, property, doc, htype());
  }

declareProperty() [6/6]

Gaudi::Details::PropertyBase& AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T > &  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; }

event_const()

const HepMC::GenEvent* GenBase::event_const ( ) const

inlineinherited

Access the current signal event (const)

Definition at line 83 of file GenBase.h.

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

events_const() [1/2]

const McEventCollection* GenBase::events_const ( ) const

inlineinherited

Access the current event's McEventCollection (const)

Definition at line 96 of file GenBase.h.

                                                {
    return events_const( getContext() );
  }

events_const() [2/2]

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

inlineinherited

Definition at line 99 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() [1/2]

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; }

evtStore() [2/2]

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

inlineinherited

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

Definition at line 90 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode GenModule::execute ( )

virtualinherited

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)
  //const EventContext& ctx = Gaudi::Hive::currentContext();
  //CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine("MyStream", ctx);
 
  // Example 2 - seeded based on the m_randomSeed property (+ slot, run, streamName)
  //const EventContext& ctx = Gaudi::Hive::currentContext();
  //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< 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();
}

fillEvt()

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

virtual

Fill the GenEvent pointer with the contents of the GenEvent cache.

The GenEvent cache is filled by calling callGenerator()

Implements GenModule.

Definition at line 212 of file BeamHaloGeneratorAlg.cxx.

                                                             {
  *event = m_evt;
  return StatusCode::SUCCESS;
}

finalize()

StatusCode GenModule::finalize ( )

inlineinherited

Definition at line 55 of file GenModule.h.

{ return genFinalize(); }

genFinalize()

StatusCode BeamHaloGeneratorAlg::genFinalize ( )

virtual

For finalising the generator, if required.

Reimplemented from GenModule.

Definition at line 219 of file BeamHaloGeneratorAlg.cxx.

                                             {
  if(m_beamHaloGenerator->genFinalize() != 0) return StatusCode::FAILURE;
  return StatusCode::SUCCESS;
}

genInitialize()

StatusCode BeamHaloGeneratorAlg::genInitialize ( )

virtual

For initializing the generator, if required.

Todo:

Use ServiceHandle system instead

Reimplemented from GenModule.

Definition at line 27 of file BeamHaloGeneratorAlg.cxx.

                                               {
  ATH_MSG_INFO("Initialising this BeamHaloGeneratorAlg: " << name());
 
  ATH_MSG_INFO("================ Generator Settings =================");
  ATH_MSG_INFO(" input type ------------------  " << m_inputTypeStr);
  ATH_MSG_INFO(" input file ------------------  " << m_inputFile);
  ATH_MSG_INFO(" interface plane -------------  " << m_interfacePlane << " (mm)");
  ATH_MSG_INFO(" enable flip about z=0 -------  " << (m_enableFlip ? "True" : "False"));
  ATH_MSG_INFO(" flip probability  -----------  " << m_flipProbability);
  ATH_MSG_INFO(" enable sampling -------------  " << (m_enableSampling ? "True" : "False"));
  ATH_MSG_INFO(" binary buffer file ----------  " << m_bufferFileName);
  std::vector<std::string>::iterator itr = m_generatorSettings.begin();
  std::vector<std::string>::iterator itr_end = m_generatorSettings.end();
  for(;itr!=itr_end;++itr) ATH_MSG_INFO((*itr));
  ATH_MSG_INFO(" Produce monitoring plots ----  " << (m_doMonitoringPlots ? "True" : "False"));
  ATH_MSG_INFO(" Random stream name ----------  " << m_randomStream);
  ATH_MSG_INFO("=====================================================");
 
  // Check the flip probability
  if(m_flipProbability <= 0) {
    ATH_MSG_INFO("Event flipping will be disabled.");
    m_enableFlip = false;
  }
  else if(m_flipProbability > 1) {
    ATH_MSG_WARNING("Flip probability " << m_flipProbability << " is out of range.  Event flipping will be disabled.");
    m_enableFlip = false;
  }
  else {
    m_enableFlip = true;
  }
 
  // Retrieve pointer to THistSvc if monitoring plots are requested
  if(m_doMonitoringPlots) {
    ATH_CHECK(m_tHistSvc.retrieve());
 
    // Create log10 bins for x-axis of E plots.
    const Int_t nbins_E = 60;
    double xmin = 1e-2;
    double xmax = 3.5e3;
    double logxmin = std::log10(xmin);
    double logxmax = std::log10(xmax);
    double binwidth = (logxmax-logxmin)/nbins_E;
    Double_t xbins[nbins_E+1];
    xbins[0] = xmin;
    for (Int_t i=1;i<=nbins_E;i++) {
      xbins[i] = xmin + std::pow(10,logxmin+i*binwidth);
    }
 
    // Create the monitoring plots
    m_validationPlots[PRI_R] = new TH1F("primaryR",";Radius   [m];Events/[m]",100,0., 0.2);
    m_validationPlots[PRI_Z] = new TH1F("primaryZ",";z   [m];Events/[m]",1100,0., 550.); // Beam gas and TCT
    m_validationPlots[PRI_Z_TCT] = new TH1F("primaryZ_TCT",";z   [m];Events/[m]",100,144., 149.); // TCT region
    m_validationPlots[SP_R_ALL] = new TH1F("scoringPlaneR_all",";Radius   [m];Particles/[m]",240,0., 24.);
    m_validationPlots[SP_E_ALL] = new TH1F("scoringPlaneE_all",";Energy   [GeV];Particles/[GeV]",nbins_E,xbins);
    m_validationPlots[SP_PZ_ALL] = new TH1F("scoringPlanePz_all",";p_{z}   [GeV];Particles/[GeV]",350,0., 3500.);
    m_validationPlots[SP_PT_ALL] = new TH1F("scoringPlanePt_all",";p_{T}   [GeV];Particles/[GeV]",500,0., 50.);
    m_validationPlots[SP_R_PROTONS] = new TH1F("scoringPlaneR_protons",";Radius   [m];Particles/[m]",240,0., 24.);
    m_validationPlots[SP_E_PROTONS] = new TH1F("scoringPlaneE_protons",";Energy   [GeV];Particles/[GeV]",nbins_E,xbins);
    m_validationPlots[SP_PZ_PROTONS] = new TH1F("scoringPlanePz_protons",";p_{z}   [GeV];Particles/[GeV]",350,0., 3500.);
    m_validationPlots[SP_PT_PROTONS] = new TH1F("scoringPlanePt_protons",";p_{T}   [GeV];Particles/[GeV]",500,0., 50.);
    m_validationPlots[SP_R_MUONS] = new TH1F("scoringPlaneR_muons",";Radius   [m];Particles/[m]",240,0., 24.);
    m_validationPlots[SP_E_MUONS] = new TH1F("scoringPlaneE_muons",";Energy   [GeV];Particles/[GeV]",nbins_E,xbins);
    m_validationPlots[SP_PZ_MUONS] = new TH1F("scoringPlanePz_muons",";p_{z}   [GeV];Particles/[GeV]",350,0., 3500.);
    m_validationPlots[SP_PT_MUONS] = new TH1F("scoringPlanePt_muons",";p_{T}   [GeV];Particles/[GeV]",500,0., 50.);  
 
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/primaryR", m_validationPlots[PRI_R]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/primaryZ", m_validationPlots[PRI_Z]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/primaryZ_TCT", m_validationPlots[PRI_Z_TCT]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlaneR_all", m_validationPlots[SP_R_ALL]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlaneE_all", m_validationPlots[SP_E_ALL]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlanePz_all", m_validationPlots[SP_PZ_ALL]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlanePt_all", m_validationPlots[SP_PT_ALL]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlaneR_protons", m_validationPlots[SP_R_PROTONS]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlaneE_protons", m_validationPlots[SP_E_PROTONS]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlanePz_protons", m_validationPlots[SP_PZ_PROTONS]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlanePt_protons", m_validationPlots[SP_PT_PROTONS]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlaneR_muons", m_validationPlots[SP_R_MUONS]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlaneE_muons", m_validationPlots[SP_E_MUONS]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlanePz_muons", m_validationPlots[SP_PZ_MUONS]));
    ATH_CHECK(m_tHistSvc->regHist("/BeamHalo/scoringPlanePt_muons", m_validationPlots[SP_PT_MUONS]));
  }
 
  // Check the input type string
  if (m_inputTypeStr == "MARS-NM") {
    m_beamHaloGenerator = new MarsHaloGenerator(&particleTable(),
                                                m_inputFile,
                                                m_generatorSettings);
  }
  else if (m_inputTypeStr == "FLUKA-VT") {
    m_beamHaloGenerator = new FlukaHaloGenerator(1, &particleTable(),
                                                 m_inputFile,
                                                 m_generatorSettings);
  }
  else if (m_inputTypeStr == "FLUKA-RB") {
    m_beamHaloGenerator = new FlukaHaloGenerator(0, &particleTable(),
                                                 m_inputFile,
                                                 m_generatorSettings);
  }
  else {
    m_beamHaloGenerator = 0;
    ATH_MSG_FATAL("Input type " << m_inputTypeStr << " is not known.  Available types are: MARS-NM or FLUKA-VT");
    return StatusCode::FAILURE;
  }
  
  // Set the options using those specified to this algorithm
  m_beamHaloGenerator->setInterfacePlane(m_interfacePlane);
  m_beamHaloGenerator->setEnableFlip(m_enableFlip);
  m_beamHaloGenerator->setFlipProbability(m_flipProbability);
  m_beamHaloGenerator->setEnableSampling(m_enableSampling);
  m_beamHaloGenerator->setBufferFileName(m_bufferFileName);
  m_beamHaloGenerator->setDebugEnable(msgLvl(MSG::DEBUG));
 
  // Initialise the generator.
  if(m_beamHaloGenerator->genInitialize() != 0) 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; }

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);
}

GeVToMeV()

void GenBase::GeVToMeV ( HepMC::GenEvent *  evt )

protectedinherited

Scale event energies/momenta by x 1000.

Todo:

Add HepMC units awareness and do it differently when HepMC provides this functionality directly (and reference-based FourVector accessors)

Definition at line 58 of file GenBase.cxx.

                                         {
  for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
    const HepMC::FourVector fv((*p)->momentum().px() * 1000,
                               (*p)->momentum().py() * 1000,
                               (*p)->momentum().pz() * 1000,
                               (*p)->momentum().e()  * 1000);
    (*p)->set_momentum(fv);
    (*p)->set_generated_mass(1000 * (*p)->generated_mass());
  }
}

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

MeVToGeV()

void GenBase::MeVToGeV ( HepMC::GenEvent *  evt )

protectedinherited

Scale event energies/momenta by x 1/1000.

Definition at line 68 of file GenBase.cxx.

                                         {
  for (HepMC::GenEvent::particle_iterator p = evt->particles_begin(); p != evt->particles_end(); ++p) {
    const HepMC::FourVector fv((*p)->momentum().px() / 1000,
                               (*p)->momentum().py() / 1000,
                               (*p)->momentum().pz() / 1000,
                               (*p)->momentum().e()  / 1000);
    (*p)->set_momentum(fv);
    (*p)->set_generated_mass((*p)->generated_mass() / 1000);
  }
}

mmTocm()

void GenBase::mmTocm ( HepMC::GenEvent *  evt )

protectedinherited

Scale event lengths by x 1/10.

Definition at line 87 of file GenBase.cxx.

                                       {
  for (HepMC::GenEvent::vertex_iterator vtx = evt->vertices_begin(); vtx != evt->vertices_end(); ++vtx) {
    const HepMC::FourVector fv((*vtx)->position().x() / 10,
                               (*vtx)->position().y() / 10,
                               (*vtx)->position().z() / 10,
                               (*vtx)->position().t() / 10);
    (*vtx)->set_position(fv);
  }
}

msg() [1/2]

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msg() [2/2]

MsgStream& AthCommonMsg< Algorithm >::msg ( const MSG::Level  lvl ) const

inlineinherited

Definition at line 27 of file AthCommonMsg.h.

                                                  {
    return this->msgStream(lvl);
  }

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.

particleData()

const HepPDT::ParticleData* GenBase::particleData ( int  pid ) const

inlineinherited

Access an element in the particle data table.

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

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

partPropSvc()

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

inlineinherited

Access the particle property service.

Definition at line 113 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 123 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< 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, PyAthena::Alg, and AthHistogramAlgorithm.

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_beamHaloGenerator

BeamHaloGenerator* BeamHaloGeneratorAlg::m_beamHaloGenerator {}

private

A pointer to the beam halo generator.

Definition at line 81 of file BeamHaloGeneratorAlg.h.

m_bufferFileName

StringProperty BeamHaloGeneratorAlg::m_bufferFileName {this, "bufferFileName", "BinaryBuffer.bin"}

private

The name of the binary buffer file, needed for sampling from a converted file.

Definition at line 66 of file BeamHaloGeneratorAlg.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_doMonitoringPlots

BooleanProperty BeamHaloGeneratorAlg::m_doMonitoringPlots {this, "doMonitoringPlots", false}

private

A flag to allow monitoring plots to be turned on or off.

Definition at line 72 of file BeamHaloGeneratorAlg.h.

m_enableFlip

BooleanProperty BeamHaloGeneratorAlg::m_enableFlip {this, "enableFlip", false}

private

Flag for flipping event.

Definition at line 56 of file BeamHaloGeneratorAlg.h.

m_enableSampling

BooleanProperty BeamHaloGeneratorAlg::m_enableSampling {this, "enableSampling", false}

private

Flag to enable or disable sampling.

Definition at line 62 of file BeamHaloGeneratorAlg.h.

m_evt

HepMC::GenEvent BeamHaloGeneratorAlg::m_evt {}

private

An empty GenEvent to cache the generate output between callGenerator and fillEvt.

Definition at line 85 of file BeamHaloGeneratorAlg.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_flipProbability

FloatProperty BeamHaloGeneratorAlg::m_flipProbability {this, "flipProbability", 0.0}

private

Flip probability.

Definition at line 59 of file BeamHaloGeneratorAlg.h.

m_generatorSettings

StringArrayProperty BeamHaloGeneratorAlg::m_generatorSettings {this, "generatorSettings", {}, "A set of cuts to be applied to generated particles."}

private

A vector of strings defining generator settings.

Definition at line 69 of file BeamHaloGeneratorAlg.h.

m_incidentSvc

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

privateinherited

Handle on the incident service.

Definition at line 101 of file GenModule.h.

m_inputFile

StringProperty BeamHaloGeneratorAlg::m_inputFile {this, "inputFile", "bgi-b2l1.1"}

private

Input file name.

Definition at line 50 of file BeamHaloGeneratorAlg.h.

m_inputTypeStr

StringProperty BeamHaloGeneratorAlg::m_inputTypeStr {this, "inputType", "MARS-NM"}

private

Input file type and therefore associated beam halo generator that should be used.

Definition at line 47 of file BeamHaloGeneratorAlg.h.

m_interfacePlane

DoubleProperty BeamHaloGeneratorAlg::m_interfacePlane {this, "interfacePlane", 20850.0}

private

The position of the interface plane in mm.

Definition at line 53 of file BeamHaloGeneratorAlg.h.

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.

m_mcEventKey

std::string GenBase::m_mcEventKey {}

protectedinherited

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

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

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

m_ppSvc

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

privateinherited

Handle on the particle property service.

Definition at line 160 of file GenBase.h.

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.

m_randomStream

StringProperty BeamHaloGeneratorAlg::m_randomStream {this, "randomStream", "BeamHalo"}

private

Name of the random number stream.

Definition at line 78 of file BeamHaloGeneratorAlg.h.

m_rndmSvc

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

privateinherited

Data members.

Definition at line 99 of file GenModule.h.

m_tHistSvc

ServiceHandle<ITHistSvc> BeamHaloGeneratorAlg::m_tHistSvc {this, "THistSvc", "THistSvc"}

private

A pointer to the THist service for validation plots.

Definition at line 75 of file BeamHaloGeneratorAlg.h.

m_validationPlots

TH1F* BeamHaloGeneratorAlg::m_validationPlots[NPLOTS]

private

An array of TH1F pointers for validation plots.

Definition at line 106 of file BeamHaloGeneratorAlg.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:

• BeamHaloGeneratorAlg.h
• BeamHaloGeneratorAlg.cxx