Gyoto
Namespaces | Classes | Typedefs | Functions
Gyoto Namespace Reference

Namespace for the Gyoto library. More...

Namespaces

namespace  Astrobj
 Access to astronomical objects.
namespace  Metric
 Access to metrics.

Classes

class  Error
 Class for thowing exceptions. More...
class  Factory
 XML input/output. More...
class  FactoryMessenger
 Factory / SmartPointee::Subcontractor_t interface. More...
class  FocalPlane
 Observed image. More...
class  LoreneMetric
 Gyoto::Metric for Lorene computed metric. More...
class  Photon
 A null geodesic transporting light. More...
class  Scenery
 Ray-tracing scene. More...
class  SmartPointee
 Can be pointed to by a SmartPointer. More...
class  SmartPointer
 Pointers performing reference counting. More...
class  Spectrometer
class  Worldline
 geodesic? More...
class  WorldlineIntegState
 Current state of a geodesic integration. More...

Typedefs

typedef unsigned int SpectroKind_t
 Spectrometer kind.
typedef unsigned int Quantity_t
 Observable quantities.
typedef unsigned int Verbosity_t
 Verbosity levels.
typedef unsigned int CoordKind_t
 Coordinate system kinds GYOTO_COORDKIND_CARTESIAN or GYOTO_COORDKIND_SPHERICAL.

Functions

void setErrorHandler (GyotoErrorHandler_t *)
void throwError (std::string)
SmartPointer< PhotonPhotonSubcontractor (Gyoto::FactoryMessenger *)
void loadPlugin (char const *const plugname, int nofail=0)
SmartPointer< SceneryScenerySubcontractor (Gyoto::FactoryMessenger *)
SmartPointer< SpectrometerSpectrometerSubcontractor (FactoryMessenger *fmp)
void debug (int mode)
 mode=1 for debug output, 0 for no output
int debug ()
 return >=1 if in debug mode, else 0
void verbose (int mode)
 mode=1 for debug output, 0 for no output
int verbose ()
 return >=1 if in debug mode, else 0
void convert (double *const x, const std::size_t nelem, const double mass_sun, const double distance_kpc, const std::string unit)

Detailed Description

Namespace for the Gyoto library.


Typedef Documentation

typedef unsigned int Gyoto::Quantity_t

Observable quantities.

Individual quantities are represented as a variable of this type. A combination of quantities is an ored list of Quantity_t, e.g.

GYOTO_QUANTITY_INTENSITY | GYOTO_QUANTITY_EMISSIONTIME

To check wheter a given quantity is listed in a Quantity_t variable quant:

if (quant & GYOTOQUANTITY_EMISSION) ...

List of all possible Quantity_t individual values and the corresponding string (see Scenery):

  • GYOTO_QUANTITY_INTENSITY : Intensity
  • GYOTO_QUANTITY_EMISSIONTIME: EmissionTime
  • GYOTO_QUANTITY_MIN_DISTANCE: MinDistance
  • GYOTO_QUANTITY_FIRST_DMIN : FirstDmin
  • GYOTO_QUANTITY_REDSHIFT : RedShift
  • GYOTO_QUANTITY_SPECTRUM : Spectrum
  • GYOTO_QUANTITY_BINSPECTRUM : BinSpectrum
  • GYOTO_QUANTITY_IMPACTCOORDS: ImpactCoords
  • GYOTO_QUANTITY_USER1 : User1
  • GYOTO_QUANTITY_USER2 : User2
  • GYOTO_QUANTITY_USER3 : User3
  • GYOTO_QUANTITY_USER4 : User4
  • GYOTO_QUANTITY_USER5 : User5
typedef unsigned int Gyoto::SpectroKind_t

Spectrometer kind.

One of: GYOTO_SPECTRO_KIND_NONE, GYOTO_SPECTRO_KIND_FREQ, GYOTO_SPECTRO_KIND_FREQLOG, GYOTO_SPECTRO_KIND_WAVE, GYOTO_SPECTRO_KIND_WAVELOG