`openspace.exoplanets`

Functions overview

Name	Documentation
`addExoplanetSystem`	Add a specific exoplanet system to the scene, based on a star name
`addExoplanetSystems`	Add multiple exoplanet systems to the scene, based on a list of names
`getListOfExoplanets`	Deprecated in favor of ‘listOfExoplanets’
`listAvailableExoplanetSystems`	Lists the names of the host stars of all exoplanet systems that have sufficient data for generating a visualization, and prints the list to the console
`listOfExoplanets`	Returns a list with names of the host star of all the exoplanet systems that have sufficient data for generating a visualization, based on the module’s loaded data file
`loadExoplanetsFromCsv`	Load a set of exoplanets based on custom data, in the form of a CSV file, and add them to the rendering
`loadSystemDataFromCsv`	Load a set of exoplanet information based on custom data in the form of a CSV file
`removeExoplanetSystem`	Remove a loaded exoplanet system
`systemData`	Return an object containing the information needed to add a specific exoplanet system

Functions

`addExoplanetSystem`

Add a specific exoplanet system to the scene, based on a star name.

Note that the formatting of the name must match the one in the dataset. That is, it must match the name as given in the NASA Exoplanet Archive.

Parameters

starName String
- The name of the star

Return type: void

Signature

openspace.exoplanets.addExoplanetSystem(starName)

`addExoplanetSystems`

Add multiple exoplanet systems to the scene, based on a list of names.

Note that the formatting of the name must match the one in the dataset. That is, they must match the names as given in the NASA Exoplanet Archive.

Parameters

listOfStarNames String[]
- A list of star names for which to create the exoplanet systems

Return type: void

Signature

openspace.exoplanets.addExoplanetSystems(listOfStarNames)

`getListOfExoplanets`

Deprecated in favor of ‘listOfExoplanets’

Return type: String[]

Signature

openspace.exoplanets.getListOfExoplanets()

`listAvailableExoplanetSystems`

Lists the names of the host stars of all exoplanet systems that have sufficient data for generating a visualization, and prints the list to the console.

Return type: void

Signature

openspace.exoplanets.listAvailableExoplanetSystems()

`listOfExoplanets`

Returns a list with names of the host star of all the exoplanet systems that have sufficient data for generating a visualization, based on the module’s loaded data file.

Return type: String[]

Signature

openspace.exoplanets.listOfExoplanets()

Load a set of exoplanets based on custom data, in the form of a CSV file, and add them to the rendering. Can be used to load custom datasets, or more recent planets than what are included in the internal data file that is released with OpenSpace.

The format and column names in the CSV should be the same as the ones provided by the NASA Exoplanet Archive.

We recommend downloading the file from the Exoplanet Archive’s Composite data table, where multiple sources are combined into one row per planet.

Please remember to include all columns in the file download, as missing data columns may lead to an incomplete visualization.

Also, avoid loading too large files of planets, as each added system will affect the rendering performance.

Parameters

csvFile String
- A path to a .csv file that contains the data for the exoplanets

Return type: void

Signature

openspace.exoplanets.loadExoplanetsFromCsv(csvFile)

`loadSystemDataFromCsv`

Load a set of exoplanet information based on custom data in the form of a CSV file.

The format and column names in the CSV should be the same as the ones provided by the NASA Exoplanet Archive.

When dowloading the data from the archive we recommend including all columns, since a few required ones are not selected by default.

Parameters

csvFile String
- A path to the CSV file to load the data from.

Return type: Table[] A list of objects of the type ExoplanetSystemData, that can be used to create the scene graph nodes for the exoplanet systems

Signature

openspace.exoplanets.loadSystemDataFromCsv(csvFile)

`removeExoplanetSystem`

Remove a loaded exoplanet system.

Parameters

starName String
- The name of the host star for the system to remove.

Return type: void

Signature

openspace.exoplanets.removeExoplanetSystem(starName)

`systemData`

Return an object containing the information needed to add a specific exoplanet system. The data is retrieved from the module’s prepared datafile for exoplanets. This file is in a binary format, for fast retrieval during runtime.

Parameters

starName String
- The name of the star to get the information for.

Return type: Table An object of the type ExoplanetSystemData that can be used to create the scene graph nodes for the exoplanet system

Signature

openspace.exoplanets.systemData(starName)

openspace.exoplanets

Functions overview

Functions

`openspace.exoplanets`