openspace.exoplanets

Functions overview

Name

Documentation

addExoplanetSystem

Add one or multiple exoplanet systems to the scene, as specified by the input

getListOfExoplanets

Deprecated in favor of ‘listOfExoplanets’

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

loadExoplanetsFromCsv

Load a set of exoplanets based on custom data, in the form of a CSV file, and add them to the rendering

removeExoplanetSystem

Functions

addExoplanetSystem

Add one or multiple exoplanet systems to the scene, as specified by the input. An input string should be the name of the system host star.

Parameters
  • starNames String | String[]

Return type: void

Signature
openspace.exoplanets.addExoplanetSystem(starNames)

getListOfExoplanets

Deprecated in favor of ‘listOfExoplanets’

Return type: String[]

Signature
openspace.exoplanets.getListOfExoplanets()

listAvailableExoplanetSystems

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()

loadExoplanetsFromCsv

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 sould be the same as the ones provided by the NASA Exoplanet Archive. https://exoplanetarchive.ipac.caltech.edu/

We recommend downloading the file from the Exoplanet Archive’s Composite data table, where multiple sources are combined into one row per planet. https://exoplanetarchive.ipac.caltech.edu /cgi-bin/TblView/nph-tblView?app=ExoTbls&config=PSCompPars

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

Return type: void

Signature
openspace.exoplanets.loadExoplanetsFromCsv(csvFile)

removeExoplanetSystem

Parameters
  • starName String

Return type: void

Signature
openspace.exoplanets.removeExoplanetSystem(starName)