LOST 0.0.1
LOST: Open-source Star Tracker
Loading...
Searching...
No Matches
databases.hpp
Go to the documentation of this file.
1#ifndef DATABASE_BUILDER_H
2#define DATABASE_BUILDER_H
3
4#include <stdlib.h>
5
6#include <array>
7#include <cstdint>
8#include <vector>
9
10#include "serialize-helpers.hpp"
11#include "star-utils.hpp"
12
13namespace lost {
14
15const int32_t kCatalogMagicValue = 0xF9A283BC;
16
17inline bool isFlagSet(uint32_t dbFlags, uint32_t flag);
18
24// TODO: QueryConservative, QueryExact, QueryTrapezoidal?
26public:
27 explicit KVectorIndex(DeserializeContext *des);
28
29 long QueryLiberal(decimal minQueryDistance, decimal maxQueryDistance, long *upperIndex) const;
30
32 long NumValues() const { return numValues; };
33 long NumBins() const { return numBins; };
35 decimal Max() const { return max; };
36 // Lower bound on elements
37 decimal Min() const { return min; };
38private:
39 long BinFor(decimal dist) const;
40
41 long numValues;
42 decimal min;
43 decimal max;
44 decimal binWidth;
45 long numBins;
46 const int32_t *bins;
47};
48
49void SerializePairDistanceKVector(SerializeContext *, const Catalog &, decimal minDistance, decimal maxDistance, long numBins);
50
57public:
59
60 const int16_t *FindPairsLiberal(decimal min, decimal max, const int16_t **end) const;
61 const int16_t *FindPairsExact(const Catalog &, decimal min, decimal max, const int16_t **end) const;
62 std::vector<decimal> StarDistances(int16_t star, const Catalog &) const;
63
65 decimal MaxDistance() const { return index.Max(); };
67 decimal MinDistance() const { return index.Min(); };
69 long NumPairs() const;
70
72 static const int32_t kMagicValue; // 0x2536f009
73 // apparently you're supposed to not actually put the value of the static variables here, but
74 // rather in a cpp implementation file.
75private:
76 KVectorIndex index;
77 // TODO: endianness
78 const int16_t *pairs;
79};
80
81// Filter star catalog to just the ones that'll be used to generate patterns
82std::vector<uint16_t> TetraPreprocessCatalog(const Catalog&,
83 const decimal maxFovDeg,
84 int numPatternStarsPerFov);
85
87 const Catalog&,
88 decimal maxFovDeg,
89 const std::vector<uint16_t>& catalogPatternStarInds,
90 int numEdgeRatioBins);
91
92// Tetra star pattern = 4 star IDs (Tetra-internal indices)
93using TetraPattern = std::array<uint16_t, TetraConstants::numPatternStars>;
94
110 public:
111 explicit TetraDatabase(DeserializeContext* des);
112
113 // Max FOV (in degrees) allowed between stars in the same pattern
114 decimal MaxFov() const { return maxFov_; }
115
116 // Number of bins used for edge ratio binning
117 int NumEdgeRatioBins() const { return numEdgeRatioBins_; }
118
119 // Number of slots in the pattern hash table
120 uint64_t PatternTableSize() const { return patternTableSize_; }
121
122 // Get the 4-tuple pattern at index
123 TetraPattern GetPattern(size_t index) const;
124
125 // Returns a list of patterns from the pattern table
126 // Under the hood, start from index and do quadratic probing
127 std::vector<TetraPattern> GetPatternMatches(size_t index) const;
128
129 uint16_t CatalogIndex(int tetraCatalogInd) const;
130
132 static const int32_t kMagicValue;
133
134 private:
135 decimal maxFov_;
136 int32_t numEdgeRatioBins_;
137 uint64_t patternTableSize_;
138 uint16_t tetraCatalogSize_;
139 const uint16_t* patternTable_;
140 const uint16_t* catalogIndices_;
141};
142
143// /**
144// * @brief Stores "inner angles" between star triples
145// * @details Unsensitive to first-order error in basic camera
146// * parameters (eg, wrong FOV or principal point), can be sensitive to second-order errors (eg,
147// * camera distortion, which may cause the effective FOV or principal point to be different in
148// * different parts of the image). Used for Mortari's Non-Dimensional Star-ID
149// */
150// class TripleInnerKVectorDatabase {
151// public:
152// explicit TripleInnerKVectorDatabase(const unsigned char *databaseBytes);
153
154// void FindTriplesLiberal(decimal min, decimal max, long **begin, long **end) const;
155// private:
156// KVectorIndex index;
157// int16_t *triples;
158// };
159
165
166#define MULTI_DB_FLOAT_FLAG 0x0001 // By default, our DB is in double mode.
167
169public:
171 explicit MultiDatabase(const unsigned char *buffer) : buffer(buffer) { };
172 const unsigned char *SubDatabasePointer(int32_t magicValue) const;
173private:
174 const unsigned char *buffer;
175};
176
178public:
179 MultiDatabaseEntry(int32_t magicValue, std::vector<unsigned char> bytes) // I wonder if making `bytes` a reference would avoid making two copies, or maybe it would be worse by preventing copy-elision
181
182 int32_t magicValue;
183 uint32_t flags;
184 std::vector<unsigned char> bytes;
185};
186
187using MultiDatabaseDescriptor = std::vector<MultiDatabaseEntry>;
188
189void SerializeMultiDatabase(SerializeContext *, const MultiDatabaseDescriptor &dbs, uint32_t flags);
190
191}
192
193#endif
A data structure enabling constant-time range queries into fixed numerical data.
Definition databases.hpp:25
decimal Min() const
Definition databases.hpp:37
KVectorIndex(DeserializeContext *des)
Construct from serialized buffer.
long QueryLiberal(decimal minQueryDistance, decimal maxQueryDistance, long *upperIndex) const
Finds all the entries in the given range, and possibly a few just outside the range on the ends.
long NumBins() const
Definition databases.hpp:33
decimal Max() const
Upper bound on elements.
Definition databases.hpp:35
long NumValues() const
The number of data points in the data referred to by the kvector.
Definition databases.hpp:32
std::vector< unsigned char > bytes
MultiDatabaseEntry(int32_t magicValue, std::vector< unsigned char > bytes)
MultiDatabase(const unsigned char *buffer)
Create a multidatabase from a serialized multidatabase.
const unsigned char * SubDatabasePointer(int32_t magicValue) const
MultiDatabase memory layout:
long NumPairs() const
Exact number of stored pairs.
std::vector< decimal > StarDistances(int16_t star, const Catalog &) const
Return the distances from the given star to each star it's paired with in the database (for debugging...
decimal MinDistance() const
Lower bound on stored star pair distances.
Definition databases.hpp:67
PairDistanceKVectorDatabase(DeserializeContext *des)
Create the database from a serialized buffer.
static const int32_t kMagicValue
Magic value to use when storing inside a MultiDatabase.
Definition databases.hpp:72
const int16_t * FindPairsExact(const Catalog &, decimal min, decimal max, const int16_t **end) const
const int16_t * FindPairsLiberal(decimal min, decimal max, const int16_t **end) const
Return at least all the star pairs whose inter-star distance is between min and max.
decimal MaxDistance() const
Upper bound on stored star pair distances.
Definition databases.hpp:65
uint16_t CatalogIndex(int tetraCatalogInd) const
TetraPattern GetPattern(size_t index) const
std::vector< TetraPattern > GetPatternMatches(size_t index) const
TetraDatabase(DeserializeContext *des)
decimal MaxFov() const
static const int32_t kMagicValue
Magic value to use when storing inside a MultiDatabase.
uint64_t PatternTableSize() const
int NumEdgeRatioBins() const
double decimal
Definition decimal.hpp:8
LOST starting point.
const int32_t kCatalogMagicValue
Definition databases.hpp:15
std::vector< MultiDatabaseEntry > MultiDatabaseDescriptor
void SerializeTetraDatabase(SerializeContext *ser, const Catalog &catalog, decimal maxFovDeg, const std::vector< uint16_t > &catalogPatternStarInds, int numEdgeRatioBins)
void SerializePairDistanceKVector(SerializeContext *ser, const Catalog &catalog, decimal minDistance, decimal maxDistance, long numBins)
Serialize a pair-distance KVector into buffer.
bool isFlagSet(uint32_t dbFlags, uint32_t flag)
Definition databases.cpp:20
std::vector< uint16_t > TetraPreprocessCatalog(const Catalog &catalog, const decimal maxFovDeg, int numPatternStarsPerFov)
std::array< uint16_t, TetraConstants::numPatternStars > TetraPattern
Definition databases.hpp:93
void SerializeMultiDatabase(SerializeContext *ser, const MultiDatabaseDescriptor &dbs, uint32_t flags)
std::vector< CatalogStar > Catalog