Base class implementation for reweighting factor for simulated events according to a specifiable ROOT TFormula. More...

#include <JEvtWeightFactorTFormula.hh>

Inheritance diagram for JAANET::JEvtWeightFactorTFormula:

Classes
struct	JEvtWeightFactorTFormulaExpression
	Auxiliary class for I/O of TFormula expression. More...

struct	JEvtWeightFactorTFormulaHelper
	Auxiliary class for I/O of TFormula-based event-weight factor. More...

Public Types
typedef JClonable< JClonable_t >::clone_type	clone_type

Public Member Functions
	JEvtWeightFactorTFormula ()
	Default constructor.

	~JEvtWeightFactorTFormula ()
	Virtual destructor.

void	load (const char *const formula)
	Compile given formula.

void	load ()
	Compile currently stored formula.

bool	is_valid () const override
	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 from input.

virtual double	getFactor (const Evt &evt) const =0
	Get event-weight factor of given event.

double	operator() (const Evt &evt) const
	Get event-weight factor of given event.

void	check_validity () const
	Check validity of this event-weight factor.

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

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

Static Public Member Functions
static const std::string	getFormulaKey ()
	Get formula keyword.

static const char *const	getTypeKey ()
	Get type keyword.

static JEquationParameters &	getEquationParameters ()
	Get equation parameters.

static void	setEquationParameters (const JEquationParameters &eqpars)
	Set equation parameters.

Private Attributes
JLoadProperty< JEvtWeightFactorTFormula, JEvtWeightFactorTFormulaExpression >	buffer
	Formula expression.

Detailed Description

Base class implementation for reweighting factor for simulated events according to a specifiable ROOT TFormula.

Definition at line 37 of file JEvtWeightFactorTFormula.hh.

Member Typedef Documentation

◆ 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

◆ JEvtWeightFactorTFormula()

JAANET::JEvtWeightFactorTFormula::JEvtWeightFactorTFormula ( )

inline

Default constructor.

Definition at line 46 of file JEvtWeightFactorTFormula.hh.

                               :
      buffer(*this)
    {}

◆ ~JEvtWeightFactorTFormula()

JAANET::JEvtWeightFactorTFormula::~JEvtWeightFactorTFormula ( )

inline

Virtual destructor.

Definition at line 54 of file JEvtWeightFactorTFormula.hh.

55 {}

Member Function Documentation

◆ getFormulaKey()

static const std::string JAANET::JEvtWeightFactorTFormula::getFormulaKey ( )

inlinestatic

Get formula keyword.

Returns: formula keyword

Definition at line 63 of file JEvtWeightFactorTFormula.hh.

    {
      return "formula";
    }

◆ load() [1/2]

void JAANET::JEvtWeightFactorTFormula::load ( const char *const formula )

inline

Compile given formula.

Parameters

formula formula

Definition at line 74 of file JEvtWeightFactorTFormula.hh.

    {
      this->Clear();
      
      if (this->Compile(formula)) {
        THROW(JValueOutOfRange, "JEvtWeightFactorTFormula::load(): Could not compile formula: " << formula);    
      }
    }

◆ load() [2/2]

void JAANET::JEvtWeightFactorTFormula::load ( )

inline

Compile currently stored formula.

Definition at line 87 of file JEvtWeightFactorTFormula.hh.

    {
      if (!buffer.empty()) {
        load(buffer.c_str());
      }
    }

◆ is_valid()

bool JAANET::JEvtWeightFactorTFormula::is_valid ( ) const

inlineoverridevirtual

Check whether this event-weight factor is valid.

Returns: true if valid; else false

Reimplemented from JAANET::JEvtWeightFactor.

Definition at line 100 of file JEvtWeightFactorTFormula.hh.

    {
      return this->IsValid();
    }

◆ getProperties() [1/2]

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

inlinefinaloverridevirtual

Get properties of this class.

Parameters

eqpars equation parameters

Reimplemented from JAANET::JEvtWeightFactor.

Definition at line 111 of file JEvtWeightFactorTFormula.hh.

    {
      return JEvtWeightFactorTFormulaHelper(*this, eqpars);
    }

◆ getProperties() [2/2]

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

inlinefinaloverridevirtual

Get properties of this class.

Parameters

eqpars equation parameters

Reimplemented from JAANET::JEvtWeightFactor.

Definition at line 122 of file JEvtWeightFactorTFormula.hh.

    {
      return JEvtWeightFactorTFormulaHelper(*this, eqpars);
    }

◆ read()

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

inlinefinaloverridevirtual

Read event-weight factor from input.

Parameters

in	input stream

Returns: input stream

Reimplemented from JAANET::JEvtWeightFactor.

Definition at line 134 of file JEvtWeightFactorTFormula.hh.

    {
      using namespace std;
 
      this->Clear();
 
      const streampos         pos   = in.tellg();
      const ios_base::iostate state = in.rdstate();      
 
      JProperties properties = getProperties();
      in >> properties;
      
      this->load();
 
      in.clear(state);
      in.seekg(pos); // Rewind to read parameters
      
      properties = getProperties();
      
      in >> properties;
 
      check_validity();
      
      return in;      
    }

◆ getTypeKey()

static const char *const JAANET::JEvtWeightFactor::getTypeKey ( )

inlinestaticinherited

Get type keyword.

Returns: type keyword

Definition at line 45 of file JEvtWeightFactor.hh.

    {
      return "type";
    }

◆ getFactor()

virtual double JAANET::JEvtWeightFactor::getFactor ( const Evt & evt ) const

pure virtualinherited

Get event-weight factor of given event.

Parameters

evt event

Returns: event-weight factor

Implemented in JAANET::JDiffuseFlux.

◆ operator()()

double JAANET::JEvtWeightFactor::operator() ( const Evt & evt ) const

inlineinherited

Get event-weight factor of given event.

Parameters

evt event

Returns: event-weight factor

Definition at line 66 of file JEvtWeightFactor.hh.

    {
      return getFactor(evt);
    }

◆ check_validity()

void JAANET::JEvtWeightFactor::check_validity ( ) const

inlineinherited

Check validity of this event-weight factor.

Definition at line 86 of file JEvtWeightFactor.hh.

    {
      using namespace JPP;
      
      if (!is_valid()) {
        THROW(JValueOutOfRange, "JEvtWeightFactor:check_validity(): Invalid event-weight factor " << *this);
      }
    }

◆ getEquationParameters()

static JEquationParameters & JAANET::JEvtWeightFactor::getEquationParameters ( )

inlinestaticinherited

Get equation parameters.

Returns: equation parameters

Definition at line 101 of file JEvtWeightFactor.hh.

    {
      static JEquationParameters equation("=", ",\n\r,", "./", "#");
       
      return equation;
    }    

◆ setEquationParameters()

static void JAANET::JEvtWeightFactor::setEquationParameters ( const JEquationParameters & eqpars )

inlinestaticinherited

Set equation parameters.

Parameters

eqpars equation parameters

Definition at line 114 of file JEvtWeightFactor.hh.

    {
      getEquationParameters() = eqpars;
    }

◆ write()

virtual std::ostream & JAANET::JEvtWeightFactor::write ( std::ostream & out ) const

inlinevirtualinherited

Write event-weight factor to output.

Parameters

out	output stream

Returns: output stream

Definition at line 174 of file JEvtWeightFactor.hh.

    {
      return out << getProperties();
    }

◆ 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 JLANG::JClonable< JMatch< hit_type > >, JLANG::JClonable< JMatch< hit_type >, JMatch1D >, JLANG::JClonable< JMatch< hit_type >, JMatch3D >, JLANG::JClonable< JMatch< JTRIGGER::JHitR1 > >, JLANG::JClonable< JMatch< JTRIGGER::JHitR1 >, JMatch3G< JTRIGGER::JHitR1 > >, JPHYSICS::JPDFTransformer_t< JArgument_t >, JPHYSICS::JPD0Transformer_t< JArgument_t >, JPHYSICS::JPDGTransformer_t< JArgument_t >, JPHYSICS::JPDFTransformer< 2, JArgument_t >, JPHYSICS::JPDFTransformer< 3, JArgument_t >, JPHYSICS::JPDFTransformer< 4, JArgument_t >, JPHYSICS::JPDFTransformer< 5, 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

◆ buffer

JLoadProperty<JEvtWeightFactorTFormula, JEvtWeightFactorTFormulaExpression> JAANET::JEvtWeightFactorTFormula::buffer

private

Formula expression.

Definition at line 245 of file JEvtWeightFactorTFormula.hh.

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

JEvtWeightFactorTFormula.hh

Classes

Public Types

Public Member Functions

Static Public Member Functions

Private Attributes

Detailed Description

Member Typedef Documentation

◆ clone_type

Constructor & Destructor Documentation

◆ JEvtWeightFactorTFormula()

◆ ~JEvtWeightFactorTFormula()

Member Function Documentation

◆ getFormulaKey()

◆ load() [1/2]

◆ load() [2/2]

◆ is_valid()

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ read()

◆ getTypeKey()

◆ getFactor()

◆ operator()()

◆ check_validity()

◆ getEquationParameters()

◆ setEquationParameters()

◆ write()

◆ clone()

Member Data Documentation

◆ buffer