Gyoto
|
Loader for Python classes implementing the Spectrum interface. More...
#include <GyotoPython.h>
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. More... | |
Public Member Functions | |
virtual Property const * | getProperties () const |
Get list of properties. More... | |
Python (const Python &) | |
virtual Python * | clone () const |
Cloner. More... | |
virtual std::string | module () const |
Return module_. More... | |
virtual void | module (const std::string &) |
Set module_ and import the Python module. More... | |
virtual std::string | inlineModule () const |
Return inline_module_. More... | |
virtual void | inlineModule (const std::string &) |
Set inline_module_ and import the Python module. More... | |
virtual std::string | klass () const |
Retrieve class_. More... | |
virtual void | klass (const std::string &) |
Set class_ and instantiate the Python class. More... | |
virtual std::vector< double > | parameters () const |
Retrieve parameters_. More... | |
virtual void | parameters (const std::vector< double > &) |
Set parameters_ and send them to pInstance_. More... | |
virtual double | operator() (double nu) const |
I_nu = mySpectrum(nu), nu in Hz. Assumes optically thick regime. More... | |
virtual double | operator() (double nu, double opacity, double ds) const |
I_nu in optically thin regime. More... | |
virtual double | integrate (double nu1, double nu2) |
Integrate optically thick I_nu. More... | |
const std::string | kind () const |
Get spectrum kind. | |
virtual double | integrate (double nu1, double nu2, const Spectrum::Generic *opacity, double ds) |
Integrate optically thin I_nu. 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. | |
virtual bool | isThreadSafe () const |
Whether this class is thread-safe. More... | |
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. More... | |
virtual void | fillProperty (Gyoto::FactoryMessenger *fmp, Property const &p) const |
Output a single Property to XML. More... | |
virtual void | fillElement (Gyoto::FactoryMessenger *fmp) const |
Fill the XML element for this Object. More... | |
virtual void | setParameters (Gyoto::FactoryMessenger *fmp) |
Main loop for parsing Properties from XML description. More... | |
virtual int | setParameter (std::string name, std::string content, std::string unit) |
Set parameter by name. More... | |
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) More... | |
std::string | describeProperty (Gyoto::Property const &p) const |
Format desrciption for a property. More... | |
void | help () const |
Print (to stdout) some help on this class. More... | |
Public Attributes | |
GYOTO_OBJECT_THREAD_SAFETY | |
Static Public Attributes | |
static GYOTO_OBJECT Property const | properties [] |
Protected Attributes | |
PyObject * | pCall_ |
Reference to ___call__. More... | |
PyObject * | pIntegrate_ |
Reference to the (optional) integrate method. | |
bool | pCall_overloaded_ |
Whether call is overloaded. More... | |
std::string | kind_ |
The "kind" that is output in the XML entity. More... | |
std::vector< std::string > | plugins_ |
The plug-ins that needs to be loaded to access this instance's class. More... | |
std::string | module_ |
Name of the Python module that holds the class. More... | |
std::string | inline_module_ |
Python source code for module that holds the class. | |
std::string | class_ |
Name of the Python class that we want to expose. More... | |
std::vector< double > | parameters_ |
Parameters that this class needs. More... | |
PyObject * | pModule_ |
Reference to the python module once it has been loaded. | |
PyObject * | pInstance_ |
Reference to the python instance once it has been instantiated. | |
Private Attributes | |
int | refCount |
Reference counter. | |
pthread_mutex_t | mutex_ |
A mutex. More... | |
Friends | |
class | Gyoto::SmartPointer< Gyoto::Spectrum::Python > |
Loader for Python classes implementing the Spectrum interface.
It interfaces with a Python class which must implement at least the call method.
Sample XML file:
Sample Python module:
|
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().
|
virtual |
Cloner.
Reimplemented from Gyoto::Spectrum::Generic.
|
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.
|
virtualinherited |
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.
|
virtualinherited |
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:
Reimplemented in Gyoto::Scenery, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::Disk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::NeutronStarModelAtmosphere, Gyoto::Astrobj::PatternDisk, Gyoto::Astrobj::PolishDoughnut, Gyoto::Screen, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Uniform, and Gyoto::Astrobj::XillverReflection.
|
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::Spectrum::Generic.
|
inherited |
Print (to stdout) some help on this class.
Describe all properties that this instance supports.
|
virtual |
Return inline_module_.
Reimplemented from Gyoto::Python::Base.
|
virtual |
Set inline_module_ and import the Python module.
Side effects:
Reimplemented from Gyoto::Python::Base.
|
virtual |
Integrate optically thick I_nu.
See operator()(double nu) const
nu1,nu2 | boundaries for the integration |
Reimplemented from Gyoto::Spectrum::Generic.
|
virtualinherited |
Integrate optically thin I_nu.
See operator()(double nu, double opacity, double ds) const
nu1,nu2 | boundaries for the integration |
opacity | the frequency-dependent opacity law given as a pointer to a Gyoto::Spectrum::Generic sub-class instance |
ds | the element length for spatial integration |
|
virtualinherited |
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.
|
virtual |
Retrieve class_.
Reimplemented from Gyoto::Python::Base.
|
virtual |
Set class_ and instantiate the Python class.
Sets pInstance_.
This generic implementation takes care of the common ground, but does not set 'this' or call parameters(parameters_). Therefore, all the derived classes should reimplement this method and at least call Python::Base::klass(c) and parameters(parameters_). Between the two is the right moment to check that the Python class implements the required API and to cache PyObject* pointers to class methods.
Reimplemented from Gyoto::Python::Base.
|
virtual |
Return module_.
Reimplemented from Gyoto::Python::Base.
|
virtual |
Set module_ and import the Python module.
Side effects:
Reimplemented from Gyoto::Python::Base.
|
virtual |
I_nu = mySpectrum(nu), nu in Hz. Assumes optically thick regime.
Implements Gyoto::Spectrum::Generic.
|
virtual |
I_nu in optically thin regime.
Generic implementation assumes emissivity = opacity.
nu | frequency in Hz |
opacity | such that opacity*ds=optical thickness. |
ds | in geometrical units |
Reimplemented from Gyoto::Spectrum::Generic.
|
virtual |
Retrieve parameters_.
Reimplemented from Gyoto::Python::Base.
|
virtual |
Set parameters_ and send them to pInstance_.
The parameters are sent to the class instance using the setitem method with numerical keys.
Reimplemented from Gyoto::Python::Base.
|
inherited |
|
virtualinherited |
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:
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.
|
virtualinherited |
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:
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 |
Reimplemented in Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Metric::KerrKS, Gyoto::Astrobj::Star, and Gyoto::Metric::RotStar3_1.
|
virtualinherited |
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:
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 in Gyoto::Astrobj::Generic, Gyoto::Astrobj::Complex, Gyoto::Spectrometer::Complex, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Photon, Gyoto::Astrobj::Star, Gyoto::Spectrometer::Uniform, and Gyoto::Astrobj::OscilTorus.
|
protectedinherited |
|
protectedinherited |
The "kind" that is output in the XML entity.
E.g. for an Astrobj, fillElement() will ensure
is written.
|
protectedinherited |
|
privateinherited |
A mutex.
When compiled with libpthread
|
protectedinherited |
|
protected |
Reference to ___call__.
call is the method in the underlying Python class that implements Gyoto::Spectrum::Generic::operator()().
|
protected |
Whether call is overloaded.
This is determined automatically by looking at the parameters accepted by call:
In this case call is not overloaded and implements only virtual double operator()(double nu) const;
In this case call is overloaded and implements both double operator()(double nu) const and virtual double operator()(double nu, double opacity, double ds) const.
|
protectedinherited |
The plug-ins that needs to be loaded to access this instance's class.
E.g. for an Astrobj, fillElement() will ensure
is written.