HEJ::ScaleFunction Class Reference

Class to calculate the scale associated with an event. More...

#include <ScaleFunction.hh>

Public Member Functions
	ScaleFunction (std::string name, std::function< double(Event const &)> fun)
	Constructor. More...
std::string const &	name () const
	Name of the scale choice. More...
double	operator() (Event const &ev) const
	Calculate the scale associated with an event. More...

Friends
ScaleFunction	operator* (double factor, ScaleFunction base_scale)
	Multiply a scale choice by a constant factor. More...
ScaleFunction	operator/ (ScaleFunction base_scale, double denom)
	Divide a scale choice by a constant factor. More...

Detailed Description

Class to calculate the scale associated with an event.

Constructor & Destructor Documentation

ScaleFunction()

HEJ::ScaleFunction::ScaleFunction ( std::string  name, std::function< double(Event const &)>  fun  )

inline

Constructor.

Parameters

name	Name of the scale choice (e.g. H_T)
fun	Function used to calculate the scale

Member Function Documentation

name()

std::string const & HEJ::ScaleFunction::name ( ) const

inline

Name of the scale choice.

operator()()

double HEJ::ScaleFunction::operator() ( Event const &  ev ) const

inline

Calculate the scale associated with an event.

Friends And Related Function Documentation

operator*

ScaleFunction operator* ( double  factor, ScaleFunction  base_scale  )

friend

Multiply a scale choice by a constant factor.

For example, multiplying 0.5 and a scale function for H_T will result in a scale function for H_T/2.

operator/

ScaleFunction operator/ ( ScaleFunction  base_scale, double  denom  )

friend

Divide a scale choice by a constant factor.

For example, dividing a scale function for H_T by 2 will result in a scale function for H_T/2.

---

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

• /home/andersen/HEJProjects/website/build/hej/include/HEJ/ScaleFunction.hh