StRoot  1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Classes | Enumerations | Functions
HepMC Namespace Reference

Classes

class  Flow
 The flow object. More...
 
class  GenCrossSection
 The GenCrossSection class stores the generated cross section. More...
 
class  GenEvent
 The GenEvent class is the core of HepMC. More...
 
class  GenParticle
 The GenParticle class contains information about generated particles. More...
 
class  GenEventVertexRange
 GenEventVertexRange acts like a collection of vertices. More...
 
class  ConstGenEventVertexRange
 ConstGenEventVertexRange acts like a collection of vertices. More...
 
class  GenEventParticleRange
 GenEventParticleRange acts like a collection of particles. More...
 
class  ConstGenEventParticleRange
 ConstGenEventParticleRange acts like a collection of particles. More...
 
class  GenVertexParticleRange
 GenVertexParticleRange acts like a collection of particles. More...
 
class  GenParticleProductionRange
 GenParticleProductionRange acts like a collection of particles. More...
 
class  ConstGenParticleProductionRange
 
class  GenParticleEndRange
 GenParticleEndRange acts like a collection of particles. More...
 
class  ConstGenParticleEndRange
 
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_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_Exception
 IO exception handling. 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  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  StreamInfo
 StreamInfo contains extra information needed when using streaming IO. 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...
 
class  I_Pythia8
 
class  Pythia8ToHepMC
 
class  Pythia8ToHepMCException
 
class  PartonEndVertexException
 

Enumerations

enum  IteratorRange {
  parents, children, family, ancestors,
  descendants, relatives
}
 type of iteration
 
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.
 

Functions

GenCrossSection getHerwigCrossSection (int ngen)
 calculate the Herwig cross section and statistical error
 
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)
 
std::ostream & operator<< (std::ostream &os, GenCrossSection &xs)
 
std::istream & operator>> (std::istream &is, GenCrossSection &xs)
 
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
 
std::ostream & operator<< (std::ostream &, GenEvent &)
 standard streaming IO output operator More...
 
std::istream & operator>> (std::istream &, GenEvent &)
 standard streaming IO input operator
 
std::istream & set_input_units (std::istream &, Units::MomentumUnit, Units::LengthUnit)
 set the units for this input stream
 
std::ostream & write_HepMC_IO_block_begin (std::ostream &)
 Explicitly write the begin block lines that IO_GenEvent uses.
 
std::ostream & write_HepMC_IO_block_end (std::ostream &)
 Explicitly write the end block line that IO_GenEvent uses.
 
GenEventconvert_units (GenEvent &evt, Units::MomentumUnit m, Units::LengthUnit l)
 
std::ostream & operator<< (std::ostream &, HeavyIon const *)
 Write the contents of HeavyIon to an output stream. More...
 
std::istream & operator>> (std::istream &, HeavyIon *)
 Read the contents of HeavyIon from an input stream. More...
 
std::ostream & operator<< (std::ostream &, PdfInfo const *)
 
std::istream & operator>> (std::istream &, PdfInfo *)
 
GenCrossSection getPythiaCrossSection ()
 calculate the Pythia cross section and statistical error
 
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 true if GenParticle is in the vector More...
 
void version (std::ostream &os=std::cout)
 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)
 send Flow informatin to ostr for printing More...
 
void HepMCStreamCallback (std::ios_base::event e, std::ios_base &b, int i)
 
template<class IO >
StreamInfoget_stream_info (IO &iost)
 
std::ostream & establish_output_stream_info (std::ostream &os)
 
std::istream & establish_input_stream_info (std::istream &is)
 
std::ostream & operator<< (std::ostream &ostr, const GenParticle &part)
 Dump this particle's full info to ostr. More...
 
std::ostream & operator<< (std::ostream &ostr, const GenVertex &vtx)
 send vertex information to ostr for printing More...
 
std::ostream & operator<< (std::ostream &ostr, const Polarization &polar)
 write theta and phi to the output stream More...
 
bool not_in_vector (std::vector< GenParticle * > *v, GenParticle *p)
 returns true if it cannot find GenParticle* in the vector
 
std::vector
< HepMC::GenParticle * >
::iterator 
already_in_vector (std::vector< GenParticle * > *v, GenParticle *p)
 returns true if GenParticle is in the vector More...
 

Detailed Description

All classes in the HepMC packages are in the HepMC namespace

Function Documentation

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

returns true if GenParticle is in the vector

Returns the index of a GenParticle* within a vector. Returns -1 if GenParticle* is not in the vector.

Definition at line 18 of file SearchVector.cc.

Referenced by not_in_vector(), HepMC::GenVertex::remove_particle_in(), and HepMC::GenVertex::remove_particle_out().

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

returns true if GenParticle is in the vector

Returns the index of a GenParticle* within a vector. Returns -1 if GenParticle* is not in the vector.

Definition at line 18 of file SearchVector.cc.

Referenced by not_in_vector(), HepMC::GenVertex::remove_particle_in(), and HepMC::GenVertex::remove_particle_out().

template<class IO >
StreamInfo& HepMC::get_stream_info ( IO iost)

A custom iomanip that allows us to store and access user data (StreamInfo) associated with the stream. This method creates the StreamInfo object the first time it is called.

Definition at line 51 of file GenEventStreamIO.cc.

References HepMCStreamCallback().

Referenced by HepMC::GenEvent::read(), set_input_units(), HepMC::GenEvent::write(), write_HepMC_IO_block_begin(), and write_HepMC_IO_block_end().

void HepMC::HepMCStreamCallback ( std::ios_base::event  e,
std::ios_base &  b,
int  i 
)

This method is called by the stream destructor. It does cleanup on stored user data (StreamInfo) and is registered by the first call to get_stream_info().

Definition at line 29 of file GenEventStreamIO.cc.

References HepMC::StreamInfo::stream_id().

Referenced by get_stream_info().

std::ostream& HepMC::operator<< ( std::ostream &  ostr,
const Polarization &  polar 
)

write theta and phi to the output stream

print polarization information

Definition at line 129 of file Polarization.cc.

References HepMC::Polarization::phi(), and HepMC::Polarization::theta().

std::ostream & HepMC::operator<< ( std::ostream &  os,
HeavyIon const *  ion 
)
std::ostream& HepMC::operator<< ( std::ostream &  ostr,
const GenParticle &  part 
)
std::ostream& HepMC::operator<< ( std::ostream &  ostr,
const Flow f 
)

send Flow informatin to ostr for printing

for printing

Definition at line 190 of file Flow.cc.

std::ostream& HepMC::operator<< ( std::ostream &  ostr,
const GenVertex &  vtx 
)

send vertex information to ostr for printing

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 &  os,
GenEvent &  evt 
)

standard streaming IO output operator

Writes evt to an output stream.

Writes evt to an output stream.

Definition at line 355 of file GenEventStreamIO.cc.

References HepMC::GenEvent::write().

std::istream & HepMC::operator>> ( std::istream &  is,
HeavyIon *  ion 
)