hej is hosted by Hepforge, IPPP Durham
HEJ 2.1.4
High energy resummation for hadron colliders
Loading...
Searching...
No Matches
HEJ::Analysis Struct Referenceabstract

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 ~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_eventThe event in resummation phase space
FO_eventThe original fixed-order event

Implemented in HEJ::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::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_eventThe event in resummation phase space
FO_eventThe original fixed-order event
Returns
Whether the event passes all cuts

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


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