Namespace for the Gyoto library.
More...
|
typedef std::vector< double > | state_t |
|
|
void | throwError (std::string) |
| Throw a Gyoto::Error. More...
|
|
void * | loadPlugin (char const *const plugname, int nofail=0) |
| Load a plugin by name. More...
|
|
bool | havePlugin (std::string plugname) |
| Check whether a given plug-in has already been loaded. More...
|
|
void | requirePlugin (std::string plugname, int nofail=0) |
| Load a plugin by name, only if not loaded yet. More...
|
|
void | debug (int mode) |
| Set debug mode. More...
|
|
int | debug () |
| Get debug mode. More...
|
|
void | verbose (int mode) |
| Set verbosity level. More...
|
|
int | verbose () |
| Get verbosity level. More...
|
|
void | convert (double *const x, const std::size_t nelem, const double mass_sun, const double distance_kpc, const std::string unit) |
| Convert lengths (deprecated) More...
|
|
double | atof (const char *str) |
| Interpret C string as double. More...
|
|
void | help (std::string class_name) |
| Print help on class. More...
|
|
std::vector< std::string > | split (std::string const &src, std::string const &delim) |
| Split string.
|
|
double | bessi0 (double xx) |
| Bessel function computation. More...
|
|
double | bessi1 (double xx) |
| Modified Bessel function I1
|
|
double | bessk0 (double xx) |
| Modified Bessel function K0
|
|
double | bessk1 (double xx) |
| Modified Bessel function K1
|
|
double | bessk (int nn, double xx) |
| Modified Bessel function.
|
|
double | hypergeom (double kappaIndex, double thetae) |
| Gauss hypergeometric 2F1 term for kappa-distribution synchrotron.
|
|
Namespace for the Gyoto library.
◆ atof()
double Gyoto::atof |
( |
const char * |
str | ) |
|
Interpret C string as double.
Wrapper around std::atof() that also interprets DBL_MIN, DBL_MAX, -DBL_MIN and -DBL_MAX.
If str starts with "(-)DBL_M" and is not one of the four special values, then an error is thrown.
- Parameters
-
[in] | str | C string to interpret |
- Returns
- double valu represented by str.
◆ bessi0()
double Gyoto::bessi0 |
( |
double |
xx | ) |
|
Bessel function computation.
Modified Bessel function I0
◆ convert()
void Gyoto::convert |
( |
double *const |
x, |
|
|
const std::size_t |
nelem, |
|
|
const double |
mass_sun, |
|
|
const double |
distance_kpc, |
|
|
const std::string |
unit |
|
) |
| |
Convert lengths (deprecated)
- Deprecated:
- Will be removed once it is not used anymore in Gyoto per se. Prefer Gyoto::Units framework.
- Parameters
-
[in,out] | x | Lengths to convert, in geometrical units on input, in specified unit on output. |
[in] | nelem | Size of x array. |
[in] | mass_sun | Black-hole mass in Solar masses. |
[in] | distance_kpc | Distance from observer in kiloparsecs. |
[in] | unit | One of "geometrical", "m", "km", "sun radius", "rad", "degree", "arcmin", "arcsec", "mas", "uas". |
◆ debug() [1/2]
Get debug mode.
- Returns
- >=1 if debug mode is on, else 0.
◆ debug() [2/2]
void Gyoto::debug |
( |
int |
mode | ) |
|
Set debug mode.
- Parameters
-
mode | 1 to turn on debug mode, 0 to turn it off. |
◆ havePlugin()
bool Gyoto::havePlugin |
( |
std::string |
plugname | ) |
|
Check whether a given plug-in has already been loaded.
- Parameters
-
[in] | plugname | std::string Plug-in name. |
◆ help()
void Gyoto::help |
( |
std::string |
class_name | ) |
|
Print help on class.
- Parameters
-
[in] | class_name | e.g. "Gyoto::Screen", "Gyoto::Astrobj::Torus". |
◆ loadPlugin()
void* Gyoto::loadPlugin |
( |
char const *const |
plugname, |
|
|
int |
nofail = 0 |
|
) |
| |
Load a plugin by name.
Uses dlopen to load the file libgyoto-<plugname>.so, looks for the function __Gyoto<plugname>Init inside it and run it. Plug-ins must be located in the runtime link search path, or in GYOTO_PKGLIBDIR, or in GYOTO_PKGLIBDIR/GYOTO_SOVERS/.
- Parameters
-
[in] | plugname | C string Plug-in name. |
[in] | nofail | int Unless nofail evals to true, the inability to find a plug-in or to run the initialization function inside it throws an Gyoto::Error. If nofail is 2 or more, such conditions are silently ignored. If nofail is one, those conditions trigger a warning. |
- Returns
- void* handle to the dlopen'ed plug-in.
◆ requirePlugin()
void Gyoto::requirePlugin |
( |
std::string |
plugname, |
|
|
int |
nofail = 0 |
|
) |
| |
Load a plugin by name, only if not loaded yet.
- Parameters
-
[in] | plugname | std::string Plug-in name. |
[in] | nofail | int Unless nofail evals to true, the inability to find a plug-in or to run the initialization function inside it throws an Gyoto::Error. If nofail is 2 or more, such conditions are silently ignored. If nofail is one, those conditions trigger a warning. |
◆ throwError()
void Gyoto::throwError |
( |
std::string |
| ) |
|
Throw a Gyoto::Error.
Most code should use the GYOTO_ERROR macro instead
◆ verbose() [1/2]
◆ verbose() [2/2]
void Gyoto::verbose |
( |
int |
mode | ) |
|
Set verbosity level.
See standard verbosity levels defined in GyotoDefs.h:
- GYOTO_DEFAULT_DEBUG_MODE
- GYOTO_QUIET_VERBOSITY
- GYOTO_SEVERE_VERBOSITY
- GYOTO_WARNING_VERBOSITY
- GYOTO_DEFAULT_VERBOSITY
- GYOTO_INFO_VERBOSITY
- GYOTO_DEBUG_VERBOSITY