ExoplanetSystemData

This is the documentation for the data object that is returned from the openspace.exoplanets.systemData function in the Scripting API.

The data object provides the information needed to create the scene graph nodes for an exoplanet system. However, depending on what data is available for the specific planets and star, some values may be undefined.

Members

Name	Documentation	Type	Description	Optional
Distance	The distance from this system to our solar system, in light years.	Double	Value of type ‘Double’	No
MeanOrbitRotation	A rotation matrix that represents the average of all the orbit planes in the system. Computed using the planets’ average inclinations, ascending nodes, and arguments of periapsis.	Matrix3x3<double>	Value of type ‘Matrix3x3’	No
NumPlanets	The number of known planets in the system that have enough data to be visualized.	Integer	Value of type ‘Integer’	No
Planets	A list of data tables for the planets in the system (that have enough data to be visualized), with data about the planet and its orbit.	Table	Table parameters	No
Position	The position of the host star, expressed in meters.	Vector3<double>	Value of type ‘Vector3’	No
StarName	The name of the star.	String	Value of type ‘String’	No
SystemId	The identifier of the system, which equals the identifier of the host star created based on the star name.	String	Value of type ‘String’	No
SystemRotation	A rotation matrix to use for the entire system’s rotation. Broadly speaking, it rotates the system so that the reference plane is perpendicular to the line-of-sight from Earth (and so that a 90 degree orbit inclination leads to an orbit that passes in front of its star, relative to the line-of-sight).	Matrix3x3<double>	Value of type ‘Matrix3x3’	No
StarColor	An RGB color for the host star, computed from the star’s B-V value, if data exists.	Color3	Value of type ‘Color3’	Yes
StarLuminosity	The luminosity for the star, in units of solar luminosities [log10(Solar)], if data exists.	Double	Value of type ‘Double’	Yes
StarRadius	The radius of the star, in meters, if data exists.	Double	Value of type ‘Double’	Yes
StarTeff	The effective temperature of the star, in Kelvin, if data exists.	Double	Value of type ‘Double’	Yes

Table parameters for Planets

A list of data tables for the planets in the system (that have enough data to be visualized), with data about the planet and its orbit.

• Optional: No

Name	Documentation	Type	Description	Optional
*		Table	Table parameters	Yes

Table parameters for *

• Optional: Yes

Name	Documentation	Type	Description	Optional
ArgumentOfPeriapsis	The argument of periapsis of the orbit, given as an angle in degrees in the range 0-360. It is the angle between the planet’s periapsis (the point where it is closest to its star) and its ascending node, that is, where it passes through its reference plane. If it does not exist in the data, it is given a default value of 90 degrees.	Double	Value of type ‘Double’	No
AscendingNode	The longitude of ascending node, that is, the angle for the direction of the point where the orbit passes through a reference plane. Also known as the right ascension of the ascending node. The angle is given as degrees in the range 0-360. If it does not exist in the data, it is given a default value of 180 degrees.	Double	Value of type ‘Double’	No
Eccentricity	The eccentricity of the planet’s orbit. If it does not exist in the data, it is given a default value of 0.	Double	Value of type ‘Double’	No
Epoch	The epoch to use when computing the planet’s initial position in its orbit, given as an ISO 8601-like date string of the format YYYY-MM-DDTHH:MN:SS. Computed based on the “Time of Conjunction (Transit Midpoint)” value in the data from the exoplanet archive.	String	Value of type ‘String’	No
HasUsedDefaultValues	True, if default values have been used for any of the orbit parameters, due to missing data.	Boolean	Value of type ‘Boolean’	No
Id	An identifier to use for the planet, created based on the planet name.	String	Value of type ‘String’	No
Inclination	The inclination of the planet’s orbit, given as an angle in degrees in the range 0-360. If it does not exist in the data, it is given a default value of 90 degrees.	Double	Value of type ‘Double’	No
Name	The name of the exoplanet.	String	Value of type ‘String’	No
OrbitPlaneRotationMatrix	A rotation matrix that represents the rotation of the plane of the orbit. It is computed based on the inclination, ascending node, and argument of periapsis values. Hence, it may be derived from default values.	Matrix3x3<double>	Value of type ‘Matrix3x3’	No
Period	Time the planet takes to make a complete orbit around the host star or system, in days.	Double	Value of type ‘Double’	No
SemiMajorAxis	The semi-major axis of the planet’s orbit, in meters. That is, the orbit size. This is required to be able to be visualize the planetary orbit.	Double	Value of type ‘Double’	No
SemiMajorAxisUncertainty	The uncertainty of the semi-major axis, given as an asymmetric uncertainty with two values: the lower and upper uncertainty for the orbit size. The values are given as values relative to the size of the SemiMajorAxis. For example, the lower (first) value is computed as the lower uncertainty value divided by the value for the semi-major axis. If no value is given, there is no uncertainty and the semi-major axis value is exact.	Vector2<double>	Value of type ‘Vector2’	Yes
StarRadius	The radius of the planet, in meters, if data exists.	Double	Value of type ‘Double’	Yes