Class for product of event-weight factors. More...

#include <JEvtWeightFactorProduct.hh>

Inheritance diagram for JAANET::JEvtWeightFactorProduct:

Classes
struct	JEvtWeightFactorProductHelper
	Auxiliary class for I/O of product of event-weight factors. More...

Public Types
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JEvtWeightFactorProduct ()
	Default constructor.

	JEvtWeightFactorProduct (const JOscProbHelper &oscProb)
	Constructor.

	JEvtWeightFactorProduct (const JOscProbHelper &oscProb, const JEvtWeightFactorHelper &factor)
	Constructor.

template<class ... Args>
	JEvtWeightFactorProduct (const JOscProbHelper &oscProb, const JEvtWeightFactorHelper &factor, const Args &...args)
	Constructor.

	JEvtWeightFactorProduct (const JEvtWeightFactorHelper &factor)
	Constructor.

template<class ... Args>
	JEvtWeightFactorProduct (const JEvtWeightFactorHelper &factor, const Args &...args)
	Constructor.

void	push_back (const JEvtWeightFactorHelper &factor)
	Put event-weight factor.

template<class ... Args>
void	push_back (const JEvtWeightFactorHelper &factor, const Args &...args)
	Put event-weight factor.

JEvtWeightFactorProduct &	join (const JEvtWeightFactorProduct &product)
	Join this product of event-weight factors with a given product of event-weight factors.

double	getFactor (const Evt &evt) const override final
	Get multiplication factor of given event.

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

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

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

std::istream &	read (std::istream &in) override final
	Read event-weight factor product from stream.

std::ostream &	write (std::ostream &out) const override final
	Write event-weight factor to output.

virtual clone_type	clone () const override
	Get clone of this object.

Public Attributes
JOscProbHelper	oscProb
	Oscillation probability calculator.

Detailed Description

Class for product of event-weight factors.

Input syntax as follows:

      <factor identifier> [<factor arguments> [& <factor identifier> [<factor arguments]]...];

where

<factor identifier> corresponds to an event-weight factor identifier (c.f. JAANET::JEvtWeighFactorDictionary::factors); and
<factor arguments> to the list of arguments for the corresponding event-weight fact

Definition at line 51 of file JEvtWeightFactorProduct.hh.

Member Typedef Documentation

◆ 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

◆ JEvtWeightFactorProduct() [1/6]

JAANET::JEvtWeightFactorProduct::JEvtWeightFactorProduct ( )

inline

Default constructor.

Definition at line 58 of file JEvtWeightFactorProduct.hh.

                              :
      oscProb()
    {}

◆ JEvtWeightFactorProduct() [2/6]

JAANET::JEvtWeightFactorProduct::JEvtWeightFactorProduct ( const JOscProbHelper & oscProb )

inline

Constructor.

Parameters

oscProb oscillation probability calculator

Definition at line 68 of file JEvtWeightFactorProduct.hh.

                                                           :
      oscProb(oscProb)
    {}

◆ JEvtWeightFactorProduct() [3/6]

JAANET::JEvtWeightFactorProduct::JEvtWeightFactorProduct	(	const JOscProbHelper &	oscProb,
		const JEvtWeightFactorHelper &	factor )

inline

Constructor.

Parameters

oscProb	oscillation probability calculator
factor	event-weight factor

Definition at line 79 of file JEvtWeightFactorProduct.hh.

                                                                  :
      oscProb(oscProb)
    {
      this->push_back(factor);
    }

◆ JEvtWeightFactorProduct() [4/6]

template<class ... Args>

JAANET::JEvtWeightFactorProduct::JEvtWeightFactorProduct	(	const JOscProbHelper &	oscProb,
		const JEvtWeightFactorHelper &	factor,
		const Args &...	args )

inline

Constructor.

Parameters

oscProb	oscillation probability calculator
factor	event-weight factor
args	remaining event-weight factors

Definition at line 95 of file JEvtWeightFactorProduct.hh.

                                                                :
      oscProb(oscProb)
    {
      this->push_back(factor, args...);
    }

◆ JEvtWeightFactorProduct() [5/6]

JAANET::JEvtWeightFactorProduct::JEvtWeightFactorProduct ( const JEvtWeightFactorHelper & factor )

inline

Constructor.

Parameters

factor event-weight factor

Definition at line 110 of file JEvtWeightFactorProduct.hh.

                                                                  :
      oscProb()
    {
      this->push_back(factor);
    }

◆ JEvtWeightFactorProduct() [6/6]

template<class ... Args>

JAANET::JEvtWeightFactorProduct::JEvtWeightFactorProduct	(	const JEvtWeightFactorHelper &	factor,
		const Args &...	args )

inline

Constructor.

Parameters

factor	event-weight factor
args	remaining event-weight factors

Definition at line 124 of file JEvtWeightFactorProduct.hh.

                                                                :
      oscProb()
    {
      this->push_back(factor, args...);
    }

Member Function Documentation

◆ push_back() [1/2]

void JAANET::JEvtWeightFactorProduct::push_back ( const JEvtWeightFactorHelper & factor )

inline

Put event-weight factor.

Parameters

factor event-weight factor

Definition at line 137 of file JEvtWeightFactorProduct.hh.

    {
      const JEvtWeightFactorProduct* p = dynamic_cast<const JEvtWeightFactorProduct*>(factor.get());
 
      if (p != NULL) {
        this->insert(this->end(), p->begin(), p->end());
      } else {
        std::vector<JEvtWeightFactorHelper>::push_back(factor);
      }
    }

◆ push_back() [2/2]

template<class ... Args>

void JAANET::JEvtWeightFactorProduct::push_back	(	const JEvtWeightFactorHelper &	factor,
		const Args &...	args )

inline

Put event-weight factor.

Parameters

factor	event-weight factor
args	remaining event-weight factors

Definition at line 156 of file JEvtWeightFactorProduct.hh.

    {
      push_back(factor);
      push_back(args...);
    }

◆ join()

JEvtWeightFactorProduct & JAANET::JEvtWeightFactorProduct::join ( const JEvtWeightFactorProduct & product )

inline

Join this product of event-weight factors with a given product of event-weight factors.

Parameters

product product of event-weight factors

Returns: joined product of event-weight factors

Definition at line 170 of file JEvtWeightFactorProduct.hh.

    {
      this->insert(this->end(), product.begin(), product.end());
 
      return (*this);
    }

◆ getFactor()

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

inlinefinaloverride

Get multiplication factor of given event.

Parameters

evt event

Returns: multiplication factor

Definition at line 184 of file JEvtWeightFactorProduct.hh.

    {
      using namespace std;
      
      double factor = 1.0;
 
      for (vector<JEvtWeightFactorHelper>::const_iterator i = this->cbegin(); i != this->cend(); ++i) {
        factor *= i->getFactor(evt);
      }
      
      return factor;
    }

◆ is_valid()

bool JAANET::JEvtWeightFactorProduct::is_valid ( ) const

inlinefinaloverride

Check whether this event-weight factor is valid.

Returns: true if valid; else false

Definition at line 203 of file JEvtWeightFactorProduct.hh.

    {
      for (const_iterator i = this->cbegin(); i != this->cend(); ++i) {
        if (!(i->is_valid())) { return false; }
      }
 
      return true;
    }

◆ getProperties() [1/2]

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

inlinefinaloverride

Get properties of this class.

Parameters

eqpars equation parameters

Definition at line 218 of file JEvtWeightFactorProduct.hh.

    {
      return JEvtWeightFactorProductHelper(*this, eqpars);
    }

◆ getProperties() [2/2]

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

inlinefinaloverride

Get properties of this class.

Parameters

eqpars equation parameters

Definition at line 229 of file JEvtWeightFactorProduct.hh.

    {
      return JEvtWeightFactorProductHelper(*this, eqpars);
    }

◆ read()

std::istream & JAANET::JEvtWeightFactorProduct::read ( std::istream & in )

inlinefinaloverride

Read event-weight factor product from stream.

Parameters

in	input stream
object	event-weight factor product

Returns: input stream

Definition at line 243 of file JEvtWeightFactorProduct.hh.

    {
      using namespace std;
      using namespace JPP;
 
      static const JEvtWeightFactorDictionary dictionary(oscProb);      
 
      JStringStream is(in);
 
      if (getFileStatus(is.str().c_str())) {
        is.load();
      }
      
      for (JToken<'&'> token; is >> token; ) {
 
        int factorID = 0;
        
        istringstream iss(token);
 
        if (!(iss >> factorID)) { continue; }
 
        const JEvtWeightFactorHelper helper(dictionary.at(factorID).getFactor());
        
        JEvtWeightFactor& factor = helper.getFactor();
        
        iss >> factor;
 
        push_back(helper);
      }
      
      return in;
    }

◆ write()

std::ostream & JAANET::JEvtWeightFactorProduct::write ( std::ostream & out ) const

inlinefinaloverride

Write event-weight factor to output.

Parameters

out	output stream

Returns: output stream

Definition at line 283 of file JEvtWeightFactorProduct.hh.

    {
      return out << getProperties(JEquationParameters("=", "\n", "./", "#"));
    }

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

Member Data Documentation

◆ oscProb

JOscProbHelper JAANET::JEvtWeightFactorProduct::oscProb

Oscillation probability calculator.

Definition at line 289 of file JEvtWeightFactorProduct.hh.

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

JEvtWeightFactorProduct.hh

Classes

Public Types

Public Member Functions

Public Attributes

Detailed Description

Member Typedef Documentation

◆ clone_type

Constructor & Destructor Documentation

◆ JEvtWeightFactorProduct() [1/6]

◆ JEvtWeightFactorProduct() [2/6]

◆ JEvtWeightFactorProduct() [3/6]

◆ JEvtWeightFactorProduct() [4/6]

◆ JEvtWeightFactorProduct() [5/6]

◆ JEvtWeightFactorProduct() [6/6]

Member Function Documentation

◆ push_back() [1/2]

◆ push_back() [2/2]

◆ join()

◆ getFactor()

◆ is_valid()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ read()

◆ write()

◆ clone()

Member Data Documentation

◆ oscProb