TabulatedWavelengthDistribution Class Reference

#include <TabulatedWavelengthDistribution.hpp>

Inheritance diagram for TabulatedWavelengthDistribution:

Public Member Functions
double	generateWavelength () const override
double	probability (double wavelength) const override
virtual double	generateWavelength () const =0
virtual double	probability (double wavelength) const =0
Public Member Functions inherited from SimulationItem
template<class T >
T *	find (bool setup=true) const
template<class T >
T *	interface (int levels=-999999, bool setup=true) const
virtual string	itemName () const
void	setup ()
string	typeAndName () const
Public Member Functions inherited from Item
	Item (const Item &)=delete
virtual	~Item ()
void	addChild (Item *child)
const vector< Item * > &	children () const
virtual void	clearItemListProperty (const PropertyDef *property)
void	destroyChild (Item *child)
virtual bool	getBoolProperty (const PropertyDef *property) const
virtual vector< double >	getDoubleListProperty (const PropertyDef *property) const
virtual double	getDoubleProperty (const PropertyDef *property) const
virtual string	getEnumProperty (const PropertyDef *property) const
virtual int	getIntProperty (const PropertyDef *property) const
virtual vector< Item * >	getItemListProperty (const PropertyDef *property) const
virtual Item *	getItemProperty (const PropertyDef *property) const
virtual string	getStringProperty (const PropertyDef *property) const
int	getUtilityProperty (string name) const
virtual void	insertIntoItemListProperty (const PropertyDef *property, int index, Item *item)
Item &	operator= (const Item &)=delete
Item *	parent () const
virtual void	removeFromItemListProperty (const PropertyDef *property, int index)
virtual void	setBoolProperty (const PropertyDef *property, bool value)
virtual void	setDoubleListProperty (const PropertyDef *property, vector< double > value)
virtual void	setDoubleProperty (const PropertyDef *property, double value)
virtual void	setEnumProperty (const PropertyDef *property, string value)
virtual void	setIntProperty (const PropertyDef *property, int value)
virtual void	setItemProperty (const PropertyDef *property, Item *item)
virtual void	setStringProperty (const PropertyDef *property, string value)
void	setUtilityProperty (string name, int value)
virtual string	type () const

Protected Member Functions
	TabulatedWavelengthDistribution ()
virtual void	getWavelengthsAndProbabilities (Array &lambdav, Array &pv) const =0
void	setupSelfBefore () override
Protected Member Functions inherited from WavelengthDistribution
	WavelengthDistribution ()
Random *	random () const
void	setupSelfBefore () override
Protected Member Functions inherited from SimulationItem
	SimulationItem ()
virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const
virtual void	setupSelfAfter ()
virtual void	setupSelfBefore ()
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType = WavelengthDistribution
using	ItemType = TabulatedWavelengthDistribution

Private Attributes
Array	_lambdav
Array	_pv
Array	_Pv

Friends
class	ItemRegistry

Detailed Description

TabulatedWavelengthDistribution is an abstract class for representing wavelength probability distributions that are tabulated by the user in the form of wavelength/probability pairs. The probability distribution function is defined segment-wise by the tabulated values, using logarithmic interpolation. The wavelengths must be listed in increasing or decreasing order. Probability values outside the range indicated by the first and the last tabulated wavelength are considered to be zero. In addition, this range is intersected with the wavelength range of the associated source (obtained through the SourceWavelengthRangeInterface) before the distribution is normalized.

The subclass must load the tabulated data, and this abstract class handles everything else.

Constructor & Destructor Documentation

TabulatedWavelengthDistribution()

TabulatedWavelengthDistribution::TabulatedWavelengthDistribution ( )

inlineprotected

Default constructor for abstract Item subclass TabulatedWavelengthDistribution : "a wavelength probability distribution tabulated by the user" .

Member Function Documentation

generateWavelength()

double TabulatedWavelengthDistribution::generateWavelength ( ) const

overridevirtual

This function draws a random wavelength from the wavelength distribution.

Implements WavelengthDistribution.

getWavelengthsAndProbabilities()

virtual void TabulatedWavelengthDistribution::getWavelengthsAndProbabilities ( Array &  lambdav, Array &  pv  ) const

protectedpure virtual

This function must be implemented in each subclass to return the wavelengths and the corresponding probabilities tabulating the distribution. The function must guarantee that both arrays have the same size. The wavelengths must be listed in increasing or decreasing order. Constant scaling of the probabilities is not important because the distribution will be normalized by this abstract class.

Implemented in FileWavelengthDistribution, and ListWavelengthDistribution.

probability()

double TabulatedWavelengthDistribution::probability ( double  wavelength ) const

overridevirtual

This function returns the probability of the distribution at the given wavelength.

Implements WavelengthDistribution.

setupSelfBefore()

void TabulatedWavelengthDistribution::setupSelfBefore ( )

overrideprotectedvirtual

This function asks the subclass to load the wavelength/probability pairs and precalculates the cumulative distribution for use by the other functions in this class.

Reimplemented from SimulationItem.

---

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

• TabulatedWavelengthDistribution.hpp