JAANET::JEvtWeightMiscellaneous Struct Reference

Implementation of event weighing for miscellaneous data
such as a merged offline file containing neutrinos and atmospheric muons. More...

#include <JEvtWeightMiscellaneous.hh>

Inheritance diagram for JAANET::JEvtWeightMiscellaneous:

Public Types
typedef std::shared_ptr< JEvtWeightFactor >	pointer_type
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JEvtWeightMiscellaneous ()
	Default constructor.
	JEvtWeightMiscellaneous (const JHead &header)
	Constructor.
	JEvtWeightMiscellaneous (const JHead &header, const JEvtWeightFactor &factor)
	Constructor.
const char *const	getName () const override final
	Get name.
void	configure (const JHead &header) override final
	Configuration.
bool	check (const JHead &header) const override final
	Check whether header is consistent with this event weighter.
double	getWeight (const Evt &evt) const override final
	Get weight of given event.
void	configure (const pointer_type &p)
	Configure event-weight factor.
void	configure (const JEvtWeightFactor &factor)
	Configure event-weight factor.
JEvtWeightFactor &	getFactor () const
	Get reference to event-weight factor.
double	getFactor (const Evt &evt) const
	Get weight-factor of given event.
bool	is_valid () const
	Check whether this event-weight factor is valid.
double	operator() (const Evt &evt) const
	Get weight-factor of given event.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters())
	Get properties of this class.
JProperties	getProperties (const JEquationParameters &eqpars=JEvtWeightFactor::getEquationParameters()) const
	Get properties of this class.
virtual clone_type	clone () const override
	Get clone of this object.

Detailed Description

Implementation of event weighing for miscellaneous data
such as a merged offline file containing neutrinos and atmospheric muons.

A uniform weight of 1.0 is applied to all events.

Definition at line 36 of file JEvtWeightMiscellaneous.hh.

Member Typedef Documentation

pointer_type

std::shared_ptr<JEvtWeightFactor> JAANET::JEvtWeightFactorHelper::pointer_type

inherited

Definition at line 31 of file JEvtWeightFactorHelper.hh.

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

JEvtWeightMiscellaneous() [1/3]

JAANET::JEvtWeightMiscellaneous::JEvtWeightMiscellaneous ( )

inline

Default constructor.

Definition at line 43 of file JEvtWeightMiscellaneous.hh.

                              :
      JEvtWeightFactorHelper()
    {}

JEvtWeightMiscellaneous() [2/3]

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

inline

Constructor.

Parameters

header

header

Definition at line 53 of file JEvtWeightMiscellaneous.hh.

                                                 :
      JEvtWeightFactorHelper()
    {
      configure(header);
    } 

JEvtWeightMiscellaneous() [3/3]

JAANET::JEvtWeightMiscellaneous::JEvtWeightMiscellaneous ( const JHead & header, const JEvtWeightFactor & factor )

inline

Constructor.

Parameters

header	header
factor	factor

Definition at line 66 of file JEvtWeightMiscellaneous.hh.

                                                            :
      JEvtWeightFactorHelper()
    {
      configure(header);
      JEvtWeightFactorHelper::configure(factor);
    }

Member Function Documentation

getName()

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

inlinefinaloverride

Get name.

Returns

name

Definition at line 80 of file JEvtWeightMiscellaneous.hh.

    {
      return "Miscellaneous";
    }

configure() [1/3]

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

inlinefinaloverride

Configuration.

Parameters

header

header

Definition at line 91 of file JEvtWeightMiscellaneous.hh.

    {
      using namespace JPP;
      
      if (check(header)) {
 
        setNormalisation(1.0);
 
      } else {
        
        THROW(JValueOutOfRange, "JEvtWeightMiscellaneous::configure(): Provided header is inconsistent with a miscellaneous, merged offline file.");
      }
    }

check()

bool JAANET::JEvtWeightMiscellaneous::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 112 of file JEvtWeightMiscellaneous.hh.

    {
      return header.simul.empty() && !is_daq(header);
    }

getWeight()

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

inlinefinaloverride

Get weight of given event.

Parameters

evt

event

Returns

weight [1/s]

Definition at line 124 of file JEvtWeightMiscellaneous.hh.

    {
      if (static_cast<const JEvtWeightFactorHelper&>(*this)) {
        
        return getFactor(evt) * getNormalisation(evt);
        
      } else if (evt.w.size() > WEIGHTLIST_RESCALED_EVENT_RATE) {
 
        return evt.w[WEIGHTLIST_RESCALED_EVENT_RATE];
        
      } else {
        
        return getNormalisation(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.

    {
      return getFactor().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 165 of file JEvtWeightFactorHelper.hh.

    {
      return getFactor().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 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));
    }

---

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

• JEvtWeightMiscellaneous.hh