#include <InstrumentWavelengthGridProbe.hpp>

Inheritance diagram for InstrumentWavelengthGridProbe:

[legend]

Static Public Member Functions
static void	writeWavelengthGrid (Probe item, const WavelengthGrid wavelengthGrid, string filename, string description)

Protected Member Functions
	InstrumentWavelengthGridProbe ()

void	probe () override

Protected Member Functions inherited from SpecialtyProbe
	SpecialtyProbe ()

Protected Member Functions inherited from Probe
	Probe ()

virtual void	initialize ()

virtual void	probe ()=0

virtual When	when () const

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

using	ItemType = InstrumentWavelengthGridProbe

Friends
class	ItemRegistry

Additional Inherited Members
Public Member Functions inherited from Probe
string	itemName () const override

int	iter () const

string	probeName () const

void	probePrimary (int iter)

void	probeRun ()

void	probeSecondary (int iter)

void	probeSetup ()

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 Types inherited from Probe
enum class	When { Setup , Run , Primary , Secondary }

Detailed Description

WavelengthGridProbe outputs a text column file with information on the wavelength grid for each instrument. Each file is named prefix_instr_wavelengths.txt so that it sits next to the files written by the corresponding instrument. For each wavelength bin, the file lists the characteristic wavelength, the wavelength bin width, and the left and right borders of the bin.

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

Constructor & Destructor Documentation

◆ InstrumentWavelengthGridProbe()

InstrumentWavelengthGridProbe::InstrumentWavelengthGridProbe ( )

inlineprotected

Default constructor for concrete Item subclass InstrumentWavelengthGridProbe : "wavelength grid: instruments" .

Member Function Documentation

◆ probe()

void InstrumentWavelengthGridProbe::probe ( )

overrideprotectedvirtual

This function performs probing.

Implements Probe.

◆ writeWavelengthGrid()

static void InstrumentWavelengthGridProbe::writeWavelengthGrid	(	Probe *	item,
		const WavelengthGrid *	wavelengthGrid,
		string	filename,
		string	description
	)

static

This function outputs a column text file for the specified wavelength grid in the format as described in the header of this class. It can be used from other probes to output wavelength grid details.

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

InstrumentWavelengthGridProbe.hpp

Static Public Member Functions

Protected Member Functions

Private Types