 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <ApertureInstrument.hpp>
Public Member Functions | |
| 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 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 |
| 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 | |
| ApertureInstrument () | |
| bool | isInsideAperture (PhotonPacket *pp) const |
| 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 |
| Protected Member Functions inherited from Item | |
| Item () | |
Private Types | |
| using | BaseType |
| using | ItemType |
Private Attributes | |
| double | _cosphi |
| double | _costheta |
| double | _radius |
| double | _radius2 |
| double | _sinphi |
| double | _sintheta |
Friends | |
| class | ItemRegistry |
ApertureInstrument is an abstract subclass of DistantInstrument that offers an extra radius property for the user to configure 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).
|
inlineprotected |
Default constructor for abstract Item subclass ApertureInstrument: "a distant instrument that offers an optional circular aperture".
|
protected |
This function returns true if the position of the specified photon packet is inside the configured radius, or if that radius is zero. Otherwise, it returns false.
|
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.
|
overrideprotectedvirtual |
This function stores some information used by the isInsideAperture() function.
Reimplemented from SimulationItem.
Reimplemented in LightCurveInstrument, SEDInstrument, SpectralTimeMapInstrument, and TimeInstrument.