openspace.exoplanets
Functions overview
Name |
Documentation |
|---|---|
Add one or multiple exoplanet systems to the scene, as specified by the input |
|
Deprecated in favor of ‘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 |
|
Load a set of exoplanets based on custom data, in the form of a CSV file, and add them to the rendering |
|
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.
starNames
String | String[]
Return type: void
openspace.exoplanets.addExoplanetSystem(starNames)
getListOfExoplanets
Deprecated in favor of ‘listOfExoplanets’
Return type: String[]
openspace.exoplanets.getListOfExoplanets()
listAvailableExoplanetSystems
Return type: void
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[]
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.
csvFile
String
Return type: void
openspace.exoplanets.loadExoplanetsFromCsv(csvFile)
removeExoplanetSystem
starName
String
Return type: void
openspace.exoplanets.removeExoplanetSystem(starName)