Mēnsūra
Public Member Functions | List of all members
pec::GeneratorInfo Class Reference

Aggregates basic generator-level information. More...

#include <GeneratorInfo.hpp>

Public Member Functions

 GeneratorInfo () noexcept
 Constructor without parameters.
 
 GeneratorInfo (GeneratorInfo const &)=default
 Default copy constructor.
 
GeneratorInfooperator= (GeneratorInfo const &)=default
 Default assignment operator.
 
void Reset ()
 Resets the object to a state right after the default initialisation.
 
void SetProcessId (int processID)
 Sets process ID. More...
 
void SetNominalWeight (float weight)
 Sets the nominal generator-level weight.
 
void AddAltWeight (float weight)
 Adds an alternative generator-level event weight to the end of the collection.
 
void SetPdfX (unsigned index, float x)
 Sets momentum fraction carried by an initial parton. More...
 
void SetPdfXs (float x1, float x2)
 Sets momentum fractions for both initial partons simultaneously. More...
 
void SetPdfId (unsigned index, int id)
 Sets ID of an initial parton. More...
 
void SetPdfIds (int id1, int id2)
 Sets IDs of both initial partons. More...
 
void SetPdfQScale (float scale)
 Sets energy scale used to evaluate PDF, GeV.
 
int ProcessId () const
 Returns process ID. More...
 
float NominalWeight () const
 Returns the nominal generator-level weight.
 
std::vector< Float_t > const & AltWeights () const
 Returns alternative weights.
 
float PdfX (unsigned index) const
 Returns momentum fraction carried by an initial parton. More...
 
int PdfId (unsigned index) const
 Returns ID of an initial parton. More...
 
float PdfQScale () const
 Returns energy scale used to evaluate PDF, GeV.
 

Detailed Description

Aggregates basic generator-level information.

Member Function Documentation

int pec::GeneratorInfo::PdfId ( unsigned  index) const

Returns ID of an initial parton.

Gluons are encoded with their PDG ID code (21). If the index is larger than 1, an exception is thrown.

float pec::GeneratorInfo::PdfX ( unsigned  index) const

Returns momentum fraction carried by an initial parton.

Throws an exception if the index is larger than 1.

int pec::GeneratorInfo::ProcessId ( ) const

Returns process ID.

This is supposed to be the process ID set be the generator. For instance, different subprocesses in MadGraph are assigned different process IDs.

void pec::GeneratorInfo::SetPdfId ( unsigned  index,
int  id 
)

Sets ID of an initial parton.

Gluons must be encoded with codes 0 or 21 (both are accepted). If the index is larger than 1, an exception is thrown.

void pec::GeneratorInfo::SetPdfIds ( int  id1,
int  id2 
)

Sets IDs of both initial partons.

Internally, calls to SetPdfId, check documentation for this method.

void pec::GeneratorInfo::SetPdfX ( unsigned  index,
float  x 
)

Sets momentum fraction carried by an initial parton.

Throws an exception if the given index is large than or the fraction is illegal.

void pec::GeneratorInfo::SetPdfXs ( float  x1,
float  x2 
)

Sets momentum fractions for both initial partons simultaneously.

Internally, calls to SetPdfX, check documentation for this method.

void pec::GeneratorInfo::SetProcessId ( int  processID)

Sets process ID.

See documentation for the method ProcessID for details.


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