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)
	Constructor. More...
void	fill (HEJ::Event const &event, HEJ::Event const &) override
	Pass an event to the underlying Rivet analysis. More...
bool	pass_cuts (HEJ::Event const &, HEJ::Event const &) override
	Decide whether an event passes the cuts. 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
	Fill event into analysis (e.g. to histograms) More...
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)

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

)

Constructor.

Parameters

config

Configuration parameters

config["analysis"] 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.

Member Function Documentation

create()

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

static

fill()

void HEJ::RivetAnalysis::fill ( HEJ::Event const &  event, HEJ::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 ( HEJ::Event const &  res_event, HEJ::Event const &  FO_event  )

inlineoverridevirtual

Decide whether an event passes the cuts.

Parameters

res_event	The event in resummation phase space
FO_event	The original fixed-order event

Returns

Whether the event passes all cuts

Implements HEJ::Analysis.

---

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

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