Gyoto
|
A null geodesic transporting light. More...
#include <GyotoPhoton.h>
Classes | |
class | Refined |
Refine last step of integration in a Photon. More... | |
Public Member Functions | |
virtual std::string | className () const |
"Photon" | |
virtual std::string | className_l () const |
"photon" | |
Photon () | |
Default constructor. More... | |
Photon (const Photon &) | |
Copy constructor. | |
Photon * | clone () const |
Cloner. | |
Photon (SmartPointer< Metric::Generic > gg, SmartPointer< Astrobj::Generic > obj, double *coord) | |
Same as Photon() followed by setInitialCondition(SmartPointer<Metric::Generic> gg, SmartPointer<Astrobj::Generic> obj, const double coord[8]) | |
Photon (SmartPointer< Metric::Generic > gg, SmartPointer< Astrobj::Generic > obj, SmartPointer< Screen > screen, double d_alpha, double d_delta) | |
Same as Photon() followed by setInitialCondition(SmartPointer<Metric::Generic> gg, SmartPointer<Astrobj::Generic> obj, SmartPointer<Screen> screen, double d_alpha, double d_delta) | |
virtual | ~Photon () |
Destructor. | |
virtual double | getMass () const |
Return 0. | |
void | astrobj (SmartPointer< Astrobj::Generic >) |
Set Photon::object_. | |
SmartPointer< Astrobj::Generic > | astrobj () const |
Get Photon::object_. | |
void | spectrometer (SmartPointer< Spectrometer::Generic > spr) |
Set Photon::spectro_. | |
SmartPointer < Spectrometer::Generic > | spectrometer () const |
Get Photon::spectro_. | |
void | freqObs (double) |
Set Photon::freq_obs__. | |
double | freqObs () const |
Get Photon::freq_obs__. | |
void | operator= (const Photon &) |
Assignment to another Photon. | |
void | setInitialCondition (SmartPointer< Metric::Generic > gg, SmartPointer< Astrobj::Generic > obj, const double coord[8]) |
Set or re-set the initial condition prior to integration. More... | |
void | setInitialCondition (SmartPointer< Metric::Generic > gg, SmartPointer< Astrobj::Generic > obj, SmartPointer< Screen > screen, double d_alpha, double d_delta) |
Set or re-set the initial condition prior to integration. More... | |
int | hit (Astrobj::Properties *data=NULL) |
Integrate the geodesic. More... | |
double | findMin (Functor::Double_constDoubleArray *object, double t1, double t2, double &tmin, double threshold=DBL_MIN) |
Find minimum of photon–object distance. More... | |
void | findValue (Functor::Double_constDoubleArray *object, double value, double tinside, double &toutside) |
Find date for which the photon is at a given distance from the object. More... | |
void | fillElement (FactoryMessenger *fmp) const |
Write XML description. | |
void | resetTransmission () |
Set transmission to 1 for each channel as well as scalar transmission. | |
double | getTransmission (size_t i) const |
Get transmission. More... | |
double | getTransmissionMax () const |
Get maximum transmission;. More... | |
double const * | getTransmission () const |
Get Photon::transmission_. More... | |
virtual void | transmit (size_t i, double t) |
Update transmission in a given channel. More... | |
size_t | getImin () const |
Get imin_. | |
size_t | getImax () const |
Get imax_. | |
size_t | getI0 () const |
Get i0_. | |
void | metric (SmartPointer< Metric::Generic >) |
Set metric Smartpointer. | |
SmartPointer< Metric::Generic > | metric () const |
Get metric. | |
virtual void | setInitCoord (const double coord[8], int dir=0) |
Set Initial coordinate. | |
virtual void | setInitCoord (double pos[4], double vel[3], int dir=1) |
Set initial coordinate. More... | |
virtual void | setPosition (double pos[4]) |
Set initial 4-position. | |
virtual void | setVelocity (double vel[3]) |
Set initial 3-velocity. | |
void | reset () |
Forget integration, keeping initial contition. | |
void | reInit () |
Reset and recompute particle properties. | |
void | integrator (std::string type) |
Set the integrator. More... | |
std::string | integrator () const |
Describe the integrator used by state_. | |
double | deltaMin () const |
Get delta_min_. | |
void | deltaMin (double h1) |
Set delta_min_. | |
double | deltaMax () const |
Get delta_max_. | |
virtual double | deltaMax (double const pos[8], double delta_max_external) const |
void | deltaMax (double h1) |
void | absTol (double) |
Set abstol_. | |
double | absTol () const |
Get abstol_. | |
void | relTol (double) |
Set reltol_. | |
double | relTol () const |
Get reltol_. | |
double | deltaMaxOverR () const |
Get delta_max_over_r_. | |
void | deltaMaxOverR (double t) |
Set delta_max_over_r_. | |
void | delta (const double delta) |
Set delta_. | |
void | delta (double, const std::string &unit) |
Set delta_ in specified units. | |
double | delta () const |
Get delta_. | |
double | delta (const std::string &unit) const |
Get delta_ in specified units. | |
double | tMin () const |
Get tmin_. | |
double | tMin (const std::string &unit) const |
Get tmin_ in specified unit. | |
void | tMin (double tlim) |
Set tmin_. | |
void | tMin (double, const std::string &unit) |
Set tmin_ in specified unit. | |
void | adaptive (bool mode) |
Set adaptive_. | |
bool | adaptive () const |
Get adaptive_. | |
void | secondary (bool sec) |
Set secondary_. | |
bool | secondary () const |
Get secondary_. | |
void | maxiter (size_t miter) |
Set maxiter_. | |
size_t | maxiter () const |
Get maxiter_. | |
double const * | getCst () const |
Returns the worldline's cst of motion (if any) More... | |
void | setCst (double const *cst, size_t const ncsts) |
Set Metric-specific constants of motion. More... | |
void | setInitialCondition (SmartPointer< Metric::Generic > gg, const double coord[8], const int dir) |
Set or re-set the initial condition prior to integration. More... | |
void | getInitialCoord (double dest[8]) const |
Get initial coordinate. | |
void | getCoord (size_t index, double dest[8]) const |
Get coordinates corresponding to index. | |
void | getCoord (double const *const dates, size_t const n_dates, double *const x1dest, double *const x2dest, double *const x3dest, double *const x0dot=NULL, double *const x1dot=NULL, double *const x2dot=NULL, double *const x3dot=NULL) |
Get 8-coordinates for specific dates. More... | |
void | getCoord (double *x0, double *x1, double *x2, double *x3) const |
Get all computed positions. More... | |
void | getCartesianPos (size_t index, double dest[4]) const |
Get Cartesian expression of 4-position at index. | |
virtual void | xStore (size_t ind, double coord[8]) |
Store coord at index ind. | |
virtual void | xFill (double tlim) |
Fill x0, x1... by integrating the Worldline from previously set inittial condition to time tlim. | |
virtual int | setParameter (std::string name, std::string content, std::string unit) |
Set parameter by name. More... | |
virtual void | setParameters (FactoryMessenger *fmp) |
Process XML entity Uses wait_pos_ and init_vel_ to make sure setVelocity() is called after setPosition(). | |
size_t | get_nelements () const |
Get number of computed dates. | |
void | get_t (double *dest) const |
Get computed dates. | |
void | getCartesian (double const *const dates, size_t const n_dates, double *const x, double *const y, double *const z, double *const xprime=NULL, double *const yprime=NULL, double *const zprime=NULL) |
Get the 6 Cartesian coordinates for specific dates. More... | |
void | get_xyz (double *x, double *y, double *z) const |
Get 3-position in cartesian coordinates for computed dates. | |
void | checkPhiTheta (double coord[8]) const |
Bring θ in [0,Π] and φ in [0,2Π]. More... | |
void | getSkyPos (SmartPointer< Screen > screen, double *dalpha, double *ddellta, double *dD) const |
Get computed positions in sky coordinates. | |
void | get_dot (double *x0dot, double *x1dot, double *x2dot, double *x3dot) const |
Get computed 4-velocities. | |
void | get_prime (double *x1prime, double *x2prime, double *x3prime) const |
Get computed 3-velocities. | |
void | save_txyz (char *fichierxyz) const |
Save in a file. | |
void | save_txyz (char *const filename, double const t1, double const mass_sun, double const distance_kpc, std::string const unit, SmartPointer< Screen > sc=NULL) |
Save, converted. | |
Static Public Member Functions | |
static SmartPointer< Photon > | Subcontractor (Gyoto::FactoryMessenger *) |
Instanciate Photon from XML description. | |
Public Attributes | |
int | stopcond |
Whether and why integration is finished. | |
Protected Types | |
typedef Gyoto::SmartPointer < Gyoto::SmartPointee > | Subcontractor_t (Gyoto::FactoryMessenger *) |
A subcontractor builds an object upon order from the Factory. More... | |
Protected Member Functions | |
Photon (Photon *orig, size_t i0, int dir, double step_max) | |
Used by Photon::Refined::Refined() | |
virtual void | xAllocate () |
Allocate x0, x1 etc. with default size. More... | |
virtual void | xAllocate (size_t size) |
Allocate x0, x1 etc. with a specified size. More... | |
virtual size_t | xExpand (int dir) |
Expand x0, x1 etc... to hold more elements. More... | |
virtual void | xExpand (double *&x, int dir) |
Expand one array to hold more elements. More... | |
virtual void | tell (Gyoto::Hook::Teller *) |
This is how a Teller tells. More... | |
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 < Gyoto::Astrobj::Generic > | object_ |
The astronomical target. More... | |
double | freq_obs_ |
Photon's frequency in observer's frame. More... | |
double | transmission_freqobs_ |
Integrated optical transmission. More... | |
SmartPointer < Spectrometer::Generic > | spectro_ |
Observer's spectrometer. More... | |
double * | transmission_ |
Integrated optical transmissions. More... | |
SmartPointer < Gyoto::Metric::Generic > | metric_ |
The Gyoto::Metric in this part of the universe. | |
double * | x0_ |
t or T | |
double * | x1_ |
r or x | |
double * | x2_ |
θ or y | |
double * | x3_ |
φ or z | |
double * | x0dot_ |
tdot or Tdot | |
double * | x1dot_ |
rdot or xdot | |
double * | x2dot_ |
θdot or ydot | |
double * | x3dot_ |
φdot or zdot | |
size_t | x_size_ |
Size of x0_, x1_... arrays. | |
size_t | imin_ |
Minimum index for which x0_, x1_... have been computed. | |
size_t | i0_ |
Index of initial condition in array. | |
size_t | imax_ |
Maximum index for which x0_, x1_... have been computed. | |
bool | adaptive_ |
Whether integration should use adaptive delta. | |
bool | secondary_ |
Experimental: choose 0 to compute only primary image. More... | |
double | delta_ |
Initial integrating step. More... | |
double | tmin_ |
Time limit for the integration (geometrical units) More... | |
double * | cst_ |
Worldline's csts of motion (if any) | |
size_t | cst_n_ |
Number of constants of motion. | |
int | wait_pos_ |
Hack in setParameters() | |
double * | init_vel_ |
Hack in setParameters() | |
size_t | maxiter_ |
Maximum number of iterations when integrating. | |
double | delta_min_ |
Minimum integration step for the adaptive integrator. More... | |
double | delta_max_ |
Maximum integration step for the adaptive integrator. More... | |
double | delta_max_over_r_ |
Numerical tuning parameter. More... | |
double | abstol_ |
Absolute tolerance of the integrator. More... | |
double | reltol_ |
Absolute tolerance of the integrator. More... | |
SmartPointer < Worldline::IntegState::Generic > | state_ |
An object to hold the integration state. | |
Private Member Functions | |
void | _allocateTransmission () |
Allocate Photon::transmission_. | |
Friends | |
class | Gyoto::SmartPointer< Gyoto::Photon > |
A null geodesic transporting light.
This is the central object for ray-tracing.
|
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().
Gyoto::Photon::Photon | ( | ) |
Default constructor.
Allocates the default size (GYOTO_DEFAULT_X_SIZE) for x1, x2 etc.
|
inherited |
Bring θ in [0,Π] and φ in [0,2Π].
checkPhiTheta() Modifies coord if the corrdinates are spherical-like so that coord[2]=theta is in [0,pi] and coord[3]=phi is in [0,2pi]. Important to use in all astrobj in spherical coordinates to prevent "z-axis problems".
|
virtualinherited |
Get delta max at a given position
[in] | pos | 4-position |
[in] | delta_max_external | external constraint on delta_max |
|
inherited |
Set delta_max_
double Gyoto::Photon::findMin | ( | Functor::Double_constDoubleArray * | object, |
double | t1, | ||
double | t2, | ||
double & | tmin, | ||
double | threshold = DBL_MIN |
||
) |
Find minimum of photon–object distance.
Return the minimum of (*object)(this->getCoord()) between t1 and t2. The date of this minimum is returned in tmin.
[in] | object | the distance to minimize is given by object->operator()(). This method is in particular implemented by the subclasses of Astrobj::Standard. |
[in] | t1 | date |
[in] | t2 | date |
[out] | tmin | on output, date correspondig to the minimum |
[in] | threshold | stop searching for a minimum if a value < threshold is found (very often, we just want to find a date below the threshold, not the accurate minimum). |
void Gyoto::Photon::findValue | ( | Functor::Double_constDoubleArray * | object, |
double | value, | ||
double | tinside, | ||
double & | toutside | ||
) |
Find date for which the photon is at a given distance from the object.
[in] | object | Object, must implement operator() (e.g. Astrobj::Standard, ThinDisk::Standard) |
[in] | value | The value to find |
[in] | tinside | A date for which object->Astrobj::operator()(Photon::getCoord()) is < value |
[in,out] | toutside | On input: a date for which object->Astrobj::operator()(Photon::getCoord()) is > value. on output, (*object)(getCoord(toutside)) is < value, very close to value. toutside is closer to tinside on output than on input. |
|
inherited |
Get the 6 Cartesian coordinates for specific dates.
The 6 coordinates (x, y, z, dx/dt, dy/dt, dz/dt) will be computed using the integrator and interpolated if necessary, so they will be as accurate as possible. Transforming to Cartesian coordinates is not necessarily meaningful.
[in] | dates | List of dates for which the coordinates are to be computed; |
[in] | n_dates | Number of dates to compute ; |
[out] | x,y,z,xprime,yprime,zprime | Arrays in which to store the result. These pointer may be set to NULL to retrieve only part of the information. Else, they must be pre-allocated. |
|
inherited |
Get 8-coordinates for specific dates.
The coordinates will be computed using the integrator, so they will be as accurate as possible. Some heuristics are used to speed up the process and it is presumably faster to call this routine with a sorted list of dates. The line will be integrated further as required. An error will be thrown if it is not possible to reach a certain date.
dates | the list of dates for which the coordinates are to be computed; |
n_dates | the number of dates to compute ; |
x1dest,x2dest,x3dest,x0dot,x1dot,x2dot,x3dot | arrays in which to store the result. These pointer may be set to NULL to retrieve only part of the information. They must be pre-allocated. |
|
inherited |
Get all computed positions.
Get all the pre-computed 8 coordinates (e.g. thanks to a prior call to xFill()) of this worldline.
|
inherited |
Returns the worldline's cst of motion (if any)
Return pointer to array holding the previously set Metric-specific constants of motion
double Gyoto::Photon::getTransmission | ( | size_t | i | ) | const |
Get transmission.
Get either Photon::transmission_freqobs_ (with i=-1) or Photon::transmission_[i].
i | channel number of the requested frequency, -1 for Photon::freq_obs_. |
double const* Gyoto::Photon::getTransmission | ( | ) | const |
getTansmission()[i] == getTransmission(size_t i)
double Gyoto::Photon::getTransmissionMax | ( | ) | const |
Get maximum transmission;.
Get current maximum of all the transmissions, Photon::transmission_freqobs_ or one elements of the Photon::transmission_ array.
int Gyoto::Photon::hit | ( | Astrobj::Properties * | data = NULL | ) |
Integrate the geodesic.
[in,out] | data | Optional Astrobj::Properties to fill with observational quantities. |
|
inherited |
Set the integrator.
Initialize state_ to use the required integrator.
[in] | type | Either "Legacy" or (if HAVE_BOOST) one of "runge_kutta_cash_karp54", "runge_kutta_fehlberg78", "runge_kutta_dopri5", "runge_kutta_cash_karp54_classic" |
|
inherited |
Set Metric-specific constants of motion.
The will (re)allocate Worldline::cst_, copy cst into it, and set Worldline::cst_n_.
|
virtualinherited |
Set initial coordinate.
pos | initial 4-position |
vel | initial 3-velocity |
dir | direction of integration |
void Gyoto::Photon::setInitialCondition | ( | SmartPointer< Metric::Generic > | gg, |
SmartPointer< Astrobj::Generic > | obj, | ||
const double | coord[8] | ||
) |
Set or re-set the initial condition prior to integration.
Set initial condition for this Photon :
gg | Gyoto::SmartPointer to the Gyoto::Metric in this universe; |
obj | Gyoto::SmartPointer to the target Gyoto::Astrobj; |
coord | 8-element array containing the initial condition, i.e. the 4-position and the 4-velocity of the Photon at the receiving end; |
void Gyoto::Photon::setInitialCondition | ( | SmartPointer< Metric::Generic > | gg, |
SmartPointer< Astrobj::Generic > | obj, | ||
SmartPointer< Screen > | screen, | ||
double | d_alpha, | ||
double | d_delta | ||
) |
Set or re-set the initial condition prior to integration.
Set initial condition for this Photon :
gg | Gyoto::SmartPointer to the Gyoto::Metric in this universe; |
obj | Gyoto::SmartPointer to the target Gyoto::Astrobj; |
screen | Observer's screen; |
d_alpha | Direction of arrival (RA offset) in radians; |
d_delta | Direction of arrival (Dec offset) in radians. |
|
inherited |
Set or re-set the initial condition prior to integration.
gg | Gyoto::SmartPointer to the Gyoto::Metric in this universe; |
coord | 8 element array containing the initial condition, i.e. the 4-position and the 4-velocity of the Photon at the receiving end; |
dir | direction: 1 for future, -1 for past. |
|
virtualinherited |
Set parameter by name.
Assume MyKind is a subclass of Worldline which has two members (a string StringMember and a double DoubleMember):
name | XML name of the parameter |
content | string representation of the value |
unit | string representation of the unit |
Reimplemented in Gyoto::Astrobj::Star, and Gyoto::Astrobj::StarTrace.
|
protectedvirtualinherited |
This is how a Teller tells.
A teller will basically call listener->tell(this).
msg | Teller* the Teller who is telling... Useful if the Listener listens to several Tellers. |
Reimplemented from Gyoto::Hook::Listener.
|
virtual |
Update transmission in a given channel.
getTransmission(size_t i) *= t.
i | channel number. -1 for scalar Photon::transmission_freqobs_. |
t | transmission of this fluid element. |
Reimplemented in Gyoto::Photon::Refined.
|
protectedvirtualinherited |
Allocate x0, x1 etc. with default size.
The default size is GYOTO_DEFAULT_X_SIZE
|
protectedvirtualinherited |
Allocate x0, x1 etc. with a specified size.
size | : number of cells in each array x0, x1 etc. |
Reimplemented in Gyoto::Astrobj::StarTrace.
|
protectedvirtualinherited |
Expand x0, x1 etc... to hold more elements.
Double the size of arrays x0, x1 etc. and copy old version of the array in the first half if dir =1 and in the second half if dir =-1.
dir | : 1 to expand after last element, -1 to expand before first element |
Reimplemented in Gyoto::Astrobj::StarTrace.
|
protectedvirtualinherited |
Expand one array to hold more elements.
If you need to expand more arrays than x0_ ... x3_ and the dots, call this on your array before calling xExpand(int dir).
[in,out] | x | array to expand |
[in] | dir |
|
protectedinherited |
Absolute tolerance of the integrator.
Used by the adaptive integrators implemented in IntegState::Boost. Refer to the boost::numeric::odeint documentation for more details.
|
protectedinherited |
Initial integrating step.
Default: GYOTO_DEFAULT_DELTA
|
protectedinherited |
Maximum integration step for the adaptive integrator.
The default (GYOTO_DEFAULT_DELTA_MAX) is usually fine.
For IntegState::Legacy, set it in the Metric instead!
|
protectedinherited |
Numerical tuning parameter.
For IntegState::Legacy, set it in the Metric instead!
Ensure that delta (the numerical integration step) is never larger than a fraction of the distance between the current location and the center of the coordinate system.
The default (GYOTO_DEFAULT_DELTA_MAX_OVER_R) is usually fine.
|
protectedinherited |
Minimum integration step for the adaptive integrator.
The default (GYOTO_DEFAULT_DELTA_MIN) is usually fine.
For IntegState::Legacy, set it in the Metric instead!
|
protected |
Photon's frequency in observer's frame.
In Hz, for quantity Emission
|
protected |
The astronomical target.
The (only) possible origin for this Photon.
|
protectedinherited |
Absolute tolerance of the integrator.
Used by the adaptive integrators implemented in IntegState::Boost. Refer to the boost::numeric::odeint documentation for more details.
|
protectedinherited |
Experimental: choose 0 to compute only primary image.
This feature is in development.
|
protected |
Observer's spectrometer.
Conveying observation frequencies for quantities Spectrum and BinSpectrum.
|
protectedinherited |
Time limit for the integration (geometrical units)
Computation does not go back before tmin_. Default is -DBL_MAX. tmin_ is always expressed in geometrical units, it is essentially a tuning parameter for the ray-tracing process. tmin_ should be chosen to always be longer than the distance between the screen and the object.
|
protected |
Integrated optical transmissions.
For each frequency in Photon::spectro_->getMidpoints(), between current position and observer.
|
protected |
Integrated optical transmission.
At Photon::freq_obs_, between current position and observer.