TrackRecordGenerator Class Reference

Track Record Generator. More...

#include <TrackRecordGenerator.h>

Inheritance diagram for TrackRecordGenerator:

Collaboration diagram for TrackRecordGenerator:

Public Member Functions
	TrackRecordGenerator (const std::string &name, ISvcLocator *pSvcLocator)
virtual	~TrackRecordGenerator ()
virtual StatusCode	callGenerator ()
	For calling the generator on each iteration of the event loop.
virtual StatusCode	fillEvt (HepMC::GenEvent *evt)
	For filling the HepMC event object.
virtual StatusCode	sysInitialize () override
	Override sysInitialize.
virtual const DataObjIDColl &	extraOutputDeps () const override
	Return the list of extra output dependencies.
ServiceHandle< StoreGateSvc > &	evtStore ()
	The standard StoreGateSvc (event store) Returns (kind of) a pointer to the StoreGateSvc.
const ServiceHandle< StoreGateSvc > &	detStore () const
	The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.
virtual StatusCode	sysStart () override
	Handle START transition.
virtual std::vector< Gaudi::DataHandle * >	inputHandles () const override
	Return this algorithm's input handles.
virtual std::vector< Gaudi::DataHandle * >	outputHandles () const override
	Return this algorithm's output handles.
Gaudi::Details::PropertyBase &	declareProperty (Gaudi::Property< T, V, H > &t)
void	updateVHKA (Gaudi::Details::PropertyBase &)
MsgStream &	msg () const
bool	msgLvl (const MSG::Level lvl) const
Event loop algorithm methods: not to be overloaded
StatusCode	initialize ()
StatusCode	execute ()
StatusCode	finalize ()
Gen-specific event loop methods: to be overloaded
virtual StatusCode	genInitialize ()
	For initializing the generator, if required.
virtual StatusCode	genuserInitialize ()
	For initialization of user code, if required. Called after genInitialize.
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
	Access the current signal event (const)
const McEventCollection *	events_const () const
	Access the current event's McEventCollection (const)
const McEventCollection *	events_const (const EventContext &ctx) 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
void	renounceArray (SG::VarHandleKeyArray &handlesArray)
	remove all handles from I/O resolution
std::enable_if_t< std::is_void_v< std::result_of_t< decltype(&T::renounce)(T)> > &&!std::is_base_of_v< SG::VarHandleKeyArray, T > &&std::is_base_of_v< Gaudi::DataHandle, T >, void >	renounce (T &h)
void	extraDeps_update_handler (Gaudi::Details::PropertyBase &ExtraDeps)
	Add StoreName to extra input/output deps as needed.

Protected Attributes
Properties
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.

Private Types
typedef ServiceHandle< StoreGateSvc >	StoreGateSvc_t

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

Private Attributes
int	m_events
std::vector< int >	m_pdgCode
std::vector< CLHEP::HepLorentzVector >	m_fourPos
std::vector< CLHEP::HepLorentzVector >	m_fourMom
CLHEP::Hep3Vector	m_center
std::vector< HepMC::Polarization >	m_polarization
double	m_smearTR
	Amount by which to smear TR position.
double	m_smearTRp
	Amount by which to smear TR momentum.
std::string	m_recordName
	TrackRecord collection name.
bool	m_stopParticles
	Stop particles before simulation.
float	m_stopped_tminus
float	m_stopped_tplus
	Bounds for random time.
bool	m_add_cL
	For stopped particles, add c*L to the time.
DataObjIDColl	m_extendedExtraObjects
StoreGateSvc_t	m_evtStore
	Pointer to StoreGate (event store by default)
StoreGateSvc_t	m_detStore
	Pointer to StoreGate (detector store by default)
std::vector< SG::VarHandleKeyArray * >	m_vhka
bool	m_varHandleArraysDeclared

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

Utility event-mangling functions
Todo Replace with HepMC units when available
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.
void	GeVToMeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1000.
void	MeVToGeV (HepMC::GenEvent *evt)
	Scale event energies/momenta by x 1/1000.
void	cmTomm (HepMC::GenEvent *evt)
	Scale event lengths by x 10.
void	mmTocm (HepMC::GenEvent *evt)
	Scale event lengths by x 1/10.

Detailed Description

Track Record Generator.

The class takes input simulation track records and uses them as generator records.

Author

Zach Marshall ZLMar.nosp@m.shal.nosp@m.l@lbl.nosp@m..gov

Definition at line 27 of file TrackRecordGenerator.h.

Member Typedef Documentation

StoreGateSvc_t

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

privateinherited

Definition at line 388 of file AthCommonDataStore.h.

Constructor & Destructor Documentation

TrackRecordGenerator()

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

Definition at line 25 of file TrackRecordGenerator.cxx.

   : GenModule(name,pSvcLocator)
   , m_events(0)
{
  // Input collection name
  declareProperty("TRCollection" , m_recordName = "CosmicRecord" );
 
  // Smearing of the initial position for tracks
  declareProperty("TRSmearing", m_smearTR=-1, "Smear the initial position of the track by up to this amount");
  declareProperty("TRPSmearing", m_smearTRp=-1, "Smear the momentum of the track by up to this amount");
  declareProperty("StopParticles", m_stopParticles=false, "Stop the particles and make them decay within 25 ns");
  declareProperty("stopped_tminus", m_stopped_tminus =-25. );
  declareProperty("stopped_tplus", m_stopped_tplus =25. );
  declareProperty("Add_cL", m_add_cL=true, "For stopped particles, shift the time by c times the decay rho");
}

~TrackRecordGenerator()

TrackRecordGenerator::~TrackRecordGenerator ( )

virtual

Definition at line 42 of file TrackRecordGenerator.cxx.

{}

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 TrackRecordGenerator::callGenerator ( )

virtual

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

Reimplemented from GenModule.

Definition at line 46 of file TrackRecordGenerator.cxx.

                                               {
 
  ++m_events;
  ATH_MSG_DEBUG( "Event #" << m_events);
 
  // clear up the vectors
  m_fourPos.clear();
  m_fourMom.clear();
  m_polarization.clear();
  m_pdgCode.clear();
 
  const EventContext& ctx = Gaudi::Hive::currentContext();
  CLHEP::HepRandomEngine* rndmEngine = this->getRandomEngine(name(), ctx);
 
  const TrackRecordCollection* coll = nullptr;
  CHECK( evtStore()->retrieve(coll,m_recordName) );
 
  ATH_MSG_INFO("retrieved "<<coll->size()<<" TTR hits; will smear position by "<< (m_smearTR>0?m_smearTR:0.) <<" mm and momentum by "<< (m_smearTRp>0?m_smearTRp:0.) <<" radians");
 
  for (const auto & iterTTR : *coll) {
 
    const HepPDT::ParticleData* particle = particleData(std::abs(iterTTR.GetPDGCode()));
    double mass = particle->mass().value();
    double en = std::sqrt(mass*mass+iterTTR.GetMomentum().mag2());
 
    ATH_MSG_VERBOSE("Reading back TTR:\n pos is "<<iterTTR.GetPosition()
                  <<"\n mom is "<<iterTTR.GetMomentum()
                  <<"\n pdg is "<<iterTTR.GetPDGCode() );
 
    CLHEP::HepLorentzVector particle4Position( iterTTR.GetPosition(), iterTTR.GetTime());
 
    ATH_MSG_DEBUG( "Smearing position by up to " << m_smearTR << " mm and momentum by up to " << m_smearTRp << " radians" );
    if (m_smearTR>0){
      ATH_MSG_DEBUG( "Track record started at " << particle4Position );
 
      // if Z is maximal, move in X and Y; otherwise move in Z and "phi"
      if ( particle4Position.z() == 22031 || particle4Position.z() == -22031 ){ //FIXME Hardcoded limits!
        particle4Position.setX( particle4Position.x() + CLHEP::RandFlat::shoot(rndmEngine, -m_smearTR, m_smearTR) );
        particle4Position.setY( particle4Position.y() + CLHEP::RandFlat::shoot(rndmEngine, -m_smearTR, m_smearTR) );
      } else {
        particle4Position.setZ( particle4Position.z() + CLHEP::RandFlat::shoot(rndmEngine, -m_smearTR, m_smearTR) );
        double R = std::sqrt( std::pow( particle4Position.x(),2 ) + std::pow(particle4Position.y(),2 ) );
        double dPhi = std::atan2( m_smearTR, R );
        dPhi = CLHEP::RandFlat::shoot( rndmEngine, -dPhi, dPhi );
        double theta = std::atan2( particle4Position.x() , particle4Position.y() );
        particle4Position.setX( R*std::sin( theta + dPhi ) );
        particle4Position.setY( R*std::cos( theta + dPhi ) );
      }
      ATH_MSG_DEBUG( "Shifted track record to " << particle4Position );
    }
    CLHEP::HepLorentzVector particle4Momentum( iterTTR.GetMomentum(), en );
    if (m_smearTRp>0){
      ATH_MSG_DEBUG( "Track record momentum was " << particle4Momentum );
 
      // Keep p - smear an angle, and then randomly spin that change in (0,2PI)
      double dTheta = CLHEP::RandFlat::shoot(rndmEngine, 0, m_smearTRp);
      double dPhi   = CLHEP::RandFlat::shoot(rndmEngine, 0, 2*M_PI);
 
      // Need a perpendicular vector...
      CLHEP::HepLorentzVector perpendicularMomentum( 1 , 0 , 0 , 0);
      if ( particle4Momentum.x() != 0 ){
        if (particle4Momentum.y() == 0){
          perpendicularMomentum.setX( 0 );
          perpendicularMomentum.setY( 1 );
        } else {
          perpendicularMomentum.setX( particle4Momentum.y() );
          perpendicularMomentum.setY( particle4Momentum.x() );
        }
      }
 
      // Now scale it based on dTheta
      double tempP = std::pow(particle4Momentum.x(),2)+std::pow(particle4Momentum.y(),2)+std::pow(particle4Momentum.z(),2);
      if ( tempP==0 ) {
        ATH_MSG_DEBUG("Our initial momentum had zero magnitude!!");
        perpendicularMomentum.setX(0);
        perpendicularMomentum.setY(0);
      } else if ( std::tan(dTheta) == 0 ){
        ATH_MSG_DEBUG("Randomly deciding to keep the vector's direction...");
        perpendicularMomentum.setX(0);
        perpendicularMomentum.setY(0);
      } else {
        double scale = ( tempP ) * std::sin(dTheta) / ( std::pow(perpendicularMomentum.x(),2)+std::pow(perpendicularMomentum.y(),2) );
        perpendicularMomentum.setX( perpendicularMomentum.x() * scale );
        perpendicularMomentum.setY( perpendicularMomentum.y() * scale );
 
        // Rotate perpendicularMomentum by dPhi around particle4Momentum
        perpendicularMomentum.rotate( dPhi , particle4Momentum.vect() );
      }
      particle4Momentum.setX( particle4Momentum.x() + perpendicularMomentum.x() );
      particle4Momentum.setY( particle4Momentum.y() + perpendicularMomentum.y() );
      particle4Momentum.setZ( particle4Momentum.z() + perpendicularMomentum.z() );
 
      // Rescale (very small effect, but want to include it)
      double scale2 = tempP==0? 1 : (pow(particle4Momentum.x(),2)+pow(particle4Momentum.y(),2)+pow(particle4Momentum.z(),2)) / tempP;
      particle4Momentum.setX( particle4Momentum.x() * scale2 );
      particle4Momentum.setY( particle4Momentum.y() * scale2 );
      particle4Momentum.setZ( particle4Momentum.z() * scale2 );
      ATH_MSG_DEBUG( "Rotated the vector by " << perpendicularMomentum );
      ATH_MSG_DEBUG( "And resulting momentum is " << particle4Momentum );
    }
    if (m_stopParticles){
      ATH_MSG_DEBUG( "Will stop the track record where it is and give it mass " << mass );
      particle4Momentum.setX(0);
      particle4Momentum.setY(0);
      particle4Momentum.setZ(0);
      particle4Momentum.setT(mass);
 
      double settime=CLHEP::RandFlat::shoot(rndmEngine,m_stopped_tminus, m_stopped_tplus);
      ATH_MSG_DEBUG( "Setting particle time to something uniform between "<<m_stopped_tminus<<" and "<<m_stopped_tplus<<" ns : " << settime );
      if (m_add_cL){
        settime += particle4Position.rho()/CLHEP::c_light;
      }
      particle4Position.setT(settime*CLHEP::c_light); // ct in mm
    }
 
    m_fourPos.push_back( particle4Position );
    m_fourMom.push_back( particle4Momentum );
 
    m_pdgCode.push_back(iterTTR.GetPDGCode());
    HepMC::Polarization thePolarization(0.0,0.0);
    m_polarization.push_back(thePolarization);
 
    if (m_stopParticles){
      ATH_MSG_DEBUG( "Only one per event!!" );
      break;
    }
  } // Loop through the track record collection
 
  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()

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

inlineprivateinherited

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

Definition at line 156 of file AthCommonDataStore.h.

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

declareProperty()

Gaudi::Details::PropertyBase & AthCommonDataStore< AthCommonMsg< Algorithm > >::declareProperty ( Gaudi::Property< T, V, H > & t )

inlineinherited

Definition at line 145 of file AthCommonDataStore.h.

                                                                     {
    typedef typename SG::HandleClassifier<T>::type htype;
    return AthCommonDataStore<PBASE>::declareGaudiProperty(t, htype());
  }

detStore()

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

inlineinherited

The standard StoreGateSvc/DetectorStore Returns (kind of) a pointer to the StoreGateSvc.

Definition at line 95 of file AthCommonDataStore.h.

{ return m_detStore; }

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

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

inlineinherited

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

Definition at line 85 of file AthCommonDataStore.h.

{ return m_evtStore; }

execute()

StatusCode 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 TrackRecordGenerator::fillEvt ( HepMC::GenEvent * evt )

virtual

For filling the HepMC event object.

Implements GenModule.

Definition at line 178 of file TrackRecordGenerator.cxx.

                                                             {
 
  if ( m_fourMom.size() != m_fourPos.size() || m_fourMom.size() != m_polarization.size()) {
    ATH_MSG_ERROR("Wrong different number of vertexes/momenta/polaritazions!");
    return StatusCode::FAILURE;
  }
  for(std::size_t v = 0; v < m_fourMom.size(); ++v){
    // Note: The vertex and particle are owned by the event, so the
    // event is responsible for those pointers.
 
    // Create the particle, and specify its polarization.
    HepMC::GenParticlePtr particle = HepMC::newGenParticlePtr( HepMC::FourVector(m_fourMom[v].x(),m_fourMom[v].y(),m_fourMom[v].z(),m_fourMom[v].t()),  m_pdgCode[v], 1);
 
    // Create the vertex, and add the particle to the vertex.
    HepMC::GenVertexPtr vertex = HepMC::newGenVertexPtr(HepMC::FourVector(m_fourPos[v].x(),m_fourPos[v].y(),m_fourPos[v].z(),m_fourPos[v].t()));
    vertex->add_particle_out( particle );
 
    // Add the vertex to the event.
    event->add_vertex( std::move(vertex) );
    
    // Add attributes
    HepMC::set_polarization(particle, m_polarization[v]);
  } // Loop over the particles
 
  event->set_event_number(m_events); // Set the event number
  if (event->weights().empty()){
      event->weights().push_back(1.0);
  }
  return StatusCode::SUCCESS;
}

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, Epos, Herwig7, Hijing, Hydjet, MultiParticleGunPileup, MultiPy8Pileup, Pythia8_i, Pythia8B_i, Sherpa_i, and Starlight_i.

Definition at line 70 of file GenModule.h.

{ return StatusCode::SUCCESS; }

genInitialize()

virtual StatusCode GenModule::genInitialize ( )

inlinevirtualinherited

For initializing the generator, if required.

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

Definition at line 62 of file GenModule.h.

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

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

inlineinherited

Definition at line 24 of file AthCommonMsg.h.

                                {
    return this->msgStream();
  }

msgLvl()

bool AthCommonMsg< Algorithm >::msgLvl ( const MSG::Level lvl ) const

inlineinherited

Definition at line 30 of file AthCommonMsg.h.

                                               {
    return this->msgLevel(lvl);
  }

outputHandles()

virtual std::vector< Gaudi::DataHandle * > AthCommonDataStore< AthCommonMsg< Algorithm > >::outputHandles ( ) const

overridevirtualinherited

Return this algorithm's output handles.

We override this to include handle instances from key arrays if they have not yet been declared. See comments on updateVHKA.

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, AthHistogramAlgorithm, and PyAthena::Alg.

Definition at line 66 of file AthAlgorithm.cxx.

                                       {
  StatusCode sc=AthCommonDataStore<AthCommonMsg<Algorithm>>::sysInitialize();
 
  if (sc.isFailure()) {
    return sc;
  }
  ServiceHandle<ICondSvc> cs("CondSvc",name());
  for (auto h : outputHandles()) {
    if (h->isCondition() && h->mode() == Gaudi::DataHandle::Writer) {
      // do this inside the loop so we don't create the CondSvc until needed
      if ( cs.retrieve().isFailure() ) {
        ATH_MSG_WARNING("no CondSvc found: won't autoreg WriteCondHandles");
        return StatusCode::SUCCESS;
      }
      if (cs->regHandle(this,*h).isFailure()) {
        sc = StatusCode::FAILURE;
        ATH_MSG_ERROR("unable to register WriteCondHandle " << h->fullKey()
                      << " with CondSvc");
      }
    }
  }
  return sc;
}

sysStart()

virtual StatusCode AthCommonDataStore< AthCommonMsg< Algorithm > >::sysStart ( )

overridevirtualinherited

Handle START transition.

We override this in order to make sure that conditions handle keys can cache a pointer to the conditions container.

updateVHKA()

void AthCommonDataStore< AthCommonMsg< Algorithm > >::updateVHKA ( Gaudi::Details::PropertyBase & )

inlineinherited

Definition at line 308 of file AthCommonDataStore.h.

                                               {
    // debug() << "updateVHKA for property " << p.name() << " " << p.toString() 
    //         << "  size: " << m_vhka.size() << endmsg;
    for (auto &a : m_vhka) {
      std::vector<SG::VarHandleKey*> keys = a->keys();
      for (auto k : keys) {
        k->setOwner(this);
      }
    }
  }

Member Data Documentation

m_add_cL

bool TrackRecordGenerator::m_add_cL

private

For stopped particles, add c*L to the time.

Definition at line 50 of file TrackRecordGenerator.h.

m_center

CLHEP::Hep3Vector TrackRecordGenerator::m_center

private

Definition at line 41 of file TrackRecordGenerator.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_events

int TrackRecordGenerator::m_events

private

Definition at line 37 of file TrackRecordGenerator.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_fourMom

std::vector<CLHEP::HepLorentzVector> TrackRecordGenerator::m_fourMom

private

Definition at line 40 of file TrackRecordGenerator.h.

m_fourPos

std::vector<CLHEP::HepLorentzVector> TrackRecordGenerator::m_fourPos

private

Definition at line 39 of file TrackRecordGenerator.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.

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

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

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

m_pdgCode

std::vector<int> TrackRecordGenerator::m_pdgCode

private

Definition at line 38 of file TrackRecordGenerator.h.

m_polarization

std::vector<HepMC::Polarization> TrackRecordGenerator::m_polarization

private

Definition at line 42 of file TrackRecordGenerator.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.

{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_recordName

std::string TrackRecordGenerator::m_recordName

private

TrackRecord collection name.

Definition at line 47 of file TrackRecordGenerator.h.

m_rndmSvc

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

privateinherited

Data members.

Definition at line 99 of file GenModule.h.

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

m_smearTR

double TrackRecordGenerator::m_smearTR

private

Amount by which to smear TR position.

Definition at line 45 of file TrackRecordGenerator.h.

m_smearTRp

double TrackRecordGenerator::m_smearTRp

private

Amount by which to smear TR momentum.

Definition at line 46 of file TrackRecordGenerator.h.

m_stopParticles

bool TrackRecordGenerator::m_stopParticles

private

Stop particles before simulation.

Definition at line 48 of file TrackRecordGenerator.h.

m_stopped_tminus

float TrackRecordGenerator::m_stopped_tminus

private

Definition at line 49 of file TrackRecordGenerator.h.

m_stopped_tplus

float TrackRecordGenerator::m_stopped_tplus

private

Bounds for random time.

Definition at line 49 of file TrackRecordGenerator.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:

• TrackRecordGenerator.h
• TrackRecordGenerator.cxx