Implementation of event weighing for MUPAGE data. More...

#include <JEvtWeightMupage.hh>

Inheritance diagram for JAANET::JEvtWeightMupage:

Public Types
typedef std::shared_ptr< JEvtWeightFactor >	pointer_type

typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JEvtWeightMupage ()
	Default Constructor. More...

	JEvtWeightMupage (const JHead &header)
	Constructor. More...

	JEvtWeightMupage (const JHead &header, const JEvtWeightFactor &factor)
	Constructor. More...

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

void	configure (const JHead &header) override final
	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 rate 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 weighing for MUPAGE data.

Definition at line 33 of file JEvtWeightMupage.hh.

Member Typedef Documentation

◆ pointer_type

typedef 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 >

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

◆ JEvtWeightMupage() [1/3]

JAANET::JEvtWeightMupage::JEvtWeightMupage ( )

inline

Default Constructor.

Definition at line 40 of file JEvtWeightMupage.hh.

                        :
       JEvtWeightFactorHelper()
     {}

◆ JEvtWeightMupage() [2/3]

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

inline

Constructor.

Parameters

header header

Definition at line 50 of file JEvtWeightMupage.hh.

                                           :
       JEvtWeightFactorHelper()
     {
       configure(header);
     } 

◆ JEvtWeightMupage() [3/3]

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

inline

Constructor.

Parameters

header	header
factor	factor

Definition at line 63 of file JEvtWeightMupage.hh.

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

Member Function Documentation

◆ getName()

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

inlinefinaloverride

Get name.

Returns: name

Definition at line 76 of file JEvtWeightMupage.hh.

     {
       return "MUPAGE";
     }

◆ configure() [1/3]

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

inlinefinaloverride

Configuration.

Parameters

header header

Definition at line 87 of file JEvtWeightMupage.hh.

     {
       using namespace JPP;
       
       if (check(header)) {
  
         const double dt = ( header.time_interval.t2 - header.time_interval.t1 > 0.0 ?
                             header.time_interval.t2 - header.time_interval.t1       :
                             (header.livetime.numberOfSeconds > 0.0 ?
                              header.livetime.numberOfSeconds : 1.0) );
         
         setNormalisation(1.0 / dt);
  
       } else {
         
         THROW(JValueOutOfRange, "JEvtWeightMupage::configure(): Provided header is inconsistent with MUPAGE.");
       }
     }

◆ check()

bool JAANET::JEvtWeightMupage::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 113 of file JEvtWeightMupage.hh.

     {
       return is_mupage(header);
     }

◆ getWeight()

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

inlinefinaloverride

Get rate of given event.

Parameters

evt event

Returns: weight [1/s]

Definition at line 125 of file JEvtWeightMupage.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.

     {
       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:

JEvtWeightMupage.hh

Public Types

Public Member Functions

Detailed Description

Member Typedef Documentation

◆ pointer_type

◆ clone_type

Constructor & Destructor Documentation

◆ JEvtWeightMupage() [1/3]

◆ JEvtWeightMupage() [2/3]

◆ JEvtWeightMupage() [3/3]

Member Function Documentation

◆ getName()

◆ configure() [1/3]

◆ check()

◆ getWeight()

◆ configure() [2/3]

◆ configure() [3/3]

◆ getFactor() [1/2]

◆ getFactor() [2/2]

◆ is_valid()

◆ operator()()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ clone()