RenderableGaiaStars

Inherits Renderable

Members

Name	Documentation	Type	Description	Optional
`ColorMap`	[codegen::verbatim(ColorTextureInfo.description)]]	`String`	Value of type ‘String’	No
`File`	The path to the file with data for the stars to be rendered.	`String`	Value of type ‘String’	No
`FileReaderOption`	This value tells the renderable what format the input data file has. ‘Fits’ will read a FITS file, construct an Octree from it and render full data. ‘Speck’ will read a SPECK file, construct an Octree from it and render full data. ‘BinaryRaw’ will read a preprocessed binary file with ordered star data, construct an Octree and render it. ‘BinaryOctree’ will read a constructed Octree from binary file and render full data. ‘StreamOctree’ will read an index file with full Octree structure and then stream nodes during runtime. (This option is suited for bigger datasets).	`String`	In list { Fits, Speck, BinaryRaw, BinaryOctree, StreamOctree }	No
`Texture`	[codegen::verbatim(PsfTextureInfo.description)]]	`String`	Value of type ‘String’	No
`AdditionalNodes`	[codegen::verbatim(AdditionalNodesInfo.description)]]	`Vector2<int>`	Value of type ‘Vector2’	Yes
`BillboardSize`	[codegen::verbatim(BillboardSizeInfo.description)]]	`Double`	Value of type ‘Double’	Yes
`CloseUpBoostDist`	[codegen::verbatim(CloseUpBoostDistInfo.description)]]	`Double`	Value of type ‘Double’	Yes
`ColumnNames`	[codegen::verbatim(ColumnNamesInfo.description)]]	`Table`		Yes
`CutOffThreshold`	[codegen::verbatim(CutOffThresholdInfo.description)]]	`Double`	Value of type ‘Double’	Yes
`FilterBpRp`	[codegen::verbatim(FilterBpRpInfo.description)]]	`Vector2<double>`	Value of type ‘Vector2’	Yes
`FilterDist`	[codegen::verbatim(FilterDistInfo.description)]]	`Vector2<double>`	Value of type ‘Vector2’	Yes
`FilterGMag`	[codegen::verbatim(FilterGMagInfo.description)]]	`Vector2<double>`	Value of type ‘Vector2’	Yes
`FilterPosX`	[codegen::verbatim(FilterPosXInfo.description)]]	`Vector2<double>`	Value of type ‘Vector2’	Yes
`FilterPosY`	[codegen::verbatim(FilterPosYInfo.description)]]	`Vector2<double>`	Value of type ‘Vector2’	Yes
`FilterPosZ`	[codegen::verbatim(FilterPosZInfo.description)]]	`Vector2<double>`	Value of type ‘Vector2’	Yes
`FilterSize`	[codegen::verbatim(TmPointFilterSizeInfo.description)]]	`Integer`	Value of type ‘Integer’	Yes
`FirstRow`	[codegen::verbatim(FirstRowInfo.description)]]	`Integer`	Value of type ‘Integer’	Yes
`LastRow`	[codegen::verbatim(LastRowInfo.description)]]	`Integer`	Value of type ‘Integer’	Yes
`LodPixelThreshold`	[codegen::verbatim(LodPixelThresholdInfo.description)]]	`Double`	Value of type ‘Double’	Yes
`LuminosityMultiplier`	[codegen::verbatim(LuminosityMultiplierInfo.description)]]	`Double`	Value of type ‘Double’	Yes
`MagnitudeBoost`	[codegen::verbatim(MagnitudeBoostInfo.description)]]	`Double`	Value of type ‘Double’	Yes
`MaxCpuMemoryPercent`	[codegen::verbatim(MaxCpuMemoryPercentInfo.description)]]	`Double`	Value of type ‘Double’	Yes
`MaxGpuMemoryPercent`	[codegen::verbatim(MaxGpuMemoryPercentInfo.description)]]	`Double`	Value of type ‘Double’	Yes
`PixelWeightThreshold`	[codegen::verbatim(TmPointPxThresholdInfo.description)]]	`Double`	Value of type ‘Double’	Yes
`RenderMode`	This value determines which predefined columns to use in rendering. If ‘Static’ only the position of the stars is used. ‘Color’ uses position + color parameters and ‘Motion’ uses pos, color as well as velocity for the stars.	`String`	In list { Static, Color, Motion }	Yes
`ReportGlErrors`	[codegen::verbatim(ReportGlErrorsInfo.description)]]	`Boolean`	Value of type ‘Boolean’	Yes
`ShaderOption`	[codegen::verbatim(ShaderOptionInfo.description)]]	`String`	In list { Point_SSBO, Point_VBO, Billboard_SSBO, Billboard_VBO, Billboard_SSBO_noFBO }	Yes
`Sharpness`	[codegen::verbatim(SharpnessInfo.description)]]	`Double`	Value of type ‘Double’	Yes
`Sigma`	[codegen::verbatim(TmPointSigmaInfo.description)]]	`Double`	Value of type ‘Double’	Yes

Inherited members from Renderable 

Name	Documentation	Type	Description	Optional
`DimInAtmosphere`	Decides if the object should be dimmed (i.e. faded out) when the camera is in the sunny part of an atmosphere.	`Boolean`	Value of type ‘Boolean’	Yes
`Enabled`	Determines whether this object will be visible or not.	`Boolean`	Value of type ‘Boolean’	Yes
`Opacity`	This value determines the opacity of this renderable. A value of 0 means completely transparent.	`Double`	In range: ( 0,1 )	Yes
`RenderBinMode`	A value that specifies if the renderable should be rendered in the Background, Opaque, Pre-/PostDeferredTransparency, Overlay, or Sticker rendering step.	`String`	In list { Background, Opaque, PreDeferredTransparent, Overlay, PostDeferredTransparent, Sticker }	Yes
`Tag`	A single tag or a list of tags that this renderable will respond to when setting properties.	`Table, or String`	Value of type ‘Table’, or Value of type ‘String’	Yes
`Type`	The type of the renderable.	`String`	Value of type ‘String’	Yes

Asset Examples

local fullOS = openspace.systemCapabilities.fullOperatingSystem()
if string.find(fullOS, "Darwin") then
  openspace.printWarning("Gaia module (RenderableGaiaStars) not supported on mac")
  return
end

-- Download a preprocessed binary octree of Radial Velocity subset values per star
-- (preprocessed into 8 binary files).
local starsFolder = asset.resource({
  Name = "Gaia Stars RV",
  Type = "HttpSynchronization",
  Identifier = "gaia_stars_rv_octree",
  Version = 1
})

local colormaps = asset.resource({
  Name = "Stars Color Table",
  Type = "HttpSynchronization",
  Identifier = "stars_colormap",
  Version = 3
})

local textures = asset.resource({
  Name = "Stars Textures",
  Type = "HttpSynchronization",
  Identifier = "stars_textures",
  Version = 1
})


local GaiaStars = {
  Identifier = "GaiaStars",
  Renderable = {
    Type = "RenderableGaiaStars",
    File = starsFolder,
    FileReaderOption = "StreamOctree",
    RenderMode = "Motion",
    ShaderOption = "Point_SSBO",
    Texture = textures .. "halo.png",
    ColorMap = colormaps .. "colorbv.cmap",
    LuminosityMultiplier = 35,
    MagnitudeBoost = 25,
    CutOffThreshold = 38,
    BillboardSize = 1,
    CloseUpBoostDist = 250,
    Sharpness = 1.45,
    LodPixelThreshold = 0,
    MaxGpuMemoryPercent = 0.24,
    MaxCpuMemoryPercent = 0.4,
    FilterSize = 5,
    Sigma = 0.5,
    AdditionalNodes = { 3.0, 2.0 },
    FilterPosX = { 0.0, 0.0 },
    FilterPosY = { 0.0, 0.0 },
    FilterPosZ = { 0.0, 0.0 },
    FilterGMag = { 20.0, 20.0 },
    FilterBpRp = { 0.0, 0.0 },
    FilterDist = { 9.0, 9.0 }
  },
  GUI = {
    Name = "Gaia Stars",
    Path = "/Milky Way",
    Focusable = false,
    Description = "Radial Velocity subset of GaiaDR2"
  }
}


asset.onInitialize(function()
  openspace.addSceneGraphNode(GaiaStars)
end)

asset.onDeinitialize(function()
  openspace.removeSceneGraphNode(GaiaStars)
end)

asset.export(GaiaStars)



asset.meta = {
  Name = "Gaia Stars",
  Description = [[This asset contains a subset of GaiaDR2. This subset contains 7.5M stars which have
  accurate values for a number of columns]],
  Author = "ESA/Gaia/DPAC",
  URL = "https://gea.esac.esa.int/archive/documentation/GDR2/index.html",
  License = [[The Gaia data are open and free to use, provided credit is given to
    'ESA/Gaia/DPAC'. In general, access to, and use of, ESA's Gaia Archive (hereafter
    called 'the website') constitutes acceptance of the following general terms and
    conditions. Neither ESA nor any other party involved in creating, producing, or
    delivering the website shall be liable for any direct, incidental, consequential,
    indirect, or punitive damages arising out of user access to, or use of, the website.
    The website does not guarantee the accuracy of information provided by external
    sources and accepts no responsibility or liability for any consequences arising from
    the use of such data]]
}