HEJ::Analysis Struct Reference

Analysis base class. More...

#include <Analysis.hh>

Inheritance diagram for HEJ::Analysis:

Public Member Functions
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 void	set_xs_scale (double scale)=0
	Set the ratio (cross section) / (sum of event weights) More...
virtual	~Analysis ()=default

Detailed Description

Analysis base class.

This is the interface that all analyses should implement, i.e. all custom analyses have to be derived from this struct.

Constructor & Destructor Documentation

~Analysis()

virtual HEJ::Analysis::~Analysis ( )

virtualdefault

Member Function Documentation

fill()

virtual void HEJ::Analysis::fill ( Event const &  res_event, Event const &  FO_event  )

pure virtual

Parameters

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

Implemented in HEJ::detail::EmptyAnalysis, and HEJ::RivetAnalysis.

finalise()

virtual void HEJ::Analysis::finalise ( )

pure virtual

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.

Implemented in HEJ::detail::EmptyAnalysis, and HEJ::RivetAnalysis.

pass_cuts()

virtual bool HEJ::Analysis::pass_cuts ( Event const &  res_event, Event const &  FO_event  )

pure virtual

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

Implemented in HEJ::detail::EmptyAnalysis, and HEJ::RivetAnalysis.

set_xs_scale()

virtual void HEJ::Analysis::set_xs_scale ( double  scale )

pure virtual

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

Implemented in HEJ::detail::EmptyAnalysis, and HEJ::RivetAnalysis.

---

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

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