Coding a Gyoto::Astrobj::Standard in Python. More...

#include <GyotoPython.h>

Inheritance diagram for Gyoto::Astrobj::Python::Standard:

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

	Standard (const Standard &)

	~Standard ()
	Destructor: does nothing. More...

Standard *	clone () const
	Cloner. More...

virtual double	emission (double nu_em, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const
	Specific intensity I_ν More...

virtual void	emission (double Inu[], double const nu_em[], size_t nbnu, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const
	Specific intensity I_ν for several values of ν_em More...

virtual double	integrateEmission (double nu1, double nu2, double dsem, state_t const &c_ph, double const c_obj[8]=NULL) const
	∫_ν₁^ν₂ I_ν dν (or j_ν) More...

virtual void	integrateEmission (double I, double const boundaries, size_t const chaninds, size_t nbnu, double dsem, state_t const &cph, double const co) const
	∫_ν₁^ν₂ I_ν dν (or j_ν) More...

virtual double	transmission (double nuem, double dsem, state_t const &cph, double const *co) const

virtual double	operator() (double const coord[4])
	Function defining the object interior. More...

virtual void	getVelocity (double const pos[4], double vel[4])
	Fluid velocity field. More...

virtual double	giveDelta (double coord[8])
	Maximum δ inside object. 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	criticalValue () const

virtual void	criticalValue (double)

virtual void	safetyValue (double val)
	Set Standard::safety_value_.

virtual double	safetyValue () const
	Get Standard::safety_value_.

double	deltaInObj () const
	Get Generic::delta_inobj_. More...

void	deltaInObj (double val)
	Set Generic::delta_inobj_.

virtual int	Impact (Gyoto::Photon ph, size_t index, Astrobj::Properties data=NULL)
	Does a photon at these coordinates impact the object? More...

virtual double	operator() (double const data[])=0
	The actual function. More...

virtual SmartPointer< Metric::Generic >	metric () const
	Get the Metric gg_. More...

virtual void	metric (SmartPointer< Metric::Generic >)
	Set the Metric gg_. More...

virtual double	rMax ()
	Get maximal distance from center of coordinate system. More...

virtual double	rMax () const
	Get maximal distance from center of coordinate system.

virtual double	rMax (std::string const &unit)
	Get rmax_ is specified unit. More...

virtual double	rMax (std::string const &unit) const
	Get rmax_ is specified unit.

virtual void	rMax (double val)
	Set maximal distance from center of coordinate system. More...

virtual void	rMax (double val, std::string const &unit)
	Set maximal distance from center of coordinate system. More...

virtual double	deltaMax (double coord[8])
	Get max step constraint for adaptive integration. More...

const std::string	kind () const
	Get the kind of the Astrobj (e.g. "Star")

	GYOTO_OBJECT_ACCESSORS_UNIT (deltaMaxInsideRMax)

void	opticallyThin (bool flag)
	Set whether the object is optically thin. More...

bool	opticallyThin () const
	Query whether object is optically thin. More...

void	showshadow (bool flag)

bool	showshadow () const

void	redshift (bool flag)

bool	redshift () const

virtual Gyoto::Quantity_t	getDefaultQuantities ()
	Which quantities to compute if know was requested. More...

virtual void	setParameters (FactoryMessenger *fmp)
	Main loop in Subcontractor_t function. More...

virtual void	processHitQuantities (Photon ph, state_t const &coord_ph_hit, double const coord_obj_hit, double dt, Astrobj::Properties *data) const
	Fills Astrobj::Properties. More...

virtual void	processHitQuantities (Photon ph, double coord_ph_hit, double coord_obj_hit, double dt, Astrobj::Properties data) const =delete

virtual double	emission (double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const =delete
	Obsolete, update your code;.

virtual void	emission (double Inu[], double nu_em[], size_t nbnu, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const =delete
	Obsolete, update your code.

virtual void	radiativeQ (double Inu[], double Taunu[], double const nu_em[], size_t nbnu, double dsem, state_t const &coord_ph, double const coord_obj[8]=NULL) const
	emission and transmission together More...

virtual void	radiativeQ (double Inu[], double Taunu[], double nu_em[], size_t nbnu, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const =delete

virtual void	radiativeQ (double Inu, double Qnu, double Unu, double Vnu, double alphaInu, double alphaQnu, double alphaUnu, double alphaVnu, double rQnu, double rUnu, double rVnu, double const nuem, size_t nbnu, double dsem, state_t const &cph, double const *co) const

virtual double	integrateEmission (double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]=NULL) const =delete
	Obsolete, update your code.

virtual void	integrateEmission (double I, double const boundaries, size_t const chaninds, size_t nbnu, double dsem, double cph, double *co) const =delete
	Obsolete, update your code.

virtual double	transmission (double nuem, double dsem, state_t const &coord_ph, double const coord_obj[8]) const
	Transmission: exp( α_ν * ds_em ) More...

virtual double	transmission (double nuem, double dsem, state_t const &coord) const =delete
	Obsolete, update your code.

virtual double	transmission (double nuem, double dsem, double coord[8]) const =delete
	Obsolete, update your code.

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 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
double	critical_value_
	See operator()(double const coord[4])

double	safety_value_
	See operator()(double const coord[4])

double	delta_inobj_
	Constant value of the integration step inside object, in units of the compact object's mass M.

SmartPointer< Gyoto::Metric::Generic >	gg_
	The Metric in this end of the Universe.

double	rmax_
	Maximum distance to the center of the coordinate system [geometrical units]. More...

double	deltamaxinsidermax_
	Maximum Photon integration step inside rmax_ [geometrical units]. More...

bool	flag_radtransf_
	1 if radiative transfer inside Astrobj, else 0

int	shadow_
	1 to highlight the shadow region in the image

int	noredshift_
	1 to impose redshift factor g = 1

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
PyObject *	pEmission_

PyObject *	pIntegrateEmission_

PyObject *	pTransmission_

PyObject *	pCall_

PyObject *	pGetVelocity_

PyObject *	pGiveDelta_

bool	pEmission_overloaded_

bool	pIntegrateEmission_overloaded_

int	__defaultfeatures
	Whether some virtual methods are implemented. More...

int	refCount
	Reference counter.

pthread_mutex_t	mutex_
	A mutex. More...

Friends
class	Gyoto::SmartPointer< Gyoto::Astrobj::Python::Standard >

Detailed Description

Coding a Gyoto::Astrobj::Standard in Python.

Sample XML file:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<Scenery>
 
  An optically thin blob centered on the origin of the coordinate
  system, in flat space-time. Computation uses the spherical
  coordinates.
 
  <Metric kind = "Minkowski">
    <Mass unit="sunmass"> 4e6 </Mass>
    <Cartesian/>
  </Metric>
 
  <Screen>
    <Distance unit="kpc"> 8 </Distance>
    <Time unit="yr"> 30e3 </Time>
    <FieldOfView unit="microas"> 150 </FieldOfView>
    In UTF-8 locales, "microas" may be written "µas".
    <Inclination unit="degree"> 90 </Inclination>
    In UTF-8 locales, "degree" may be written "°".
    <PALN> 0 </PALN>
    <Argument> 0 </Argument>
    <Resolution> 32 </Resolution>
  </Screen>
 
  <Astrobj kind = "Python::Standard">
    <Module>gyoto_sample_standard</Module>
    <Class>FixedStar</Class>
    <CriticalValue> 12 </CriticalValue>
    <SafetyValue> 15 </SafetyValue>
 
    For this object, the 3 first parameters give the position, the
    last parameter give Cartesian (0) or spherical (non-zero).
    <Parameters> 0 0 0 </Parameters>
    <OpticallyThin/>
    <RMax>20.</RMax>
  </Astrobj>
 
  <Delta> 1e0 </Delta>
  <MinimumTime> 0. </MinimumTime>
  <Quantities>
    Intensity
  </Quantities>
  One can also specify a unit (if Gyoto was compiled with --with-udunits):
    Intensity[mJy/pix²]
    Intensity[mJy/µas²]
    Intensity[J.m-2.s-1.sr-1.Hz-1]
    Intensity[erg.cm-2.s-1.sr-1.Hz-1]
    Intensity[mJy.sr-1]
    Intensity[Jy.sr-1]
 
</Scenery>

Sample Python module:

'''Sample Astrobj::Standard for using with Gyoto Python plug-in
 
   Those classes demonstrate how to use Python classes as Gyoto
   Astrobj::Standard implementations using Gyoto's "python"
   plug-in. Note that this plug-in can be renamed to whatever matches
   the particular version of Python it has been built against
   (e.g. python3.4).
 
   The goal is to be able to instantiate these from XML, from
   Yorick... and even from Python using the gyoto extension...
 
   Synopsis:
 
   import gyoto.core
   gyoto.core.requirePlugin("python") # or python2.7 or python3.4...
   sp=gyoto.core.Astrobj("Python::Standard")
   sp.set("Module", "gyoto_sample_standard")
   sp.set("Class", "FixedStar")
   sp.set("Parameters", (0., 0., 0.))
 
   Classes that aim at implementing the Gyoto::Astrobj::Standard
   interface do so by providing the following methods:
 
   __call__: required
   getVelocity: required
   giveDelta, emission, integrateEmission, transmission, __setitem__:
              optional.
   emission and integrateEmission can be overloaded by using the
   varargs argument.
 
'''
 
import math
import numpy
import gyoto.core
 
class FixedStar:
    ''' Sample class for Astrobj::Python::Standard
    '''
    def __init__(self):
        '''Initialize instance
 
        Needed here to make a non-static array data member.
        '''
        self.pos = numpy.zeros((4), float)
 
    def __setitem__(self, key, value):
        '''Set parameters
 
        Here, the parameters will be the 3 space coordinates of the
        center of the blob.
 
        '''
        if key in (0, 1, 2):
            self.pos[key+1]=value
        else:
            raise IndexError
        self.coord_st=self.to_cartesian(self.pos)
 
    def to_cartesian(self, coord):
        '''Helper function, not in the API
 
        '''
        gg=self.this.metric()
        spherical=False
        if gg is not None:
            spherical = gg.coordKind() == gyoto.core.GYOTO_COORDKIND_SPHERICAL
        if spherical:
            rs=coord[1]
            ths=coord[2]
            phs=coord[3]
            st=math.sin(ths)
            ct=math.cos(ths)
            sp=math.sin(phs)
            cp=math.cos(phs)
            return numpy.array((coord[0], rs*st*cp, rs*st*sp, rs*ct))
        return coord
 
    def __call__(self, coord):
        ''' Astrobj::Standard::operator()()
 
        Required
        '''
        coord_ph=self.to_cartesian(coord)
        coord_st=self.coord_st
        dx = coord_ph[1]-coord_st[1]
        dy = coord_ph[2]-coord_st[2]
        dz = coord_ph[3]-coord_st[3]
        return math.sqrt(dx*dx + dy*dy + dz*dz)
 
    def getVelocity(self, coord, vel):
        ''' Velocity field
 
        Required
        '''
        vel[0]=1.
        for i in range(1, 4):
            vel[i]=0.
 
    def emission(self, nuem, dsem, cph, co):
        ''' emission
 
        Optional
        '''
        return 1.

Member Typedef Documentation

◆ Subcontractor_t

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

◆ ~Standard()

Gyoto::Astrobj::Python::Standard::~Standard ( )

virtual

Destructor: does nothing.

Reimplemented from Gyoto::Astrobj::Standard.

Member Function Documentation

◆ clone()

Standard * Gyoto::Astrobj::Python::Standard::clone ( ) const

virtual

Cloner.

This method must be implemented by the various Astrobj::Generic subclasses in order to support cloning:

SmartPointer<Astrobj> deep_copy = original->clone();

Gyoto::SmartPointer

Pointers performing reference counting.

Definition: GyotoSmartPointer.h:135

Cloning is necessary for multi-threading, recommended for interaction with the Yorick plug-in etc.

Implementing it is very straightforward, as long as the copy constructor Generic(const Generic& ) has been implemented:

MyAstrobj* MyAstrobj::clone() const { return new MyAstrobj(*this); }

Implements Gyoto::Astrobj::Generic.

◆ deltaInObj()

double Gyoto::Astrobj::Standard::deltaInObj ( ) const

inherited

Get Generic::delta_inobj_.

Get the constant integration step inside the astrobj

Returns: delta_inobj_ in geometrical units

◆ deltaMax()

virtual double Gyoto::Astrobj::Generic::deltaMax ( double coord[8] )

virtualinherited

Get max step constraint for adaptive integration.

Parameters

[in] coord position

Returns: max step to find this object reliably

Reimplemented in Gyoto::Astrobj::Complex.

◆ describeProperty()

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.

◆ emission() [1/2]

virtual void Gyoto::Astrobj::Python::Standard::emission	(	double	Inu[],
		double const	nu_em[],
		size_t	nbnu,
		double	dsem,
		state_t const &	coord_ph,
		double const	coord_obj[8] = `NULL`
	)		const

virtual

Specific intensity I_ν for several values of ν_em

Called by the default implementation for processHitQuantities().

emission() computes the intensity I_ν emitted by the small volume of length dsem. It should take self-absorption along dsem into account.

Same as emission(double nu_em, double dsem, double coord_ph[8], double coord_obj[8]=NULL) const looping on several values of nu_em.

Parameters

Inu[nbnu]	Output (must be set to a previously allocated array of doubles)
nu_em[nbnu]	Frequencies at emission
nbnu	Size of Inu[] and nu_em[]
dsem	Length over which to integrate inside the object
coord_ph	Photon coordinate
coord_obj	Emitter coordinate at current photon position

Returns: I_ν or dI_ν [W m-2 sr-2]

Reimplemented from Gyoto::Astrobj::Generic.

◆ emission() [2/2]

virtual double Gyoto::Astrobj::Python::Standard::emission	(	double	nu_em,
		double	dsem,
		state_t const &	coord_ph,
		double const	coord_obj[8] = `NULL`
	)		const

virtual

Specific intensity I_ν

Called by the default implementation for processHitQuantities().

emission() computes the intensity I_ν emitted by the small volume of length ds_em, in the emitter's frame. It should take self-absorption along ds_em into account.

Reminder :

intensity = I_ν [J m^-2 s^-1 ster^-1 Hz^-1];
invariant intensity = I_ν/ν³, which has the same value in any frame;
emission coefficient = j_ν [J m^-3 s^-1 ster^-1 Hz^-1] , defined by dI_ν = j_ν*ds, where ds is the distance travelled by the photon inside the object;
invariant emission coef = j_ν/ν², which has the same value in any frame.

The equation used for radiative transfer (without absorption) is:

d(I_ν/ν³)/dλ = (j_ν/ν²) [*]

where λ is the integration parameter along the null geodesic.

NB: Let us consider a particular observer, with ν being the frequency measured by this observer, and ds being the proper distance (as measured by the observer) that the photon travels as it moves from λ to λ+dλ along its geodesic. Then it can be shown that:

dλ = ds/ν

This shows that Eq. [*] is homogeneous.

The default implementation returns 1. if optically thick and ds_em if optically thin. It allows for a quick implementation of your object for visualization purposes.

Parameters

nu_em	Frequency at emission [Hz]
dsem	length over which to integrate inside the object [geometrical units]
coord_ph	Photon coordinate
coord_obj	Emitter coordinate at current photon position

Reimplemented from Gyoto::Astrobj::Generic.

◆ fillElement()

virtual void Gyoto::Object::fillElement ( Gyoto::FactoryMessenger * fmp ) const

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.

◆ fillProperty()

virtual void Gyoto::Object::fillProperty	(	Gyoto::FactoryMessenger *	fmp,
		Property const &	p
	)		const

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:

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

◆ getDefaultQuantities()

virtual Gyoto::Quantity_t Gyoto::Astrobj::Generic::getDefaultQuantities ( )

virtualinherited

Which quantities to compute if know was requested.

Return a Gyoto::Quantity_t suitable as input to Gyoto::Scenery::setRequestedQuantities() to set de default quantities to compute for this object. The default of these defaults GYOTO_QUANTITY_INTENSITY.

Reimplemented in Gyoto::Astrobj::PageThorneDisk.

◆ getProperties()

virtual Property const * Gyoto::Astrobj::Python::Standard::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::Astrobj::Standard.

◆ getVelocity()

virtual void Gyoto::Astrobj::Python::Standard::getVelocity	(	double const	pos[4],
		double	vel[4]
	)

virtual

Fluid velocity field.

Fill vel with the 4-vector velocity of the fluid at 4-position pos.

Parameters

[in]	pos	4-position at which to compute velocity;
[out]	vel	4-velocity at pos.

Implements Gyoto::Astrobj::Standard.

◆ giveDelta()

virtual double Gyoto::Astrobj::Python::Standard::giveDelta ( double coord[8] )

virtual

Maximum δ inside object.

Gives the requested integration step δ_t (in coordinate time t) between two neighbooring points along a portion of geodesic inside an astrobj; the current implementation only considers a constant delta, equal to Standard::deltaInobj()

Parameters

coord input coordinate at which δ_t is given

Reimplemented from Gyoto::Astrobj::Standard.

◆ help()

void Gyoto::Object::help ( ) const

inherited

Print (to stdout) some help on this class.

Describe all properties that this instance supports.

◆ Impact()

virtual int Gyoto::Astrobj::Standard::Impact	(	Gyoto::Photon *	ph,
		size_t	index,
		Astrobj::Properties *	data = `NULL`
	)

virtualinherited

Does a photon at these coordinates impact the object?

Impact() checks whether a Photon impacts the object between two integration steps of the photon's trajectory (those two steps are photon->getCoord(index, coord1) and photon->getCoord(index+1, coord2)). Impact returns 1 if the photon impacts the object between these two steps, else 0. In many cases of geometrically thick obects, the implementation Astrobj::Standard::Impact() will be fine.

Impact will call Generic::processHitQuantities() (which is virtual and may be re-implemented) to compute observable properties on demand: if the data pointer is non-NULL, the object will look in it for pointers to properties which apply to its kind. If a pointer to a property known to this object is present, then the property is computed and store at the pointed-to address. For instance, all objects know the "intensity" property. If data->intensity != NULL, the instensity is computed and stored in *data->intensity.

If data is non-NULL and only in this case, processHitQuantities() will also call ph->transmit() to update the transmissions of the Photon (see Photon::transmit(size_t, double)). This must not be done if data is NULL (see Astrobj::Complex::Impact() for an explanation).

Impact() may not extend the ph Worldline. The only two dates that are guaranteed to be defined are at indices index and index+1.

Parameters

ph	Gyoto::Photon aimed at the object;
index	Index of the last photon step;
data	Pointer to a structure to hold the observables at impact.

Returns: 1 if impact, 0 if not.

Implements Gyoto::Astrobj::Generic.

Reimplemented in Gyoto::Astrobj::InflateStar, and Gyoto::Astrobj::PolishDoughnut.

◆ inlineModule() [1/2]

virtual std::string Gyoto::Astrobj::Python::Standard::inlineModule ( ) const

virtual

Return inline_module_.

Reimplemented from Gyoto::Python::Base.

◆ inlineModule() [2/2]

virtual void Gyoto::Astrobj::Python::Standard::inlineModule ( const std::string & )

virtual

Set inline_module_ and import the Python module.

Side effects:

sets module_ to "";
calls klass(class_) if class_ is already known, so module_ can be set (or reset) after class_.

Reimplemented from Gyoto::Python::Base.

◆ integrateEmission() [1/2]

virtual void Gyoto::Astrobj::Python::Standard::integrateEmission	(	double *	I,
		double const *	boundaries,
		size_t const *	chaninds,
		size_t	nbnu,
		double	dsem,
		state_t const &	cph,
		double const *	co
	)		const

virtual

∫_ν₁^ν₂ I_ν dν (or j_ν)

Like double integrateEmission(double nu1, double nu2, double dsem, double c_ph[8], double c_obj[8]) const for each Spectrometer channel.

Reimplemented from Gyoto::Astrobj::Generic.

◆ integrateEmission() [2/2]

virtual double Gyoto::Astrobj::Python::Standard::integrateEmission	(	double	nu1,
		double	nu2,
		double	dsem,
		state_t const &	c_ph,
		double const	c_obj[8] = `NULL`
	)		const

virtual

∫_ν₁^ν₂ I_ν dν (or j_ν)

Compute the integral of emission() from ν₁ to ν₂. The default implementation is a numerical integrator which works well enough and is reasonably fast if emission() is a smooth function (i.e. no emission or absorption lines). If possible, it is wise to implement an analytical solution. It is used by processHitQuantities to compute the "BinSpectrum" quantity which is the most physical: it is the only quantity that can be actually measured directly by a real-life instrument.

Reimplemented from Gyoto::Astrobj::Generic.

◆ isThreadSafe()

virtual bool Gyoto::Object::isThreadSafe ( ) const

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.

◆ klass() [1/2]

virtual std::string Gyoto::Astrobj::Python::Standard::klass ( ) const

virtual

Retrieve class_.

Reimplemented from Gyoto::Python::Base.

◆ klass() [2/2]

virtual void Gyoto::Astrobj::Python::Standard::klass ( const std::string & c )

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.

◆ metric() [1/2]

virtual SmartPointer< Metric::Generic > Gyoto::Astrobj::Generic::metric ( ) const

virtualinherited

Get the Metric gg_.

Reimplemented in Gyoto::Astrobj::Complex, Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::FlaredDiskSynchrotron, Gyoto::Astrobj::Jet, Gyoto::Astrobj::NeutronStar, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::Star, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::ThickDisk, and Gyoto::Astrobj::XillverReflection.

◆ metric() [2/2]

virtual void Gyoto::Astrobj::Generic::metric ( SmartPointer< Metric::Generic > )

virtualinherited

Set the Metric gg_.

Reimplemented in Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::Complex, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::NeutronStar, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::Complex, Gyoto::Astrobj::DeformedTorus, Gyoto::Astrobj::DirectionalDisk, Gyoto::Astrobj::DynamicalDisk3D, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::FlaredDiskSynchrotron, Gyoto::Astrobj::Jet, Gyoto::Astrobj::Jet, Gyoto::Astrobj::OscilTorus, Gyoto::Astrobj::PageThorneDisk, Gyoto::Astrobj::Star, Gyoto::Astrobj::StarTrace, Gyoto::Astrobj::ThickDisk, Gyoto::Astrobj::ThickDisk, Gyoto::Astrobj::XillverReflection, and Gyoto::Astrobj::XillverReflection.

◆ module() [1/2]

virtual std::string Gyoto::Astrobj::Python::Standard::module ( ) const

virtual

Return module_.

Reimplemented from Gyoto::Python::Base.

◆ module() [2/2]

virtual void Gyoto::Astrobj::Python::Standard::module ( const std::string & )

virtual

Set module_ and import the Python module.

Side effects:

sets inline_module_ to "";
calls klass(class_) if class_ is already known, so module_ can be set (or reset) after class_.

Reimplemented from Gyoto::Python::Base.

◆ operator()() [1/2]

virtual double Gyoto::Astrobj::Python::Standard::operator() ( double const coord[4] )

virtual

Function defining the object interior.

A potential, distance, or whatever function such that operator()(double const coord[4]) < Standard::critical_value_ if and only if coord is inside the object. This function is used by the default implmenetation of Impact(). If Impact() is overloaded, it is not necessary to overload operator()(double coord[4]). The default implementation throws an error.

Implements Gyoto::Astrobj::Standard.

◆ operator()() [2/2]

virtual double Gyoto::Functor::Double_constDoubleArray::operator() ( double const data[] )

pure virtualinherited

The actual function.

Implemented in Gyoto::Astrobj::ThinDisk.

◆ opticallyThin() [1/2]

bool Gyoto::Astrobj::Generic::opticallyThin ( ) const

inherited

Query whether object is optically thin.

See opticallyThin(bool flag).

◆ opticallyThin() [2/2]

void Gyoto::Astrobj::Generic::opticallyThin ( bool flag )

inherited

Set whether the object is optically thin.

Set flag indicating that radiative transfer should be integrated, i.e. the object is to be considered optically thin.

Parameters

flag	1 if optically thin, 0 if optically thick.

◆ parameters() [1/2]

virtual std::vector< double > Gyoto::Astrobj::Python::Standard::parameters ( ) const

virtual

Retrieve parameters_.

Reimplemented from Gyoto::Python::Base.

◆ parameters() [2/2]

virtual void Gyoto::Astrobj::Python::Standard::parameters ( const std::vector< double > & )

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.

◆ processHitQuantities()

virtual void Gyoto::Astrobj::Generic::processHitQuantities	(	Photon *	ph,
		state_t const &	coord_ph_hit,
		double const *	coord_obj_hit,
		double	dt,
		Astrobj::Properties *	data
	)		const

virtualinherited

Fills Astrobj::Properties.

processHitQuantities fills the requested data in Impact. To use it, you need to call it in the Impact() method for your object in case of hit. It will fill Redshift, Intensity, Spectrum, BinSpectrum and update the Photon's transmission by calling Photon::transmit(), only if data==NULL.

You can overload it for your Astrobj. The generic implementation calls emission(), integrateEmission() and transmission() below.

Reimplemented in Gyoto::Astrobj::PageThorneDisk, and Gyoto::Astrobj::DynamicalDiskBolometric.

◆ property()

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.

◆ radiativeQ()

virtual void Gyoto::Astrobj::Generic::radiativeQ	(	double	Inu[],
		double	Taunu[],
		double const	nu_em[],
		size_t	nbnu,
		double	dsem,
		state_t const &	coord_ph,
		double const	coord_obj[8] = `NULL`
	)		const

virtualinherited

emission and transmission together

Reimplemented in Gyoto::Astrobj::Blob, Gyoto::Astrobj::Jet, Gyoto::Astrobj::PolishDoughnut, Gyoto::Astrobj::ThickDisk, Gyoto::Astrobj::Torus, and Gyoto::Astrobj::FlaredDiskSynchrotron.

◆ rMax() [1/4]

virtual double Gyoto::Astrobj::Generic::rMax ( )

virtualinherited

Get maximal distance from center of coordinate system.

Get maximal distance from center of coordinate system at which a Photon may hit the object.

Child classes may use the rmax_ member to cache this value, if its current value is DBL_MAX.

It can also be set using rMax().

Returns: rmax_ in geometrical units

Reimplemented in Gyoto::Astrobj::Complex, Gyoto::Astrobj::FixedStar, Gyoto::Astrobj::Star, and Gyoto::Astrobj::Torus.

◆ rMax() [2/4]

virtual void Gyoto::Astrobj::Generic::rMax ( double val )

virtualinherited

Set maximal distance from center of coordinate system.

Set maximal distance from center of coordinate system at which a Photon may hit the object.

Parameters

val	new rmax_ in geometrical units.

◆ rMax() [3/4]

virtual void Gyoto::Astrobj::Generic::rMax	(	double	val,
		std::string const &	unit
	)

virtualinherited

Set maximal distance from center of coordinate system.

Call Generic::rMax(double val) after converting val from unit to geometrical units.

Parameters

val	rmax_ expressed in unit "unit";
unit	string...

◆ rMax() [4/4]

virtual double Gyoto::Astrobj::Generic::rMax ( std::string const & unit )

virtualinherited

Get rmax_ is specified unit.

Call rMax() and convert result to unit.

Parameters

unit string

Returns: double rmax converted to unit

◆ setParameter() [1/2]

virtual void Gyoto::Object::setParameter	(	Gyoto::Property const &	p,
		std::string const &	name,
		std::string const &	content,
		std::string const &	unit
	)

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:

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.

◆ setParameter() [2/2]

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

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:

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::Astrobj::Star, and Gyoto::Metric::RotStar3_1.

◆ setParameters()

virtual void Gyoto::Astrobj::Generic::setParameters ( FactoryMessenger * fmp )

virtualinherited

Main loop in Subcontractor_t function.

The Subcontractor_t function for each Astrobj kind should look somewhat like this (templated as Gyoto::Astrobj::Subcontractor<MyKind>):

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

Each object kind should implement setParameter(string name, string content, string unit) to interpret the individual XML elements. setParameters() can be overloaded in case the specific Astrobj class needs low level access to the FactoryMessenger. See UniformSphere::setParameters().

Reimplemented from Gyoto::Object.

Reimplemented in Gyoto::Astrobj::Complex, Gyoto::Astrobj::EquatorialHotSpot, Gyoto::Astrobj::Star, and Gyoto::Astrobj::OscilTorus.

◆ transmission()

virtual double Gyoto::Astrobj::Generic::transmission	(	double	nuem,
		double	dsem,
		state_t const &	coord_ph,
		double const	coord_obj[8]
	)		const

virtualinherited

Transmission: exp( α_ν * ds_em )

transmission() computes the transmission of this fluid element or 0 if optically thick. The default implementation returns 1. (no attenuation) if optically thin, 0. if optically thick.

Parameters

nuem	frequency in the fluid's frame
coord	Photon coordinate
dsem	geometrical length in geometrical units

Reimplemented in Gyoto::Astrobj::PatternDisk, and Gyoto::Astrobj::DynamicalDisk3D.

Member Data Documentation

◆ __defaultfeatures

int Gyoto::Astrobj::Generic::__defaultfeatures

privateinherited

Whether some virtual methods are implemented.

The default implementations of some methods call one-another. This member is used internally to avoid infinite recursion.

◆ class_

std::string Gyoto::Python::Base::class_

protectedinherited

Name of the Python class that we want to expose.

Property name: Class.

◆ deltamaxinsidermax_

double Gyoto::Astrobj::Generic::deltamaxinsidermax_

protectedinherited

Maximum Photon integration step inside rmax_ [geometrical units].

Maximum step for Photon integation when inside the sphere of radius rmax_.

deltamaxinsidermax_ is in geometrical units.

◆ kind_

std::string Gyoto::Object::kind_

protectedinherited

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

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

Gyoto::Astrobj::Generic::kind

const std::string kind() const

Get the kind of the Astrobj (e.g. "Star")

is written.

◆ module_

std::string Gyoto::Python::Base::module_

protectedinherited

Name of the Python module that holds the class.

For instance, if the class is implemented in toto.py, the module name is "toto". Property name: Module.

◆ mutex_

pthread_mutex_t Gyoto::SmartPointee::mutex_

privateinherited

A mutex.

When compiled with libpthread

◆ parameters_

std::vector<double> Gyoto::Python::Base::parameters_

protectedinherited

Parameters that this class needs.

A list of parameters (doubles) can be passed in the Property Parameters. They will be sent to the Python instance using setitem.

◆ plugins_

std::vector<std::string> Gyoto::Object::plugins_

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.

◆ rmax_

double Gyoto::Astrobj::Generic::rmax_

protectedinherited

Maximum distance to the center of the coordinate system [geometrical units].

Maximum distance from the center of the coordinate system at which a photon may hit the object. Child classes may compute a decent value for rmax_ at any time if rmax_ is DBL_MAX. External classes (Photons in particular) must use rMax() to access this information.

rmax_ is in geometrical units.

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

GyotoPython.h

Public Types

Public Member Functions

Public Attributes

Static Public Attributes

Protected Attributes

Private Attributes

Friends

Detailed Description

Member Typedef Documentation

◆ Subcontractor_t

Constructor & Destructor Documentation

◆ ~Standard()

Member Function Documentation

◆ clone()

◆ deltaInObj()

◆ deltaMax()

◆ describeProperty()

◆ emission() [1/2]

◆ emission() [2/2]

◆ fillElement()

◆ fillProperty()

◆ getDefaultQuantities()

◆ getProperties()

◆ getVelocity()

◆ giveDelta()

◆ help()

◆ Impact()

◆ inlineModule() [1/2]

◆ inlineModule() [2/2]

◆ integrateEmission() [1/2]

◆ integrateEmission() [2/2]

◆ isThreadSafe()

◆ klass() [1/2]

◆ klass() [2/2]

◆ metric() [1/2]

◆ metric() [2/2]

◆ module() [1/2]

◆ module() [2/2]

◆ operator()() [1/2]

◆ operator()() [2/2]

◆ opticallyThin() [1/2]

◆ opticallyThin() [2/2]

◆ parameters() [1/2]

◆ parameters() [2/2]

◆ processHitQuantities()

◆ property()

◆ radiativeQ()

◆ rMax() [1/4]

◆ rMax() [2/4]

◆ rMax() [3/4]

◆ rMax() [4/4]

◆ setParameter() [1/2]

◆ setParameter() [2/2]

◆ setParameters()

◆ transmission()

Member Data Documentation

◆ __defaultfeatures

◆ class_

◆ deltamaxinsidermax_

◆ kind_

◆ module_

◆ mutex_

◆ parameters_

◆ plugins_

◆ rmax_