![]() |
HepMC Reference DocumentationHepMC |
Classes | |
class | CommonIO |
class | Flow |
The flow object. More... | |
class | GenEvent |
The GenEvent class is the core of HepMC. More... | |
class | GenParticle |
The GenParticle class contains information about generated particles. More... | |
class | GenVertex |
GenVertex contains information about decay vertices. More... | |
class | HeavyIon |
The HeavyIon class stores information about heavy ions. More... | |
class | HEPEVT_Wrapper |
Generic Wrapper for the fortran HEPEVT common block. More... | |
class | IO_Ascii |
IO_Ascii is used to read or write from an ascii file. More... | |
class | IO_AsciiParticles |
event input/output in ascii format for eye and machine reading More... | |
class | IO_BaseClass |
all input/output classes inherit from IO_BaseClass More... | |
class | IO_ExtendedAscii |
IO_ExtendedAscii also deals with HeavyIon and PdfInfo. More... | |
class | IO_GenEvent |
IO_GenEvent also deals with HeavyIon and PdfInfo. More... | |
class | IO_HEPEVT |
HEPEVT IO class. More... | |
class | IO_HERWIG |
IO_HERWIG is used to get Herwig information. More... | |
class | IO_PDG_ParticleDataTable |
an example ParticleDataTable IO method More... | |
class | ParticleData |
an example ParticleData class More... | |
class | ParticleDataTable |
an example ParticleDataTable class More... | |
class | PdfInfo |
The PdfInfo class stores PDF information. More... | |
class | Polarization |
The Polarization class stores theta and phi for a GenParticle. More... | |
class | FourVector |
FourVector is a simple representation of a physics 4 vector. More... | |
class | ThreeVector |
ThreeVector is a simple representation of a position or displacement 3 vector. More... | |
class | TempParticleMap |
TempParticleMap is a temporary GenParticle* container used during input. More... | |
class | WeightContainer |
Container for the Weights associated with an event or vertex. 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 *) |
void | version () |
print HepMC version | |
void | writeVersion (std::ostream &os) |
write HepMC version to os | |
std::string | versionName () |
return HepMC version | |
std::ostream & | operator<< (std::ostream &ostr, const Flow &f) |
for printing | |
std::ostream & | operator<< (std::ostream &ostr, const GenParticle &part) |
print particle | |
std::ostream & | operator<< (std::ostream &ostr, const GenVertex &vtx) |
print vertex information | |
std::ostream & | operator<< (std::ostream &ostr, const ParticleData &pdata) |
write to ostr | |
std::ostream & | operator<< (std::ostream &ostr, const Polarization &polar) |
print polarization information | |
bool | not_in_vector (std::vector< GenParticle * > *v, GenParticle *p) |
std::vector< HepMC::GenParticle * >::iterator | already_in_vector (std::vector< GenParticle * > *v, GenParticle *p) |
returns true if GenParticle is in the vector | |
Variables | |
static const double | HepMC_hbarc |
hbar * c --> calculated with units of [mm*GeV] | |
static const double | HepMC_pi = 3.14159265358979323846 |
enum HepMC::IteratorRange |
enum HepMC::known_io |
The known_io enum is used to track which type of input is being read.
Definition at line 22 of file CommonIO.h.
std::vector<HepMC::GenParticle*>::iterator HepMC::already_in_vector | ( | std::vector< GenParticle * > * | v, | |
GenParticle * | p | |||
) |
returns true if GenParticle is in the vector
Definition at line 18 of file SearchVector.cc.
References p.
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.
Referenced by not_in_vector(), HepMC::GenVertex::remove_particle_in(), and HepMC::GenVertex::remove_particle_out().
double HepMC::clifetime_from_width | ( | double | width | ) |
set lifetime from width
if you want to instantiate the particle lifetime from its width, use this static method inside the constructor:
Definition at line 110 of file ParticleData.cc.
References HepMC_hbarc.
Referenced by main(), and HepMC::IO_PDG_ParticleDataTable::read_entry().
bool HepMC::compareBeamParticles | ( | GenEvent * | , | |
GenEvent * | ||||
) |
Definition at line 77 of file CompareGenEvent.cc.
References HepMC::GenEvent::beam_particles().
Referenced by compareGenEvent().
bool HepMC::compareGenEvent | ( | GenEvent * | , | |
GenEvent * | ||||
) |
Definition at line 16 of file CompareGenEvent.cc.
References HepMC::GenEvent::alphaQCD(), HepMC::GenEvent::alphaQED(), compareBeamParticles(), compareParticles(), compareSignalProcessVertex(), compareVertices(), compareWeights(), HepMC::GenEvent::event_number(), HepMC::GenEvent::event_scale(), HepMC::GenEvent::heavy_ion(), HepMC::GenEvent::mpi(), HepMC::GenEvent::pdf_info(), HepMC::GenEvent::random_states(), and HepMC::GenEvent::signal_process_id().
Referenced by main().
bool HepMC::compareParticles | ( | GenEvent * | , | |
GenEvent * | ||||
) |
Definition at line 109 of file CompareGenEvent.cc.
References HepMC::GenEvent::particles_begin(), HepMC::GenEvent::particles_end(), and HepMC::GenEvent::particles_size().
Referenced by compareGenEvent().
bool HepMC::compareSignalProcessVertex | ( | GenEvent * | , | |
GenEvent * | ||||
) |
Definition at line 64 of file CompareGenEvent.cc.
References HepMC::GenEvent::signal_process_vertex().
Referenced by compareGenEvent().
bool HepMC::compareVertex | ( | GenVertex * | v1, | |
GenVertex * | v2 | |||
) |
Definition at line 152 of file CompareGenEvent.cc.
References HepMC::GenVertex::barcode(), HepMC::GenVertex::particles_in_const_begin(), HepMC::GenVertex::particles_in_const_end(), HepMC::GenVertex::particles_in_size(), HepMC::GenVertex::particles_out_const_begin(), HepMC::GenVertex::particles_out_const_end(), HepMC::GenVertex::particles_out_size(), and HepMC::GenVertex::position().
Referenced by compareVertices().
bool HepMC::compareVertices | ( | GenEvent * | , | |
GenEvent * | ||||
) |
Definition at line 131 of file CompareGenEvent.cc.
References HepMC::GenEvent::barcode_to_vertex(), compareVertex(), v, HepMC::GenEvent::vertices_begin(), HepMC::GenEvent::vertices_end(), and HepMC::GenEvent::vertices_size().
Referenced by compareGenEvent().
bool HepMC::compareWeights | ( | GenEvent * | , | |
GenEvent * | ||||
) |
Definition at line 92 of file CompareGenEvent.cc.
References HepMC::WeightContainer::size(), and HepMC::GenEvent::weights().
Referenced by compareGenEvent().
void HepMC::copy_if | ( | InputIterator | first, | |
InputIterator | last, | |||
OutputIterator | out, | |||
Predicate | pred | |||
) | [inline] |
define the type of iterator to use
Definition at line 50 of file GenEvent.h.
Referenced by main().
bool HepMC::not_in_vector | ( | std::vector< GenParticle * > * | v, | |
GenParticle * | p | |||
) |
bool HepMC::not_in_vector | ( | std::vector< HepMC::GenParticle * > * | , | |
GenParticle * | ||||
) |
returns true if it cannot find GenParticle* in the vector
Referenced by HepMC::Flow::connected_partners(), and HepMC::Flow::dangling_connected_partners().
std::ostream& HepMC::operator<< | ( | std::ostream & | ostr, | |
const Polarization & | polar | |||
) |
print polarization information
Definition at line 107 of file Polarization.cc.
References HepMC::Polarization::phi(), and HepMC::Polarization::theta().
std::ostream& HepMC::operator<< | ( | std::ostream & | ostr, | |
const ParticleData & | pdata | |||
) |
write to ostr
Definition at line 94 of file ParticleData.cc.
References HepMC::ParticleData::charge(), HepMC::ParticleData::clifetime(), HepMC::ParticleData::mass(), HepMC::ParticleData::name(), HepMC::ParticleData::pdg_id(), and HepMC::ParticleData::spin().
std::ostream& HepMC::operator<< | ( | std::ostream & | ostr, | |
const GenVertex & | vtx | |||
) |
print vertex information
Definition at line 440 of file GenVertex.cc.
References HepMC::GenVertex::barcode(), HepMC::GenVertex::position(), and HepMC::FourVector::x().
std::ostream& HepMC::operator<< | ( | std::ostream & | ostr, | |
const GenParticle & | part | |||
) |
print particle
Definition at line 189 of file GenParticle.cc.
References HepMC::GenVertex::barcode(), HepMC::GenParticle::barcode(), HepMC::FourVector::e(), HepMC::GenParticle::end_vertex(), HepMC::GenParticle::momentum(), HepMC::GenParticle::pdg_id(), HepMC::FourVector::px(), HepMC::FourVector::py(), HepMC::FourVector::pz(), and HepMC::GenParticle::status().
std::ostream& HepMC::operator<< | ( | std::ostream & | ostr, | |
const Flow & | f | |||
) |
void HepMC::version | ( | ) | [inline] |
std::string HepMC::versionName | ( | ) | [inline] |
return HepMC version
Definition at line 21 of file Version.h.
Referenced by version(), HepMC::IO_GenEvent::write_event(), HepMC::IO_ExtendedAscii::write_event(), HepMC::IO_AsciiParticles::write_event(), HepMC::IO_Ascii::write_event(), and writeVersion().
void HepMC::writeVersion | ( | std::ostream & | os | ) | [inline] |
write HepMC version to os
Definition at line 32 of file Version.h.
References versionName().
Referenced by HepMC::GenEvent::print_version().
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
Definition at line 56 of file ParticleData.h.
Referenced by clifetime_from_width(), HepMC::ParticleData::set_width(), and HepMC::ParticleData::width().
const double HepMC::HepMC_pi = 3.14159265358979323846 [static] |
Definition at line 19 of file Polarization.h.