thepeg is hosted by Hepforge, IPPP Durham
ThePEG  2.1.4

The AnalysisHandler is the base class of all analysis objects which may be handled by the FullEventGenerator. More...

#include <AnalysisHandler.h>

Inheritance diagram for ThePEG::AnalysisHandler:

Classes

class  NoHistFactory
 Exception class used if no histogram factory was found. More...
 

Public Types

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.
 
- Public Types inherited from ThePEG::InterfacedBase
enum  InitState { initializing = -1, uninitialized = 0, initialized = 1, runready = 2 }
 Enumeration reflecting the state of an InterfacedBase object. More...
 
- Public Types inherited from ThePEG::Pointer::ReferenceCounted
typedef unsigned int CounterType
 The integer type used for counting.
 

Public Member Functions

Virtual functions required by the AnalysisHandler class.
virtual void analyze (tEventPtr event, long ieve, int loop, int state)
 Analyze a given Event. More...
 
virtual LorentzRotation transform (tEventPtr event) const
 Transform the event to the desired Lorentz frame and return the corresponding LorentzRotation. More...
 
virtual LorentzRotation transform (tcEventPtr event) const
 Return a LorentzTransform which would put the event in the desired Lorentz frame. More...
 
virtual void analyze (const tPVector &particles)
 Analyze the given vector of particles. More...
 
virtual void analyze (const tPVector &particles, double weight)
 Analyze the given vector of particles. More...
 
virtual void analyze (tPPtr particle)
 Analyze the given particle. More...
 
virtual void analyze (tPPtr particle, double weight)
 Analyze the given particle. More...
 
Functions to access histograms.
bool checkHistogramFactory (bool warn=false) const
 Check if the associated EventGenerator has been assigned a histogram factory. More...
 
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. More...
 
void unitNormalize (tH1DPtr h) const
 Normalize the histogran h to unit integral.
 
Functions used by the persistent I/O system.
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::HandlerBaseT< UseRandom >
double rnd () const
 Return a simple flat random number in the range ]0,1[.
 
double rnd (double xu) const
 Return a simple flat random number in the range ]0,xu[.
 
double rnd (double xl, double xu) const
 Return a simple flat random number in the range ]xl,xu[.
 
bool rndbool () const
 Return true with 50% probability.
 
bool rndbool (double p) const
 Return a true with probability p.
 
bool rndbool (double p1, double p2) const
 Return a true with probability p1/(p1+p2).
 
int rndsign (double p1, double p2, double p3) const
 Return -1, 0, or 1 with relative probabilities p1, p2, p3.
 
int rnd2 (double p0, double p1) const
 Return an integer $i$ with probability p $i$/(p0+p1).
 
int rnd3 (double p0, double p1, double p2) const
 Return an integer $i$ with probability p $i$/(p0+p1+p2).
 
int rnd4 (double p0, double p1, double p2, double p3) const
 Return an integer/ $i$ with probability p $i$(p0+p1+p2+p3).
 
long irnd (long xu=2) const
 Return a simple flat random integrer number in the range [0,xu[.
 
long irnd (long xl, long xu) const
 Return a simple flat random integrer number in the range [xl,xu[.
 
const StandardModelBaseSM () const
 Return a reference to the object containing the standard model parameters for this run.
 
tSMPtr standardModel () const
 Return a pointer to the object containing the standard model parameters for this run.
 
virtual ~HandlerBaseT ()
 Destructor.
 
- Public Member Functions inherited from ThePEG::Interfaced
virtual ~Interfaced ()
 Empty virtual destructor.
 
virtual bool defaultInit ()
 Functions which are to be used during the actual event generation, after the setup is complete. More...
 
PPtr getParticle (PID) const
 Create a new Particle instance given a id number.
 
PDPtr getParticleData (PID) const
 Return a pointer to the ParticleData object corresponding to the given id number.
 
bool used () const
 Returns true if this object has actally been used.
 
void useMe () const
 Should be called to indicate that this object has actually been used.
 
tEGPtr generator () const
 Return a pointer to the EventGenerator controlling the run. More...
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::InterfacedBase
virtual ~InterfacedBase ()
 The virtual (empty) destructor;.
 
string fullName () const
 Returns the full name of this object including its path, e.g. More...
 
string name () const
 Returns the name of this object, without the path.
 
string path () const
 Returns the path to this object including the trailing '/'. More...
 
string comment () const
 Returns a comment assigned to this object.
 
void setup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual void debugme () const
 Print out debugging information for this object on std::cerr. More...
 
void update ()
 Calls the doupdate() function with recursion prevention.
 
void init ()
 Calls the doinit() function with recursion prevention.
 
virtual bool preInitialize () const
 Return true if this object needs to be initialized before all other objects (except those for which this function also returns true). More...
 
void initrun ()
 Calls the doinitrun() function with recursion prevention.
 
void finish ()
 Calls the dofinish() function with recursion prevention.
 
void touch ()
 This function should be called every time something in this object has changed in a way that a sanity check with update() is needed.
 
void reset ()
 Set the state of this object to uninitialized.
 
void clear ()
 Calls reset() and unTouch().
 
InitState state () const
 Return the state of initialization of this object.
 
bool locked () const
 Return true if the BaseRepository is not allowed to change the state of this object.
 
bool touched () const
 Return true if the state of this object has been changed since the last call to update().
 
void persistentOutput (PersistentOStream &os) const
 Function used to write out object persistently. More...
 
void persistentInput (PersistentIStream &is, int version)
 Function used to read in object persistently. More...
 
- Public Member Functions inherited from ThePEG::Base
virtual ~Base ()
 The virtual destructor.
 
void debug () const
 Print out debugging information for this object on std::cerr. More...
 
- Public Member Functions inherited from ThePEG::Pointer::ReferenceCounted
CounterType referenceCount () const
 Return the reference count.
 
- Public Member Functions inherited from ThePEG::Named
 Named (const string &newName=string())
 Constructor with name.
 
const string & name () const
 Return name.
 
bool operator== (const Named &other) const
 Test for equality.
 
bool operator< (const Named &other) const
 Lexicographical comparison.
 

Static Public Member Functions

static void Init ()
 Standard Init function used to initialize the interface.
 
- Static Public Member Functions inherited from ThePEG::HandlerBase
static void Init ()
 Standard Init function used to initialize the interface.
 
- Static Public Member Functions inherited from ThePEG::Interfaced
static void Init ()
 Standard Init function.
 
- Static Public Member Functions inherited from ThePEG::InterfacedBase
static void Init ()
 Standard Init function.
 
- Static Public Member Functions inherited from ThePEG::Base
static void Init ()
 The standard Init function used to initialize the interfaces. More...
 

Protected Member Functions

Clone Methods.
virtual IBPtr clone () const
 Make a simple clone of this object. More...
 
virtual IBPtr fullclone () const
 Make a clone of this object, possibly modifying the cloned object to make it sane. More...
 
- Protected Member Functions inherited from ThePEG::Interfaced
void reporeg (IBPtr object, string name) const
 Register the given object in the Repository with the given name in a subdirectory with the same name as this object. More...
 
template<typename PtrT >
bool setDefaultReference (PtrT &ptr, string classname, string objectname)
 If the pointer, ptr, to an object is not set, create an object of class classname and register it with the Repository with the given objectname in a sib-directory with the same name as this object.
 
 Interfaced ()
 Protected default constructor.
 
 Interfaced (const string &newName)
 Protected constructor taking a name as argument.
 
 Interfaced (const Interfaced &i)
 Protected copy-constructor.
 
void setGenerator (tEGPtr generator)
 Protected function to reset the generator pointer, required for automatic decayer generation in Herwig++ BSM models.
 
- Protected Member Functions inherited from ThePEG::InterfacedBase
 InterfacedBase ()
 Protected default constructor.
 
 InterfacedBase (string newName)
 Protected constructor with the name given as argument.
 
 InterfacedBase (const InterfacedBase &i)
 Protected copy-constructor.
 
virtual void readSetup (istream &is)
 Read setup info from a standard istream is. More...
 
virtual void doupdate ()
 Check sanity of the object during the setup phase. More...
 
virtual void doinit ()
 Initialize this object after the setup phase before saving an EventGenerator to disk. More...
 
virtual void doinitrun ()
 Initialize this object. More...
 
virtual void dofinish ()
 Finalize this object. More...
 
virtual IVector getReferences ()
 Return a vector of all pointers to Interfaced objects used in this object. More...
 
virtual void rebind (const TranslationMap &)
 Rebind pointer to other Interfaced objects. More...
 
- Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
 ReferenceCounted ()
 Default constructor.
 
 ReferenceCounted (const ReferenceCounted &)
 Copy-constructor.
 
ReferenceCountedoperator= (const ReferenceCounted &)
 Assignment.
 
- Protected Member Functions inherited from ThePEG::Named
const Namedoperator= (const Named &other)
 Assignment.
 
const string & name (const string &newName)
 Set new name.
 

Private Attributes

AnalysisVector theSlaves
 A list of slave analysis objects which are called for the same extracted particles and in the same Lorentz frame as this one.
 

Static Private Attributes

static ClassDescription< AnalysisHandlerinitAnalysisHandler
 The static object used to initialize the description of this class. More...
 

Additional Inherited Members

- Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long uniqueId
 The unique ID. More...
 
- Static Protected Member Functions inherited from ThePEG::Interfaced
static void registerRepository (IBPtr)
 Register an Interfaced object with the Repository.
 
static void registerRepository (IBPtr, string newName)
 Register an Interfaced object with the Repository, giving it a name.
 

Detailed Description

The AnalysisHandler is the base class of all analysis objects which may be handled by the FullEventGenerator.

The main function is the virtual analyze() method which which is called for each analysis handler after each event. The method may be called several times for each event - this may be checked by the analysis handler by looking at the ieve, loop and state arguments to the analyze method.

Initialization of histograms etc. should be made in the doinitrun() function, while writing out of histograms and analysis results should be performed in the dofinish() function.

See also
The interfaces defined for AnalysisHandler.
FullEventGenerator
Event

Definition at line 41 of file AnalysisHandler.h.

Member Function Documentation

◆ analyze() [1/5]

virtual void ThePEG::AnalysisHandler::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 extract all final state particles, temporarily boost them according to the transform(tEventPtr) function 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 in ThePEG::HepMC3File, ThePEG::HepMCFile, ThePEG::HIHepMCFile, ThePEG::ProgressLog, ThePEG::XSecCheck, ThePEG::NLOHepMC3File, ThePEG::NLOHepMCFile, ThePEG::GraphvizPlot, ThePEG::NLORivetAnalysis, and ThePEG::RivetAnalysis.

◆ analyze() [2/5]

virtual void ThePEG::AnalysisHandler::analyze ( const tPVector particles)
virtual

Analyze the given vector of particles.

The default version calls analyze(tPPtr) for each of the particles.

Parameters
particlesthe vector of pointers to particles to be analyzed
Deprecated:
Use analyze(const tPVector &, double) instead.

◆ analyze() [3/5]

virtual void ThePEG::AnalysisHandler::analyze ( const tPVector particles,
double  weight 
)
virtual

Analyze the given vector of particles.

The default version calls analyze(tPPtr) for each of the particles.

Parameters
particlesthe vector of pointers to particles to be analyzed
weightthe weight of the current event.

◆ analyze() [4/5]

virtual void ThePEG::AnalysisHandler::analyze ( tPPtr  particle)
virtual

Analyze the given particle.

Parameters
particlepointer to the particle to be analyzed.
Deprecated:
us analyze(tPPtr, double) instead.

◆ analyze() [5/5]

virtual void ThePEG::AnalysisHandler::analyze ( tPPtr  particle,
double  weight 
)
virtual

Analyze the given particle.

Parameters
particlepointer to the particle to be analyzed.
weightthe weight of the current event.

◆ checkHistogramFactory()

bool ThePEG::AnalysisHandler::checkHistogramFactory ( bool  warn = false) const

Check if the associated EventGenerator has been assigned a histogram factory.

If warn is true also emit a warning saying that no histograms will be generated.

◆ clone()

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

◆ fullclone()

virtual IBPtr ThePEG::AnalysisHandler::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::InterfacedBase.

Reimplemented in ThePEG::NLOHepMC3File, ThePEG::NLOHepMCFile, ThePEG::ProgressLog, ThePEG::HepMC3File, ThePEG::HepMCFile, ThePEG::HIHepMCFile, ThePEG::XSecCheck, ThePEG::GraphvizPlot, ThePEG::NLORivetAnalysis, and ThePEG::RivetAnalysis.

Referenced by iHistogramFactory().

◆ normalize()

void ThePEG::AnalysisHandler::normalize ( tH1DPtr  h,
CrossSection  unit = picobarn 
) const

Normalize the histogran h using the collected statistics from the EventGenerator.

If the histogram has been filled with the Event::weight() as weight a plotted function will correspond to a proper cross section distribution in units of unit. This only works for evenly binned histograms. If not evenly binned, nothing will be done.

Referenced by iHistogramFactory().

◆ persistentInput()

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

Referenced by iHistogramFactory().

◆ persistentOutput()

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

Function used to write out object persistently.

Parameters
osthe persistent output stream written to.

Referenced by iHistogramFactory().

◆ transform() [1/2]

virtual LorentzRotation ThePEG::AnalysisHandler::transform ( tEventPtr  event) const
virtual

Transform the event to the desired Lorentz frame and return the corresponding LorentzRotation.

Parameters
eventa pointer to the Event to be transformed.
Returns
the LorentzRotation used in the transformation.
Deprecated:
Use transform(tcEventPtr) instead. This method is no longer used automatically.

◆ transform() [2/2]

virtual LorentzRotation ThePEG::AnalysisHandler::transform ( tcEventPtr  event) const
virtual

Return a LorentzTransform which would put the event in the desired Lorentz frame.

Parameters
eventa pointer to the Event to be considered.
Returns
the LorentzRotation used in the transformation.

Member Data Documentation

◆ initAnalysisHandler

ClassDescription<AnalysisHandler> ThePEG::AnalysisHandler::initAnalysisHandler
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 244 of file AnalysisHandler.h.


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