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	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	compile (const char *const formula)
	Compile given formula.

void	compile ()
	Compile currently stored formula.

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.

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

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.

Protected Member Functions
TFormula &	getFormula ()
	Retrieve TFormula.

const TFormula &	getFormula () const
	Retrieve TFormula.

Detailed Description

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

Definition at line 33 of file JEvtWeightFactorTFormula.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

◆ JEvtWeightFactorTFormula()

JAANET::JEvtWeightFactorTFormula::JEvtWeightFactorTFormula ( )

inline

Default constructor.

Definition at line 42 of file JEvtWeightFactorTFormula.hh.

43 {}

◆ ~JEvtWeightFactorTFormula()

JAANET::JEvtWeightFactorTFormula::~JEvtWeightFactorTFormula ( )

inline

Virtual destructor.

Definition at line 49 of file JEvtWeightFactorTFormula.hh.

50 {}

Member Function Documentation

◆ getFormulaKey()

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

inlinestatic

Get formula keyword.

Returns: formula keyword

Definition at line 58 of file JEvtWeightFactorTFormula.hh.

    {
      return "formula";
    }

◆ compile() [1/2]

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

inline

Compile given formula.

Parameters

formula formula

Definition at line 69 of file JEvtWeightFactorTFormula.hh.

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

◆ compile() [2/2]

void JAANET::JEvtWeightFactorTFormula::compile ( )

inline

Compile currently stored formula.

Definition at line 84 of file JEvtWeightFactorTFormula.hh.

    {
      compile(this->GetExpFormula());
    }

◆ 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 95 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 106 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 118 of file JEvtWeightFactorTFormula.hh.

    {
      using namespace std;
 
      this->Clear();
 
      streampos pos = in.tellg();      
 
      JProperties properties = getProperties();
      in >> properties;
      
      this->compile();
 
      in.clear(); // Rewind to read parameters
      in.seekg(pos);
 
      properties = getProperties();
      in >> properties;
 
      return in;      
    }

◆ getFormula() [1/2]

TFormula & JAANET::JEvtWeightFactorTFormula::getFormula ( )

inlineprotected

Retrieve TFormula.

Returns: TFormula

Definition at line 148 of file JEvtWeightFactorTFormula.hh.

    {
      return static_cast<TFormula&>(*this);
    }

◆ getFormula() [2/2]

const TFormula & JAANET::JEvtWeightFactorTFormula::getFormula ( ) const

inlineprotected

Retrieve TFormula.

Returns: TFormula

Definition at line 159 of file JEvtWeightFactorTFormula.hh.

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

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

◆ is_valid()

virtual bool JAANET::JEvtWeightFactor::is_valid ( ) const

inlinevirtualinherited

Check whether this event-weight factor is valid.

Returns: true if valid; else false

Definition at line 77 of file JEvtWeightFactor.hh.

    {
      return true;
    }

◆ 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("=", ",", "./", "#");
       
      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 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));
    }

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

JEvtWeightFactorTFormula.hh

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Detailed Description

Member Typedef Documentation

◆ clone_type

Constructor & Destructor Documentation

◆ JEvtWeightFactorTFormula()

◆ ~JEvtWeightFactorTFormula()

Member Function Documentation

◆ getFormulaKey()

◆ compile() [1/2]

◆ compile() [2/2]

◆ getProperties() [1/2]

◆ getProperties() [2/2]

◆ read()

◆ getFormula() [1/2]

◆ getFormula() [2/2]

◆ getTypeKey()

◆ getFactor()

◆ operator()()

◆ is_valid()

◆ check_validity()

◆ getEquationParameters()

◆ setEquationParameters()

◆ write()

◆ clone()