HEJ::HDF5Writer Class Reference

This is an event writer specifically for HDF5 output. More...

#include <HDF5Writer.hh>

Inheritance diagram for HEJ::HDF5Writer:

Collaboration diagram for HEJ::HDF5Writer:

Public Member Functions
	HDF5Writer (std::string const &file, LHEF::HEPRUP heprup)
	Constructor. More...
	HDF5Writer (std::string const &file, LHEF::HEPRUP heprup, std::string_view config)
	Constructor. More...
	HDF5Writer ()=delete
void	write (Event const &ev) override
	Write an event to the output file. More...
void	set_xs_scale (double scale) override
	Set the ratio (cross section) / (sum of event weights) More...
void	finish () override
	Finish writing. More...
	~HDF5Writer () override
Public Member Functions inherited from HEJ::EventWriter
virtual	~EventWriter ()=default

Additional Inherited Members
Protected Member Functions inherited from HEJ::EventWriter
void	finish_or_abort (EventWriter *writer, std::string const &name) const noexcept
	If writer is not finished run finish() and abort on error. More...
bool	finished () const

Detailed Description

This is an event writer specifically for HDF5 output.

Constructor & Destructor Documentation

HDF5Writer() [1/3]

HEJ::HDF5Writer::HDF5Writer	(	std::string const &	file,
		LHEF::HEPRUP	heprup
	)

Constructor.

Parameters

file	name of the output file
heprup	general process information

HDF5Writer() [2/3]

HEJ::HDF5Writer::HDF5Writer	(	std::string const &	file,
		LHEF::HEPRUP	heprup,
		std::string_view	config
	)

Constructor.

Parameters

file	name of the output file
heprup	general process information
config	HEJ configuration

This constructor will write the init group of an event file in the format specified in arXiv:1905.05120 to the given output file. In addition, a header group will be created. If heprup.generators is non-empty, the header group will contain a dataset containing the configuration passed via the config argument. The name of the dataset is the last element of heprup.generators with all spaces removed.

HDF5Writer() [3/3]

HEJ::HDF5Writer::HDF5Writer ( )

delete

~HDF5Writer()

HEJ::HDF5Writer::~HDF5Writer ( )

override

Member Function Documentation

finish()

void HEJ::HDF5Writer::finish ( )

overridevirtual

Finish writing.

Reimplemented from HEJ::EventWriter.

set_xs_scale()

void HEJ::HDF5Writer::set_xs_scale ( double  scale )

overridevirtual

Set the ratio (cross section) / (sum of event weights)

Implements HEJ::EventWriter.

write()

void HEJ::HDF5Writer::write ( Event const &  ev )

overridevirtual

Write an event to the output file.

Implements HEJ::EventWriter.

---

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

• /home/amaier/tmp/website/build/hej/include/HEJ/HDF5Writer.hh