HepMC event record
Public Member Functions | Data Fields | Protected Member Functions
GenPdfInfo Class Reference

Detailed Description

Stores additional information about PDFs.

This is an example of event attribute used to store PDF-related information

Note
Input parton flavour codes id1 & id2 are expected to obey the PDG code conventions, especially g = 21.
The contents of pdf1 and pdf2 are expected to be x*f(x). The LHAPDF set ids are the entries in the first column of http:///projects.hepforge.org/lhapdf/PDFsets.index
Examples:
HepMC3_fileIO_example.cc.

Definition at line 32 of file build/outputs/include/HepMC/GenPdfInfo.h.

#include <GenPdfInfo.h>

+ Inheritance diagram for GenPdfInfo:
+ Collaboration diagram for GenPdfInfo:

Public Member Functions

bool from_string (const string &att)
 Implementation of Attribute::from_string. More...
 
bool to_string (string &att) const
 Implementation of Attribute::to_string. More...
 
void set (int parton_id1, int parton_id2, double x1, double x2, double scale_in, double xf1, double xf2, int pdf_id1=0, int pdf_id2=0)
 Set all fields. More...
 
bool operator== (const GenPdfInfo &) const
 Operator ==. More...
 
bool operator!= (const GenPdfInfo &) const
 Operator !=. More...
 
bool is_valid () const
 Verify that the instance contains non-zero information. More...
 
bool from_string (const string &att)
 Implementation of Attribute::from_string. More...
 
bool to_string (string &att) const
 Implementation of Attribute::to_string. More...
 
void set (int parton_id1, int parton_id2, double x1, double x2, double scale_in, double xf1, double xf2, int pdf_id1=0, int pdf_id2=0)
 Set all fields. More...
 
bool operator== (const GenPdfInfo &) const
 Operator ==. More...
 
bool operator!= (const GenPdfInfo &) const
 Operator !=. More...
 
bool is_valid () const
 Verify that the instance contains non-zero information. More...
 
virtual bool init (const GenEvent &)
 Optionally initialize the attribute after from_string. More...
 
virtual bool init (const GenRunInfo &)
 Optionally initialize the attribute after from_string. More...
 
virtual bool init (const GenEvent &)
 Optionally initialize the attribute after from_string. More...
 
virtual bool init (const GenRunInfo &)
 Optionally initialize the attribute after from_string. More...
 
bool is_parsed ()
 Check if this attribute is parsed. More...
 
bool is_parsed ()
 Check if this attribute is parsed. More...
 
const string & unparsed_string () const
 Get unparsed string. More...
 
const string & unparsed_string () const
 Get unparsed string. More...
 

Data Fields

int parton_id [2]
 Parton PDG ID. More...
 
int pdf_id [2]
 LHAPDF ID code. More...
 
double scale
 Factorisation scale (in GEV) More...
 
double x [2]
 Parton momentum fraction. More...
 
double xf [2]
 PDF value. More...
 

Protected Member Functions

void set_is_parsed (bool flag)
 Set is_parsed flag. More...
 
void set_is_parsed (bool flag)
 Set is_parsed flag. More...
 
void set_unparsed_string (const string &st)
 Set unparsed string. More...
 
void set_unparsed_string (const string &st)
 Set unparsed string. More...
 

Member Function Documentation

◆ from_string() [1/2]

bool from_string ( const string &  att)
virtual

Implementation of Attribute::from_string.

Implements Attribute.

Definition at line 18 of file GenPdfInfo.cc.

References GenPdfInfo::parton_id, GenPdfInfo::pdf_id, GenPdfInfo::scale, GenPdfInfo::x, and GenPdfInfo::xf.

◆ from_string() [2/2]

bool from_string ( const string &  att)
virtual

Implementation of Attribute::from_string.

Implements Attribute.

◆ init() [1/4]

virtual bool init ( const GenEvent )
inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenEvent object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 73 of file build/outputs/include/HepMC/Attribute.h.

◆ init() [2/4]

virtual bool init ( const GenEvent )
inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenEvent object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 73 of file include/HepMC/Attribute.h.

◆ init() [3/4]

virtual bool init ( const GenRunInfo )
inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenRunInfo object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 82 of file include/HepMC/Attribute.h.

◆ init() [4/4]

virtual bool init ( const GenRunInfo )
inlinevirtualinherited

Optionally initialize the attribute after from_string.

Is passed a reference to the GenRunInfo object to which the Attribute belongs.

Reimplemented in HEPEUPAttribute, and HEPEUPAttribute.

Definition at line 82 of file build/outputs/include/HepMC/Attribute.h.

◆ is_parsed() [1/2]

bool is_parsed ( )
inlineinherited

Check if this attribute is parsed.

Definition at line 94 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::m_is_parsed.

◆ is_parsed() [2/2]

bool is_parsed ( )
inlineinherited

Check if this attribute is parsed.

Definition at line 94 of file include/HepMC/Attribute.h.

References Attribute::m_is_parsed.

◆ is_valid() [1/2]

bool is_valid ( ) const

Verify that the instance contains non-zero information.

◆ is_valid() [2/2]

bool is_valid ( ) const

Verify that the instance contains non-zero information.

Definition at line 91 of file GenPdfInfo.cc.

References GenPdfInfo::parton_id, GenPdfInfo::pdf_id, GenPdfInfo::scale, GenPdfInfo::x, and GenPdfInfo::xf.

◆ operator!=() [1/2]

bool operator!= ( const GenPdfInfo a) const

Operator !=.

Definition at line 87 of file GenPdfInfo.cc.

◆ operator!=() [2/2]

bool operator!= ( const GenPdfInfo ) const

Operator !=.

◆ operator==() [1/2]

bool operator== ( const GenPdfInfo ) const

Operator ==.

◆ operator==() [2/2]

bool operator== ( const GenPdfInfo a) const

Operator ==.

Definition at line 83 of file GenPdfInfo.cc.

◆ set() [1/2]

void set ( int  parton_id1,
int  parton_id2,
double  x1,
double  x2,
double  scale_in,
double  xf1,
double  xf2,
int  pdf_id1 = 0,
int  pdf_id2 = 0 
)

Set all fields.

◆ set() [2/2]

void set ( int  parton_id1,
int  parton_id2,
double  x1,
double  x2,
double  scale_in,
double  xf1,
double  xf2,
int  pdf_id1 = 0,
int  pdf_id2 = 0 
)

Set all fields.

Definition at line 69 of file GenPdfInfo.cc.

References GenPdfInfo::parton_id, GenPdfInfo::pdf_id, GenPdfInfo::scale, GenPdfInfo::x, and GenPdfInfo::xf.

◆ set_is_parsed() [1/2]

void set_is_parsed ( bool  flag)
inlineprotectedinherited

Set is_parsed flag.

Definition at line 101 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::m_is_parsed.

◆ set_is_parsed() [2/2]

void set_is_parsed ( bool  flag)
inlineprotectedinherited

Set is_parsed flag.

Definition at line 101 of file include/HepMC/Attribute.h.

References Attribute::m_is_parsed.

◆ set_unparsed_string() [1/2]

void set_unparsed_string ( const string &  st)
inlineprotectedinherited

Set unparsed string.

Definition at line 104 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::m_string.

◆ set_unparsed_string() [2/2]

void set_unparsed_string ( const string &  st)
inlineprotectedinherited

Set unparsed string.

Definition at line 104 of file include/HepMC/Attribute.h.

References Attribute::m_string.

◆ to_string() [1/2]

bool to_string ( string &  att) const
virtual

Implementation of Attribute::to_string.

Implements Attribute.

◆ to_string() [2/2]

bool to_string ( string &  att) const
virtual

Implementation of Attribute::to_string.

Implements Attribute.

Definition at line 50 of file GenPdfInfo.cc.

References GenPdfInfo::parton_id, GenPdfInfo::pdf_id, GenPdfInfo::scale, GenPdfInfo::x, and GenPdfInfo::xf.

◆ unparsed_string() [1/2]

const string& unparsed_string ( ) const
inlineinherited

Get unparsed string.

Definition at line 97 of file build/outputs/include/HepMC/Attribute.h.

References Attribute::m_string.

◆ unparsed_string() [2/2]

const string& unparsed_string ( ) const
inlineinherited

Get unparsed string.

Definition at line 97 of file include/HepMC/Attribute.h.

References Attribute::m_string.

Field Documentation

◆ parton_id

int parton_id

Parton PDG ID.

Definition at line 38 of file build/outputs/include/HepMC/GenPdfInfo.h.

◆ pdf_id

int pdf_id

LHAPDF ID code.

Definition at line 39 of file build/outputs/include/HepMC/GenPdfInfo.h.

◆ scale

double scale

Factorisation scale (in GEV)

Definition at line 40 of file build/outputs/include/HepMC/GenPdfInfo.h.

◆ x

double x

Parton momentum fraction.

Definition at line 41 of file build/outputs/include/HepMC/GenPdfInfo.h.

◆ xf

double xf

PDF value.

Definition at line 42 of file build/outputs/include/HepMC/GenPdfInfo.h.


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