In This Package:

HepMC Namespace Reference

All classes in the HepMC packages are in the HepMC namespace. More...

Classes
class	CommonIO
class	Flow
	The particle's flow object keeps track of an arbitrary number of flow patterns within a graph (i.e. More...
class	GenEvent
	HepMC::GenEvent contains information about generated particles. More...
class	GenParticle
	HepMC::GenParticle contains momentum, generated mass, particle ID, decay status, flow, polarization, pointers to production and decay vertices and a unique barcode identfier. More...
class	GenVertex
	HepMC::GenVertex contains the position in space and time of a decay. More...
class	HeavyIon
	HepMC::HeavyIon provides additional information storage for Heavy Ion generators in GenEvent. More...
class	HEPEVT_Wrapper
	This class is intended for static use only - it makes no sense to instantiate it. More...
class	IO_Ascii
	Strategy for reading or writing events/particleData as machine readable ascii to a file. More...
class	IO_AsciiParticles
	Strategy for reading or writing events/particleData as machine readable ascii to a file. More...
class	IO_BaseClass
	If you want to write a new IO class, then inherit from this class and re-define read_event() and write_event(). More...
class	IO_ExtendedAscii
	event input/output in ascii format for machine reading extended format contains HeavyIon and PdfInfo classes More...
class	IO_GenEvent
	event input/output in ascii format for machine reading extended format contains HeavyIon and PdfInfo classes More...
class	IO_HEPEVT
	IO class for reading the standard HEPEVT common block. More...
class	IO_HERWIG
	IO class for reading the HEPEVT common block from the Herwig monte carlo program. More...
class	IO_PDG_ParticleDataTable
	Example of reading from file PDG98_ParticleDataTable.txt. More...
class	ParticleData
	Particle Data common to all particles of a given PDG id. More...
class	ParticleDataTable
	Example container for ParticleData instances. More...
class	PdfInfo
	HepMC::PdfInfo stores additional PDF information for a GenEvent. More...
class	Polarization
	HepMC::Polarization stores a particle's theta and phi in radians. More...
class	FourVector
	For compatibility with existing code, the basic expected geometrical access methods are povided. More...
class	ThreeVector
	For compatibility with existing code, the basic expected geometrical access methods are povided. More...
class	TempParticleMap
	Used by IO classes for recoverable particle ordering. More...
class	WeightContainer
	Basically just an interface to STL vector. More...
Namespaces
namespace	detail
Enumerations
enum	known_io {   gen = 1, ascii, extascii, ascii_pdt,   extascii_pdt }
	The known_io enum is used to track which type of input is being read. More...
enum	IteratorRange {   parents, children, family, ancestors,   descendants, relatives }
	type of iteration More...
Functions
bool	compareGenEvent (GenEvent *, GenEvent *)
bool	compareSignalProcessVertex (GenEvent *, GenEvent *)
bool	compareBeamParticles (GenEvent *, GenEvent *)
bool	compareWeights (GenEvent *, GenEvent *)
bool	compareVertices (GenEvent *, GenEvent *)
bool	compareParticles (GenEvent *, GenEvent *)
bool	compareVertex (GenVertex *v1, GenVertex *v2)
template<class InputIterator, class OutputIterator, class Predicate>
void	copy_if (InputIterator first, InputIterator last, OutputIterator out, Predicate pred)
	define the type of iterator to use
double	clifetime_from_width (double width)
	set lifetime from width
bool	not_in_vector (std::vector< HepMC::GenParticle * > *, GenParticle *)
	returns true if it cannot find GenParticle* in the vector
std::vector< HepMC::GenParticle * >::iterator	already_in_vector (std::vector< HepMC::GenParticle * > *, GenParticle *)
	Returns the index of a GenParticle* within a vector.
void	version ()
	print HepMC version
void	writeVersion (std::ostream &os)
	write HepMC version to os
std::string	versionName ()
	return HepMC version
Variables
static const double	HepMC_hbarc
	hbar * c --> calculated with units of [mm*GeV]
static const double	HepMC_pi = 3.14159265358979323846

---

Detailed Description

All classes in the HepMC packages are in the HepMC namespace.

---

Enumeration Type Documentation

enum HepMC::known_io

The known_io enum is used to track which type of input is being read.

Enumerator:

gen
ascii
extascii
ascii_pdt
extascii_pdt

Definition at line 22 of file CommonIO.h.

{ gen=1, ascii, extascii, ascii_pdt, extascii_pdt };

enum HepMC::IteratorRange

type of iteration

Enumerator:

parents
children
family
ancestors
descendants
relatives

Definition at line 35 of file GenVertex.h.

                       { parents, children, family, 
                         ancestors, descendants, relatives };

---

Function Documentation

bool HepMC::compareGenEvent	(	GenEvent *	,
		GenEvent *
	)

bool HepMC::compareSignalProcessVertex	(	GenEvent *	,
		GenEvent *
	)

bool HepMC::compareBeamParticles	(	GenEvent *	,
		GenEvent *
	)

bool HepMC::compareWeights	(	GenEvent *	,
		GenEvent *
	)

bool HepMC::compareVertices	(	GenEvent *	,
		GenEvent *
	)

bool HepMC::compareParticles	(	GenEvent *	,
		GenEvent *
	)

bool HepMC::compareVertex	(	GenVertex *	v1,
		GenVertex *	v2
	)

template<class InputIterator, class OutputIterator, class Predicate>

void HepMC::copy_if	(	InputIterator	first,
		InputIterator	last,
		OutputIterator	out,
		Predicate	pred
	)

define the type of iterator to use

Definition at line 50 of file GenEvent.h.

                                   {
        for ( ; first != last; ++first ) { if ( pred(*first) ) out = *first; }
    }

double HepMC::clifetime_from_width

(

double

width

)

set lifetime from width

bool HepMC::not_in_vector	(	std::vector< HepMC::GenParticle * > *	,
		GenParticle *
	)

returns true if it cannot find GenParticle* in the vector

std::vector<HepMC::GenParticle*>::iterator HepMC::already_in_vector	(	std::vector< HepMC::GenParticle * > *	,
		GenParticle *
	)

Returns the index of a GenParticle* within a vector.

Returns -1 if GenParticle* is not in the vector.

void HepMC::version

(

)

[inline]

print HepMC version

Definition at line 26 of file Version.h.

{
    std::cout << " --------------- HepMC Version " << versionName()
              << " --------------- " << std::endl;
}

void HepMC::writeVersion

(

std::ostream &

os

)

[inline]

write HepMC version to os

Definition at line 32 of file Version.h.

{
    os << "             HepMC Version: " << versionName() << std::endl;
}

std::string HepMC::versionName

(

)

[inline]

return HepMC version

Definition at line 21 of file Version.h.

{
    return "2.03.09";
}

---

Variable Documentation

const double HepMC::HepMC_hbarc [static]

Initial value:

 (6.6260755e-34 * (1.e-6/1.60217733e-19) / (2*3.14159265358979323846))
                                        * (2.99792458e+8 * 1000.) * 1.e+3

hbar * c --> calculated with units of [mm*GeV]

Definition at line 56 of file ParticleData.h.

const double HepMC::HepMC_pi = 3.14159265358979323846 [static]

Definition at line 19 of file Polarization.h.

---