mirror/OpenSpace
1
0
Fork 0
mirror of https://github.com/OpenSpace/OpenSpace.git synced 2026-01-06 11:39:49 -06:00
Code Issues Packages Projects Releases Wiki Activity

Doxygen style overhaul (#2954)

Browse Source 
Reformatting the existing Doxygen comments to be unified
This commit is contained in:
Alexander Bock
2023-11-20 23:39:17 +01:00
committed by GitHub
parent 4ee078502b
commit 7db7c40841
163 changed files with 2266 additions and 2035 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
modules/fitsfilereader/include/fitsfilereader.h
View File

@@ -73,10 +73,10 @@ public:
std::shared_ptr<T> readHeaderValue(const std::string key);
/**
* Read specified table columns from fits file.
* If `readAll` is set to true the entire table will be read before the
* selected columns, which makes the function take a lot longer if it's a big file.
* If no HDU index is given the current Extension HDU will be read from.
* Read specified table columns from fits file. If `readAll` is set to true the entire
* table will be read before the selected columns, which makes the function take a lot
* longer if it's a big file. If no HDU index is given the current Extension HDU will
* be read from.
*/
template<typename T>
std::shared_ptr<TableData<T>> readTable(const std::filesystem::path& path,
@@ -85,17 +85,17 @@ public:
/**
* Reads a single FITS file with pre-defined columns (defined for Viennas TGAS-file).
* Returns a vector with all read stars with `nValuesPerStar`.
* If additional columns are given by `filterColumnNames`, they will be
* read but it will slow doen the reading tremendously.
* Returns a vector with all read stars with `nValuesPerStar`. If additional columns
* are given by `filterColumnNames`, they will be read but it will slow doen the
* reading tremendously.
*/
std::vector<float> readFitsFile(std::filesystem::path filePath, int& nValuesPerStar,
int firstRow, int lastRow, std::vector<std::string> filterColumnNames,
int multiplier = 1);
/**
* Reads a single SPECK file and returns a vector with `nRenderValues`
* per star. Reads data in pre-defined order based on AMNH's star data files.
* Reads a single SPECK file and returns a vector with `nRenderValues` per star. Reads
* data in pre-defined order based on AMNH's star data files.
*/
std::vector<float> readSpeckFile(const std::filesystem::path& filePath,
int& nRenderValues);