#include <ListWavelengthDistribution.hpp>
Public Types | |
enum class | UnitStyle : int { neutralmonluminosity , wavelengthmonluminosity , frequencymonluminosity , energymonluminosity } |
Public Member Functions | |
const vector< double > & | probabilities () const |
UnitStyle | unitStyle () const |
const vector< double > & | wavelengths () 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 | |
ListWavelengthDistribution () | |
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 = ListWavelengthDistribution |
Private Attributes | |
vector< double > | _probabilities |
UnitStyle | _unitStyle |
vector< double > | _wavelengths |
Friends | |
class | ItemRegistry |
A ListWavelengthDistribution object represents a wavelength probability distribution that is fully specified inside the configuration file (i.e. without referring to an input file) by tabulated wavelength/probability pairs. The probability distribution function is defined segment-wise by the tabulated values, using logarithmic interpolation. This class is intended for use in cases where there are just a few wavelength/probability pairs, but nothing keeps the user from specifying a long list. The wavelengths must be listed in increasing or decreasing order. The probability outside the range indicated by the first and the last wavelength in the list is considered to be zero.
The probability values are in fact given in luminosity units. The default is to use per-wavelength units, but the user can opt 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.
|
strong |
The enumeration type indicating the specific luminosity unit style, e.g. whether to use specific luminosity per unit of wavelength, frequency or energy.
neutralmonluminosity : "neutral: λ L_λ = ν L_ν" .
wavelengthmonluminosity : "per unit of wavelength: L_λ" .
frequencymonluminosity : "per unit of frequency: L_ν" .
energymonluminosity : "counts per unit of energy: L_E" .
|
inlineprotected |
Default constructor for concrete Item subclass ListWavelengthDistribution : "a wavelength probability distribution specified inside the configuration file" .
|
overrideprotectedvirtual |
This function loads the configured data into the specified arrays.
Implements TabulatedWavelengthDistribution.
|
inline |
This function returns the value of the discoverable double list property probabilities : "the probabilities at each of the given wavelengths" .
This property represents a physical quantity of type "@unitStyle" .
The minimum value for this property is "]0" .
|
inline |
This function returns the value of the discoverable UnitStyle enumeration property unitStyle : "the probability unit style" .
The default value for this property is given by the conditional value expression "wavelengthmonluminosity" .
|
inline |
This function returns the value of the discoverable double list property wavelengths : "the wavelengths at which to specify the probability" .
This property represents a physical quantity of type "wavelength" .
The minimum value for this property is "1 pm" .
The maximum value for this property is "1 m" .