JAANET::JEvtWeightFactorProduct Struct Reference

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.
const JOscProbHelper &	getOscProb () const
	Get oscillation probability calculator.
size_t	setOscProb (const JOscProbHelper &oscProb)
	Set oscillation probability calculator for all compatible 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.

Private Attributes
JOscProbHelper	oscProb
	Oscillation probability calculator.

Detailed Description

Class for product of event-weight factors.

The input syntax follows the following scheme:

[oscillation probabilities configuration] <factor>+,

in which:

• oscillation probabilities configuration refers to an optional specification of the oscillation parameters, which can be given according to one of the following formats:
  1. <oscprob_file>,
  2. oscprob=<oscprob_file>,
  3. <oscprob_key>=<oscprob_value>[<end of line> <oscprob_key>=<oscprob_value>]+ or
  4. oscprob.<oscprob_key>=<oscprob_value>[<end of line> oscprob.<oscprob_key>=<oscprob_value>]+, where:
  • oscprob_key refers to an oscillation probability calculator configuration key;
  • oscprob_value to an oscillation probability calculator configuration value and
  • oscprob_file to an oscillation probability calculator configuration file with key-value pairs,
• factor refers to a weighting factor, which needs to be specified according to the following format:
  1. <factor identifier> [<factor arguments> [ & <factor identifier> [<factor arguments] ]+ ];, where:
  • factor identifier refers to an event-weight factor identifier (c.f. JAANET::JEvtWeighFactorDictionary::factors); and
  • factor arguments to the list of arguments for the corresponding event-weight factor,
• multiple weighting factors can be combined into one when specified as a group separated by the '&' character.

Definition at line 64 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 71 of file JEvtWeightFactorProduct.hh.

                              :
      oscProb()
    {}

JEvtWeightFactorProduct() [2/6]

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

inline

Constructor.

Parameters

oscProb

oscillation probability calculator

Definition at line 81 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 92 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 108 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 123 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 137 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 150 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 169 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 183 of file JEvtWeightFactorProduct.hh.

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

getOscProb()

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

inline

Get oscillation probability calculator.

Returns

oscillation probability calculator

Definition at line 196 of file JEvtWeightFactorProduct.hh.

    {
      return oscProb;
    }

setOscProb()

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

inline

Set oscillation probability calculator for all compatible event weight factors.

Parameters

oscProb

oscillation probability calculator

Returns

number of modified event weighters

Definition at line 208 of file JEvtWeightFactorProduct.hh.

    {
      using namespace JPP;
      
      if (oscProb) {
      
        size_t n = 0;
      
        this->oscProb = oscProb;
 
        for (iterator i = this->begin(); i != this->end(); ++i) {
 
          JEvtWeightFactorHelper& factor = *i;
 
          if (!factor) { continue; }
          
          JOscFlux* p = dynamic_cast<JOscFlux*>(factor.get());
          
          if (p != NULL) {
            
            p->setOscProb(oscProb);
            ++n;
            
          } else {
 
            JOscProbHelper* q = dynamic_cast<JOscProbHelper*>(factor.get());
 
            if (q != NULL) {
              *q = oscProb;
              ++n;
            }
          }
        }
      
        return n;
        
      } else {
 
        THROW(JNullPointerException, "JEvtWeightFactorProduct::setOscProb(): Given oscillation probability function is invalid.");
      }
    }

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 257 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 276 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 291 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 302 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

Returns

input stream

Definition at line 314 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();
      }
 
      // Read event weight factors
      
      for (JToken<'&'> token; is >> token; ) {
 
        int factorID = 0;
 
        istringstream iss(token);
        
        const streampos poss = iss.tellg();
 
        if (!(iss >> factorID)) { // Check if token corresponds to oscillation parameter set
 
          iss.clear();
          iss.seekg(poss);
 
          iss >> oscProb;
 
          if (fail(iss)) {
            continue;
          }
        }
 
        const JEvtWeightFactorHelper helper = dictionary[factorID];
        
        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 368 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

private

Oscillation probability calculator.

Definition at line 413 of file JEvtWeightFactorProduct.hh.

---

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

• JEvtWeightFactorProduct.hh