#include <FileBand.hpp>

Inheritance diagram for FileBand:

[legend]

Public Member Functions
string	filename () 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
	FileBand ()

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

Private Attributes
string	_filename

Friends
class	ItemRegistry

Detailed Description

A FileBand object represents a wavelength band with a transmission curve 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 transmission value. Any additional columns in the file are ignored. 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.

The wavelengths are by default given in micron (the units can be overridden by column header info in the file). The transmission values are dimensionless. The scaling of these 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

◆ FileBand()

FileBand::FileBand ( )

inlineprotected

Default constructor for concrete Item subclass FileBand : "a wavelength band (transmission curve) loaded from a text file" .

Member Function Documentation

◆ filename()

string FileBand::filename ( ) const

inline

This function returns the value of the discoverable string property filename : "the name of the file defining the transmission curve" .

◆ getWavelengthsAndTransmissions()

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

overrideprotectedvirtual

This function loads the wavelengths and the corresponding transmission values from the user-configured text file and returns them into the result arrays.

Implements TabulatedBand.

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

FileBand.hpp

Public Member Functions

Protected Member Functions

Private Types