#include <ListBand.hpp>

Inheritance diagram for ListBand:

[legend]

Public Member Functions
const vector< double > &	transmissionValues () const

const vector< double > &	wavelengths () const

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

Protected Member Functions
	ListBand ()

void	getWavelengthsAndTransmissions (Array &lambdav, Array &transv) const override

Protected Member Functions inherited from TabulatedBand
	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 ()

virtual size_t	dataSize () const =0

void	setupSelfAfter () override

virtual const double *	transmissionData () const =0

virtual const double *	wavelengthData () const =0

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 = TabulatedBand

using	ItemType = ListBand

Private Attributes
vector< double >	_transmissionValues

vector< double >	_wavelengths

Friends
class	ItemRegistry

Detailed Description

A ListBand object represents a wavelength band with a transmission curve that is fully specified inside the configuration file (i.e. without referring to an input file). It is intended for use in cases where there are just a few wavelength/transmission pairs, but nothing keeps the user from specifying a long list. The wavelengths must be listed in increasing or decreasing order, and a dimensionless transmission value must be specified corresponding to each wavelength. The transmission outside the range indicated by the first and the last wavelength in the list is considered to be zero. The scaling of the transmission values is arbitrary because the transmission curve will be normalized after being loaded. Refer to the description of the Band class for more information.

Constructor & Destructor Documentation

◆ ListBand()

ListBand::ListBand ( )

inlineprotected

Default constructor for concrete Item subclass ListBand : "a wavelength band (transmission curve) specified inside the configuration file" .

Member Function Documentation

◆ getWavelengthsAndTransmissions()

void ListBand::getWavelengthsAndTransmissions	(	Array &	lambdav,
		Array &	transv
	)		const

overrideprotectedvirtual

This function copies the user-configured wavelengths and transmission values into the result arrays.

Implements TabulatedBand.

◆ transmissionValues()

ListBand::transmissionValues ( ) const

inline

This function returns the value of the discoverable double list property transmissionValues : "the transmission at each of the given wavelengths" .

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

◆ wavelengths()

ListBand::wavelengths ( ) const

inline

This function returns the value of the discoverable double list property wavelengths : "the wavelengths at which to specify the transmission" .

This property represents a physical quantity of type "wavelength" .

The minimum value for this property is "1 pm" .

The maximum value for this property is "1 m" .

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

ListBand.hpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes