JAANET::JEvtWeight Struct Reference

Abstract base class for event weighing. More...

#include <JEvtWeight.hh>

Inheritance diagram for JAANET::JEvtWeight:

Public Types
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JEvtWeight ()
	Default constructor.
virtual	~JEvtWeight ()
	Virtual destructor.
virtual double	getNormalisation () const override
	Get event-weight normalisation.
virtual double	getNormalisation (const Evt &evt) const
	Get event-weight normalisation.
virtual void	setNormalisation (const double normalisation) override
	Set event-weight normalisation factor.
virtual const char *const	getName () const =0
	Get name.
virtual void	configure (const JHead &header)=0
	Configuration.
virtual bool	check (const JHead &header) const =0
	Check whether header is consistent with this event weighter.
virtual double	getWeight (const Evt &evt) const =0
	Get weight of given event.
virtual clone_type	clone () const override
	Get clone of this object.

Protected Attributes
double	normalisation
	Event-weight normalisation.

Detailed Description

Abstract base class for event weighing.

Definition at line 28 of file JEvtWeight.hh.

Member Typedef Documentation

clone_type

template<class JClonable_t , class JDerived_t >

JClonable<JClonable_t>::clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone_type

inherited

Definition at line 61 of file JClonable.hh.

Constructor & Destructor Documentation

JEvtWeight()

JAANET::JEvtWeight::JEvtWeight ( )

inline

Default constructor.

Definition at line 35 of file JEvtWeight.hh.

                 : normalisation(1.0)
    {}

~JEvtWeight()

virtual JAANET::JEvtWeight::~JEvtWeight ( )

inlinevirtual

Virtual destructor.

Definition at line 42 of file JEvtWeight.hh.

    {}

Member Function Documentation

getNormalisation() [1/2]

virtual double JAANET::JEvtWeight::getNormalisation ( ) const

inlineoverridevirtual

Get event-weight normalisation.

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

Returns

event-weight normalisation

Implements JAANET::JEvtWeightInterface.

Definition at line 52 of file JEvtWeight.hh.

    {
      return normalisation;
    }

getNormalisation() [2/2]

virtual double JAANET::JEvtWeight::getNormalisation ( const Evt & evt ) const

inlinevirtual

Get event-weight normalisation.

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

Parameters

evt

event

Returns

event-weight normalisation

Definition at line 65 of file JEvtWeight.hh.

    {
      return (evt.w.size() > WEIGHTLIST_NORMALISATION &&
              evt.w[WEIGHTLIST_NORMALISATION] > 0.0 ?
              evt.w[WEIGHTLIST_NORMALISATION] : normalisation);
    }

setNormalisation()

virtual void JAANET::JEvtWeight::setNormalisation ( const double normalisation )

inlineoverridevirtual

Set event-weight normalisation factor.

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

Parameters

normalisation

event-weight normalisation factor.

Implements JAANET::JEvtWeightInterface.

Definition at line 79 of file JEvtWeight.hh.

    {
      this->normalisation = normalisation;
    }

getName()

virtual const char *const JAANET::JEvtWeightInterface::getName ( ) const

pure virtualinherited

Get name.

Returns

name

configure()

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

pure virtualinherited

Configuration.

Parameters

header

header

check()

virtual bool JAANET::JEvtWeightInterface::check ( const JHead & header ) const

pure virtualinherited

Check whether header is consistent with this event weighter.

Parameters

header

header

Returns

true if consistent; else false

getWeight()

virtual double JAANET::JEvtWeightInterface::getWeight ( const Evt & evt ) const

pure virtualinherited

Get weight of given event.

Parameters

evt

event

Returns

weight [Hz]

clone()

template<class JClonable_t , class JDerived_t >

virtual clone_type JLANG::JClonable< JClonable_t, JDerived_t >::clone ( ) const

inlineoverridevirtualinherited

Get clone of this object.

Returns

pointer to newly created object

Reimplemented in JPHYSICS::JPD0Transformer_t< JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer_t< JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, and JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer.

Definition at line 69 of file JClonable.hh.

    {
      return new JDerived_t(static_cast<const JDerived_t&>(*this));
    }

Member Data Documentation

normalisation

double JAANET::JEvtWeight::normalisation

protected

Event-weight normalisation.

Definition at line 87 of file JEvtWeight.hh.

---

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

• JEvtWeight.hh