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

#include <PredefinedBandWavelengthGrid.hpp>

Inheritance diagram for PredefinedBandWavelengthGrid:
Inheritance graph
[legend]

Public Member Functions

bool include2MASS () const
 
bool includeGALEX () const
 
bool includeHERSCHEL () const
 
bool includeSDSS () const
 
bool includeWISE () 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

 PredefinedBandWavelengthGrid ()
 
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 = PredefinedBandWavelengthGrid
 

Private Attributes

bool _include2MASS
 
bool _includeGALEX
 
bool _includeHERSCHEL
 
bool _includeSDSS
 
bool _includeWISE
 

Friends

class ItemRegistry
 

Detailed Description

An instance of the PredefinedBandWavelengthGrid class represents a wavelength grid where each bin is defined by a Band object. The class offers a list of predefined bands comprising the GALEX, SDSS, 2MASS, WISE and HERSCHEL broadbands. Each of these sets can be included or excluded as a whole through configuration flags.

Constructor & Destructor Documentation

◆ PredefinedBandWavelengthGrid()

PredefinedBandWavelengthGrid::PredefinedBandWavelengthGrid ( )
inlineprotected

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

Member Function Documentation

◆ bandList()

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

This function returns the list of predefined Band objects, depending on the user-configured flags.

Implements BandWavelengthGrid.

◆ include2MASS()

PredefinedBandWavelengthGrid::include2MASS ( ) const
inline

This function returns the value of the discoverable Boolean property include2MASS : "include 2MASS J, H and Ks bands" .

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

◆ includeGALEX()

PredefinedBandWavelengthGrid::includeGALEX ( ) const
inline

This function returns the value of the discoverable Boolean property includeGALEX : "include GALEX FUV and NUV bands" .

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

◆ includeHERSCHEL()

PredefinedBandWavelengthGrid::includeHERSCHEL ( ) const
inline

This function returns the value of the discoverable Boolean property includeHERSCHEL : "include HERSCHEL PACS 70,100,160 and SPIRE 250,350,500 bands" .

The default value for this property is given by the conditional value expression "DustEmission:true;false" .

◆ includeSDSS()

PredefinedBandWavelengthGrid::includeSDSS ( ) const
inline

This function returns the value of the discoverable Boolean property includeSDSS : "include SDSS ugriz bands" .

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

◆ includeWISE()

PredefinedBandWavelengthGrid::includeWISE ( ) const
inline

This function returns the value of the discoverable Boolean property includeWISE : "include WISE W1, W2, W3 and W4 bands" .

The default value for this property is given by the conditional value expression "DustEmission:true;false" .


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