The SKIRT project
advanced radiative transfer for astrophysics
FullInstrument Class Reference

#include <FullInstrument.hpp>

Inheritance diagram for FullInstrument:

Protected Member Functions

 FullInstrument ()
void setupSelfBefore () override
Protected Member Functions inherited from FrameInstrument
 FrameInstrument ()
Protected Member Functions inherited from DistantInstrument
 DistantInstrument ()
Protected Member Functions inherited from Instrument
 Instrument ()
 ~Instrument ()
FluxRecorderinstrumentFluxRecorder ()
void setSameObserverAsPreceding ()
void setupSelfAfter () override
void setupSelfBefore () 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

Friends

class ItemRegistry

Additional Inherited Members

Public Member Functions inherited from FrameInstrument
double centerX () const
double centerY () const
void detect (PhotonPacket *pp) override
double fieldOfViewX () const
double fieldOfViewY () const
int numPixelsX () const
int numPixelsY () 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
void flush ()
string instrumentName () const
const WavelengthGridinstrumentWavelengthGrid () const
bool isSameObserverAsPreceding () const
string itemName () const override
int numScatteringLevels () const
bool recordComponents () const
bool recordPolarization () const
bool recordStatistics () const
WavelengthGridwavelengthGrid () 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
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 ItemgetItemProperty (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)
Itemoperator= (const Item &)=delete
Itemparent () 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

A FullInstrument object represents a distant instrument that records and outputs both the spatially integrated flux density for each wavelength (as an SED text column file) and the surface brightness in every pixel of a given frame for each wavelength (as an IFU data cube in a FITS file).

This instrument acts as a combination of an SEDInstrument with infinite aperture radius and a FrameInstrument with a configurable field of view. Photon packets arriving from a point that parallel projects outside of this field of view are ignored for the purposes of the embedded FrameInstrument, but are still included in the results of the embedded SEDInstrument. Therefore, when interpreting the instrument output for a particular wavelength, spatially integrating the surface brightness recorded by the embedded FrameInstrument might produce a lower flux density value than the one recorded by the embedded SEDInstrument.

Constructor & Destructor Documentation

◆ FullInstrument()

FullInstrument::FullInstrument ( )
inlineprotected

Default constructor for concrete Item subclass FullInstrument: "a distant instrument that outputs both the flux density (SED) and surface brightness (data cube)".

Member Function Documentation

◆ setupSelfBefore()

void FullInstrument::setupSelfBefore ( )
overrideprotectedvirtual

This function augments the FluxRecorder configuration established in the FrameInstrumet base class by requesting an SED in addition to a data cube.

Reimplemented from FrameInstrument.


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