PYTHIA  8.311
Public Member Functions | List of all members
Pythia8Rivet Class Reference

#include <Pythia8Rivet.h>

Public Member Functions

 Pythia8Rivet (Pythia &pytin, string fname)
 
 ~Pythia8Rivet ()
 
void addAnalysis (string ana)
 
void addPreload (string prel)
 Add a YODA file pre-load pre-filled histogram from.
 
void ignoreBeams (bool flagIn)
 Set "ignore beams" flag.
 
void dump (int period, string fname="")
 
void addAttribute (const string &name, double val)
 Add an attribute to the current event.
 
void addRunName (const string runname)
 Add an (optional) run name for Rivet internal use.
 
void init ()
 Initialize Rivet. Will do nothing if Rivet was already initialized.
 
void initpath () const
 Helper function to set analysis path.
 
void operator() ()
 
void operator() (Event &event)
 Analyze the given event.
 
void done ()
 

Detailed Description

Simplified interface to the Rivet program. Remember to link with pythia and -lhepmcinterface -lHepMC -lRivet

Usage: (1) Create an object giving the pythia object and a filename as arguments. (2) Repeatedly specify (the name of an) analysis with the addAnalysis() function, possibly with analysis parameters. (3) initialize the underlying Rivet object with the init() function. (4) Analyze an event with the operator() function. (5) Dump the histograms to a file with the done() function.

Constructor & Destructor Documentation

Pythia8Rivet ( Pythia pytin,
string  fname 
)
inline

The constructor needs to have the main Pythia object, and the name of the file where the histograms are dumped.

~Pythia8Rivet ( )
inline

The destructor will write the histogram file if this has not already been done.

Member Function Documentation

void addAnalysis ( string  ana)
inline

Add the name of an analysis to be performed, with a list of analysis parameters.

void done ( )
inline

Writes histograms to file and deletes the Rivet object. Does nothing if Rivet was not initialized.

void dump ( int  period,
string  fname = "" 
)
inline

Set Rivet dump period and file name for intermittent histograms. If no dumpfile given, the default output file is used.

void operator() ( )
inline

Analyze the default Pythia event. Will do nothing if Rivet has not been intialized.


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