group Main analysis methods

Main analysis methods

Functions

Name
virtual voidinit()
virtual voidanalyze(const Event & event) =0
virtual voidfinalize()

Functions Documentation

function init

inline virtual void init()

Reimplemented by: Rivet::MC_JetAnalysis::init, Rivet::MC_JetSplittings::init, Rivet::MC_ParticleAnalysis::init

Initialize this analysis object. A concrete class should here book all necessary histograms. An overridden function must make sure it first calls the base class function.

function analyze

virtual void analyze(
    const Event & event
) =0

Reimplemented by: Rivet::MC_JetAnalysis::analyze, Rivet::MC_JetSplittings::analyze, Rivet::MC_ParticleAnalysis::analyze

Analyze one event. A concrete class should here apply the necessary projections on the event and fill the relevant histograms. An overridden function must make sure it first calls the base class function.

function finalize

inline virtual void finalize()

Reimplemented by: Rivet::MC_JetAnalysis::finalize, Rivet::MC_JetSplittings::finalize, Rivet::MC_ParticleAnalysis::finalize

Finalize this analysis object. A concrete class should here make all necessary operations on the histograms. Writing the histograms to a file is, however, done by the Rivet class. An overridden function must make sure it first calls the base class function.


Updated on 2022-08-07 at 20:17:18 +0100