 |
The SKIRT project
advanced radiative transfer for astrophysics
|
|
The SKIRT project
advanced radiative transfer for astrophysics
|
#include <ImportedSourceLuminosityProbe.hpp>
Public Member Functions | |
| bool | convolve () const |
| WavelengthGrid * | materialWavelengthGrid () const override |
| WavelengthGrid * | wavelengthGrid () const |
| Range | wavelengthRange () const override |
 Public Member Functions inherited from InputModelFormProbe | |
| GenericForm * | form () const |
| void | probe () override |
| 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 |
| virtual WavelengthGrid * | materialWavelengthGrid () const |
| Public Member Functions inherited from WavelengthRangeInterface | |
| virtual | ~WavelengthRangeInterface () |
| virtual Range | wavelengthRange () const =0 |
Protected Member Functions | |
| ImportedSourceLuminosityProbe () | |
| void | probeImportedSources (const vector< const ImportedSource * > &sources, const vector< const Snapshot * > &snapshots) override |
| Protected Member Functions inherited from InputModelFormProbe | |
| InputModelFormProbe () | |
| virtual void | probeImportedMedium (string sh, const ImportedMedium *medium, const Snapshot *snapshot) |
| virtual void | probeImportedSources (const vector< const ImportedSource * > &sources, const vector< const Snapshot * > &snapshots) |
| 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 () | |
| Protected Member Functions inherited from MaterialWavelengthRangeInterface | |
| MaterialWavelengthRangeInterface () | |
| Protected Member Functions inherited from WavelengthRangeInterface | |
| WavelengthRangeInterface () | |
Private Types | |
| using | BaseType = InputModelFormProbe |
| using | ItemType = ImportedSourceLuminosityProbe |
Private Attributes | |
| bool | _convolve |
| WavelengthGrid * | _wavelengthGrid |
Friends | |
| class | ItemRegistry |
Additional Inherited Members | |
| Protected Types inherited from Probe | |
| enum class | When { Setup , Run , Primary , Secondary } |
ImportedSourceLuminosityProbe probes the specific luminosity aggregated over all imported sources in the simulation at the wavelengths specified by a user-configured wavelength grid. The probe uses the data as represented by the imported snapshot, without involving the spatial grid of the simulation. It produces output only if the simulation has at least one source component and if all sources are imported.
When associated with a form that samples the luminosity at a set of positions, such as for a linear or planar cut, the probe outputs a monochromatic luminosity volume density (with SI units of W/m/m3 for the per-wavelength flavor). When associated with a form that projects the luminosity along a path, the probe outputs a monochromatic luminosity surface density divided by the area of the unit sphere (with resulting SI units of W/m/m2/sr for the per-wavelength flavor). In case of parallel projection towards a distant observer, this quantity is equivalent to surface brightness. In other words, this probe can be used to produce transparent noise-free images of the imported sources.
If the convolve configuration property is false, the specific luminosity is sampled at the characteristic wavelength of each bin. If the convolve property is true, the specific luminosity is averaged over the width of each wavelength bin (for disjoint wavelength grids) or convolved over each broadband transmission curve (for band wavelength bins). This option is ignored for oligochromatic simulation modes.
This item type is displayed only if the Boolean expression "ImportedSource" evaluates to true after replacing the names by true or false depending on their presence.
|
inlineprotected |
Default constructor for concrete Item subclass ImportedSourceLuminosityProbe : "imported source: specific luminosity density" .
|
inline |
This function returns the value of the discoverable Boolean property convolve : "average or convolve the specific luminosity over the wavelength bin" .
The default value for this property is given by the conditional value expression "false" .
This property is relevant only if the Boolean expression "Panchromatic" evaluates to true after replacing the names by true or false depending on their presence.
|
overridevirtual |
This function returns a pointer to the user-configured wavelength grid for this probe, if any, indicating that wavelength-dependent material properties may be required for these wavelengths.
Reimplemented from MaterialWavelengthRangeInterface.
|
overrideprotectedvirtual |
This function probes the specified imported source components.
Reimplemented from InputModelFormProbe.
|
inline |
This function returns the value of the discoverable item property wavelengthGrid : "the wavelength grid for this probe" .
This property is relevant only if the Boolean expression "Panchromatic" evaluates to true after replacing the names by true or false depending on their presence.
This property is required only if the Boolean expression "!DefaultInstrumentWavelengthGrid" evaluates to true after replacing the names by true or false depending on their presence.
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.
|
overridevirtual |
This function returns a wavelength range corresponding to the user-configured wavelength grid for this probe, if any, indicating that wavelength-dependent material properties may be required for this wavelength range.
Implements WavelengthRangeInterface.