- Brief class description:
- This is the main class used to administer an event generation run. The actual generation of each event is handled by the assigned
EventHandler object. When the event generatoris properly set up it can be initialized with the command MakeRun and/or saved to a file with the command SaveRun. If saved to a file, the event generator can be read into another program to produce events. The file can also be read into the runThePEG program where a number of events determined by the parameter NumberOfEvents is generated with each event analysed by the list of assigned AnalysisHandlers.
See also ThePEG::EventGenerator
Name: UseStdout
Type: Switch
- Description:
- Redirect the logging and output to stdout instead of files.
Registered options:
- 0(
No)
- Use log files.
- 1(
Yes)
- Use stdout instead of log files.
Default value: 0
Name: QuickSize
Type: Integer parameter
- Description:
- The max absolute id number of particle data objects which are accessed quickly through a vector indexed by the id number.
Default value: 7000
Minimum value: 0
Name: MaxErrors
Type: Integer parameter
- Description:
- The maximum number of errors of each type which will be tolerated. If more errors are reported, the run will be aborted.
Default value: 10
Minimum value: 1
Name: MaxWarnings
Type: Integer parameter
- Description:
- The maximum number of warnings of each type which will be printed.
Default value: 10
Minimum value: 1
Name: DebugEvent
Type: Integer parameter
- Description:
- If the debug level is above zero, step up to the highest debug level befor event number 'DebugEvent'.
Default value: 0
Minimum value: 0
Name: DumpPeriod
Type: Integer parameter
- Description:
- If the debug level is above zero, dump the full state of the run every 'DumpPeriod' events. Set it to -1 to disable dumping even in the case of errors.
Default value: 0
Minimum value: -1
Name: PrintEvent
Type: Integer parameter
- Description:
- If the debug level is above zero, print the first 'PrintEvent' events.
Default value: 0
Minimum value: 0
Name: DebugLevel
Type: Integer parameter
- Description:
- The level of debug information sent out to the log file in the run. Level 0 only gives a limited ammount of warnings and error messages. Level 1 will print the first few events. Level 5 will print every event. Level 9 will print every step in every event.
Default value: 0
Minimum value: 0
Maximum value: 9
Name: NumberOfEvents
Type: Integer parameter
- Description:
- The number of events to be generated in this run. If less than zero, the number of events is unlimited
Default value: 1000
Minimum value: -1
Name: RunName
Type: Character string parameter
- Description:
- The name of this run. This name will be used in the output filenames. The files wil be placed in the directory specified by the
Path parameterIf empty the name of the event generator will be used instead.
Default value: (May be changed by member function.)
Name: Path
Type: Character string parameter
- Description:
- The directory where the output files are put.
Default value: . (May be changed by member function.)
Name: RandomNumberGenerator
Type: Reference to objects of class
ThePEG::RandomGenerator
- Description:
- An ThePEG::RandomGenerator object which should typically interaface to a CLHEP Random object. This will be the default random number generator for the run, but individual objects may use their own random generator if they wish.
Name: Strategy
Type: Reference to objects of class
ThePEG::Strategy
- Description:
- An ThePEG::Strategy with additional ThePEG::ParticleData objects to be used in this run.
Name: DefaultObjects
Type: Varying size vector of references to objects of class
ThePEG::Interfaced
- Description:
- A vector of pointers to default objects. In a ThePEG::Reference or ThePEG::RefVector interface with the defaultIfNull() flag set, if a null pointer is encountered this vector is gone through until an acceptable object is found in which case the null pointer is replaced by a pointer to this object.
Name: LocalParticles
Type: Varying size vector of references to objects of class
ThePEG::ParticleData
- Description:
- Special versions of ThePEG::ParticleData objects to be used in this run. Note that to delete an object, its number in the list should be given, rather than its id number.
Name: EventManipulator
Type: Reference to objects of class
ThePEG::EventManipulator
- Description:
- An ThePEG::EventManipulator called each time the generation of an event is stopped. The ThePEG::EventManipulator object is able to manipulate the generated event, as opposed to an ThePEG::AnalysisHandler which may only look at the event.
Name: HistogramFactory
Type: Reference to objects of class
ThePEG::FactoryBase
- Description:
- An associated factory object for handling histograms to be used by
AnalysisHandlers.
Name: AnalysisHandlers
Type: Varying size vector of references to objects of class
ThePEG::AnalysisHandler
- Description:
- ThePEG::AnalysisHandler objects to be used to analyze the produced events in this run.
Name: EventHandler
Type: Reference to objects of class
ThePEG::EventHandler
- Description:
- The ThePEG::EventHandler object to be used to generate the individual events in this run.
Name: StandardModelParameters
Type: Reference to objects of class
ThePEG::StandardModelBase
- Description:
- The ThePEG::StandardModelBase object to be used to access standard model parameters in this run.
Name: MakeRun
Type: Command
- Description:
- Isolate and initialize this event generator and give it a run name. If no argument is given, the run name is taken from the
RunName parameter.
Name: SaveRun
Type: Command
- Description:
- Isolate, initialize and save this event generator to a file, from which it can be read in and run in another program. If an agument is given this is used as the run name, otherwise the run name is taken from the
RunName parameter.
