BandLuminosityNormalization Class Reference

#include <BandLuminosityNormalization.hpp>

Inheritance diagram for BandLuminosityNormalization:

Public Types
enum class	UnitStyle : int { neutralmonluminosity , wavelengthmonluminosity , frequencymonluminosity , energymonluminosity }

Public Member Functions
Band *	band () const
double	luminosityForSED (SED *sed) const override
double	specificLuminosity () const
UnitStyle	unitStyle () 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
	BandLuminosityNormalization ()
Protected Member Functions inherited from LuminosityNormalization
	LuminosityNormalization ()
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
using	ItemType

Private Attributes
Band *	_band
double	_specificLuminosity
UnitStyle	_unitStyle

Friends
class	ItemRegistry

Detailed Description

A BandLuminosityNormalization instance sets the normalization of a primary source by specifying the mean specific luminosity (radiative power per units of wavelength or frequency) for a given wavelength band such as, for example, a standard Johnson filter or the transmission curve for an actual instrument. See the Band class for more information.

Member Enumeration Documentation

UnitStyle

enum class BandLuminosityNormalization::UnitStyle : int

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".

Constructor & Destructor Documentation

BandLuminosityNormalization()

BandLuminosityNormalization::BandLuminosityNormalization ( )

inlineprotected

Default constructor for concrete Item subclass BandLuminosityNormalization: "source normalization through the specific luminosity for a given wavelength band".

Member Function Documentation

band()

Band * BandLuminosityNormalization::band ( ) const

inline

This function returns the value of the discoverable item property band: "the wavelength band for which to provide the specific luminosity".

The default value for this property is given by the conditional value expression "BroadBand".

luminosityForSED()

double BandLuminosityNormalization::luminosityForSED ( SED * sed ) const

overridevirtual

This function returns the luminosity of a source with the specified SED, limited to the source's wavelength range. Given that the luminosity of the spectrum described by the SED object over the source wavelength range is normalized to unity, the requested luminosity is obtained by dividing the user-configured specific luminosity by the normalized specific luminosity in the SED at the same wavelength.

Implements LuminosityNormalization.

specificLuminosity()

double BandLuminosityNormalization::specificLuminosity ( ) const

inline

This function returns the value of the discoverable double property specificLuminosity: "the specific luminosity for the given band".

This property represents a physical quantity of type "@unitStyle".

The minimum value for this property is "]0".

unitStyle()

UnitStyle BandLuminosityNormalization::unitStyle ( ) const

inline

This function returns the value of the discoverable UnitStyle enumeration property unitStyle: "the luminosity unit style".

The default value for this property is given by the conditional value expression "wavelengthmonluminosity".

---

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

• BandLuminosityNormalization.hpp