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

The GraphvizPlot class generates an output of the tree structure of the event which can be viewed using dot. More...

#include <GraphvizPlot.h>

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

List of all members.

Public Member Functions

Standard constructors and destructors.
 GraphvizPlot ()
 The default constructor.
Virtual functions required by the AnalysisHandler class.
virtual void analyze (tEventPtr event, long ieve, int loop, int state)
 Analyze a given Event.
Functions used by the persistent I/O system.
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently.
void persistentInput (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

string particleName (tcPPtr) const
 Helper function to obtain the name of a particle.
Clone Methods.
virtual IBPtr clone () const
 Make a simple clone of this object.
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane.
Standard Interfaced functions.
virtual void dofinish ()
 Finalize this object.
Clone Methods.

Private Member Functions

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

Private Attributes

long _eventNumber
 Event number that should be drawn.
bool _quiet
 Tell the object not to write out messages to the standard output.

Static Private Attributes

static ClassDescription
< GraphvizPlot
initGraphvizPlot
 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

The GraphvizPlot class generates an output of the tree structure of the event which can be viewed using dot.

See also:
The interfaces defined for GraphvizPlot.

Definition at line 27 of file GraphvizPlot.h.


Member Function Documentation

virtual void ThePEG::GraphvizPlot::analyze ( 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 IBPtr ThePEG::GraphvizPlot::clone ( ) const
inlineprotectedvirtual

Make a simple clone of this object.

Returns:
a pointer to the new object.

Reimplemented from ThePEG::AnalysisHandler.

Definition at line 97 of file GraphvizPlot.h.

References ThePEG::Pointer::new_ptr().

virtual void ThePEG::GraphvizPlot::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 IBPtr ThePEG::GraphvizPlot::fullclone ( ) const
inlineprotectedvirtual

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.

Definition at line 103 of file GraphvizPlot.h.

References ThePEG::Pointer::new_ptr().

static void ThePEG::GraphvizPlot::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.

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

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

void ThePEG::GraphvizPlot::persistentInput ( 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::GraphvizPlot::persistentOutput ( PersistentOStream os) const

Function used to write out object persistently.

Parameters:
osthe persistent output stream written to.

Reimplemented from ThePEG::AnalysisHandler.


Member Data Documentation

ClassDescription<GraphvizPlot> ThePEG::GraphvizPlot::initGraphvizPlot
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 128 of file GraphvizPlot.h.


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