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

#include <JEvtWeightKM3BUU.hh>

Inheritance diagram for JAANET::JEvtWeightKM3BUU:

Public Types
typedef JEvtWeightFactorHelper::pointer_type	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...

const char *const	getName () const override final
	Get name. More...

void	configure (const JHead &header) override final
	Weight configuration. More...

bool	check (const JHead &header) const override final
	Check whether header is consistent with this event weighter. More...

double	getWeight (const Evt &evt) const override final
	Get weight of given event. More...

JFlux &	getFlux () const
	Get reference to flux function. More...

double	getFlux (const Evt &evt) const
	Get flux of given event. More...

void	configure (const pointer_type &p)
	Configure event-weight factor. More...

void	configure (const JEvtWeightFactor &factor)
	Configure event-weight factor. More...

JEvtWeightFactor &	getFactor () const
	Get reference to event-weight factor. More...

double	getFactor (const Evt &evt) const
	Get weight-factor of given event. More...

bool	is_valid () const
	Check whether this event-weight factor is valid. More...

double	operator() (const Evt &evt) const
	Get weight-factor of given event. More...

JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters())
	Get properties of this class. More...

JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) const
	Get properties of this class. 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

◆ pointer_type

typedef JEvtWeightFactorHelper::pointer_type JAANET::JFluxHelper::pointer_type

inherited

Definition at line 26 of file JFluxHelper.hh.

◆ clone_type

template<class JClonable_t , class JDerived_t >

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

◆ JEvtWeightKM3BUU() [1/3]

JAANET::JEvtWeightKM3BUU::JEvtWeightKM3BUU ( )

inline

Default constructor.

Definition at line 41 of file JEvtWeightKM3BUU.hh.

                        :
       JFluxHelper()
     {}

◆ JEvtWeightKM3BUU() [2/3]

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

inline

Constructor.

Parameters

header header

Definition at line 51 of file JEvtWeightKM3BUU.hh.

                                           :
       JFluxHelper()
     {
       configure(header);
     }

◆ JEvtWeightKM3BUU() [3/3]

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);
     }

Member Function Documentation

◆ getName()

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

inlinefinaloverride

Get name.

Returns: name

Definition at line 78 of file JEvtWeightKM3BUU.hh.

     {
       return "KM3BUU";
     }

◆ configure() [1/3]

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

inlinefinaloverride

Weight configuration.

Parameters

header header

Definition at line 89 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.");
       }
     }

◆ check()

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

inlinefinaloverride

Check whether header is consistent with this event weighter.

Parameters

header header

Returns: true if consistent; else false

Definition at line 114 of file JEvtWeightKM3BUU.hh.

     {
       return is_km3buu(header);
     }

◆ getWeight()

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

inlinefinaloverride

Get weight of given event.

Parameters

evt event

Returns: weight [Hz]

Definition at line 126 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.");
         }
       }
     }

◆ getFlux() [1/2]

JFlux& JAANET::JFluxHelper::getFlux ( ) const

inlineinherited

Get reference to flux function.

Returns: reference to flux function

Definition at line 62 of file JFluxHelper.hh.

     {
       using namespace JPP;
  
       JEvtWeightFactor& factor = this->getFactor();
  
       JFlux* p = dynamic_cast<JFlux*>(&factor);
  
       if (p != NULL) {
         return *p;
       } else {
         THROW(JNullPointerException, "JFluxHelper::getFlux(): Cannot convert event-weight factor to flux function.");
       }
     }

◆ getFlux() [2/2]

double JAANET::JFluxHelper::getFlux ( const Evt & evt ) const

inlineinherited

Get flux of given event.

Parameters

evt event

Returns: flux [GeV^-1 * m^-2 * sr^-1 * s^-1]

Definition at line 84 of file JFluxHelper.hh.

     {
       return getFactor(evt);
     }

◆ configure() [2/3]

void JAANET::JEvtWeightFactorHelper::configure ( const pointer_type & p )

inlineinherited

Configure event-weight factor.

Parameters

p	pointer to event-weight factor

Definition at line 68 of file JEvtWeightFactorHelper.hh.

     {
       static_cast<pointer_type&>(*this) = p;
     }

◆ configure() [3/3]

void JAANET::JEvtWeightFactorHelper::configure ( const JEvtWeightFactor & factor )

inlineinherited

Configure event-weight factor.

Parameters

factor event-weight factor

Definition at line 79 of file JEvtWeightFactorHelper.hh.

     {
       using namespace JPP;
       
       JEvtWeightFactor* p = dynamic_cast<JEvtWeightFactor*>(factor.clone());
  
       if (p != NULL) {
         this->reset(p);
       } else {
         THROW(JNullPointerException, "JEvtWeightFactorHelper::configure(): Could not retrieve event-weight factor interface.");
       }
     }

◆ getFactor() [1/2]

JEvtWeightFactor& JAANET::JEvtWeightFactorHelper::getFactor ( ) const

inlineinherited

Get reference to event-weight factor.

Returns: reference to event-weight factor

Definition at line 98 of file JEvtWeightFactorHelper.hh.

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

◆ getFactor() [2/2]

double JAANET::JEvtWeightFactorHelper::getFactor ( const Evt & evt ) const

inlineinherited

Get weight-factor of given event.

Parameters

evt event

Returns: event-weight factor

Definition at line 129 of file JEvtWeightFactorHelper.hh.

     {
       const JEvtWeightFactor& weightFactor = getFactor();
  
       return weightFactor.getFactor(evt);
     }

◆ is_valid()

bool JAANET::JEvtWeightFactorHelper::is_valid ( ) const

inlineinherited

Check whether this event-weight factor is valid.

Returns: true if valid; else false

Definition at line 115 of file JEvtWeightFactorHelper.hh.

     {
       const JEvtWeightFactorHelper& helper = static_cast<const JEvtWeightFactorHelper&>(*this);
       
       return (helper && helper->is_valid());
     }

◆ operator()()

double JAANET::JEvtWeightFactorHelper::operator() ( const Evt & evt ) const

inlineinherited

Get weight-factor of given event.

Parameters

evt event

Returns: event-weight factor

Definition at line 143 of file JEvtWeightFactorHelper.hh.

     {
       return getFactor(evt);
     }

◆ getProperties() [1/2]

JProperties JAANET::JEvtWeightFactorHelper::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() )

inlineinherited

Get properties of this class.

Parameters

eqpars equation parameters

Definition at line 154 of file JEvtWeightFactorHelper.hh.

     {
       const JEvtWeightFactor& weightFactor = getFactor();
       
       return weightFactor.getProperties(eqpars);
     }

◆ getProperties() [2/2]

JProperties JAANET::JEvtWeightFactorHelper::getProperties ( const JEquationParameters & eqpars = JEvtWeightFactor::getEquationParameters() ) const

inlineinherited

Get properties of this class.

Parameters

eqpars equation parameters

Definition at line 167 of file JEvtWeightFactorHelper.hh.

     {
       const JEvtWeightFactor& weightFactor = getFactor();
       
       return weightFactor.getProperties(eqpars);
     }

◆ 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 JTOOLS::JMultiMapTransformer< N, JArgument_t >::JMultiMapDefaultTransformer, 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 >, and JPHYSICS::JPDFTransformer_t< JArgument_t >.

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

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ pointer_type

◆ clone_type

Constructor & Destructor Documentation

◆ JEvtWeightKM3BUU() [1/3]

◆ JEvtWeightKM3BUU() [2/3]

◆ JEvtWeightKM3BUU() [3/3]

Member Function Documentation

◆ getName()

◆ configure() [1/3]

◆ check()

◆ getWeight()

◆ getFlux() [1/2]

◆ getFlux() [2/2]

◆ configure() [2/3]

◆ configure() [3/3]

◆ getFactor() [1/2]

◆ getFactor() [2/2]

◆ is_valid()

◆ operator()()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ clone()