/search.css" rel="stylesheet" type="text/css"/> /search.js">
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

In This Package:

Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
HepMC::IO_HERWIG Class Reference

IO_HERWIG is used to get Herwig information. More...

#include <IO_HERWIG.h>

Inheritance diagram for HepMC::IO_HERWIG:
Inheritance graph
[legend]
Collaboration diagram for HepMC::IO_HERWIG:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 IO_HERWIG ()
virtual ~IO_HERWIG ()
bool fill_next_event (GenEvent *)
 get the next event
void print (std::ostream &ostr=std::cout) const
 write to ostr
double interfaces_to_version_number () const
 this information is dubious
bool print_inconsistency_errors () const
 default is true
void set_print_inconsistency_errors (bool b=1)
 decide whether or not to print inconsistency errors
bool no_gaps_in_barcodes () const
 ask how to deal with extra non-physical pseudo particles
void set_no_gaps_in_barcodes (bool a)
 The HERWIG HEPEVT common block has some EXTRA non-physical ENTRIES (such as CMS frame, HARD subprocess, and CONE).
GenEventread_next_event ()
 do not over-ride
ParticleDataTableread_particle_data_table ()
 do not over-ride
virtual GenEvent *& operator>> (GenEvent *&)
 the same as read_next_event
virtual ParticleDataTable *& operator>> (ParticleDataTable *&)
 the same as read_particle_data_table
virtual const GenEvent *& operator<< (const GenEvent *&)
 the same as write_event
virtual GenEvent *& operator<< (GenEvent *&)
 the same as write_event
virtual const ParticleDataTable *& operator<< (const ParticleDataTable *&)
 the same as write_particle_data_table
virtual ParticleDataTable *& operator<< (ParticleDataTable *&)
 the same as write_particle_data_table

Protected Member Functions

bool trust_both_mothers_and_daughters () const
 default is true
bool trust_mothers_before_daughters () const
 default is false
void set_trust_mothers_before_daughters (bool b=1)
 define mother daughter trust rules
void set_trust_both_mothers_and_daughters (bool b=0)
 define mother daughter trust rules
GenParticlebuild_particle (int index)
 make a particle
void build_production_vertex (int i, std::vector< GenParticle * > &hepevt_particle, GenEvent *evt)
 make a production vertex
void build_end_vertex (int i, std::vector< GenParticle * > &hepevt_particle, GenEvent *evt)
 make a decay vertex
int find_in_map (const std::map< GenParticle *, int > &m, GenParticle *p) const
 find this particle in the map
void repair_hepevt () const
 make the HERWIG HEPEVT common block look like the standard
void remove_gaps_in_hepevt () const
 deal with artifacts of repairing HEPEVT
void zero_hepevt_entry (int i) const
 zero out a HEPEVT pseudo particle
int translate_herwig_to_pdg_id (int i) const
 translate particle ID

Private Member Functions

virtual void write_event (const GenEvent *)
 write this GenEvent
virtual void write_particle_data_table (const ParticleDataTable *)
 write this ParticleDataTable
virtual bool fill_particle_data_table (ParticleDataTable *)
 fill this ParticleDataTable
 IO_HERWIG (const IO_HERWIG &)

Private Attributes

bool m_trust_mothers_before_daughters
bool m_trust_both_mothers_and_daughters
bool m_print_inconsistency_errors
bool m_no_gaps_in_barcodes
std::vector< int > m_herwig_to_pdg_id
std::set< int > m_no_antiparticles

Detailed Description

IO_HERWIG is used to get Herwig information.

IO class for reading the HEPEVT common block from the Herwig monte carlo program.

Definition at line 57 of file IO_HERWIG.h.


Constructor & Destructor Documentation

HepMC::IO_HERWIG::IO_HERWIG ( )
virtual HepMC::IO_HERWIG::~IO_HERWIG ( ) [virtual]
HepMC::IO_HERWIG::IO_HERWIG ( const IO_HERWIG ) [inline, private]

Definition at line 129 of file IO_HERWIG.h.

: IO_BaseClass() {}

Member Function Documentation

bool HepMC::IO_HERWIG::fill_next_event ( GenEvent ) [virtual]

get the next event

Implements HepMC::IO_BaseClass.

void HepMC::IO_HERWIG::print ( std::ostream &  ostr = std::cout) const [virtual]

write to ostr

Reimplemented from HepMC::IO_BaseClass.

double HepMC::IO_HERWIG::interfaces_to_version_number ( ) const [inline]

this information is dubious

Definition at line 66 of file IO_HERWIG.h.

{return 6.400;}
bool HepMC::IO_HERWIG::print_inconsistency_errors ( ) const [inline]

default is true

Definition at line 149 of file IO_HERWIG.h.

void HepMC::IO_HERWIG::set_print_inconsistency_errors ( bool  b = 1) [inline]

decide whether or not to print inconsistency errors

Definition at line 158 of file IO_HERWIG.h.

bool HepMC::IO_HERWIG::no_gaps_in_barcodes ( ) const [inline]

ask how to deal with extra non-physical pseudo particles

Definition at line 75 of file IO_HERWIG.h.

                             { return m_no_gaps_in_barcodes; }
void HepMC::IO_HERWIG::set_no_gaps_in_barcodes ( bool  a) [inline]

The HERWIG HEPEVT common block has some EXTRA non-physical ENTRIES (such as CMS frame, HARD subprocess, and CONE).

These are removed by IO_HERWIG. Thus the HepMC event will APPEAR to have fewer particles in it that herwig did. There is a switch m_no_gaps_in_barcodes. For true - then the extra particles are removed from HEPEVT, with the result that the HepMC barcodes will be sequential, with no gaps. false - the barcodes will correspond directly to the HEPEVT index, but there will be gaps ... ie some barcodes will be unassigned. this switch requested by I Hinchliffe, October 31, 2002

Definition at line 88 of file IO_HERWIG.h.

bool HepMC::IO_HERWIG::trust_both_mothers_and_daughters ( ) const [inline, protected]

default is true

Definition at line 143 of file IO_HERWIG.h.

bool HepMC::IO_HERWIG::trust_mothers_before_daughters ( ) const [inline, protected]

default is false

Definition at line 146 of file IO_HERWIG.h.

void HepMC::IO_HERWIG::set_trust_mothers_before_daughters ( bool  b = 1) [inline, protected]

define mother daughter trust rules

Definition at line 155 of file IO_HERWIG.h.

void HepMC::IO_HERWIG::set_trust_both_mothers_and_daughters ( bool  b = 0) [inline, protected]

define mother daughter trust rules

Definition at line 152 of file IO_HERWIG.h.

GenParticle* HepMC::IO_HERWIG::build_particle ( int  index) [protected]

make a particle

void HepMC::IO_HERWIG::build_production_vertex ( int  i,
std::vector< GenParticle * > &  hepevt_particle,
GenEvent evt 
) [protected]

make a production vertex

void HepMC::IO_HERWIG::build_end_vertex ( int  i,
std::vector< GenParticle * > &  hepevt_particle,
GenEvent evt 
) [protected]

make a decay vertex

int HepMC::IO_HERWIG::find_in_map ( const std::map< GenParticle *, int > &  m,
GenParticle p 
) const [protected]

find this particle in the map

void HepMC::IO_HERWIG::repair_hepevt ( ) const [protected]

make the HERWIG HEPEVT common block look like the standard

void HepMC::IO_HERWIG::remove_gaps_in_hepevt ( ) const [protected]

deal with artifacts of repairing HEPEVT

void HepMC::IO_HERWIG::zero_hepevt_entry ( int  i) const [protected]

zero out a HEPEVT pseudo particle

int HepMC::IO_HERWIG::translate_herwig_to_pdg_id ( int  i) const [protected]

translate particle ID

virtual void HepMC::IO_HERWIG::write_event ( const GenEvent ) [inline, private, virtual]

write this GenEvent

Implements HepMC::IO_BaseClass.

Definition at line 123 of file IO_HERWIG.h.

{}
virtual void HepMC::IO_HERWIG::write_particle_data_table ( const ParticleDataTable ) [inline, private, virtual]

write this ParticleDataTable

Implements HepMC::IO_BaseClass.

Definition at line 124 of file IO_HERWIG.h.

{}
virtual bool HepMC::IO_HERWIG::fill_particle_data_table ( ParticleDataTable ) [inline, private, virtual]

fill this ParticleDataTable

Implements HepMC::IO_BaseClass.

Definition at line 125 of file IO_HERWIG.h.

            { return 0; }
GenEvent * HepMC::IO_BaseClass::read_next_event ( ) [inline, inherited]

do not over-ride

creates a new event and fills it by calling the sister method read_next_event( GenEvent* )

Definition at line 87 of file IO_BaseClass.h.

                                                   {
        // 
        // 1. create an empty event container
        GenEvent* evt = new GenEvent();
        // 2. fill the evt container - if the read is successful, return the
        //    pointer, otherwise return null and delete the evt
        if ( fill_next_event( evt ) ) return evt;
        // note: the below delete is only reached if read fails
        //       ... thus there is not much overhead in new then delete 
        //       since this statement is rarely reached
        delete evt;
        return 0;
    }
ParticleDataTable * HepMC::IO_BaseClass::read_particle_data_table ( ) [inline, inherited]

do not over-ride

creates a new particle data table and fills it by calling the sister method read_particle_data_table( ParticleDataTable* )

Definition at line 103 of file IO_BaseClass.h.

                                                                     {
        //
        // 1. create an empty pdt
        ParticleDataTable* pdt = new ParticleDataTable();
        // 2. fill the pdt container - if the read is successful, return the
        //    pointer, otherwise return null and delete the evt
        if ( fill_particle_data_table( pdt ) ) return pdt;
        // next statement is only reached if read fails
        delete pdt;
        return 0;
    }
GenEvent *& HepMC::IO_BaseClass::operator>> ( GenEvent *&  evt) [inline, virtual, inherited]

the same as read_next_event

Definition at line 121 of file IO_BaseClass.h.

                                                              {
        evt = read_next_event();
        return evt;
    }
ParticleDataTable *& HepMC::IO_BaseClass::operator>> ( ParticleDataTable *&  pdt) [inline, virtual, inherited]

the same as read_particle_data_table

Definition at line 137 of file IO_BaseClass.h.

                                                                    {
        pdt = read_particle_data_table();
        return pdt;
    }
const GenEvent *& HepMC::IO_BaseClass::operator<< ( const GenEvent *&  evt) [inline, virtual, inherited]

the same as write_event

Definition at line 126 of file IO_BaseClass.h.

                                                                     {
        write_event( evt );
        return evt;
    }
GenEvent *& HepMC::IO_BaseClass::operator<< ( GenEvent *&  evt) [inline, virtual, inherited]

the same as write_event

Definition at line 132 of file IO_BaseClass.h.

                                                               {
        write_event( evt );
        return evt;
    }
const ParticleDataTable *& HepMC::IO_BaseClass::operator<< ( const ParticleDataTable *&  pdt) [inline, virtual, inherited]

the same as write_particle_data_table

Definition at line 143 of file IO_BaseClass.h.

                                                                             {
        write_particle_data_table( pdt );
        return pdt;
    }
ParticleDataTable *& HepMC::IO_BaseClass::operator<< ( ParticleDataTable *&  pdt) [inline, virtual, inherited]

the same as write_particle_data_table

Definition at line 149 of file IO_BaseClass.h.

                                                                              {
        write_particle_data_table( pdt );
        return pdt;
    }

Member Data Documentation

Definition at line 132 of file IO_HERWIG.h.

Definition at line 133 of file IO_HERWIG.h.

Definition at line 134 of file IO_HERWIG.h.

Definition at line 135 of file IO_HERWIG.h.

std::vector<int> HepMC::IO_HERWIG::m_herwig_to_pdg_id [private]

Definition at line 136 of file IO_HERWIG.h.

std::set<int> HepMC::IO_HERWIG::m_no_antiparticles [private]

Definition at line 137 of file IO_HERWIG.h.


The documentation for this class was generated from the following file:
| Classes | Job Modules | Data Objects | Services | Algorithms | Tools | Packages | Directories | Tracs |

Generated on Fri May 16 2014 09:49:37 for HepMC by doxygen 1.7.4