mirror of
https://github.com/OpenSpace/OpenSpace.git
synced 2026-01-06 03:29:44 -06:00
Point cloud rewrite (RIP RenderableBillboardsCloud) (#2932)
* Start refactoring billboardscloud renderable * Remove extra unit computation in geometry shader * More refactor and fix size parameter not working without colormap (it never did) * Remove redundant bool in shader * Divide settings into property owners * Refactor colormap * More refactoring (utilize properties for visiblity) * Remove redundant extra data structures for options * Move data logic to the colormap settings structure * Remove confusing correction size properties * Separate polygon cloud into its own renderable * Clean up some unused code * Update some property descriptions * Split some more code out into functions * Remove odd and unused "linear filtering" Should be reimplemented ina better way in a general color map overhaul * Start refactoring some more properties * Make color optional and remove redundant color assignments in assets * Refactor color-parameter input and make range mapping work correctly * Code cleanup (unused code and fix data types) * Rename ScaleFactor to ScaleExponent * Add a scale factor as well, as they're easier to use, and clarify documentation * Fix faultily renamed scale factors * Remove confusing multiplication for scale exponent * Fix problem with points not appearing when _drawElements was set to true * Move all colormapsettings into its own table in the asset files * Move scaling/sizing into its own table as well * Group sizing properties and remove min pixel size limit (was always zero) * Add some docs and rename a parameter to avoid repetition * Remove IsExact colormap and add an option to hide outliers OBS! Still need to update the actual cmap files * Add property to disable size mapping * Increase pixel size of polyon texture - reduces jagged edges * Remove unused points class * Rename files and billboard class, to make it clearer that it is a point cloud * Move size mapping into size settings * Move color map properties out into its own component * Move color map related computations into the new component * Add outlier colors, to cover some specific color mapping issues * Automatically fill parameter options if no colormap parameters were defined * Move all color-related parameters to under one property owner * Inlcude changes from matrix maintenance * Add a checkbox to disable additive blending * Remove a unused variable in shader * DO color maping on the graphics card instead of CPU, using a texture * WIP remove old "Outliers" and start introducing concept of no data colors instead * Move speck loader to core and divide into a general data loader and a speck specific loader (In preparation for adding CSV support) * More labelscomponent to core * Fix a faulty header * Handle NaN values * Rename color map component property owner It's not just the color map, but the settings for the entire mapping * Hide point with nan value is show missing data is not selected * Fix labels component documentation after move * Add option to not provide any texture, and use a sphere generated form the shader * Don't crash when loading unsupported data formats :) * Add some TODO comments that should be addressed before merge * Move renderables from DU module to base, and do some header cleanup * Move colormapping component to core ad rename it to make it clear that it is not the color map itself * Add above, below and nan color values to cmap loading * Remove missing Data value specs in asset (and use belowRange in cmap instead) * Make warning about wrong color number more verbose * Add TODO comment about colormap, and actually used color in prev version, to localdwarfs * WIP: Load CSV files * Update some property visbility * Check if chosen parameter options actually exist * Fix fault column check * Update example asset to cover more different cases * Use new asset.resource loading * Update asset versions (major update) * Add parent documentation for RenderablePolygonCloud * Add point cloud example with size scaling and add TODO comment * Add example with textured points * Don't blend textured points * Fix problem with shaders being confused about texture units * Bring back deepsky points color * Start implementing more sophisticated datamapping for point data files * Allow reading datamapping from input dictionary * Load dataset in constructor instead Solves problem with color map columns not loading for big datasets when loaded the first time * Fix crash from reading column value that is interpreted as inf * Inlcude information about data mapping when caching dataset Updating the parameters now leads to an updated caching of the data file * Adapt to tolower update * Add option to specify columns to exclude in load (for CSV files) * Start updating some docs * Add a readonly property that shows the number of data points * Rename example asset to shorter name * Add option for not using cache when loading dataset * Fix some errors in example asset * Set scaleExponent from max position if not specified That way the points are always visible, even when no exponent is given * Restructure and add explanations in example asset * Add option to not cache labels component data file * Add example file with labels and units * Compute fade distances in model coordinates instead of world space (issue #1746) * Add possiblity to invert fading and add exmaple asset * Make a separate propertyowner for fading settings * Update docs * Add example asset with custom data mapping * Address some of my own review comments * Read provided Parameter from asset * Read ValueRange from asset * Add example asset for more advanced color mapping settings * Allow using the same column for two position coordinate axes * Update src/rendering/colormappingcomponent.cpp Co-authored-by: Alexander Bock <alexander.bock@liu.se> * Update src/data/datamapping.cpp * Use helper function for tolowercase * Simplify some std::optional handling, and fix broken assignment from code review fix * Update data file versions to get updated cmap files * Include a progress bar to show progress of CSV data loading * Update csv data-to-float parsing for clang * Add a description about why `openspace.absPath` is used in the file instead of `asset.resource` * Apply suggestions from code review * Apply suggestions from code review * Add some missing info in documentation * Place size-related property descriptions next to each other * Remove the explicitly set renderbin * Fix overly complicated description * Fix polygon texture not being used * Add polygon cloud example * only bind texture and activate texture unit when required * Rename alpha to opacity in shader * Fix value range not loading, and make first parameter in list the default * Rename Pixel Size property * Use base 10 for scale exponent instead of base e * Update src/data/datamapping.cpp * Update modules/base/shaders/billboardpoint_gs.glsl * Remove some redundant asset settings (Home label) * Review comments * Add TODO comment for localdwarfs asset (Speck file reading problems) * Oops, forgot part of the comment * Apply suggestions from code review Co-authored-by: Alexander Bock <alexander.bock@liu.se> * More code review fixes * Fix faulty isReady check when labels are included * Apply suggestions from code review Co-authored-by: Alexander Bock <alexander.bock@liu.se> * Apply suggestions from code review Co-authored-by: Alexander Bock <alexander.bock@liu.se> * More code review updates --------- Co-authored-by: Alexander Bock <alexander.bock@liu.se>
This commit is contained in:
Emma Broman
39
include/openspace/data/csvloader.h
Normal file
39
include/openspace/data/csvloader.h
Normal file
@@ -0,0 +1,39 @@
|
||||
/*****************************************************************************************
|
||||
* *
|
||||
* OpenSpace *
|
||||
* *
|
||||
* Copyright (c) 2014-2023 *
|
||||
* *
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
|
||||
* software and associated documentation files (the "Software"), to deal in the Software *
|
||||
* without restriction, including without limitation the rights to use, copy, modify, *
|
||||
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
|
||||
* permit persons to whom the Software is furnished to do so, subject to the following *
|
||||
* conditions: *
|
||||
* *
|
||||
* The above copyright notice and this permission notice shall be included in all copies *
|
||||
* or substantial portions of the Software. *
|
||||
* *
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
|
||||
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
|
||||
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
|
||||
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
|
||||
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
|
||||
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
||||
****************************************************************************************/
|
||||
|
||||
#ifndef __OPENSPACE_CORE___CSVLOADER___H__
|
||||
#define __OPENSPACE_CORE___CSVLOADER___H__
|
||||
|
||||
#include <openspace/data/dataloader.h>
|
||||
#include <filesystem>
|
||||
#include <optional>
|
||||
|
||||
namespace openspace::dataloader::csv {
|
||||
|
||||
Dataset loadCsvFile(std::filesystem::path path,
|
||||
std::optional<DataMapping> specs = std::nullopt);
|
||||
|
||||
} // namespace openspace::dataloader
|
||||
|
||||
#endif // __OPENSPACE_CORE___CSVLOADER___H__
|
||||
138
include/openspace/data/dataloader.h
Normal file
138
include/openspace/data/dataloader.h
Normal file
@@ -0,0 +1,138 @@
|
||||
/*****************************************************************************************
|
||||
* *
|
||||
* OpenSpace *
|
||||
* *
|
||||
* Copyright (c) 2014-2023 *
|
||||
* *
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
|
||||
* software and associated documentation files (the "Software"), to deal in the Software *
|
||||
* without restriction, including without limitation the rights to use, copy, modify, *
|
||||
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
|
||||
* permit persons to whom the Software is furnished to do so, subject to the following *
|
||||
* conditions: *
|
||||
* *
|
||||
* The above copyright notice and this permission notice shall be included in all copies *
|
||||
* or substantial portions of the Software. *
|
||||
* *
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
|
||||
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
|
||||
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
|
||||
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
|
||||
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
|
||||
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
||||
****************************************************************************************/
|
||||
|
||||
#ifndef __OPENSPACE_CORE___DATALOADER___H__
|
||||
#define __OPENSPACE_CORE___DATALOADER___H__
|
||||
|
||||
#include <openspace/data/datamapping.h>
|
||||
#include <ghoul/glm.h>
|
||||
#include <ghoul/misc/boolean.h>
|
||||
#include <ghoul/misc/csvreader.h>
|
||||
#include <filesystem>
|
||||
#include <optional>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
namespace openspace::dataloader {
|
||||
|
||||
/**
|
||||
* A dataset representing objects with positions and various other data columns.
|
||||
* Based on the SPECK format originally used for the digital universe datasets.
|
||||
* Mostly used for point-data.
|
||||
*
|
||||
* The read data files may also have associated texture values to be used for the
|
||||
* points.
|
||||
*/
|
||||
struct Dataset {
|
||||
struct Variable {
|
||||
int index = -1;
|
||||
std::string name;
|
||||
};
|
||||
std::vector<Variable> variables;
|
||||
|
||||
struct Texture {
|
||||
int index = -1;
|
||||
std::string file;
|
||||
};
|
||||
std::vector<Texture> textures;
|
||||
|
||||
int textureDataIndex = -1;
|
||||
int orientationDataIndex = -1;
|
||||
|
||||
struct Entry {
|
||||
glm::vec3 position = glm::vec3(0.f);
|
||||
std::vector<float> data;
|
||||
std::optional<std::string> comment;
|
||||
};
|
||||
std::vector<Entry> entries;
|
||||
|
||||
/// This variable can be used to get an understanding of the world scale size of
|
||||
/// the dataset
|
||||
float maxPositionComponent = 0.f;
|
||||
|
||||
int index(std::string_view variableName) const;
|
||||
bool normalizeVariable(std::string_view variableName);
|
||||
glm::vec2 findValueRange(int variableIndex) const;
|
||||
glm::vec2 findValueRange(std::string_view variableName) const;
|
||||
};
|
||||
|
||||
struct Labelset {
|
||||
int textColorIndex = -1;
|
||||
|
||||
struct Entry {
|
||||
glm::vec3 position = glm::vec3(0.f);
|
||||
std::string identifier;
|
||||
std::string text;
|
||||
bool isEnabled = true;
|
||||
};
|
||||
std::vector<Entry> entries;
|
||||
};
|
||||
|
||||
struct ColorMap {
|
||||
std::optional<glm::vec4> belowRangeColor;
|
||||
std::optional<glm::vec4> aboveRangeColor;
|
||||
std::optional<glm::vec4> nanColor;
|
||||
std::vector<glm::vec4> entries;
|
||||
};
|
||||
|
||||
namespace data {
|
||||
|
||||
Dataset loadFile(std::filesystem::path path,
|
||||
std::optional<DataMapping> specs = std::nullopt);
|
||||
|
||||
std::optional<Dataset> loadCachedFile(std::filesystem::path path);
|
||||
void saveCachedFile(const Dataset& dataset, std::filesystem::path path);
|
||||
|
||||
Dataset loadFileWithCache(std::filesystem::path path,
|
||||
std::optional<DataMapping> specs = std::nullopt);
|
||||
|
||||
} // namespace data
|
||||
|
||||
namespace label {
|
||||
|
||||
Labelset loadFile(std::filesystem::path path,
|
||||
std::optional<DataMapping> specs = std::nullopt);
|
||||
|
||||
std::optional<Labelset> loadCachedFile(std::filesystem::path path);
|
||||
void saveCachedFile(const Labelset& labelset, std::filesystem::path path);
|
||||
|
||||
Labelset loadFileWithCache(std::filesystem::path path);
|
||||
|
||||
} // namespace label
|
||||
|
||||
namespace color {
|
||||
|
||||
ColorMap loadFile(std::filesystem::path path,
|
||||
std::optional<DataMapping> specs = std::nullopt);
|
||||
|
||||
std::optional<ColorMap> loadCachedFile(std::filesystem::path path);
|
||||
void saveCachedFile(const ColorMap& colorMap, std::filesystem::path path);
|
||||
|
||||
ColorMap loadFileWithCache(std::filesystem::path path);
|
||||
|
||||
} // namespace color
|
||||
|
||||
} // namespace openspace::dataloader
|
||||
|
||||
#endif // __OPENSPACE_CORE___DATALOADER___H__
|
||||
74
include/openspace/data/datamapping.h
Normal file
74
include/openspace/data/datamapping.h
Normal file
@@ -0,0 +1,74 @@
|
||||
/*****************************************************************************************
|
||||
* *
|
||||
* OpenSpace *
|
||||
* *
|
||||
* Copyright (c) 2014-2023 *
|
||||
* *
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
|
||||
* software and associated documentation files (the "Software"), to deal in the Software *
|
||||
* without restriction, including without limitation the rights to use, copy, modify, *
|
||||
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
|
||||
* permit persons to whom the Software is furnished to do so, subject to the following *
|
||||
* conditions: *
|
||||
* *
|
||||
* The above copyright notice and this permission notice shall be included in all copies *
|
||||
* or substantial portions of the Software. *
|
||||
* *
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
|
||||
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
|
||||
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
|
||||
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
|
||||
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
|
||||
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
||||
****************************************************************************************/
|
||||
|
||||
#ifndef __OPENSPACE_CORE___DATAMAPPING___H__
|
||||
#define __OPENSPACE_CORE___DATAMAPPING___H__
|
||||
|
||||
#include <optional>
|
||||
#include <string>
|
||||
#include <vector>
|
||||
|
||||
namespace openspace::documentation { struct Documentation; }
|
||||
namespace ghoul { class Dictionary; }
|
||||
|
||||
namespace openspace::dataloader {
|
||||
|
||||
struct DataMapping {
|
||||
static DataMapping createFromDictionary(const ghoul::Dictionary& dictionary);
|
||||
static documentation::Documentation Documentation();
|
||||
|
||||
bool hasExcludeColumns() const;
|
||||
bool isExcludeColumn(std::string_view column) const;
|
||||
|
||||
std::optional<std::string> xColumnName;
|
||||
std::optional<std::string> yColumnName;
|
||||
std::optional<std::string> zColumnName;
|
||||
|
||||
std::optional<float> missingDataValue;
|
||||
|
||||
bool isCaseSensitive = false;
|
||||
|
||||
std::vector<std::string> excludeColumns;
|
||||
|
||||
// OBS! When new parameters are added they should be included in the generateHash
|
||||
// function
|
||||
};
|
||||
|
||||
/**
|
||||
* Generate a string based on the data mapping, that can be used to uniquely
|
||||
* identify the dataset.
|
||||
*/
|
||||
std::string generateHashString(const DataMapping& dm);
|
||||
|
||||
bool isPositionColumn(const std::string& c, const std::optional<DataMapping>& mapping);
|
||||
|
||||
bool isColumnX(const std::string& c, const std::optional<DataMapping>& mapping);
|
||||
|
||||
bool isColumnY(const std::string& c, const std::optional<DataMapping>& mapping);
|
||||
|
||||
bool isColumnZ(const std::string& c, const std::optional<DataMapping>& mapping);
|
||||
|
||||
} // namespace openspace::dataloader
|
||||
|
||||
#endif // __OPENSPACE_CORE___DATAMAPPING___H__
|
||||
43
include/openspace/data/speckloader.h
Normal file
43
include/openspace/data/speckloader.h
Normal file
@@ -0,0 +1,43 @@
|
||||
/*****************************************************************************************
|
||||
* *
|
||||
* OpenSpace *
|
||||
* *
|
||||
* Copyright (c) 2014-2023 *
|
||||
* *
|
||||
* Permission is hereby granted, free of charge, to any person obtaining a copy of this *
|
||||
* software and associated documentation files (the "Software"), to deal in the Software *
|
||||
* without restriction, including without limitation the rights to use, copy, modify, *
|
||||
* merge, publish, distribute, sublicense, and/or sell copies of the Software, and to *
|
||||
* permit persons to whom the Software is furnished to do so, subject to the following *
|
||||
* conditions: *
|
||||
* *
|
||||
* The above copyright notice and this permission notice shall be included in all copies *
|
||||
* or substantial portions of the Software. *
|
||||
* *
|
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, *
|
||||
* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A *
|
||||
* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT *
|
||||
* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF *
|
||||
* CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE *
|
||||
* OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
||||
****************************************************************************************/
|
||||
|
||||
#ifndef __OPENSPACE_CORE___SPECKLOADER___H__
|
||||
#define __OPENSPACE_CORE___SPECKLOADER___H__
|
||||
|
||||
#include <openspace/data/dataloader.h>
|
||||
#include <filesystem>
|
||||
#include <optional>
|
||||
|
||||
namespace openspace::dataloader::speck {
|
||||
|
||||
Dataset loadSpeckFile(std::filesystem::path path,
|
||||
std::optional<DataMapping> specs = std::nullopt);
|
||||
|
||||
Labelset loadLabelFile(std::filesystem::path path);
|
||||
|
||||
ColorMap loadCmapFile(std::filesystem::path path);
|
||||
|
||||
} // namespace openspace::dataloader::speck
|
||||
|
||||
#endif // __OPENSPACE_CORE___SPECKLOADER___H__
|
||||
Reference in New Issue
Block a user