Ocean
Ocean::Tracking::MapBuilding::Utilities Class Reference

This class implements utility functions. More...

Inheritance diagram for Ocean::Tracking::MapBuilding::Utilities:

Static Public Member Functions

static bool writeDescriptorMap (const UnifiedDescriptorMap &unifiedDescriptorMap, IO::OutputBitstream &outputStream)
 Writes a descriptor map to an output stream. More...
 
static bool readDescriptorMap (IO::InputBitstream &inputStream, std::shared_ptr< UnifiedDescriptorMap > &unifiedDescriptorMap)
 Reads a descriptor map from an output stream. More...
 
- Static Public Member Functions inherited from Ocean::Tracking::MapBuilding::DescriptorHandling
static OCEAN_FORCE_INLINE unsigned int determineFreakDistance (const FreakMultiDescriptor256 &descriptorA, const FreakMultiDescriptor256 &descriptorB)
 Determines the minimal distance between one FREAK multi descriptor and another FREAK multi descriptors. More...
 
static OCEAN_FORCE_INLINE unsigned int determineFreakDistance (const FreakMultiDescriptor256 &descriptorA, const FreakMultiDescriptors256 &descriptorsB)
 Determines the minimal distance between one FREAK multi descriptor and several FREAK multi descriptors. More...
 
static OCEAN_FORCE_INLINE unsigned int determineFreakDistance (const FreakMultiDescriptors256 &descriptorsA, const FreakMultiDescriptors256 &descriptorsB)
 Determines the minimal distance between two sets of FREAK descriptors. More...
 
static OCEAN_FORCE_INLINE unsigned int determineFreakDistance (const FreakMultiDescriptors256 *const &descriptorsA, const UnifiedDescriptor::BinaryDescriptor< 256u > &descriptorB)
 Determines the minimal distance between a set of FREAK descriptors and a second FREAK descriptor. More...
 
static OCEAN_FORCE_INLINE unsigned int determineFreakDistance (const FreakMultiDescriptors256 *const &descriptorsA, const FreakMultiDescriptors256 &descriptorB)
 Determines the minimal distance between two set of FREAK descriptors. More...
 
static OCEAN_FORCE_INLINE unsigned int determineFreakDistance (const FreakMultiDescriptors256 &descriptorsA, const UnifiedDescriptor::BinaryDescriptor< 256u > &descriptorB)
 Determines the minimal distance between a set of FREAK descriptors and a binary descriptor. More...
 
static OCEAN_FORCE_INLINE unsigned int calculateHammingDistance (const FreakMultiDescriptor256 &descriptorA, const UnifiedDescriptor::BinaryDescriptor< 256u > &descriptorB)
 Determines the minimal distance between a FREAK descriptors and a binary descriptor. More...
 
static OCEAN_FORCE_INLINE const UnifiedDescriptor::BinaryDescriptor< 256u > * multiDescriptorFunction (const FreakMultiDescriptor256 &multiDescriptor, const size_t index)
 Returns one binary descriptor from a FREAK Multi descriptor. More...
 
static OCEAN_FORCE_INLINE const FreakMultiDescriptor256multiDescriptorGroupFunction (const FreakMultiDescriptors256 *const &multiDescriptorGroup, const size_t index)
 Returns one FREAK Multi descriptor from a FREAK Multi descriptor group. More...
 
static bool computeFreakDescriptor (const CV::FramePyramid &yFramePyramid, const AnyCamera &anyCamera, const Vector2 &point, FreakMultiDescriptor256 &freakDescriptor)
 Computes the FREAK Multi descriptor for a given 2D location within an image. More...
 
static bool replaceDescriptorPyramid (const CV::FramePyramid &yFramePyramid, CV::FramePyramid &yFramePyramidForDescriptors, Worker *worker=nullptr)
 Replaces an image pyramid which is intended for FREAK descriptor extraction. More...
 

Additional Inherited Members

- Public Types inherited from Ocean::Tracking::MapBuilding::DescriptorHandling
typedef CV::Detector::FREAKDescriptor32 FreakMultiDescriptor256
 Definition of a FREAK Multi Descriptor with 32 bytes or 256 bits. More...
 
typedef CV::Detector::FREAKDescriptors32 FreakMultiDescriptors256
 Definition of a vector holding FREAK Multi Descriptors with 32 bytes or 256 bits. More...
 
typedef std::unordered_map< Index32, FreakMultiDescriptors256FreakMultiDescriptorMap256
 Definition of an unordered map mapping FREAK Multi descriptors. More...
 

Detailed Description

This class implements utility functions.

Member Function Documentation

◆ readDescriptorMap()

static bool Ocean::Tracking::MapBuilding::Utilities::readDescriptorMap ( IO::InputBitstream inputStream,
std::shared_ptr< UnifiedDescriptorMap > &  unifiedDescriptorMap 
)
static

Reads a descriptor map from an output stream.

Parameters
inputStreamThe stream from which the map will be read
unifiedDescriptorMapThe resulting descriptor map
Returns
True, if succeeded

◆ writeDescriptorMap()

static bool Ocean::Tracking::MapBuilding::Utilities::writeDescriptorMap ( const UnifiedDescriptorMap unifiedDescriptorMap,
IO::OutputBitstream outputStream 
)
static

Writes a descriptor map to an output stream.

Parameters
unifiedDescriptorMapThe descriptor map to write
outputStreamThe output stream to which the map will be written
Returns
True, if succeeded

The documentation for this class was generated from the following file: