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

#include <ConfigurableBandWavelengthGrid.hpp>

Inheritance diagram for ConfigurableBandWavelengthGrid:
Inheritance graph
[legend]

Public Member Functions

const vector< Band * > & bands () const
 
- Public Member Functions inherited from BandWavelengthGrid
const Bandband (int ell) const
 
int bin (double lambda) const override
 
vector< int > bins (double lambda) const override
 
double effectiveWidth (int ell) const override
 
double leftBorder (int ell) const override
 
int numBins () const override
 
double rightBorder (int ell) const override
 
double transmission (int ell, double lambda) const override
 
double wavelength (int ell) const override
 
- Public Member Functions inherited from WavelengthGrid
virtual int bin (double lambda) const =0
 
virtual vector< int > bins (double lambda) const =0
 
virtual double effectiveWidth (int ell) const =0
 
virtual double leftBorder (int ell) const =0
 
virtual int numBins () const =0
 
virtual double rightBorder (int ell) const =0
 
virtual double transmission (int ell, double lambda) const =0
 
virtual double wavelength (int ell) const =0
 
Range wavelengthRange () 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

 ConfigurableBandWavelengthGrid ()
 
vector< Band * > bandList () override
 
- Protected Member Functions inherited from BandWavelengthGrid
 BandWavelengthGrid ()
 
virtual vector< Band * > bandList ()=0
 
void setupSelfAfter () override
 
- Protected Member Functions inherited from WavelengthGrid
 WavelengthGrid ()
 
- 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 = BandWavelengthGrid
 
using ItemType = ConfigurableBandWavelengthGrid
 

Private Attributes

vector< Band * > _bands
 

Friends

class ItemRegistry
 

Detailed Description

An instance of the ConfigurableBandWavelengthGrid class represents a wavelength grid where each bin is defined by a Band object. These bands can be individually configured by the user. Examples include the standard Johnson filters and the broadbands for actual observatories such as GALEX, SDSS or Herschel. See the Band class for more information.

The Band objects are automatically sorted in order of increasing pivot wavelength, even if the configuration file specifies a different order. The intervals in which the transmission is nonzero is allowed to overlap, but no two bands in the list should have the same pivot wavelength (this restriction essentially disallows specifying the same band twice).

This item type is displayed only if the Boolean expression "Level2" evaluates to true after replacing the names by true or false depending on their presence.

Constructor & Destructor Documentation

◆ ConfigurableBandWavelengthGrid()

ConfigurableBandWavelengthGrid::ConfigurableBandWavelengthGrid ( )
inlineprotected

Default constructor for concrete Item subclass ConfigurableBandWavelengthGrid : "a wavelength grid including a configurable list of (broad)bands" .

Member Function Documentation

◆ bandList()

vector< Band * > ConfigurableBandWavelengthGrid::bandList ( )
overrideprotectedvirtual

This function returns the list of user-configured Band objects.

Implements BandWavelengthGrid.

◆ bands()

ConfigurableBandWavelengthGrid::bands ( ) const
inline

This function returns the value of the discoverable item list property bands : "the (broad)bands defining this wavelength grid" .

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


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