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

#include <LWHFactory.h>

Inheritance diagram for ThePEG::LWHFactory:

[legend]

Public Member Functions
Manipulate histograms
virtual void	normalizeToXSec (tH1DPtr histogram, CrossSection unit=picobarn) const
	Rescale the given histogram so that the integral over the bins will give the correct integrated cross section for the observable in the given unit.

virtual void	normalizeToXSecFraction (tH1DPtr histogram) const
	Rescale the given histogram so that the integral over the bins gives the fraction of the total cross section generated which is contained in the bins.

virtual void	normalizeToUnity (tH1DPtr histogram) const
	Rescale the given histogram so that the integral over the bins gives one.

virtual void	normalizeToXSec (tH2DPtr histogram, CrossSection unit=picobarn) const
	Rescale the given histogram so that the integral over the bins will give the correct integrated cross section for the observable in the given unit.

virtual void	normalizeToXSecFraction (tH2DPtr histogram) const
	Rescale the given histogram so that the integral over the bins gives the fraction of the total cross section generated which is contained in the bins.

virtual void	normalizeToUnity (tH2DPtr histogram) const
	Rescale the given histogram so that the integral over the bins gives one.

Public Member Functions inherited from ThePEG::FactoryBase
	FactoryBase ()
	The default constructor.

	FactoryBase (const FactoryBase &)
	The copy constructor.

virtual	~FactoryBase ()
	The destructor.

const string &	filename () const
	Together with suffix(), the name of the file where the resulting histograms will be stored.

const string &	suffix () const
	Together with filename(), the name of the file where the resulting histograms will be stored.

const string &	storeType () const
	The format in which the histograms are stored in the output file.

AIDA::IAnalysisFactory &	analysisFactory () const
	Access the underlying AIDA::IAnalysisFactory object.

AIDA::ITree &	tree () const
	Access the underlying AIDA::ITree object.

AIDA::IHistogramFactory &	histogramFactory () const
	A pointer to the underlying AIDA::IHistogramFactory object.

AIDA::IDataPointSetFactory &	dataSetFactory () const
	A pointer to the underlying AIDA::IDataPointSetFactory object.

void	mkdir (const string &path)
	Create a new directory in the underlying AIDA tree.

void	mkdirs (const string &path)
	Create a new directory in the underlying AIDA tree.

void	cd (const string &path)
	Set the default working directory for the underlying AIDA tree.

tH1DPtr	createHistogram1D (const string &path, int nb, double lo, double up)
	Create and return a AIDA::IHistogram1D object in the underlying AIDA histogram factory.

tH1DPtr	createHistogram1D (const string &path, const string &title, int nb, double lo, double up)
	Create and return a AIDA::IHistogram1D object in the underlying AIDA histogram factory.

tH1DPtr	createHistogram1D (const string &path, const string &title, const std::vector< double > &edges)
	Create and return a AIDA::IHistogram1D object in the underlying AIDA histogram factory.

tH2DPtr	createHistogram2D (const string &path, int nbx, double xlo, double xup, int nby, double ylo, double yup)
	Create and return a AIDA::IHistogram2D object in the underlying AIDA histogram factory.

tH2DPtr	createHistogram2D (const string &path, const string &title, int nbx, double xlo, double xup, int nby, double ylo, double yup)
	Create and return a AIDA::IHistogram2D object in the underlying AIDA histogram factory.

tH2DPtr	createHistogram2D (const string &path, const string &title, const std::vector< double > &xedges, const std::vector< double > &yedges)
	Create and return a AIDA::IHistogram2D object in the underlying AIDA histogram factory.

DataFiller	createDataSet (const string &path, const string &title, int dim)
	Create a IDataPointSet with the given path and title and containing points with the given number of dimensions, dim.

void	registerClient (tIPtr client)
	Used by a client object to indicate that he has required histograms from this factory.

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

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.

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::InterfacedBase
virtual	~InterfacedBase ()
	The virtual (empty) destructor;.

string	fullName () const
	Returns the full name of this object including its path, e.g.

string	name () const
	Returns the name of this object, without the path.

string	path () const
	Returns the path to this object including the trailing '/'.

string	comment () const
	Returns a comment assigned to this object.

void	setup (istream &is)
	Read setup info from a standard istream is.

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).

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.

void	persistentInput (PersistentIStream &is, int version)
	Function used to read in object persistently.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

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.

virtual void	debugme () const
	Print out debugging information for this object on std::cerr.

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.

	Named (const Named &)=default
	Explicit default copy-constructor (too avoid compiler warnings)

const string &	name () const
	Return name.

bool	operator== (const Named &other) const
	Test for equality.

bool	operator< (const Named &other) const
	Lexicographical comparison.

Protected Member Functions
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.

Protected Member Functions inherited from ThePEG::FactoryBase
virtual void	dofinish ()
	Finalize this object.

void	analysisFactory (AIDA::IAnalysisFactory *x)
	Set the underlying AIDA::IAnalysisFactory object.

void	clear ()
	Delete all associated AIDA objects.

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.

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
virtual void	readSetup (istream &is)
	Read setup info from a standard istream is.

virtual void	doupdate ()
	Check sanity of the object during the setup phase.

virtual void	doinit ()
	Initialize this object after the setup phase before saving an EventGenerator to disk.

virtual IVector	getReferences ()
	Return a vector of all pointers to Interfaced objects used in this object.

virtual void	rebind (const TranslationMap &)
	Rebind pointer to other Interfaced objects.

	InterfacedBase ()
	Protected default constructor.

	InterfacedBase (string newName)
	Protected constructor with the name given as argument.

	InterfacedBase (const InterfacedBase &i)
	Protected copy-constructor.

Protected Member Functions inherited from ThePEG::Pointer::ReferenceCounted
	ReferenceCounted ()
	Default constructor.

	ReferenceCounted (const ReferenceCounted &)
	Copy-constructor.

ReferenceCounted &	operator= (const ReferenceCounted &)
	Assignment.

Protected Member Functions inherited from ThePEG::Named
const Named &	operator= (const Named &other)
	Assignment.

const string &	name (const string &newName)
	Set new name.

Standard Interfaced functions.
static ClassDescription< LWHFactory >	initLWHFactory
	The static object used to initialize the description of this class.

virtual void	doinitrun ()
	Initialize this object.

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

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.

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

Additional Inherited Members
Public Types inherited from ThePEG::FactoryBase
typedef AIDA::IHistogram1D *	tH1DPtr
	Convenient typedef for pointer to AIDA::IHistogram1D.

typedef const AIDA::IHistogram1D *	tcH1DPtr
	Convenient typedef for pointer to const AIDA::IHistogram1D.

typedef AIDA::IHistogram2D *	tH2DPtr
	Convenient typedef for pointer to AIDA::IHistogram2D.

typedef const AIDA::IHistogram2D *	tcH2DPtr
	Convenient typedef for pointer to const AIDA::IHistogram2D.

typedef AIDA::IDataPointSet *	tDSetPtr
	Convenient typedef for pointer to AIDA::IHistogram1D.

typedef const AIDA::IDataPointSet *	tcDSetPtr
	Convenient typedef for pointer to const 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.

Static Public Member Functions inherited from ThePEG::FactoryBase
static void	Init ()
	The standard Init function used to initialize the interfaces.

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.

Public Attributes inherited from ThePEG::Pointer::ReferenceCounted
const unsigned long	uniqueId
	The unique ID.

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

Here is the documentation of the LWHFactory class.

It inherits from the abstract FactoryBase class and implements the Light-Weight Histogram package, LWH. This implements the most rudimentary histogramming facilities according to the AIDA interface specifications. Currently the only thing that is supported is simple, equally binned, one dimensional histograms. It is mainly intended to be used in applications where one needs to fill simple histograms and output them. With LWH it is then possible to do this without the overhead of a full AIDA implementation, but still having the option to use a full implementation later on with minimal changes.

See also: The interfaces defined for LWHFactory.

Definition at line 36 of file LWHFactory.h.

Member Function Documentation

◆ clone()

virtual IBPtr ThePEG::LWHFactory::clone ( ) const

inlineprotectedvirtual

Make a simple clone of this object.

Returns: a pointer to the new object.

Implements ThePEG::InterfacedBase.

Definition at line 119 of file LWHFactory.h.

References ThePEG::Pointer::new_ptr().

◆ doinitrun()

virtual void ThePEG::LWHFactory::doinitrun ( )

protectedvirtual

Initialize this object.

Called in the run phase just before a run begins.

Reimplemented from ThePEG::FactoryBase.

◆ fullclone()

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

Definition at line 125 of file LWHFactory.h.

References ThePEG::Pointer::new_ptr().

◆ Init()

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

◆ normalizeToUnity() [1/2]

virtual void ThePEG::LWHFactory::normalizeToUnity ( tH1DPtr histogram ) const

virtual

Rescale the given histogram so that the integral over the bins gives one.

Implements ThePEG::FactoryBase.

◆ normalizeToUnity() [2/2]

virtual void ThePEG::LWHFactory::normalizeToUnity ( tH2DPtr histogram ) const

virtual

Rescale the given histogram so that the integral over the bins gives one.

Implements ThePEG::FactoryBase.

◆ normalizeToXSec() [1/2]

virtual void ThePEG::LWHFactory::normalizeToXSec	(	tH1DPtr	histogram,
		CrossSection	unit = `picobarn`
	)		const

virtual

Rescale the given histogram so that the integral over the bins will give the correct integrated cross section for the observable in the given unit.

Implements ThePEG::FactoryBase.

◆ normalizeToXSec() [2/2]

virtual void ThePEG::LWHFactory::normalizeToXSec	(	tH2DPtr	histogram,
		CrossSection	unit = `picobarn`
	)		const

virtual

Rescale the given histogram so that the integral over the bins will give the correct integrated cross section for the observable in the given unit.

Implements ThePEG::FactoryBase.

◆ normalizeToXSecFraction() [1/2]

virtual void ThePEG::LWHFactory::normalizeToXSecFraction ( tH1DPtr histogram ) const

virtual

Rescale the given histogram so that the integral over the bins gives the fraction of the total cross section generated which is contained in the bins.

Implements ThePEG::FactoryBase.

◆ normalizeToXSecFraction() [2/2]

virtual void ThePEG::LWHFactory::normalizeToXSecFraction ( tH2DPtr histogram ) const

virtual

Rescale the given histogram so that the integral over the bins gives the fraction of the total cross section generated which is contained in the bins.

Implements ThePEG::FactoryBase.

◆ operator=()

LWHFactory & ThePEG::LWHFactory::operator= ( const LWHFactory & )

privatedelete

The assignment operator is private and must never be called.

In fact, it should not even be implemented.

◆ persistentInput()

void ThePEG::LWHFactory::persistentInput	(	PersistentIStream &	is,
		int	version
	)

Function used to read in object persistently.

Parameters

is	the persistent input stream read from.
version	the version number of the object when written.

◆ persistentOutput()

void ThePEG::LWHFactory::persistentOutput ( PersistentOStream & os ) const

Function used to write out object persistently.

Parameters

os	the persistent output stream written to.

Member Data Documentation

◆ initLWHFactory

ClassDescription<LWHFactory> ThePEG::LWHFactory::initLWHFactory

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 148 of file LWHFactory.h.

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

LWHFactory.h

Public Member Functions

Protected Member Functions

Standard Interfaced functions.

Functions used by the persistent I/O system.

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ clone()

◆ doinitrun()

◆ fullclone()

◆ Init()

◆ normalizeToUnity() [1/2]

◆ normalizeToUnity() [2/2]

◆ normalizeToXSec() [1/2]

◆ normalizeToXSec() [2/2]

◆ normalizeToXSecFraction() [1/2]

◆ normalizeToXSecFraction() [2/2]

◆ operator=()

◆ persistentInput()

◆ persistentOutput()

Member Data Documentation

◆ initLWHFactory