FamilySED Class Reference

#include <FamilySED.hpp>

Inheritance diagram for FamilySED:

Public Member Functions
double	generateWavelength () const override
double	integratedLuminosity (const Range &wavelengthRange) const override
Range	intrinsicWavelengthRange () const override
double	specificLuminosity (double wavelength) const override
void	specificLuminosityArray (Array &lambdav, Array &pv, const Range &wavelengthRange) const override
virtual double	specificLuminosity (double wavelength) const =0
virtual void	specificLuminosityArray (Array &lambdav, Array &pv, const Range &wavelengthRange) const =0
Public Member Functions inherited from SED
virtual double	generateWavelength () const =0
virtual double	integratedLuminosity (const Range &wavelengthRange) const =0
virtual Range	intrinsicWavelengthRange () const =0
Range	normalizationWavelengthRange () const
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
	FamilySED ()
virtual const SEDFamily *	getFamilyAndParameters (Array &parameters)=0
void	setupSelfBefore () override
Protected Member Functions inherited from ContSED
	ContSED ()
Protected Member Functions inherited from SED
	SED ()
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 = ContSED
using	ItemType = FamilySED

Private Attributes
const SEDFamily *	_family
Array	_lambdav
double	_Ltot
Array	_parameters
Array	_pv
Array	_Pv

Friends
class	ItemRegistry

Detailed Description

FamilySED is an abstract class for representing a spectral energy distribution obtained from an SED family for a set of parameters configured by the user. The subclass must provide a function to create the appropriate SEDFamily object and to return the configuration parameters.

Constructor & Destructor Documentation

FamilySED()

FamilySED::FamilySED ( )

inlineprotected

Default constructor for abstract Item subclass FamilySED : "a spectral energy distribution obtained from an SED family" .

Member Function Documentation

generateWavelength()

double FamilySED::generateWavelength ( ) const

overridevirtual

This function draws a random wavelength from the normalized spectral energy distribution.

Implements SED.

getFamilyAndParameters()

virtual const SEDFamily * FamilySED::getFamilyAndParameters ( Array &  parameters )

protectedpure virtual

This function must be implemented in each subclass to return a newly created SEDFamily object (which is already hooked into the simulation item hierachy so it will be automatcially deleted) and to store the parameters for the specific SED configured by the user in the specified array. The SED will be normalized by this abstract base class, so the parameter values can be given for arbitary scaling.

Implemented in BpassSED, BruzualCharlotSED, CastelliKuruczSED, FSPSSED, MappingsSED, MarastonSED, Starburst99SED, and ToddlersSED.

integratedLuminosity()

double FamilySED::integratedLuminosity ( const Range &  wavelengthRange ) const

overridevirtual

This function returns the normalized integrated luminosity \(L\) (i.e. radiative power) over the specified wavelength range.

Implements SED.

intrinsicWavelengthRange()

Range FamilySED::intrinsicWavelengthRange ( ) const

overridevirtual

This function returns the intrinsic wavelength range of the SED. For the current class, the range is retrieved from the associated SED family.

Implements SED.

setupSelfBefore()

void FamilySED::setupSelfBefore ( )

overrideprotectedvirtual

This function asks the subclass to create the appropriate SEDFamily object and to return the configuration parameters. It then sets up the cumulative distribution that will be used to sample random wavelengths.

Reimplemented from SimulationItem.

specificLuminosity()

double FamilySED::specificLuminosity ( double  wavelength ) const

overridevirtual

This function returns the normalized specific luminosity \(L_\lambda\) (i.e. radiative power per unit of wavelength) at the specified wavelength.

Implements ContSED.

specificLuminosityArray()

void FamilySED::specificLuminosityArray ( Array &  lambdav, Array &  pv, const Range &  wavelengthRange  ) const

overridevirtual

This function returns the normalized specific luminosity \(L_\lambda\) (i.e. radiative power per unit of wavelength) at a number of wavelength points within the specified wavelength range.

Implements ContSED.

---

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

• FamilySED.hpp