TabulatedBand Class Reference

#include <TabulatedBand.hpp>

Inheritance diagram for TabulatedBand:

Protected Member Functions
	TabulatedBand ()
size_t	dataSize () const override
virtual void	getWavelengthsAndTransmissions (Array &lambdav, Array &transv) const =0
void	setupSelfBefore () override
const double *	transmissionData () const override
const double *	wavelengthData () const override
Protected Member Functions inherited from Band
	Band ()
void	setupSelfAfter () override
Protected Member Functions inherited from SimulationItem
	SimulationItem ()
virtual bool	offersInterface (const std::type_info &interfaceTypeInfo) const
Protected Member Functions inherited from Item
	Item ()

Private Types
using	BaseType
using	ItemType

Private Attributes
Array	_lambdav
Array	_transv

Friends
class	ItemRegistry

Additional Inherited Members
Public Member Functions inherited from Band
double	effectiveWidth () const
double	meanSpecificLuminosity (const Array &lambdav, const Array &pv) const
double	pivotWavelength () const
double	transmission (double wavelength) const
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 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

Detailed Description

TabulatedBand is an abstract class for representing a wavelength band that is tabulated by the user in the form of wavelength/transmission pairs. The wavelengths must be listed in increasing or decreasing order. The transmission outside the range indicated by the first and the last wavelength in the list is considered to be zero. Refer to the description of the Band class for more information.

The subclass must load the tabulated data. The scaling of the transmission values is arbitrary because the transmission curve will be normalized by this abstract base class.

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

TabulatedBand()

TabulatedBand::TabulatedBand ( )

inlineprotected

Default constructor for abstract Item subclass TabulatedBand: "a wavelength band (transmission curve) tabulated by the user".

Member Function Documentation

dataSize()

size_t TabulatedBand::dataSize ( ) const

overrideprotectedvirtual

This function returns the number of elements in the wavelength and transmission data arrays held by this subclass.

Implements Band.

getWavelengthsAndTransmissions()

virtual void TabulatedBand::getWavelengthsAndTransmissions ( Array & lambdav, Array & transv ) const

protectedpure virtual

This function must be implemented in each subclass to return the wavelengths and the corresponding transmission values. The function must guarantee that both arrays have the same size. The wavelengths must be listed in increasing or decreasing order. The scaling of the transmission values is arbitrary because the transmission curve will be normalized by this abstract base class.

Implemented in FileBand, and ListBand.

setupSelfBefore()

void TabulatedBand::setupSelfBefore ( )

overrideprotectedvirtual

This function asks the subclass to load the wavelength/transmission pairs and normalizes the transmission values as described in the Band class header.

Reimplemented from SimulationItem.

transmissionData()

const double * TabulatedBand::transmissionData ( ) const

overrideprotectedvirtual

This function returns a pointer to the first transmission value in the corresponding array held by this subclass. The number of elements in this array can be obtained through the dataSize() function. The transmission values are normalized as described in the Band class header.

Implements Band.

wavelengthData()

const double * TabulatedBand::wavelengthData ( ) const

overrideprotectedvirtual

This function returns a pointer to the first wavelength in the corresponding array held by this subclass. The number of elements in this array can be obtained through the dataSize() function.

Implements Band.

---

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

• TabulatedBand.hpp