SEDFamily Class Reference

#include <SEDFamily.hpp>

Inheritance diagram for SEDFamily:

Public Member Functions
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
	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 = SimulationItem
using	ItemType = SEDFamily

Friends
class	ItemRegistry

Detailed Description

SEDFamily is an abstract class for representing some family of SEDs. Each subclass implements an SED family, where the exact form of the SED depends on one or more parameters. This base class offers a generic interface for obtaining information on a particlar SED from the family, given the appropriate number and type of parameter values.

Constructor & Destructor Documentation

SEDFamily()

SEDFamily::SEDFamily ( )

inlineprotected

Default constructor for abstract Item subclass SEDFamily : "an SED family" .

Member Function Documentation

cdf()

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

pure virtual

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. If the wavelength range or any of the parameter values are out of range of the internal grid, the corresponding luminosities are considered to be zero. The number and type of parameters must match the information returned by the parameterInfo() function; if not the behavior is undefined.

The resulting wavelength grid is constructed into lambdav, the corresponding pdf into pv, and the corresponding cdf into Yv. The function returns the normalization factor, i.e. the value of Pv[n] before normalization.

Implemented in BlackBodySEDFamily, BpassSEDFamily, BruzualCharlotSEDFamily, CastelliKuruczSEDFamily, FileIndexedSEDFamily, FileSSPSEDFamily, FSPSSEDFamily, LyaDoublePeakedSEDFamily, LyaGaussianSEDFamily, LyaSEDFamilyDecorator, MappingsSEDFamily, MarastonSEDFamily, SpinFlipSEDFamily, Starburst99SEDFamily, and ToddlersSEDFamily.

intrinsicWavelengthRange()

virtual Range SEDFamily::intrinsicWavelengthRange ( ) const

pure virtual

This function returns the intrinsic wavelength range of the SED family. Outside this range, all luminosities are zero.

Implemented in BlackBodySEDFamily, BpassSEDFamily, BruzualCharlotSEDFamily, CastelliKuruczSEDFamily, FileIndexedSEDFamily, FileSSPSEDFamily, FSPSSEDFamily, LyaDoublePeakedSEDFamily, LyaGaussianSEDFamily, LyaSEDFamilyDecorator, MappingsSEDFamily, MarastonSEDFamily, SpinFlipSEDFamily, Starburst99SEDFamily, and ToddlersSEDFamily.

parameterInfo()

virtual vector< SnapshotParameter > SEDFamily::parameterInfo ( ) const

pure virtual

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.

Implemented in BlackBodySEDFamily, BpassSEDFamily, BruzualCharlotSEDFamily, CastelliKuruczSEDFamily, FileIndexedSEDFamily, FileSSPSEDFamily, FSPSSEDFamily, LyaDoublePeakedSEDFamily, LyaGaussianSEDFamily, LyaSEDFamilyDecorator, MappingsSEDFamily, MarastonSEDFamily, SpinFlipSEDFamily, Starburst99SEDFamily, and ToddlersSEDFamily.

specificLuminosity()

virtual double SEDFamily::specificLuminosity ( double  wavelength, const Array &  parameters  ) const

pure virtual

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.

Implemented in BlackBodySEDFamily, BpassSEDFamily, BruzualCharlotSEDFamily, CastelliKuruczSEDFamily, FileIndexedSEDFamily, FileSSPSEDFamily, FSPSSEDFamily, LyaDoublePeakedSEDFamily, LyaGaussianSEDFamily, LyaSEDFamilyDecorator, MappingsSEDFamily, MarastonSEDFamily, SpinFlipSEDFamily, Starburst99SEDFamily, and ToddlersSEDFamily.

---

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

• SEDFamily.hpp