Jpp  18.1.0
the software that should make you happy
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Public Member Functions | List of all members
JAANET::JEvtWeightInterface Struct Referenceabstract

Low-level interface for event weighing. More...

#include <JEvtWeightInterface.hh>

Inheritance diagram for JAANET::JEvtWeightInterface:
JAANET::JEvtWeight

Public Member Functions

virtual void configure (const JHead &header)=0
 Configuration. More...
 
virtual bool check (const JHead &header) const =0
 Check whether header is consistent with this event weighter. More...
 
virtual double getWeight (const Evt &evt) const =0
 Get weight of given event. More...
 
virtual double getNormalisation () const =0
 Get event-weight normalisation factor. More...
 

Detailed Description

Low-level interface for event weighing.

Definition at line 19 of file JEvtWeightInterface.hh.

Member Function Documentation

virtual void JAANET::JEvtWeightInterface::configure ( const JHead header)
pure virtual

Configuration.

Parameters
headerheader
virtual bool JAANET::JEvtWeightInterface::check ( const JHead header) const
pure virtual

Check whether header is consistent with this event weighter.

Parameters
headerheader
Returns
true if consistent; else false
virtual double JAANET::JEvtWeightInterface::getWeight ( const Evt evt) const
pure virtual

Get weight of given event.

Parameters
evtevent
Returns
weight [Hz]
virtual double JAANET::JEvtWeightInterface::getNormalisation ( ) const
pure virtual

Get event-weight normalisation factor.

Note: the return-value should be multiplied in order to normalise the event-weight

Returns
event-weight normalisation factor.

Implemented in JAANET::JEvtWeight.


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