JAANET::JEvtWeightKM3BUU Struct Reference

Implementation of event weighting for KM3BUU data. More...

#include <JEvtWeightKM3BUU.hh>

Inheritance diagram for JAANET::JEvtWeightKM3BUU:

Public Types
typedef JEvtWeightFactorHelper < JEvtWeightFactor_t >	JEvtWeightFactorHelper_t
typedef std::shared_ptr < JEvtWeightFactor_t >	pointer_type
typedef JClonable< JClonable_t > ::clone_type	clone_type

Public Member Functions
	JEvtWeightKM3BUU ()
	Default constructor. More...
	JEvtWeightKM3BUU (const JHead &header)
	Constructor. More...
	JEvtWeightKM3BUU (const JHead &header, const JFlux &flux)
	Constructor. More...
	JEvtWeightKM3BUU (const JEvtWeightKM3BUU &object)
	Copy constructor. More...
virtual const char *const	getName () const override
	Get name. More...
void	configure (const JHead &header) override
	Weight configuration. More...
bool	check (const JHead &header) const override
	Check whether header is consistent with this event weighter. More...
double	getWeight (const Evt &evt) const override
	Get weight of given event. More...
void	configure (const JEvtWeightFactor_t &factor)
	Configure event-weight factor. More...
JEvtWeightFactor_t &	getEvtWeightFactor () const
	Get reference to event-weight factor. More...
double	getFactor (const Evt &evt) const
	Get weight-factor of given event. More...
virtual clone_type	clone () const override
	Get clone of this object. More...

Detailed Description

Implementation of event weighting for KM3BUU data.

Definition at line 34 of file JEvtWeightKM3BUU.hh.

Member Typedef Documentation

template<class JEvtWeightFactor_t>

typedef JEvtWeightFactorHelper<JEvtWeightFactor_t> JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::JEvtWeightFactorHelper_t

inherited

Definition at line 32 of file JEvtWeightFactorHelper.hh.

template<class JEvtWeightFactor_t>

typedef std::shared_ptr<JEvtWeightFactor_t> JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::pointer_type

inherited

Definition at line 33 of file JEvtWeightFactorHelper.hh.

template<class JClonable_t, class JDerived_t = JNullType>

typedef 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

JAANET::JEvtWeightKM3BUU::JEvtWeightKM3BUU ( )

inline

Default constructor.

Definition at line 41 of file JEvtWeightKM3BUU.hh.

                       :
      JFluxHelper()
    {}

JAANET::JEvtWeightKM3BUU::JEvtWeightKM3BUU ( const JHead &  header )

inline

Constructor.

Parameters

header

header

Definition at line 51 of file JEvtWeightKM3BUU.hh.

                                          :
      JFluxHelper()
    {
      configure(header);
    }

JAANET::JEvtWeightKM3BUU::JEvtWeightKM3BUU ( const JHead &  header, const JFlux &  flux  )

inline

Constructor.

Parameters

header	header
flux	flux

Definition at line 64 of file JEvtWeightKM3BUU.hh.

                                        :
      JFluxHelper()
    {
      configure(header);
      JFluxHelper::configure(flux);
    }

JAANET::JEvtWeightKM3BUU::JEvtWeightKM3BUU ( const JEvtWeightKM3BUU &  object )

inline

Copy constructor.

Parameters

object

original object

Definition at line 78 of file JEvtWeightKM3BUU.hh.

    {
      setNormalisation(object.getNormalisation());

      if (static_cast<const JFluxHelper&>(object)) {
        JFluxHelper::configure(*(object.get()));
      }
    }

Member Function Documentation

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

inlineoverridevirtual

Get name.

Returns

name

Definition at line 93 of file JEvtWeightKM3BUU.hh.

    {
      return "KM3BUU";
    }

void JAANET::JEvtWeightKM3BUU::configure ( const JHead &  header )

inlineoverride

Weight configuration.

Parameters

header

header

Definition at line 104 of file JEvtWeightKM3BUU.hh.

    {
      using namespace JPP;
      
      if (check(header)) {

        const double Nevents = header.genvol.numberOfEvents;
        const double dt      = (header.tgen.numberOfSeconds > 0.0 ?
                                header.tgen.numberOfSeconds : 1.0);
        
        setNormalisation(1.0 / Nevents / dt);
        
      } else {
        
        THROW(JValueOutOfRange, "JEvtWeightKM3BUU::configure(): Provided header is inconsistent with KM3BUU.");
      }
    }

bool JAANET::JEvtWeightKM3BUU::check ( const JHead &  header ) const

inlineoverride

Check whether header is consistent with this event weighter.

Parameters

header

header

Returns

true if consistent; else false

Definition at line 129 of file JEvtWeightKM3BUU.hh.

    {
      return is_km3buu(header);
    }

double JAANET::JEvtWeightKM3BUU::getWeight ( const Evt &  evt ) const

inlineoverride

Get weight of given event.

Parameters

evt

event

Returns

weight [Hz]

Definition at line 141 of file JEvtWeightKM3BUU.hh.

    {
      using namespace JPP;
      
      if (static_cast<const JFluxHelper&>(*this) &&
          evt.w.size() > WEIGHTLIST_DIFFERENTIAL_EVENT_RATE) {
        
        return evt.w[WEIGHTLIST_DIFFERENTIAL_EVENT_RATE] * getFactor(evt) * getNormalisation(evt);
        
      } else if (evt.w.size() > WEIGHTLIST_RESCALED_EVENT_RATE) {

        return evt.w[WEIGHTLIST_RESCALED_EVENT_RATE];

      } else if (evt.w.size() > WEIGHTLIST_EVENT_RATE) {

        return evt.w[WEIGHTLIST_EVENT_RATE] * getNormalisation(evt);
        
      } else {

        if (!static_cast<const JFluxHelper&>(*this)) {
          THROW(JNullPointerException, "JEvtWeightKM3BUU::getWeight(): Unspecified flux function.");
        } else {
          THROW(JIndexOutOfRange,      "JEvtWeightKM3BUU::getWeight(): Empty " << (evt.w.size() < 3 ? "w2-" : "w3-") << "weight.");
        }
      }
    }

template<class JEvtWeightFactor_t>

void JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::configure ( const JEvtWeightFactor_t &  factor )

inlineinherited

Configure event-weight factor.

Parameters

factor

event-weight factor

Definition at line 59 of file JEvtWeightFactorHelper.hh.

    {
      using namespace JPP;
      
      JEvtWeightFactor_t* p = dynamic_cast<JEvtWeightFactor_t*>(factor.clone());

      if (p != NULL) {
        this->reset(p);
      } else {
        THROW(JNullPointerException, "JEvtWeightFactorHelper::configure(): Invalid downcast to class derived from JEvtWeightFactor.");
      }
    }

template<class JEvtWeightFactor_t>

JEvtWeightFactor_t& JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::getEvtWeightFactor ( ) const

inlineinherited

Get reference to event-weight factor.

Returns

reference to event-weight factor

Definition at line 78 of file JEvtWeightFactorHelper.hh.

    {
      using namespace JPP;

      if (static_cast<const JEvtWeightFactorHelper_t&>(*this)) {
        return *(this->get());
      } else {
        THROW(JNullPointerException, "JEvtWeightFactorHelper::getEvtWeightFactor(): Event-weight factor is not set.");
      }
    }

template<class JEvtWeightFactor_t>

double JAANET::JEvtWeightFactorHelper< JEvtWeightFactor_t >::getFactor ( const Evt &  evt ) const

inlineinherited

Get weight-factor of given event.

Parameters

evt

event

Returns

event-weight factor

Definition at line 96 of file JEvtWeightFactorHelper.hh.

    {
      const JEvtWeightFactor_t& weightFactor = getEvtWeightFactor();

      return weightFactor.getFactor(evt);
    }

template<class JClonable_t, class JDerived_t = JNullType>

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::JPDFTransformer< 5, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, JPHYSICS::JPD0Transformer_t< JArgument_t >, JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer, JPHYSICS::JPDFTransformer_t< JArgument_t >, JLANG::JClonable< JMatch< hit_type > >, JLANG::JClonable< JMatch< hit_type >, JMatch3D >, JLANG::JClonable< JMatch< JTRIGGER::JHitR1 > >, JLANG::JClonable< JMatch< JTRIGGER::JHitR1 >, JMatch3G< JTRIGGER::JHitR1 > >, and JLANG::JClonable< JMatch< hit_type >, JMatch1D >.

Definition at line 69 of file JClonable.hh.

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

---

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

• JEvtWeightKM3BUU.hh