hej is hosted by Hepforge, IPPP Durham
HEJ 2.1.4
High energy resummation for hadron colliders
Loading...
Searching...
No Matches
HEJ::HepMC3Interface Class Reference

This class converts the Events into HepMC3::GenEvents. More...

#include <HepMC3Interface.hh>

Public Member Functions

 HepMC3Interface (LHEF::HEPRUP heprup)
 
 ~HepMC3Interface ()
 
HepMC3Interfaceoperator= (HepMC3Interface const &other)=default
 
 HepMC3Interface (HepMC3Interface const &other)=default
 
HepMC3Interfaceoperator= (HepMC3Interface &&other)=default
 
 HepMC3Interface (HepMC3Interface &&other)=default
 
HepMC3::GenEvent operator() (Event const &event, int weight_index=-1)
 main function to convert an event into HepMC3::GenEvent More...
 
void set_central (HepMC3::GenEvent &out_ev, Event const &event, int weight_index=-1)
 Sets the central value from event to out_ev. More...
 
std::shared_ptr< HepMC3::GenRunInfo > run_info ()
 Pointer to generic run informations. More...
 

Protected Member Functions

HepMC3::GenEvent init_event (Event const &event) const
 initialise generic event infomrations (not central weights) More...
 

Detailed Description

This class converts the Events into HepMC3::GenEvents.

The output is depended on the HepMC3 version HEJ is compiled with, both HepMC3 2 and HepMC3 3 are supported. If HEJ 2 is compiled without HepMC3 calling this interface will throw an error.

This interface will also keep track of the cross section of all the events that being fed into it.

Constructor & Destructor Documentation

◆ HepMC3Interface() [1/3]

HEJ::HepMC3Interface::HepMC3Interface ( LHEF::HEPRUP  heprup)

◆ ~HepMC3Interface()

HEJ::HepMC3Interface::~HepMC3Interface ( )

◆ HepMC3Interface() [2/3]

HEJ::HepMC3Interface::HepMC3Interface ( HepMC3Interface const &  other)
default

◆ HepMC3Interface() [3/3]

HEJ::HepMC3Interface::HepMC3Interface ( HepMC3Interface &&  other)
default

Member Function Documentation

◆ init_event()

HepMC3::GenEvent HEJ::HepMC3Interface::init_event ( Event const &  event) const
protected

initialise generic event infomrations (not central weights)

Parameters
eventEvent to convert

◆ operator()()

HepMC3::GenEvent HEJ::HepMC3Interface::operator() ( Event const &  event,
int  weight_index = -1 
)

main function to convert an event into HepMC3::GenEvent

Parameters
eventEvent to convert
weight_indexoptional selection of specific weight (negative value gives central weight)

◆ operator=() [1/2]

HepMC3Interface & HEJ::HepMC3Interface::operator= ( HepMC3Interface &&  other)
default

◆ operator=() [2/2]

HepMC3Interface & HEJ::HepMC3Interface::operator= ( HepMC3Interface const &  other)
default

◆ run_info()

std::shared_ptr< HepMC3::GenRunInfo > HEJ::HepMC3Interface::run_info ( )
inline

Pointer to generic run informations.

◆ set_central()

void HEJ::HepMC3Interface::set_central ( HepMC3::GenEvent &  out_ev,
Event const &  event,
int  weight_index = -1 
)

Sets the central value from event to out_ev.

Parameters
out_evHepMC3::GenEvent to write to
eventEvent to convert
weight_indexoptional selection of specific weight (negative value gives "central")

This overwrites the central value of out_ev.


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