The SKIRT project
advanced radiative transfer for astrophysics
TimeInstrument Class Reference

#include <TimeInstrument.hpp>

Inheritance diagram for TimeInstrument:

Public Member Functions

TimeGridtimeGrid () const
Public Member Functions inherited from ApertureInstrument
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 void detect (PhotonPacket *pp)=0
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

Protected Member Functions

 TimeInstrument ()
void setupSelfBefore () override
Protected Member Functions inherited from ApertureInstrument
 ApertureInstrument ()
bool isInsideAperture (PhotonPacket *pp) const
Protected Member Functions inherited from DistantInstrument
 DistantInstrument ()
Protected Member Functions inherited from Instrument
 Instrument ()
 ~Instrument ()
FluxRecorderinstrumentFluxRecorder ()
void setSameObserverAsPreceding ()
void setupSelfAfter () 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

Private Attributes

TimeGrid_timeGrid

Friends

class ItemRegistry

Detailed Description

TimeInstrument is an abstract subclass of ApertureInstrument (and thus of DistantInstrument) that offers a TimeGrid property, used by subclasses that record the timelag response to a pulse in the source luminosity. The origin of the arrival time is defined as the time at which a photon emitted at the spatial origin arrives at the observer directly.

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

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

Constructor & Destructor Documentation

◆ TimeInstrument()

TimeInstrument::TimeInstrument ( )
inlineprotected

Default constructor for abstract Item subclass TimeInstrument: "an instrument that records the timelag response to a source luminosity pulse".

Member Function Documentation

◆ setupSelfBefore()

void TimeInstrument::setupSelfBefore ( )
overrideprotectedvirtual

This function configures the FluxRecorder instance associated with this instrument.

Reimplemented from ApertureInstrument.

◆ timeGrid()

TimeGrid * TimeInstrument::timeGrid ( ) const
inline

This function returns the value of the discoverable item property timeGrid: "the time grid for this instrument".


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