#include <SEDInstrument.hpp>

Inheritance diagram for SEDInstrument:

[legend]

Public Member Functions
void	detect (PhotonPacket *pp) override

double	radius () const

Public Member Functions inherited from DistantInstrument
double	azimuth () const

Direction	bfkobs (const Position &bfr) const override

Direction	bfky (const Position &bfr) const override

void	determineSameObserverAsPreceding (const Instrument *precedingInstrument) override

double	distance () const

double	inclination () const

double	roll () const

Public Member Functions inherited from Instrument
virtual Direction	bfkobs (const Position &bfr) const =0

virtual Direction	bfky (const Position &bfr) const =0

virtual void	detect (PhotonPacket *pp)=0

virtual void	determineSameObserverAsPreceding (const Instrument *precedingInstrument)=0

void	flush ()

string	instrumentName () const

const WavelengthGrid *	instrumentWavelengthGrid () const

bool	isSameObserverAsPreceding () const

string	itemName () const override

int	numScatteringLevels () const

bool	recordComponents () const

bool	recordPolarization () const

bool	recordStatistics () const

WavelengthGrid *	wavelengthGrid () const

void	write ()

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
	SEDInstrument ()

void	setupSelfBefore () override

Protected Member Functions inherited from DistantInstrument
	DistantInstrument ()

void	setupSelfBefore () override

Protected Member Functions inherited from Instrument
	Instrument ()

	~Instrument ()

FluxRecorder *	instrumentFluxRecorder ()

void	setSameObserverAsPreceding ()

void	setupSelfAfter () override

void	setupSelfBefore () override

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

using	ItemType = SEDInstrument

Private Attributes
double	_cosphi

double	_costheta

double	_radius

double	_radius2

double	_sinphi

double	_sintheta

Friends
class	ItemRegistry

Detailed Description

An SEDInstrument object represents a distant instrument that records the spatially integrated flux density for each wavelength and outputs an SED text column file.

The instrument allows configuring the radius of a circular aperture centered on the origin of the model coordinate system and in the plane perpendicular to the instrument's line of sight. Photon packets arriving from a point that parallel projects outside of this aperture are ignored. If the radius is zero (the default value), the instrument does not have an aperture (or, equivalently, the aperture radius is infinite).

Constructor & Destructor Documentation

◆ SEDInstrument()

SEDInstrument::SEDInstrument ( )

inlineprotected

Default constructor for concrete Item subclass SEDInstrument : "a distant instrument that outputs the spatially integrated flux density as an SED" .

Member Function Documentation

◆ detect()

void SEDInstrument::detect ( PhotonPacket * pp )

overridevirtual

This function simulates the detection of a photon packet by the instrument. It verifies that the arriving photon packet projects within the aperture and then calls the detect() function of the FluxRecorder instance associated with this instrument.

Implements Instrument.

◆ radius()

SEDInstrument::radius ( ) const

inline

This function returns the value of the discoverable double property radius : "the radius of the circular aperture, or zero for no aperture" .

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

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

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

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

◆ setupSelfBefore()

void SEDInstrument::setupSelfBefore ( )

overrideprotectedvirtual

This function configures the FluxRecorder instance associated with this instrument.

Reimplemented from DistantInstrument.

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

SEDInstrument.hpp

Public Member Functions

Protected Member Functions

Private Types

Private Attributes