Gyoto::Photon Class Reference

A null geodesic transporting light. More...

#include <GyotoPhoton.h>

Inheritance diagram for Gyoto::Photon:
Gyoto::Worldline Gyoto::SmartPointee Gyoto::Object Gyoto::Hook::Listener Gyoto::Photon::Refined

List of all members.

Classes

class  Refined
 Refine last step of integration in a Photon. More...

Public Types

typedef Gyoto::SmartPointer
< Gyoto::SmartPointee
Subcontractor_t (Gyoto::FactoryMessenger *, std::vector< std::string > const &)
 A subcontractor builds an object upon order from the Factory.

Public Member Functions

virtual Property const * getProperties () const
 Get list of properties.
virtual std::string className () const
 "Photon"
virtual std::string className_l () const
 "photon"
 Photon ()
 Default constructor.
 Photon (const Photon &)
 Copy constructor.
Photonclone () 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::Genericastrobj () const
 Get Photon::object_.
void metric (SmartPointer< Metric::Generic >)
 Set metric Smartpointer.
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 setInitialCondition (SmartPointer< Metric::Generic > gg, SmartPointer< Astrobj::Generic > obj, const double coord[8])
 Set or re-set the initial condition prior to integration.
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.
int hit (Astrobj::Properties *data=NULL)
 Integrate the geodesic.
double findMin (Functor::Double_constDoubleArray *object, double t1, double t2, double &tmin, double threshold=DBL_MIN)
 Find minimum of photon--object distance.
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.
virtual void setParameters (FactoryMessenger *fmp)
 Main loop for parsing Properties from XML description.
void resetTransmission ()
 Set transmission to 1 for each channel as well as scalar transmission.
double getTransmission (size_t i) const
 Get transmission.
double getTransmissionMax () const
 Get maximum transmission;.
double const * getTransmission () const
 Get Photon::transmission_.
virtual void transmit (size_t i, double t)
 Update transmission in a given channel.
size_t getImin () const
 Get imin_.
size_t getImax () const
 Get imax_.
size_t getI0 () const
 Get i0_.
SmartPointer< Metric::Genericmetric () const
 Get metric.
void initCoord (std::vector< double > const &)
std::vector< double > initCoord () const
virtual void setInitCoord (const double coord[8], int dir=0)
 Set Initial coordinate.
virtual void setInitCoord (double const pos[4], double const vel[3], int dir=0)
 Set initial coordinate.
virtual void setPosition (double const pos[4])
 Set initial 4-position.
virtual void setVelocity (double const vel[3])
 Set initial 3-velocity.
void reset ()
 Forget integration, keeping initial contition.
void reInit ()
 Reset and recompute particle properties.
void integrator (std::string const &type)
 Set the integrator.
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)
 Assignment to another Worldline.
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).
void setCst (double const *cst, size_t const ncsts)
 Set Metric-specific constants of motion.
void setInitialCondition (SmartPointer< Metric::Generic > gg, const double coord[8], const int dir)
 Set or re-set the initial condition prior to integration.
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.
void getCoord (double *x0, double *x1, double *x2, double *x3) const
 Get all computed positions.
void getCartesianPos (size_t index, double dest[4]) const
 Get Cartesian expression of 4-position at index.
virtual void xStore (size_t ind, double const 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.
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.
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].
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.
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.
virtual bool isThreadSafe () const
 Whether this class is thread-safe.
void set (Property const &p, Value val)
 Set Value of a Property.
void set (Property const &p, Value val, std::string const &unit)
 Set Value (expressed in unit) of a Property.
void set (std::string const &pname, Value val)
 Set Value of a Property.
void set (std::string const &pname, Value val, std::string const &unit)
 Set Value (expressed in unit) of a Property.
Value get (Property const &p) const
 Get Value of a Property.
Value get (std::string const &pname) const
 Get Value of a Property.
Value get (Property const &p, std::string const &unit) const
 Get Value of a Property, converted to unit.
Value get (std::string const &pname, std::string const &unit) const
 Get Value of a Property, converted to unit.
Property const * property (std::string const pname) const
 Find property by name.
virtual void fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const
 Output a single Property to XML.
virtual void fillElement (Gyoto::FactoryMessenger *fmp) const
 Fill the XML element for this Object.
virtual int setParameter (std::string name, std::string content, std::string unit)
 Set parameter by name.
virtual void setParameter (Gyoto::Property const &p, std::string const &name, std::string const &content, std::string const &unit)
 Set parameter by Property (and name).
std::string describeProperty (Gyoto::Property const &p) const
 Format desrciption for a property.
void help () const
 Print (to stdout) some help on this class.

Static Public Member Functions

static SmartPointer< PhotonSubcontractor (Gyoto::FactoryMessenger *)

Public Attributes

 GYOTO_OBJECT_THREAD_SAFETY
 GYOTO_WORLDLINE
int stopcond
 Whether and why integration is finished.

Static Public Attributes

static GYOTO_OBJECT Property const properties []
 Property list.

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.
virtual void xAllocate (size_t size)
 Allocate x0, x1 etc. with a specified size.
virtual size_t xExpand (int dir)
 Expand x0, x1 etc... to hold more elements.
virtual void xExpand (double *&x, int dir)
 Expand one array to hold more elements.
virtual void tell (Gyoto::Hook::Teller *)
 This is how a Teller tells.

Protected Attributes

SmartPointer
< Gyoto::Astrobj::Generic
object_
 The astronomical target.
double freq_obs_
 Photon's frequency in observer's frame.
double transmission_freqobs_
 Integrated optical transmission.
SmartPointer
< Spectrometer::Generic
spectro_
 Observer's spectrometer.
double * transmission_
 Integrated optical transmissions.
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.
double delta_
 Initial integrating step.
double tmin_
 Time limit for the integration (geometrical units).
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.
double delta_max_
 Maximum integration step for the adaptive integrator.
double delta_max_over_r_
 Numerical tuning parameter.
double abstol_
 Absolute tolerance of the integrator.
double reltol_
 Absolute tolerance of the integrator.
SmartPointer
< Worldline::IntegState::Generic
state_
 An object to hold the integration state.
std::string kind_
 The "kind" that is output in the XML entity.
std::vector< std::string > plugins_
 The plug-ins that needs to be loaded to access this instance's class.

Private Member Functions

void _allocateTransmission ()
 Allocate Photon::transmission_.

Friends

class Gyoto::SmartPointer< Gyoto::Photon >
class Gyoto::Hook::Teller

Detailed Description

A null geodesic transporting light.

This is the central object for ray-tracing.


Member Typedef Documentation

typedef Gyoto::SmartPointer<Gyoto::SmartPointee> Gyoto::SmartPointee::Subcontractor_t(Gyoto::FactoryMessenger *, std::vector< std::string > const &) [inherited]

A subcontractor builds an object upon order from the Factory.

Various classes need to provide a subcontractor to be able to instantiate 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::Photon::Photon (  ) 

Default constructor.

Allocates the default size (GYOTO_DEFAULT_X_SIZE) for x1, x2 etc.


Member Function Documentation

void Gyoto::Worldline::checkPhiTheta ( double  coord[8]  )  const [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".

void Gyoto::Worldline::delta ( const double  delta  )  [inherited]

Assignment to another Worldline.

Set delta_

void Gyoto::Worldline::deltaMax ( double  h1  )  [inherited]

Set delta_max_

virtual double Gyoto::Worldline::deltaMax ( double const   pos[8],
double  delta_max_external 
) const [virtual, inherited]

Get delta max at a given position

Parameters:
[in] pos 4-position
[in] delta_max_external external constraint on delta_max
Returns:
the smallest value between delta_max_, delta_max_external, and R*delta_max_over_r_ where R is pos[1] in spherical coordinates and max(x1, x2, x3) in Cartesian coordinates.
std::string Gyoto::Object::describeProperty ( Gyoto::Property const &  p  )  const [inherited]

Format desrciption for a property.

Returns a string containing the name(s) and type of the property, as well as whether it supports unit.

virtual void Gyoto::Object::fillElement ( Gyoto::FactoryMessenger fmp  )  const [virtual, inherited]

Fill the XML element for this Object.

The base implementation simply calls fillProperty() for each Property defined for the Object.

Derived classes should avoid overriding fillElement(). It may make sense occasionally, e.g. to make sure that the metric is output first.

To customize how a given Property is rendered, it is better to override fillProperty().

If this method is overridden, the implementation should in general call fillElement() on the direct base.

Reimplemented in Gyoto::Astrobj::Complex, Gyoto::Spectrometer::Complex, and Gyoto::Scenery.

virtual void Gyoto::Object::fillProperty ( Gyoto::FactoryMessenger fmp,
Property const &  p 
) const [virtual, inherited]

Output a single Property to XML.

The base implementation decides what to do based on the p.type. The format matches how setParameters() an setParameter() would interpret the XML descition.

Overriding this method should be avoided, but makes sense in some cases (for instance Screen::fillProperty() selects a different unit for Distance based on its magnitude, so that stellar sizes are expressed in solar radii while smaller sizes can be expressed in meters and larger sizes in parsecs).

Overriding implementation should fall-back on calling the implementation in the direct parent class:

 class A: public Object {};
 class B: public A { 
  using B::setParameter;
  virtual void fillProperty(Gyoto::FactoryMessenger *fmp,
                        Property const &p) const ;
 };
 void B::fillProperty(Gyoto::FactoryMessenger *fmp,
                        Property const &p) const {
   if (name=="Duff") fmp->doSomething();
   else A::fillProperty(fmp, p);
 }

Reimplemented in Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::NeutronStarModelAtmosphere, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, Gyoto::Scenery, Gyoto::Screen, Gyoto::Astrobj::Star, and Gyoto::Spectrometer::Uniform.

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.

Parameters:
[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.

Parameters:
[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.
void Gyoto::Worldline::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 
) [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.

Parameters:
[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.

Reimplemented in Gyoto::Astrobj::Star.

void Gyoto::Worldline::getCoord ( double *  x0,
double *  x1,
double *  x2,
double *  x3 
) const [inherited]

Get all computed positions.

Get all the pre-computed 8 coordinates (e.g. thanks to a prior call to xFill()) of this worldline.

void Gyoto::Worldline::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 
) [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.

Parameters:
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.
double const* Gyoto::Worldline::getCst (  )  const [inherited]

Returns the worldline's cst of motion (if any).

Return pointer to array holding the previously set Metric-specific constants of motion

virtual Property const* Gyoto::Photon::getProperties (  )  const [virtual]

Get list of properties.

This method is declared automatically by the GYOTO_OBJECT macro and defined automatically by the GYOTO_PROPERTY_END macro.

Reimplemented from Gyoto::Object.

double const* Gyoto::Photon::getTransmission (  )  const

Get Photon::transmission_.

getTansmission()[i] == getTransmission(size_t i)

double Gyoto::Photon::getTransmission ( size_t  i  )  const

Get transmission.

Get either Photon::transmission_freqobs_ (with i=-1) or Photon::transmission_[i].

Parameters:
i channel number of the requested frequency, -1 for Photon::freq_obs_.
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.

void Gyoto::Object::help (  )  const [inherited]

Print (to stdout) some help on this class.

Describe all properties that this instance supports.

int Gyoto::Photon::hit ( Astrobj::Properties data = NULL  ) 

Integrate the geodesic.

Parameters:
[in,out] data Optional Astrobj::Properties to fill with observational quantities.
Returns:
1 if object was hit, else 0.
void Gyoto::Worldline::integrator ( std::string const &  type  )  [inherited]

Set the integrator.

Initialize state_ to use the required integrator.

Parameters:
[in] type Either "Legacy" or (if GYOTO_HAVE_BOOST_INTEGRATORS) one of "runge_kutta_cash_karp54", "runge_kutta_fehlberg78", "runge_kutta_dopri5", "runge_kutta_cash_karp54_classic"
virtual bool Gyoto::Object::isThreadSafe (  )  const [virtual, inherited]

Whether this class is thread-safe.

Return True if this object is thread-safe, i.e. if an instance and its clone can be used in parallel threads (in the context of Scenery::raytrace()). Known objects which are not thread-safe include Lorene metrics and everything from the Python plug-in.

The default implementation considers that the class itself is thread safe and recurses into the declared properties to check whether they are safe too. Classes that abide to the Object/Property paradigm and are themselves thread-safe have nothing special to do.

Objects that clone children in their copy constructor that are not declared as properties must take these children into account.

Classes that are never thread-safe must declare it. It acn be easily done using GYOTO_OBJECT_THREAD_SAFETY in the class declaration and GYOTO_PROPERTY_THREAD_UNSAFE in the class definition.

Property const* Gyoto::Object::property ( std::string const   pname  )  const [inherited]

Find property by name.

Look into the Property list for a Property whose name (or name_false, for a boolean Property) is pname. Return a const pointer to the first such property found, or NULL if none is found.

void Gyoto::Worldline::setCst ( double const *  cst,
size_t const   ncsts 
) [inherited]

Set Metric-specific constants of motion.

The will (re)allocate Worldline::cst_, copy cst into it, and set Worldline::cst_n_.

virtual void Gyoto::Worldline::setInitCoord ( double const   pos[4],
double const   vel[3],
int  dir = 0 
) [virtual, inherited]

Set initial coordinate.

Parameters:
pos initial 4-position
vel initial 3-velocity
dir direction of integration
virtual void Gyoto::Worldline::setInitCoord ( const double  coord[8],
int  dir = 0 
) [virtual, inherited]

Set Initial coordinate.

Set imin_=imax_=i0_, and x_[i0_]=coord[].

If dir==1, i0_ is set to 0. If dir==-1, i0_ is set to x_size_-1.

If dir==0 and the Worldine has never been computed (i0_==0, imin_==1 and imax_==0), then dir defaults to 1 for a massive particle and -1 for a massless particle.

If dir==0 and the Worldine has already been computed, i0_ is not changed.

Parameters:
coord new initial coordinates
dir direction of integration. 1 for forward integration, -1 for backards integration, 0 for unknown or both.

Reimplemented in Gyoto::Astrobj::StarTrace.

void Gyoto::Worldline::setInitialCondition ( SmartPointer< Metric::Generic gg,
const double  coord[8],
const int  dir 
) [inherited]

Set or re-set the initial condition prior to integration.

Parameters:
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.
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 :

Parameters:
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.
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 :

Parameters:
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;
virtual void Gyoto::Object::setParameter ( Gyoto::Property const &  p,
std::string const &  name,
std::string const &  content,
std::string const &  unit 
) [virtual, inherited]

Set parameter by Property (and name).

This function is used when parsing an XML description, if Property (p) of this name is found (i.e. either p.name or p.name_false is equal to name). Implementation should fall-back on calling the direct's parent implementation:

 class A: public Object {};
 class B: public A { 
  using B::setParameter;
  virtual void setParameter(Gyoto::Property const &p,
                            std::string name,
                                std::string content,
                                std::string unit);
 };
 void B::setParameter(Gyoto::Property const &p,
                          std::string name,
                          std::string content,
                          std::string unit) {
   if (name=="Duff") doSomething(content, unit);
   else A::setParameter(p, name, content, unit);
 }
Parameters:
p Property that matches name (p.name == name or p.name_false == name)
name XML name of the parameter (XML entity)
content string representation of the value
unit string representation of the unit

Reimplemented in Gyoto::Astrobj::PolishDoughnut.

virtual int Gyoto::Object::setParameter ( std::string  name,
std::string  content,
std::string  unit 
) [virtual, inherited]

Set parameter by name.

This function is used when parsing an XML description, if no Property of this name is found. Overriding implementation should fall-back on calling the direct's parent implementation:

 class A: public Object {};
 class B: public A { 
  using B::setParameter;
  virtual int setParameter(std::string name,
                            std::string content,
                            std::string unit);
 };
 int B::setParameter(std::string name,
                            std::string content,
                            std::string unit) {
   if (name=="Duff") doSomething(content, unit);
   else return A::setParameter(name, content, unit);
   return 0;  // name was known
 }
Parameters:
name XML name of the parameter (XML entity). This may have a path component, e.g. "Astrobj::Radius", in which case a property named "Astrobj" will be sought in the current object, and setParameter will be called recusrively on this Astrobj with Radius as name.
content string representation of the value
unit string representation of the unit
Returns:
0 if this parameter is known, 1 if it is not.

Reimplemented in Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Metric::KerrKS, Gyoto::Metric::RotStar3_1, and Gyoto::Astrobj::Star.

virtual void Gyoto::Photon::setParameters ( FactoryMessenger fmp  )  [virtual]

Main loop for parsing Properties from XML description.

This function queries the FactoryMessenger for elements to parse, and tries to matche each element to a Property to set it accordingly.

Any class that tries to be buildable from XML must supply a subcontractor (for base classes such as Metric, Astrobj, Spectrum and Spectrometer, it is done as a template that must be specialized for each class).

This subcontractor typically looks somewhat like this:

SmartPointer<Metric::Generic>
Gyoto::Metric::MyKind::Subcontractor(FactoryMessenger* fmp) {
  SmartPointer<MyKind> gg = new MyKind();
  gg -> setParameters(fmp);
  return gg;
}

Although this is discouraged, it is possible to override the following functions to customize how XML entities are parsed:

  • setParameters() if low-level access to the FactoryMessenger is required;
  • setParameter(std::string name, std::string content, std::string unit) to interpret an entity that does not match a Property (e.g. alternative name);
  • setParameter(Gyoto::Property const &p, std::string const &name, std::string const &content, std::string const &unit) to change how a Property is interpreted.

Reimplemented from Gyoto::Object.

virtual void Gyoto::Worldline::tell ( Gyoto::Hook::Teller msg  )  [protected, virtual, inherited]

This is how a Teller tells.

A teller will basically call listener->tell(this).

Parameters:
msg Teller* the Teller who is telling... Useful if the Listener listens to several Tellers.

Reimplemented from Gyoto::Hook::Listener.

virtual void Gyoto::Photon::transmit ( size_t  i,
double  t 
) [virtual]

Update transmission in a given channel.

getTransmission(size_t i) *= t.

Parameters:
i channel number. -1 for scalar Photon::transmission_freqobs_.
t transmission of this fluid element.

Reimplemented in Gyoto::Photon::Refined.

virtual void Gyoto::Worldline::xAllocate ( size_t  size  )  [protected, virtual, inherited]

Allocate x0, x1 etc. with a specified size.

Parameters:
size : number of cells in each array x0, x1 etc.

Reimplemented in Gyoto::Astrobj::StarTrace.

virtual void Gyoto::Worldline::xAllocate (  )  [protected, virtual, inherited]

Allocate x0, x1 etc. with default size.

The default size is GYOTO_DEFAULT_X_SIZE

virtual void Gyoto::Worldline::xExpand ( double *&  x,
int  dir 
) [protected, virtual, inherited]

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).

Parameters:
inout] x array to expand
[in] dir 
virtual size_t Gyoto::Worldline::xExpand ( int  dir  )  [protected, virtual, inherited]

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.

Parameters:
dir : 1 to expand after last element, -1 to expand before first element
Returns:
ind : if dir=1, new index of old last element, if dir=-1, new index of old first element

Reimplemented in Gyoto::Astrobj::StarTrace.


Member Data Documentation

double Gyoto::Worldline::abstol_ [protected, inherited]

Absolute tolerance of the integrator.

Used by the adaptive integrators implemented in IntegState::Boost. Refer to the boost::numeric::odeint documentation for more details.

double Gyoto::Worldline::delta_ [protected, inherited]

Initial integrating step.

Default: GYOTO_DEFAULT_DELTA

double Gyoto::Worldline::delta_max_ [protected, inherited]

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!

double Gyoto::Worldline::delta_max_over_r_ [protected, inherited]

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.

double Gyoto::Worldline::delta_min_ [protected, inherited]

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!

double Gyoto::Photon::freq_obs_ [protected]

Photon's frequency in observer's frame.

In Hz, for quantity Emission

std::string Gyoto::Object::kind_ [protected, inherited]

The "kind" that is output in the XML entity.

E.g. for an Astrobj, fillElement() will ensure

   <Astrobj kind="kind_" ...>...</Astrobj>

is written.

The astronomical target.

The (only) possible origin for this Photon.

std::vector<std::string> Gyoto::Object::plugins_ [protected, inherited]

The plug-ins that needs to be loaded to access this instance's class.

E.g. for an Astrobj, fillElement() will ensure

   <Astrobj ... plugin="plugins_">...</Astrobj>

is written.

GYOTO_OBJECT Property const Gyoto::Photon::properties[] [static]

Property list.

This static member is declared automatically by the GYOTO_OBJECT macro and defined automatically by the GYOTO_PROPERTY_START, GYOTO_PROPERTY_END and GYOTO_PROPERTY_* macros.

The list of properties is implemented as a static array of Property instances. The last item in a Property of type Property::empty_t, which evaluates to false, so the list can be considered to be NULL-terminated (it is actually rather false-terminated). This empty_t last item can be a link to another Property list: for instance, the last item in Gyoto::Astrobj::Standard::properties is a link to Gyoto::Astrobj::Generic::properties.

Reimplemented from Gyoto::Object.

double Gyoto::Worldline::reltol_ [protected, inherited]

Absolute tolerance of the integrator.

Used by the adaptive integrators implemented in IntegState::Boost. Refer to the boost::numeric::odeint documentation for more details.

bool Gyoto::Worldline::secondary_ [protected, inherited]

Experimental: choose 0 to compute only primary image.

This feature is in development.

Observer's spectrometer.

Conveying observation frequencies for quantities Spectrum and BinSpectrum.

double Gyoto::Worldline::tmin_ [protected, inherited]

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.

Reimplemented in Gyoto::Astrobj::StarTrace.

double* Gyoto::Photon::transmission_ [protected]

Integrated optical transmissions.

For each frequency in Photon::spectro_->getMidpoints(), between current position and observer.

Integrated optical transmission.

At Photon::freq_obs_, between current position and observer.


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

Generated on 22 Jul 2017 for Gyoto by  doxygen 1.6.1