Pythia8::Pythia8Rivet Class Reference

#include <Pythia8Rivet.h>

Public Member Functions
	Pythia8Rivet (Pythia &pytin, string fname)
	~Pythia8Rivet ()
void	addAnalysis (string ana)
void	addRunName (const string runname)
void	init (const HepMC::GenEvent &gev)
void	operator() ()
void	operator() (Event &event, int ievnum=-1, Pythia8::Info *pyinfo=0, Pythia8::Settings *pyset=0, bool append=false, HepMC::GenParticle *rootParticle=0, int iBarcode=-1)
void	done ()
	Pythia8Rivet (Pythia &pytin, string fname)
	~Pythia8Rivet ()
void	addAnalysis (string ana)
void	addPreload (string prel)
void	ignoreBeams (bool flagIn)
void	addRunName (const string runname)
void	init (const HepMC::GenEvent &gev)
void	operator() ()
void	operator() (Event &event, int ievnum=-1, const Pythia8::Info *pyinfo=0, Pythia8::Settings *pyset=0, bool append=false, HepMC::GenParticle *rootParticle=0, int iBarcode=-1)
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. (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.

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.

Definition at line 33 of file Pythia8Rivet.h.

Constructor & Destructor Documentation

Pythia8::Pythia8Rivet::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.

Definition at line 41 of file Pythia8Rivet.h.

Pythia8::Pythia8Rivet::~Pythia8Rivet ( )

inline

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

Definition at line 48 of file Pythia8Rivet.h.

Pythia8::Pythia8Rivet::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.

Definition at line 39 of file Pythia8Rivet.h.

Pythia8::Pythia8Rivet::~Pythia8Rivet ( )

inline

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

Definition at line 46 of file Pythia8Rivet.h.

References done().

Member Function Documentation

void Pythia8::Pythia8Rivet::addAnalysis ( string  ana )

inline

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

Definition at line 54 of file Pythia8Rivet.h.

void Pythia8::Pythia8Rivet::addAnalysis ( string  ana )

inline

Add the name of an analysis to be performed. Will silently fail if rivet has already been initialized.

Definition at line 56 of file Pythia8Rivet.h.

void Pythia8::Pythia8Rivet::addPreload ( string  prel )

inline

Add a YODA file pre-load pre-filled histogram from.

Definition at line 61 of file Pythia8Rivet.h.

void Pythia8::Pythia8Rivet::addRunName ( const string  runname )

inline

Add an (optional) run name for Rivet internal use.

Definition at line 63 of file Pythia8Rivet.h.

void Pythia8::Pythia8Rivet::addRunName ( const string  runname )

inline

Add an (optional) run name for Rivet internal use.

Definition at line 75 of file Pythia8Rivet.h.

void Pythia8::Pythia8Rivet::done ( )

inline

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

Definition at line 119 of file Pythia8Rivet.h.

Referenced by ~Pythia8Rivet().

void Pythia8::Pythia8Rivet::done ( )

inline

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

Definition at line 137 of file Pythia8Rivet.h.

void Pythia8::Pythia8Rivet::ignoreBeams ( bool  flagIn )

inline

Set "ignore beams" flag.

Definition at line 68 of file Pythia8Rivet.h.

void Pythia8::Pythia8Rivet::init ( const HepMC::GenEvent &  gev )

inline

Initialize Rivet. Will do nothing if Rivet was already initialized

Definition at line 69 of file Pythia8Rivet.h.

Referenced by operator()().

void Pythia8::Pythia8Rivet::init ( const HepMC::GenEvent &  gev )

inline

Initialize Rivet. Will do nothing if Rivet was already initialized

Definition at line 81 of file Pythia8Rivet.h.

void Pythia8::Pythia8Rivet::operator() ( )

inline

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

Definition at line 82 of file Pythia8Rivet.h.

Referenced by operator()().

void Pythia8::Pythia8Rivet::operator() ( Event &  event, int  ievnum = -1, Pythia8::Info *  pyinfo = 0, Pythia8::Settings *  pyset = 0, bool  append = false, HepMC::GenParticle *  rootParticle = 0, int  iBarcode = -1  )

inline

Analyze the given event.

Definition at line 89 of file Pythia8Rivet.h.

References HepMC::GenEvent::set_heavy_ion(), HepMC::HeavyIon::set_impact_parameter(), HepMC::HeavyIon::set_Ncoll(), HepMC::HeavyIon::set_Ncoll_hard(), HepMC::HeavyIon::set_Npart_proj(), and HepMC::HeavyIon::set_Npart_targ().

void Pythia8::Pythia8Rivet::operator() ( )

inline

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

Definition at line 99 of file Pythia8Rivet.h.

References operator()().

void Pythia8::Pythia8Rivet::operator() ( Event &  event, int  ievnum = -1, const Pythia8::Info *  pyinfo = 0, Pythia8::Settings *  pyset = 0, bool  append = false, HepMC::GenParticle *  rootParticle = 0, int  iBarcode = -1  )

inline

Analyze the given event.

Definition at line 106 of file Pythia8Rivet.h.

References init(), HepMC::GenEvent::set_heavy_ion(), HepMC::HeavyIon::set_impact_parameter(), HepMC::HeavyIon::set_Ncoll(), HepMC::HeavyIon::set_Ncoll_hard(), HepMC::HeavyIon::set_Npart_proj(), and HepMC::HeavyIon::set_Npart_targ().

---

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

• StarGenerator/Pythia8_2_35/include/Pythia8Plugins/Pythia8Rivet.h
• StarGenerator/Pythia8_3_03/include/Pythia8Plugins/Pythia8Rivet.h