Ray-tracing scene. More...
#include <GyotoScenery.h>
Public Member Functions | |
| Scenery () | |
| Set everything to defaults. | |
| Scenery (const Scenery &o) | |
| Copy constructor. | |
| Scenery * | clone () const |
| Cloner. | |
| Scenery (SmartPointer< Metric::Generic >, SmartPointer< Screen >, SmartPointer< Astrobj::Generic >) | |
| SmartPointer< Metric::Generic > | getMetric () |
| Get Metric. | |
| void | setMetric (SmartPointer< Metric::Generic >) |
| Set Metric. | |
| SmartPointer< Screen > | getScreen () |
| Get Screen object. | |
| void | setScreen (SmartPointer< Screen >) |
| Set screen object. | |
| SmartPointer< Astrobj::Generic > | getAstrobj () |
| void | setAstrobj (SmartPointer< Astrobj::Generic >) |
| double | getDelta () const |
| void | setDelta (double) |
| void | setRequestedQuantities (Quantity_t) |
| void | setRequestedQuantities (std::string) |
| Quantity_t | getRequestedQuantities () const |
| std::string | getRequestedQuantitiesString () const |
| size_t | getScalarQuantitiesCount () const |
| void | setTlim (double) |
| set tlim_; | |
| double | getTlim () const |
| get tlim_ | |
| void | rayTrace (size_t imin, size_t imax, size_t jmin, size_t jmax, Astrobj::Properties *data, double *impactcoords=NULL) |
| void | operator() (size_t i, size_t j, Astrobj::Properties *data, double *impactcoords=NULL) |
| void | fillElement (FactoryMessenger *fmp) |
| called from Factory | |
Protected Types | |
| typedef Gyoto::SmartPointer < Gyoto::SmartPointee > | Subcontractor_t (Gyoto::FactoryMessenger *) |
| A subcontractor builds an object upon order from the Factory. | |
Protected Member Functions | |
| void | incRefCount () |
| Increment the reference counter. Warning: Don't mess with the counter. | |
| int | decRefCount () |
| Decrement the reference counter and return current value. Warning: Don't mess with the counter. | |
| int | getRefCount () |
| Get the current number of references. | |
Protected Attributes | |
| SmartPointer< Metric::Generic > | gg_ |
| SmartPointer< Screen > | screen_ |
| SmartPointer< Astrobj::Generic > | obj_ |
| double | delta_ |
| Gyoto::Quantity_t | quantities_ |
| Gyoto::Photon | ph_ |
| a Photon. | |
| double | tlim_ |
| Time limit for the integration (geometrical units) | |
Friends | |
| class | Gyoto::SmartPointer< Gyoto::Scenery > |
Detailed Description
Ray-tracing scene.
An Scenery contains:
- a Metric: used in Astrobj, Screen and Photon;
- a Screen: sets the field-of-view, the position of the camera, the observation time, and the Spectrometer;
- an Astrobj: light emitter.
In addition, Quantities may be specified (or the default Quantity will be produced: generally Intensity). Not all Astrobj implement all Quantities. The order in which Quantities are listed is not relevant (it is not stored). A value of the integration step for the Photon's trajectory can be specified in Delta. It will be used as the initial step, which is adaptive. Possible Quantities:
- Intensity: the intensity that reaches the object, integrated over the line-of-sight;
- EmissionTime: date of emission;
- MinDistance: minimum distance between the Photon reaching each pixel and the Astrobj;
- FirstDistMin: last closest approach between Photon and Astrobj;
- Redshift;
- ImpactCoords: 8-coordinates of the object and photon at impact;
- Spectrum: I_{nu} computed at various values frequencies, corresponding to the Screen's Spectrometer.
Thus a fully populated Scenery XML looks like that:
Member Typedef Documentation
|
inherited |
A subcontractor builds an object upon order from the Factory.
Various classes need to provide a subcontractor to be able to instanciate themselves upon order from the Factory. A subcontractor is a function (often a static member function) which accepts a pointer to a FactoryMessenger as unique parameter, communicates with the Factory using this messenger to read an XML description of the object to build, and returns this objet. SmartPointee::Subcontractor_t* is just generic enough a typedef to cast to and from other subcontractor types: Astrobj::Subcontractor_t, Metric::Subcontractor_t, Spectrum::Subcontractor_t. A subcontractor needs to be registered using the relevant Register() function: Astrobj::Register(), Metric::Register(), Spectrum::Register().
Constructor & Destructor Documentation
| Gyoto::Scenery::Scenery | ( | SmartPointer< Metric::Generic > | , |
| SmartPointer< Screen > | , | ||
| SmartPointer< Astrobj::Generic > | |||
| ) |
Member Function Documentation
| void Gyoto::Scenery::setAstrobj | ( | SmartPointer< Astrobj::Generic > | ) |
| void Gyoto::Scenery::setMetric | ( | SmartPointer< Metric::Generic > | ) |
| void Gyoto::Scenery::setScreen | ( | SmartPointer< Screen > | ) |
Member Data Documentation
|
protected |
Default integration step for the photons
|
protected |
The Metric, or stage, for this scenery.
|
protected |
The astrophysical emitting light in this scenery... the actor.
|
protected |
a Photon.
Used internally to not always reallocate memory when operator() is called.
|
protected |
The list of quantities that will be computed, for instance: GYOTO_QUANTITY_INTENSITY | GYOTO_QUANTITY_EMISSIONTIME | ...
|
protected |
Screen, the camera for this scenery.
|
protected |
Time limit for the integration (geometrical units)
Computation does not go back before tlim_. Default is 0. tlim_ is always expressed in geometrical units, it is essentially a tunig parameter for the ray-tracing process. tlim should be chosen to always be longer than the distance between the screen and the object.
The documentation for this class was generated from the following file:
