The SKIRT project
advanced radiative transfer for astrophysics
Public Member Functions | Protected Member Functions | Private Types | Private Attributes | Friends | List of all members
FileSED Class Reference

#include <FileSED.hpp>

Inheritance diagram for FileSED:
Inheritance graph
[legend]

Public Member Functions

string filename () const
 
- Public Member Functions inherited from TabulatedSED
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 ItemgetItemProperty (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)
 
Itemoperator= (const Item &)=delete
 
Itemparent () 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

 FileSED ()
 
void getWavelengthsAndLuminosities (Array &lambdav, Array &pv) const override
 
- Protected Member Functions inherited from TabulatedSED
 TabulatedSED ()
 
virtual void getWavelengthsAndLuminosities (Array &lambdav, Array &pv) const =0
 
void setupSelfBefore () override
 
- Protected Member Functions inherited from ContSED
 ContSED ()
 
- Protected Member Functions inherited from SED
 SED ()
 
Randomrandom () 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 = TabulatedSED
 
using ItemType = FileSED
 

Private Attributes

string _filename
 

Friends

class ItemRegistry
 

Detailed Description

A FileSED object represents a spectral energy distribution that is loaded from an input file. The floating point numbers in the first two columns of the text file specify respectively the wavelength and the corresponding specific luminosity per unit of wavelength. Any additional columns in the file are ignored. The wavelengths must be listed in increasing or decreasing order. The luminosity outside the range indicated by the first and the last wavelength in the file is considered to be zero.

The wavelengths are by default given in micron (the units can be overridden by column header info in the file). The specific luminosity values are by default given in per-wavelength units. Again, this can be overridden by column header info in the file to use per-frequency or neutral units. Other than this, the scaling of the values is arbitrary because the SED will be normalized after being loaded. However, the input procedure still insists on knowing the precise units.

Constructor & Destructor Documentation

◆ FileSED()

FileSED::FileSED ( )
inlineprotected

Default constructor for concrete Item subclass FileSED : "a spectral energy distribution loaded from a text file" .

Member Function Documentation

◆ filename()

string FileSED::filename ( ) const
inline

This function returns the value of the discoverable string property filename : "the name of the file with the spectral energy distribution" .

◆ getWavelengthsAndLuminosities()

void FileSED::getWavelengthsAndLuminosities ( Array lambdav,
Array pv 
) const
overrideprotectedvirtual

This function loads the input file into the specified arrays.

Implements TabulatedSED.


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