HEJ::RivetAnalysis Class Reference

Class representing a Rivet analysis. More...

#include <RivetAnalysis.hh>

Inheritance diagram for HEJ::RivetAnalysis:

Collaboration diagram for HEJ::RivetAnalysis:

Public Member Functions
	RivetAnalysis (YAML::Node const &config, LHEF::HEPRUP heprup)
	Constructor. More...
	~RivetAnalysis () override
void	fill (Event const &event, Event const &) override
	Pass an event to the underlying Rivet analysis. More...
bool	pass_cuts (Event const &, Event const &) override
	no additional cuts are applied More...
void	finalise () override
	Finalise analysis. More...
Public Member Functions inherited from HEJ::Analysis
virtual void	fill (Event const &res_event, Event const &FO_event)=0
virtual bool	pass_cuts (Event const &res_event, Event const &FO_event)=0
	Decide whether an event passes the cuts. More...
virtual void	finalise ()=0
	Finalise analysis. More...
virtual	~Analysis ()=default

Static Public Member Functions
static std::unique_ptr< Analysis >	create (YAML::Node const &config, LHEF::HEPRUP const &heprup)
	Create RivetAnalysis. More...

Detailed Description

Class representing a Rivet analysis.

This class inherits from Analysis and can therefore be used like any other HEJ 2 analysis.

Constructor & Destructor Documentation

RivetAnalysis()

HEJ::RivetAnalysis::RivetAnalysis	(	YAML::Node const &	config,
		LHEF::HEPRUP	heprup
	)

Constructor.

Parameters

config	Configuration parameters
heprup	General run informations

config["rivet"] should be the name of a single Rivet analysis or a list of Rivet analyses. config["output"] is the prefix for the .yoda output files.

~RivetAnalysis()

HEJ::RivetAnalysis::~RivetAnalysis ( )

override

Member Function Documentation

create()

static std::unique_ptr< Analysis > HEJ::RivetAnalysis::create ( YAML::Node const &  config, LHEF::HEPRUP const &  heprup  )

static

Create RivetAnalysis.

fill()

void HEJ::RivetAnalysis::fill ( Event const &  event, Event const &    )

overridevirtual

Pass an event to the underlying Rivet analysis.

Implements HEJ::Analysis.

finalise()

void HEJ::RivetAnalysis::finalise ( )

overridevirtual

Finalise analysis.

This function is called after all events have been processed and can be used for example to print out or save the results.

Implements HEJ::Analysis.

pass_cuts()

bool HEJ::RivetAnalysis::pass_cuts ( Event const &  , Event const &    )

inlineoverridevirtual

no additional cuts are applied

Implements HEJ::Analysis.

---

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

• /home/andersen/HEJProjects/website/build/hej/include/HEJ/RivetAnalysis.hh