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 JEvtWeightFactorHelper < JEvtWeightFactor >	JEvtWeightFactorHelper_t
typedef JClonable< JClonable_t > ::clone_type	clone_type
typedef std::shared_ptr < JEvtWeightFactor >	pointer_type

Public Member Functions
	JEvtWeightMiscellaneous ()
	Default constructor. More...
	JEvtWeightMiscellaneous (const JHead &header)
	Constructor. More...
	JEvtWeightMiscellaneous (const JHead &header, const JEvtWeightFactor &factor)
	Constructor. More...
	JEvtWeightMiscellaneous (const JEvtWeightMiscellaneous &object)
	Copy constructor. More...
virtual const char *const	getName () const override
	Get name. More...
void	configure (const JHead &header) override
	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...
virtual clone_type	clone () const override
	Get clone of this object. More...
void	configure (const JEvtWeightFactor &factor)
	Configure event-weight factor. More...
JEvtWeightFactor &	getEvtWeightFactor () const
	Get reference to event-weight factor. More...
double	getFactor (const Evt &evt) const
	Get weight-factor of given event. More...

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

typedef JEvtWeightFactorHelper<JEvtWeightFactor> JAANET::JEvtWeightMiscellaneous::JEvtWeightFactorHelper_t

Definition at line 40 of file JEvtWeightMiscellaneous.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.

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

inherited

Definition at line 33 of file JEvtWeightFactorHelper.hh.

Constructor & Destructor Documentation

JAANET::JEvtWeightMiscellaneous::JEvtWeightMiscellaneous ( )

inline

Default constructor.

Definition at line 46 of file JEvtWeightMiscellaneous.hh.

                              :
      JEvtWeightFactorHelper()
    {}

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

inline

Constructor.

Parameters

header

header

Definition at line 56 of file JEvtWeightMiscellaneous.hh.

                                                 :
      JEvtWeightFactorHelper()
    {
      configure(header);
    } 

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

inline

Constructor.

Parameters

header	header
factor	factor

Definition at line 69 of file JEvtWeightMiscellaneous.hh.

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

JAANET::JEvtWeightMiscellaneous::JEvtWeightMiscellaneous ( const JEvtWeightMiscellaneous &  object )

inline

Copy constructor.

Parameters

object

original object

Definition at line 83 of file JEvtWeightMiscellaneous.hh.

    {
      setNormalisation(object.getNormalisation());

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

Member Function Documentation

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

inlineoverridevirtual

Get name.

Returns

name

Definition at line 98 of file JEvtWeightMiscellaneous.hh.

    {
      return "Miscellaneous";
    }

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

inlineoverride

Configuration.

Parameters

header

header

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

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

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

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

inlineoverride

Get weight of given event.

Parameters

evt

event

Returns

weight [1/s]

Definition at line 142 of file JEvtWeightMiscellaneous.hh.

    {
      if (static_cast<const JEvtWeightFactorHelper_t&>(*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);
      }
    }

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 > >, and JLANG::JClonable< JMatch< JTRIGGER::JHitR1 >, JMatch3G< JTRIGGER::JHitR1 > >.

Definition at line 69 of file JClonable.hh.

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

void JAANET::JEvtWeightFactorHelper< JEvtWeightFactor >::configure ( const JEvtWeightFactor &  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.");
      }
    }

JEvtWeightFactor & JAANET::JEvtWeightFactorHelper< JEvtWeightFactor >::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.");
      }
    }

double JAANET::JEvtWeightFactorHelper< JEvtWeightFactor >::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);
    }

---

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

• JEvtWeightMiscellaneous.hh