DefaultWavelengthDistribution Class Reference

#include <DefaultWavelengthDistribution.hpp>

Inheritance diagram for DefaultWavelengthDistribution:

Public Member Functions
double	generateWavelength () const override
double	probability (double wavelength) const override
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
	DefaultWavelengthDistribution ()
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 ()
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType
using	ItemType

Private Attributes
double	_logMin
double	_logWidth
Range	_range

Friends
class	ItemRegistry

Detailed Description

A DefaultWavelengthDistribution object represents a wavelength probability distribution for which the logarithm of the wavelength is distributed uniformly over the full wavelength range of the source. This is equivalent to a LogWavelengthDistribution object configured with a wavelength range that fully contains the source wavelength range, but without the need for any user configuration.

Specifically, with \(a\) and \(b\) denoting the minimum and maximum of the source wavelength range, the normalized probability distribution can be written as

\[ p(\lambda) = \begin{cases} \frac{1}{\ln b - \ln a}\,\frac{1}{\lambda} & a < \lambda < b \\ 0 & \mathrm{elsewhere} \end{cases} \]

Using the inversion method, this easily leads to the formula for sampling a wavelength from this distribution:

\[ \ln\lambda = \ln a + (\ln b - \ln a) \mathcal{X} \]

where \(\mathcal{X} \) is a random deviate.

Constructor & Destructor Documentation

DefaultWavelengthDistribution()

DefaultWavelengthDistribution::DefaultWavelengthDistribution ( )

inlineprotected

Default constructor for concrete Item subclass DefaultWavelengthDistribution: "the default (logarithmic) wavelength probability distribution".

Member Function Documentation

generateWavelength()

double DefaultWavelengthDistribution::generateWavelength ( ) const

overridevirtual

This function draws a random wavelength from the wavelength distribution.

Implements WavelengthDistribution.

probability()

double DefaultWavelengthDistribution::probability ( double wavelength ) const

overridevirtual

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

Implements WavelengthDistribution.

setupSelfBefore()

void DefaultWavelengthDistribution::setupSelfBefore ( )

overrideprotectedvirtual

This function precalculates some values used by the other functions in this class.

Reimplemented from SimulationItem.

---

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

• DefaultWavelengthDistribution.hpp