Encapsulates a full ordered list of (is the aggregate of) concrete EventGeneratorI implementations that must act on the EventRecord to generate an event. Each of these implementations corresponds to a single processing step. More...

#include <EventGenerator.h>

Inheritance diagram for genie::EventGenerator:

[legend]

Collaboration diagram for genie::EventGenerator:

[legend]

Public Member Functions
	EventGenerator ()
	EventGenerator (string config)
	~EventGenerator ()
void	ProcessEventRecord (GHepRecord *event_rec) const
const GVldContext &	ValidityContext (void) const
const InteractionListGeneratorI *	IntListGenerator (void) const
const XSecAlgorithmI *	CrossSectionAlg (void) const
void	Configure (const Registry &config)
void	Configure (string param_set)
Public Member Functions inherited from genie::EventGeneratorI
virtual	~EventGeneratorI ()
Public Member Functions inherited from genie::EventRecordVisitorI
virtual	~EventRecordVisitorI ()
Public Member Functions inherited from genie::Algorithm
virtual	~Algorithm ()
virtual void	FindConfig (void)
virtual const Registry &	GetConfig (void) const
Registry *	GetOwnedConfig (void)
virtual const AlgId &	Id (void) const
	Get algorithm ID.
virtual AlgStatus_t	GetStatus (void) const
	Get algorithm status.
virtual bool	AllowReconfig (void) const
virtual AlgCmp_t	Compare (const Algorithm *alg) const
	Compare with input algorithm.
virtual void	SetId (const AlgId &id)
	Set algorithm ID.
virtual void	SetId (string name, string config)
const Algorithm *	SubAlg (const RgKey &registry_key) const
void	AdoptConfig (void)
void	AdoptSubstructure (void)
virtual void	Print (ostream &stream) const
	Print algorithm info.

Private Member Functions
void	Init (void)
void	LoadConfig (void)

Private Attributes
vector< const EventRecordVisitorI * > *	fEVGModuleVec
	list of modules
vector< double > *	fEVGTime
	module timing info
const XSecAlgorithmI *	fXSecModel
	xsec model for events handled by thread
const InteractionListGeneratorI *	fIntListGen
	generates list of handled interactions
GVldContext *	fVldContext
	validity context
TStopwatch *	fWatch
	stopwatch for module timing
TBits *	fFiltUnphysMask
	mask for allowing unphysical events to pass through (if requested)
GHepRecordHistory	fRecHistory
	event record history

Additional Inherited Members
Static Public Member Functions inherited from genie::Algorithm
static string	BuildParamVectKey (const std::string &comm_name, unsigned int i)
static string	BuildParamVectSizeKey (const std::string &comm_name)
static string	BuildParamMatKey (const std::string &comm_name, unsigned int i, unsigned int j)
static string	BuildParamMatRowSizeKey (const std::string &comm_name)
static string	BuildParamMatColSizeKey (const std::string &comm_name)
Protected Member Functions inherited from genie::EventGeneratorI
	EventGeneratorI ()
	EventGeneratorI (string name)
	EventGeneratorI (string name, string config)
Protected Member Functions inherited from genie::EventRecordVisitorI
	EventRecordVisitorI ()
	EventRecordVisitorI (string name)
	EventRecordVisitorI (string name, string config)
Protected Member Functions inherited from genie::Algorithm
	Algorithm ()
	Algorithm (string name)
	Algorithm (string name, string config)
void	Initialize (void)
void	DeleteConfig (void)
void	DeleteSubstructure (void)
Registry *	ExtractLocalConfig (const Registry &in) const
Registry *	ExtractLowerConfig (const Registry &in, const string &alg_key) const
	Split an incoming configuration Registry into a block valid for the sub-algo identified by alg_key.
template<class T>
bool	GetParam (const RgKey &name, T &p, bool is_top_call=true) const
template<class T>
bool	GetParamDef (const RgKey &name, T &p, const T &def) const
template<class T>
int	GetParamVect (const std::string &comm_name, std::vector< T > &v, bool is_top_call=true) const
	Handle to load vectors of parameters.
int	GetParamVectKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
template<class T>
int	GetParamMat (const std::string &comm_name, TMatrixT< T > &mat, bool is_top_call=true) const
	Handle to load matrix of parameters.
template<class T>
int	GetParamMatSym (const std::string &comm_name, TMatrixTSym< T > &mat, bool is_top_call=true) const
int	GetParamMatKeys (const std::string &comm_name, std::vector< RgKey > &k, bool is_top_call=true) const
int	AddTopRegistry (Registry *rp, bool owns=true)
	add registry with top priority, also update ownership
int	AddLowRegistry (Registry *rp, bool owns=true)
	add registry with lowest priority, also update ownership
int	MergeTopRegistry (const Registry &r)
int	AddTopRegisties (const vector< Registry * > &rs, bool owns=false)
	Add registries with top priority, also udated Ownerships.
Protected Attributes inherited from genie::Algorithm
bool	fAllowReconfig
bool	fOwnsSubstruc
	true if it owns its substructure (sub-algs,...)
AlgId	fID
	algorithm name and configuration set
vector< Registry * >	fConfVect
vector< bool >	fOwnerships
	ownership for every registry in fConfVect
AlgStatus_t	fStatus
	algorithm execution status
AlgMap *	fOwnedSubAlgMp
	local pool for owned sub-algs (taken out of the factory pool)

Detailed Description

Encapsulates a full ordered list of (is the aggregate of) concrete EventGeneratorI implementations that must act on the EventRecord to generate an event. Each of these implementations corresponds to a single processing step.

Is a concrete implementation of the EventGeneratorI interface.

Author: Costas Andreopoulos <c.andreopoulos \at cern.ch> University of Liverpool

Created:\n October 03, 2004

License:\n Copyright (c) 2003-2025, The GENIE Collaboration: For the full text of the license visit http://copyright.genie-mc.org

Definition at line 38 of file EventGenerator.h.

Constructor & Destructor Documentation

◆ EventGenerator() [1/2]

EventGenerator::EventGenerator ( )

Definition at line 42 of file EventGenerator.cxx.

                               :
EventGeneratorI("genie::EventGenerator")
{
  this->Init();
}

References genie::EventGeneratorI::EventGeneratorI(), and Init().

◆ EventGenerator() [2/2]

EventGenerator::EventGenerator ( string config )

Definition at line 48 of file EventGenerator.cxx.

                                            :
EventGeneratorI("genie::EventGenerator", config)
{
  this->Init();
}

References genie::EventGeneratorI::EventGeneratorI(), and Init().

◆ ~EventGenerator()

EventGenerator::~EventGenerator ( )

Definition at line 54 of file EventGenerator.cxx.

{
  delete fWatch;
  delete fFiltUnphysMask;
 
  if(fEVGModuleVec) delete fEVGModuleVec;
  if(fEVGTime)      delete fEVGTime;
  if(fVldContext)   delete fVldContext;
}

References fEVGModuleVec, fEVGTime, fFiltUnphysMask, fVldContext, and fWatch.

Member Function Documentation

◆ Configure() [1/2]

void EventGenerator::Configure ( const Registry & config )

virtual

Configure the algorithm with an external registry The registry is merged with the top level registry if it is owned, Otherwise a copy of it is added with the highest priority

Reimplemented from genie::Algorithm.

Definition at line 207 of file EventGenerator.cxx.

{
  Algorithm::Configure(config);
  this->LoadConfig();
}

References genie::Algorithm::Configure(), and LoadConfig().

◆ Configure() [2/2]

void EventGenerator::Configure ( string config )

virtual

Configure the algorithm from the AlgoConfigPool based on param_set string given in input An algorithm contains a vector of registries coming from different xml configuration files, which are loaded according a very precise prioriy This methods will load a number registries in order of priority: 1) "Tunable" parameter set from CommonParametes. This is loaded with the highest prioriry and it is designed to be used for tuning procedure Usage not expected from the user. 2) For every string defined in "CommonParame" the corresponding parameter set will be loaded from CommonParameter.xml 3) parameter set specified by the config string and defined in the xml file of the algorithm 4) if config is not "Default" also the Default parameter set from the same xml file will be loaded Effectively this avoids the repetion of a parameter when it is not changed in the requested configuration

Reimplemented from genie::Algorithm.

Definition at line 213 of file EventGenerator.cxx.

{
  Algorithm::Configure(param_set);
 
  AddLowRegistry( AlgConfigPool::Instance() -> GlobalParameterList(), false ) ;
 
  this->LoadConfig();
}

References genie::Algorithm::AddLowRegistry(), genie::Algorithm::Configure(), genie::AlgConfigPool::Instance(), and LoadConfig().

◆ CrossSectionAlg()

const XSecAlgorithmI * EventGenerator::CrossSectionAlg ( void ) const

virtual

Implements genie::EventGeneratorI.

Definition at line 202 of file EventGenerator.cxx.

{
  return fXSecModel;
}

References fXSecModel.

◆ Init()

void EventGenerator::Init ( void )

private

Definition at line 227 of file EventGenerator.cxx.

{
  fWatch        = new TStopwatch;
  fVldContext   = 0;
  fEVGModuleVec = 0;
  fEVGTime      = 0;
  fXSecModel    = 0;
  fIntListGen   = 0;
 
  fFiltUnphysMask = new TBits(GHepFlags::NFlags());
  fFiltUnphysMask->ResetAllBits(false);
 
  if (gSystem->Getenv("GUNPHYSMASK")) {
     unsigned int i=0;
     const char * bitfield = gSystem->Getenv("GUNPHYSMASK");
 
     while(bitfield[i]) {
        bool flag = (bitfield[i]=='1');
 
        if(i<GHepFlags::NFlags()) fFiltUnphysMask->SetBitNumber(i,flag);
        i++;
     }
  }
  LOG("EventGenerator", pDEBUG)
    << "Initializing unphysical event mask (" << GHepFlags::NFlags()
    << "->0) = " << *fFiltUnphysMask;
}

References fEVGModuleVec, fEVGTime, fFiltUnphysMask, fIntListGen, fVldContext, fWatch, fXSecModel, LOG, genie::GHepFlags::NFlags(), and pDEBUG.

Referenced by EventGenerator(), and EventGenerator().

◆ IntListGenerator()

const InteractionListGeneratorI * EventGenerator::IntListGenerator ( void ) const

virtual

Implements genie::EventGeneratorI.

Definition at line 197 of file EventGenerator.cxx.

{
  return fIntListGen;
}

References fIntListGen.

◆ LoadConfig()

void EventGenerator::LoadConfig ( void )

private

Definition at line 255 of file EventGenerator.cxx.

{
  if(fEVGModuleVec) delete fEVGModuleVec;
  if(fEVGTime)      delete fEVGTime;
  if(fVldContext)   delete fVldContext;
 
  LOG("EventGenerator", pDEBUG) << "Loading the generator validity context";
 
  string encoded_vld_context ;
  GetParam("VldContext", encoded_vld_context ) ;
  fVldContext = new GVldContext;
  fVldContext->Decode( encoded_vld_context );
 
  LOG("EventGenerator", pDEBUG) << "Loading the event generation modules";
 
  int nsteps ;
  GetParam("NModules", nsteps) ;
  if(nsteps == 0) {
    LOG("EventGenerator", pFATAL)
         << "EventGenerator configuration declares null visitor list!";
  }
  assert(nsteps>0);
 
  fEVGModuleVec = new vector<const EventRecordVisitorI *> (nsteps);
  fEVGTime      = new vector<double>(nsteps);
 
  for(int istep = 0; istep < nsteps; istep++) {
 
    ostringstream keystream;
    keystream << "Module-" << istep;
    RgKey key = keystream.str();
 
    RgAlg temp_alg ;
    GetParam( key, temp_alg ) ;
 
    SLOG("EventGenerator", pINFO)
        << " -- Loading module " << istep << " : " << temp_alg ;
 
    const EventRecordVisitorI * visitor =
               dynamic_cast<const EventRecordVisitorI *>(this->SubAlg(key));
 
    (*fEVGModuleVec)[istep] = visitor;
    (*fEVGTime)[istep]      = 0;
  }
 
  //-- load the interaction list generator
  RgKey ikey = "ILstGen";
  RgAlg ialg ;
  GetParam( ikey, ialg ) ;
  LOG("EventGenerator", pINFO) 
      << " -- Loading the interaction list generator: " << ialg;
  fIntListGen = 
      dynamic_cast<const InteractionListGeneratorI *> (this->SubAlg(ikey));
  assert(fIntListGen);
 
  //-- load the cross section model
  RgKey xkey    = "XSecModel@" + this->Id().Key();
  RgAlg xalg ;
  GetParam( xkey, xalg ) ;
  LOG("EventGenerator", pINFO) 
     << " -- Loading the cross section model: " << xalg;
  fXSecModel =
    dynamic_cast<const XSecAlgorithmI *> (
      this -> SubAlg( xkey ) ) ;
  assert(fXSecModel);
}

References fEVGModuleVec, fEVGTime, fIntListGen, fVldContext, fXSecModel, genie::Algorithm::GetParam(), genie::Algorithm::Id(), genie::AlgId::Key(), LOG, pDEBUG, pFATAL, pINFO, SLOG, and genie::Algorithm::SubAlg().

Referenced by Configure(), and Configure().

◆ ProcessEventRecord()

void EventGenerator::ProcessEventRecord ( GHepRecord * event_rec ) const

virtual

Implements genie::EventRecordVisitorI.

Definition at line 64 of file EventGenerator.cxx.

{
  LOG("EventGenerator", pNOTICE) << "Generating Event...";
 
  //-- Clear previous virtual list folder
  LOG("EventGenerator", pNOTICE) << "Clearing the GHepVirtualListFolder";
  GHepVirtualListFolder * vlfolder = GHepVirtualListFolder::Instance();
  vlfolder->Clear();
 
  //-- Clean previous history + add the bootstrap record in the buffer
  fRecHistory.PurgeHistory();
  fRecHistory.AddSnapshot(-1, event_rec);
 
  //-- Initialize evg thread control flags
  bool ffwd = false;
  unsigned int nexceptions = 0;
 
  //-- Reset stop-watch
  fWatch->Reset();
 
  string mesgh = "Event generation thread: " + this->Id().Key() + 
                 " -> Running module: ";
 
  //-- Loop over the event record processing modules
  int istep=0;
  vector<const EventRecordVisitorI *>::const_iterator miter;
 
  for(miter = fEVGModuleVec->begin();
      miter != fEVGModuleVec->end(); ++miter)
  {
    const EventRecordVisitorI * visitor = *miter; // generation module
 
    string mesg = mesgh + visitor->Id().Key();
    LOG("EventGenerator", pNOTICE)
                 << utils::print::PrintFramedMesg(mesg,0,'~');
    if(ffwd) {
      LOG("EventGenerator", pNOTICE)
           << "Fast Forward flag was set - Skipping processing step!";
      continue;
    }
    try
    {
      fWatch->Start();
      visitor->ProcessEventRecord(event_rec);
      fWatch->Stop();
      fRecHistory.AddSnapshot(istep, event_rec);
      (*fEVGTime)[istep] = fWatch->CpuTime(); // sec
    }
    catch (EVGThreadException exception)
    {
      LOG("EventGenerator", pNOTICE)
           << "An exception was thrown and caught by EventGenerator!";
      LOG("EventGenerator", pNOTICE) << exception;
 
      nexceptions++;
      if ( nexceptions > kMaxEVGThreadExceptions ) {
         LOG("EventGenerator", pFATAL)
           << "Caught max allowed number (" << kMaxEVGThreadExceptions
           << ") of EVGThreadExceptions/thread. Aborting";
         LOG("EventGenerator", pFATAL) << "Event : \n" << *event_rec ;
         exit(1);
      }
 
      //
      // What should I do with this exception?
      // Check whether the user wants to get this unphysical event anyway
      // If not, follow instructions coming with the expection thrown:
      // Either step back to a particular processing step and try re-generating
      // the event or pass it through
      //
 
      // check whether user wants this type of unphysical events passed through
      bool accept = event_rec->Accept();
      if(accept) {
        LOG("EventGenerator", pWARN)
          << "An unphysical event was generated and was accepted by the user";
        break;
      } else {
        LOG("EventGenerator", pWARN)
          << "An unphysical event was generated and was rejected";
      }
 
      // now, follow instructions contained in the exception itself
 
      // make sure we are not asked to go at both directions...
      assert( !(exception.FastForward() && exception.StepBack()) );
 
      ffwd = exception.FastForward();
      if(exception.StepBack()) {
 
         // get return step (if return_step > current_step just ignore it)
         if(exception.ReturnStep() >= 0 && exception.ReturnStep() <= istep) {
 
           int rstep = exception.ReturnStep();
           LOG("EventGenerator", pNOTICE)
               << "Return at processing step " << rstep;
           advance(miter, rstep-istep-1);
           istep = rstep;
 
           // restore the event record as it was just before the processing
           // step we are about to return to
           LOG("EventGenerator", pNOTICE)
                  << "Restoring GHEP as it was just before the return step";
           event_rec->ResetRecord();
           istep--;
           GHepRecord * snapshot = fRecHistory[istep];
           fRecHistory.PurgeRecentHistory(istep+1);
           event_rec->Copy(*snapshot);
         } // valid-return-step
      } // step-back
    } // catch exception
 
    istep++;
  }
 
  LOG("EventGenerator", pNOTICE)
              << utils::print::PrintFramedMesg("Thread Summary",0,'*');
  LOG("EventGenerator", pNOTICE)
           << "The EventRecord was visited by all EventRecordVisitors";
 
  LOG("EventGenerator", pINFO) << "** Event generation timing info **";
  istep=0;
  for(miter = fEVGModuleVec->begin();
                               miter != fEVGModuleVec->end(); ++miter){
    const EventRecordVisitorI * visitor = *miter;
 
    BLOG("EventGenerator", pINFO)
       << "module " << visitor->Id().Key() << " -> ~"
                        << TMath::Max(0.,(*fEVGTime)[istep++]) << " s";
  }
  LOG("EventGenerator", pNOTICE) << "Done generating event!";
}

References genie::GHepRecord::Accept(), BLOG, genie::GHepVirtualListFolder::Clear(), genie::GHepRecord::Copy(), genie::exceptions::EVGThreadException::FastForward(), fEVGModuleVec, fEVGTime, fRecHistory, fWatch, genie::Algorithm::Id(), genie::GHepVirtualListFolder::Instance(), genie::AlgId::Key(), genie::controls::kMaxEVGThreadExceptions, LOG, pFATAL, pINFO, pNOTICE, genie::utils::print::PrintFramedMesg(), genie::EventRecordVisitorI::ProcessEventRecord(), pWARN, genie::GHepRecord::ResetRecord(), genie::exceptions::EVGThreadException::ReturnStep(), and genie::exceptions::EVGThreadException::StepBack().

◆ ValidityContext()

const GVldContext & EventGenerator::ValidityContext ( void ) const

virtual

Implements genie::EventGeneratorI.

Definition at line 222 of file EventGenerator.cxx.

{
  return *fVldContext;
}

References fVldContext.

Member Data Documentation

◆ fEVGModuleVec

vector<const EventRecordVisitorI *>* genie::EventGenerator::fEVGModuleVec

private

list of modules

Definition at line 64 of file EventGenerator.h.

Referenced by Init(), LoadConfig(), ProcessEventRecord(), and ~EventGenerator().

◆ fEVGTime

vector<double>* genie::EventGenerator::fEVGTime

private

module timing info

Definition at line 65 of file EventGenerator.h.

Referenced by Init(), LoadConfig(), ProcessEventRecord(), and ~EventGenerator().

◆ fFiltUnphysMask

TBits* genie::EventGenerator::fFiltUnphysMask

private

mask for allowing unphysical events to pass through (if requested)

Definition at line 70 of file EventGenerator.h.

Referenced by Init(), and ~EventGenerator().

◆ fIntListGen

const InteractionListGeneratorI* genie::EventGenerator::fIntListGen

private

generates list of handled interactions

Definition at line 67 of file EventGenerator.h.

Referenced by Init(), IntListGenerator(), and LoadConfig().

◆ fRecHistory

GHepRecordHistory genie::EventGenerator::fRecHistory

mutableprivate

event record history

Definition at line 71 of file EventGenerator.h.

Referenced by ProcessEventRecord().

◆ fVldContext

GVldContext* genie::EventGenerator::fVldContext

private

validity context

Definition at line 68 of file EventGenerator.h.

Referenced by Init(), LoadConfig(), ValidityContext(), and ~EventGenerator().

◆ fWatch

TStopwatch* genie::EventGenerator::fWatch

private

stopwatch for module timing

Definition at line 69 of file EventGenerator.h.

Referenced by Init(), ProcessEventRecord(), and ~EventGenerator().

◆ fXSecModel

const XSecAlgorithmI* genie::EventGenerator::fXSecModel

private

xsec model for events handled by thread

Definition at line 66 of file EventGenerator.h.

Referenced by CrossSectionAlg(), Init(), and LoadConfig().

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

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ EventGenerator() [1/2]

◆ EventGenerator() [2/2]

◆ ~EventGenerator()

Member Function Documentation

◆ Configure() [1/2]

◆ Configure() [2/2]

◆ CrossSectionAlg()

◆ Init()

◆ IntListGenerator()

◆ LoadConfig()

◆ ProcessEventRecord()

◆ ValidityContext()

Member Data Documentation

◆ fEVGModuleVec

◆ fEVGTime

◆ fFiltUnphysMask

◆ fIntListGen

◆ fRecHistory

◆ fVldContext

◆ fWatch

◆ fXSecModel