#include <FileWavelengthDistribution.hpp>

Inheritance diagram for FileWavelengthDistribution:

[legend]

Public Member Functions
string	filename () const

Public Member Functions inherited from TabulatedWavelengthDistribution
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
	FileWavelengthDistribution ()

void	getWavelengthsAndProbabilities (Array &lambdav, Array &pv) const override

Protected Member Functions inherited from TabulatedWavelengthDistribution
	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 = TabulatedWavelengthDistribution

using	ItemType = FileWavelengthDistribution

Private Attributes
string	_filename

Friends
class	ItemRegistry

Detailed Description

A FileWavelengthDistribution object represents a wavelength probability distribution that is loaded from an input file. The floating point numbers in the first two columns of the text file specify respectively the wavelength and the corresponding probability value. Any additional columns in the file are ignored. 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 wavelength in the file are considered to be zero.

The wavelengths are by default given in micron (the units can be overridden by column header info in the file). The probability values are in fact given in luminosity units. The default is to use per-wavelength units. Again, this can be overridden by column header info in the file to use per-frequency or neutral units. Other than this, the scaling of the values is arbitrary because the distribution will be normalized after being loaded. However, the input procedure still insists on knowing the precise units.

Constructor & Destructor Documentation

◆ FileWavelengthDistribution()

FileWavelengthDistribution::FileWavelengthDistribution ( )

inlineprotected

Default constructor for concrete Item subclass FileWavelengthDistribution : "a wavelength probability distribution loaded from a text file" .

Member Function Documentation

◆ filename()

string FileWavelengthDistribution::filename ( ) const

inline

This function returns the value of the discoverable string property filename : "the name of the file with the wavelength probability distribution" .

◆ getWavelengthsAndProbabilities()

void FileWavelengthDistribution::getWavelengthsAndProbabilities	(	Array &	lambdav,
		Array &	pv
	)		const

overrideprotectedvirtual

This function loads the input file into the specified arrays.

Implements TabulatedWavelengthDistribution.

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

FileWavelengthDistribution.hpp

Public Member Functions

Protected Member Functions

Private Types