ThePEG  1.8.0
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Static Private Attributes
ThePEG::RivetAnalysis Class Reference

Here is the documentation of the RivetAnalysis class. More...

#include <RivetAnalysis.h>

Inheritance diagram for ThePEG::RivetAnalysis:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 RivetAnalysis ()
 The default constructor.
Virtual functions required by the AnalysisHandler class.
virtual void analyze (ThePEG::tEventPtr event, long ieve, int loop, int state)
 Analyze a given Event.
Functions used by the persistent I/O system.
void persistentOutput (ThePEG::PersistentOStream &os) const
 Function used to write out object persistently.
void persistentInput (ThePEG::PersistentIStream &is, int version)
 Function used to read in object persistently.
- Public Member Functions inherited from ThePEG::AnalysisHandler
virtual LorentzRotation transform (tEventPtr event) const
 Transform the event to the desired Lorentz frame and return the corresponding LorentzRotation.
virtual LorentzRotation transform (tcEventPtr event) const
 Return a LorentzTransform which would put the event in the desired Lorentz frame.
virtual void analyze (const tPVector &particles)
 Analyze the given vector of particles.
virtual void analyze (const tPVector &particles, double weight)
 Analyze the given vector of particles.
virtual void analyze (tPPtr particle)
 Analyze the given particle.
virtual void analyze (tPPtr particle, double weight)
 Analyze the given particle.
bool checkHistogramFactory (bool warn=false) const
 Check if the associated EventGenerator has been assigned a histogram factory.
FactoryBasehistogramFactory ()
 Access the HistogramFactory from the EventGenerator.
const FactoryBasehistogramFactory () const
 Access the HistogramFactory from the EventGenerator.
AIDA::IHistogramFactory & iHistogramFactory () const
 Access the underlying AIDA::IHistogramFactory in the HistogramFactory from the EventGenerator.
void normalize (tH1DPtr h, CrossSection unit=picobarn) const
 Normalize the histogran h using the collected statistics from the EventGenerator.
void unitNormalize (tH1DPtr h) const
 Normalize the histogran h to unit integral.

Static Public Member Functions

static void Init ()
 The standard Init function used to initialize the interfaces.

Protected Member Functions

Clone Methods.
virtual ThePEG::IBPtr clone () const
 Make a simple clone of this object.
virtual ThePEG::IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane.
Standard Interfaced functions.
virtual void doinit ()
 Initialize this object.
virtual void doinitrun ()
 Initialize this object.
virtual void dofinish ()
 Finalize this object.
Clone Methods.

Private Member Functions

RivetAnalysisoperator= (const RivetAnalysis &)
 The assignment operator is private and must never be called.

Private Attributes

vector< string > _analyses
 The Analyses to use.
string filename
 The base name of the output file.
bool debug
 Enable debugging information from Rivet.
Rivet::AnalysisHandler * _rivet
 The RivetAnalysisHandler.
unsigned long _nevent
 Event count.

Static Private Attributes

static
ThePEG::ClassDescription
< RivetAnalysis
initRivetAnalysis
 The static object used to initialize the description of this class.

Additional Inherited Members

- Public Types inherited from ThePEG::AnalysisHandler
typedef FactoryBase::tH1DPtr tH1DPtr
 Convenient typedef for pointer to AIDA::IHistogram1D.
typedef FactoryBase::tcH1DPtr tcH1DPtr
 Convenient typedef for pointer to AIDA::IHistogram1D.
typedef FactoryBase::tH2DPtr tH2DPtr
 Convenient typedef for pointer to AIDA::IHistogram1D.
typedef FactoryBase::tcH2DPtr tcH2DPtr
 Convenient typedef for pointer to AIDA::IHistogram1D.

Detailed Description

Here is the documentation of the RivetAnalysis class.

See also:
The interfaces defined for RivetAnalysis.

Definition at line 19 of file RivetAnalysis.h.


Member Function Documentation

virtual void ThePEG::RivetAnalysis::analyze ( ThePEG::tEventPtr  event,
long  ieve,
int  loop,
int  state 
)
virtual

Analyze a given Event.

Note that a fully generated event may be presented several times, if it has been manipulated in between. The default version of this function will call transform to make a lorentz transformation of the whole event, then extract all final state particles and call analyze(tPVector) of this analysis object and those of all associated analysis objects. The default version will not, however, do anything on events which have not been fully generated, or have been manipulated in any way.

Parameters:
eventpointer to the Event to be analyzed.
ievethe event number.
loopthe number of times this event has been presented. If negative the event is now fully generated.
statea number different from zero if the event has been manipulated in some way since it was last presented.

Reimplemented from ThePEG::AnalysisHandler.

virtual ThePEG::IBPtr ThePEG::RivetAnalysis::clone ( ) const
protectedvirtual

Make a simple clone of this object.

Returns:
a pointer to the new object.

Reimplemented from ThePEG::AnalysisHandler.

virtual void ThePEG::RivetAnalysis::dofinish ( )
protectedvirtual

Finalize this object.

Called in the run phase just after a run has ended. Used eg. to write out statistics.

Reimplemented from ThePEG::InterfacedBase.

virtual void ThePEG::RivetAnalysis::doinit ( )
protectedvirtual

Initialize this object.

Called in the read phase.

Reimplemented from ThePEG::InterfacedBase.

virtual void ThePEG::RivetAnalysis::doinitrun ( )
protectedvirtual

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::InterfacedBase.

virtual ThePEG::IBPtr ThePEG::RivetAnalysis::fullclone ( ) const
protectedvirtual

Make a clone of this object, possibly modifying the cloned object to make it sane.

Returns:
a pointer to the new object.

Reimplemented from ThePEG::AnalysisHandler.

static void ThePEG::RivetAnalysis::Init ( )
static

The standard Init function used to initialize the interfaces.

Called exactly once for each class by the class description system before the main function starts or when this class is dynamically loaded.

Reimplemented from ThePEG::AnalysisHandler.

RivetAnalysis& ThePEG::RivetAnalysis::operator= ( const RivetAnalysis )
private

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

void ThePEG::RivetAnalysis::persistentInput ( ThePEG::PersistentIStream is,
int  version 
)

Function used to read in object persistently.

Parameters:
isthe persistent input stream read from.
versionthe version number of the object when written.

Reimplemented from ThePEG::AnalysisHandler.

void ThePEG::RivetAnalysis::persistentOutput ( ThePEG::PersistentOStream os) const

Function used to write out object persistently.

Parameters:
osthe persistent output stream written to.

Reimplemented from ThePEG::AnalysisHandler.


Member Data Documentation

ThePEG::ClassDescription<RivetAnalysis> ThePEG::RivetAnalysis::initRivetAnalysis
staticprivate

The static object used to initialize the description of this class.

Indicates that this is a concrete class with persistent data.

Definition at line 123 of file RivetAnalysis.h.


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