FileIndexedSEDFamily Class Reference

#include <FileIndexedSEDFamily.hpp>

Inheritance diagram for FileIndexedSEDFamily:

Public Member Functions
double	cdf (Array &lambdav, Array &pv, Array &Pv, const Range &wavelengthRange, const Array &parameters) const override
string	filename () const
Range	intrinsicWavelengthRange () const override
vector< SnapshotParameter >	parameterInfo () const override
double	specificLuminosity (double wavelength, const Array &parameters) const override
virtual double	cdf (Array &lambdav, Array &pv, Array &Pv, const Range &wavelengthRange, const Array &parameters) const =0
virtual Range	intrinsicWavelengthRange () const =0
virtual vector< SnapshotParameter >	parameterInfo () const =0
virtual double	specificLuminosity (double wavelength, const Array &parameters) 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
	FileIndexedSEDFamily ()
void	setupSelfBefore () override
Protected Member Functions inherited from SEDFamily
	SEDFamily ()
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 = SEDFamily
using	ItemType = FileIndexedSEDFamily

Private Attributes
string	_filename
StoredTable< 2 >	_table

Friends
class	ItemRegistry

Detailed Description

An instance of the FileIndexedSEDFamily can be used to specify user-provided spectra for an imported source such as a CellSource or a ParticleSource. This can be useful, for example, to include emission from the interstellar medium in a simulation. The spectra should be provided in SKIRT stored table format as a 2-dimensional table with the wavelength as the first axis.

The implementation of this class has on purpose been kept very basic to allow for maximum flexibility: the spectra are parametrised using a single (positive) dimensionless index parameter that identifies each spectrum. Apart from the positivity requirement, there are no restrictions on the values of the index. Although originally conceived as an integer counter, the use of a stored table by the implementation also allows for floating point indices. Care has to be taken that the indices referenced by the imported source elements do in fact exist in the stored table. If not, the implementation will interpolate from existing index values and this interpolation will most likely be wrong because spectra with consecutive indices do not necessarily have a physical relationship.

To allow for source elements without emission, a negative index is interpreted as "no emission".

Constructor & Destructor Documentation

FileIndexedSEDFamily()

FileIndexedSEDFamily::FileIndexedSEDFamily ( )

inlineprotected

Default constructor for concrete Item subclass FileIndexedSEDFamily : "a user-provided, indexed SED family" .

Member Function Documentation

cdf()

double FileIndexedSEDFamily::cdf ( Array &  lambdav, Array &  pv, Array &  Pv, const Range &  wavelengthRange, const Array &  parameters  ) const

overridevirtual

This function constructs both the normalized probability density function (pdf) and the corresponding normalized cumulative distribution function (cdf) for the SED with the specified parameters over the specified wavelength range. The function returns the normalization factor. The number and type of parameters must match the information returned by the parameterInfo() function; if not the behavior is undefined.

Implements SEDFamily.

filename()

string FileIndexedSEDFamily::filename ( ) const

inline

This function returns the value of the discoverable string property filename : "the name of the stored table file listing the SEDs" .

intrinsicWavelengthRange()

Range FileIndexedSEDFamily::intrinsicWavelengthRange ( ) const

overridevirtual

This function returns the intrinsic wavelength range of the SED family. It retrieves this range from the underlying stored table.

Implements SEDFamily.

parameterInfo()

vector< SnapshotParameter > FileIndexedSEDFamily::parameterInfo ( ) const

overridevirtual

This function returns the number and type of parameters used by this particular SED family as a list of SnapshotParameter objects. Each of these objects specifies unit information and a human-readable descripton for the parameter.

Implements SEDFamily.

setupSelfBefore()

void FileIndexedSEDFamily::setupSelfBefore ( )

overrideprotectedvirtual

This function opens the user-specified resource file (in SKIRT stored table format).

Reimplemented from SimulationItem.

specificLuminosity()

double FileIndexedSEDFamily::specificLuminosity ( double  wavelength, const Array &  parameters  ) const

overridevirtual

This function returns the specific luminosity \(L_\lambda\) (i.e. radiative power per unit of wavelength) for the SED with the specified parameters at the specified wavelength, or zero if the wavelength is outside of the SED's intrinsic wavelength range. The number and type of parameters must match the information returned by the parameterInfo() function; if not the behavior is undefined.

Implements SEDFamily.

---

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

• FileIndexedSEDFamily.hpp