A bag of word of keyframe. This class provides a data structure of keyframe retrieval model (BoW). More...
#include <KeyframeRetrieval.h>
Inheritance diagram for SolAR::datastructure::KeyframeRetrieval:
Collaboration diagram for SolAR::datastructure::KeyframeRetrieval:
Public Member Functions | |
| KeyframeRetrieval ()=default | |
| KeyframeRetrieval constructor. | |
| KeyframeRetrieval (const KeyframeRetrieval &other)=default | |
| KeyframeRetrieval & | operator= (const KeyframeRetrieval &other)=default |
| ~KeyframeRetrieval ()=default | |
| ~KeyframeRetrieval | |
| FrameworkReturnCode | addDescriptor (uint32_t id, const SolAR::datastructure::BoWFeature &bowDesc, const SolAR::datastructure::BoWLevelFeature &bowLevelDesc) |
| This method allow to add a keyframe descriptor to keyframe retrieval. More... | |
| FrameworkReturnCode | removeDescriptor (uint32_t id) |
| This method allow to remove a keyframe descriptor in keyframe retrieval. More... | |
| FrameworkReturnCode | getBoWFeature (uint32_t id, SolAR::datastructure::BoWFeature &bowDesc) |
| This method allow to get bow descirptor. More... | |
| FrameworkReturnCode | getBoWLevelFeature (uint32_t id, SolAR::datastructure::BoWLevelFeature &bowLevelDesc) |
| This method allow to get bow descirptor at the desired level. More... | |
| FrameworkReturnCode | getInvertedIndex (uint32_t nodeId, std::set< uint32_t > &invertedIndex) |
| This method allow to get inverted index at each node. More... | |
| template<typename Archive > | |
| void | serialize (Archive &ar, ATTRIBUTE(maybe_unused) const unsigned int version) |
 Public Member Functions inherited from SolAR::datastructure::Lockable | |
| Lockable ()=default | |
| LockableCollection constructor. | |
| std::unique_lock< std::mutex > | acquireLock () |
| This method returns the point cloud. More... | |
| void | lock () |
| void | unlock () |
| bool | tryLock () |
Friends | |
| class | boost::serialization::access |
Detailed Description
A bag of word of keyframe. This class provides a data structure of keyframe retrieval model (BoW).
Member Function Documentation
◆ addDescriptor()
| FrameworkReturnCode SolAR::datastructure::KeyframeRetrieval::addDescriptor | ( | uint32_t | id, |
| const SolAR::datastructure::BoWFeature & | bowDesc, | ||
| const SolAR::datastructure::BoWLevelFeature & | bowLevelDesc | ||
| ) |
This method allow to add a keyframe descriptor to keyframe retrieval.
- Parameters
-
[in] id the id of the keyframe [in] bowDesc fbow descriptor [in] bowLevelDesc fbow2 descriptor
- Returns
- FrameworkReturnCode::SUCCESS if the addition succeed, else FrameworkReturnCode::_ERROR.
◆ getBoWFeature()
| FrameworkReturnCode SolAR::datastructure::KeyframeRetrieval::getBoWFeature | ( | uint32_t | id, |
| SolAR::datastructure::BoWFeature & | bowDesc | ||
| ) |
This method allow to get bow descirptor.
- Parameters
-
[in] id the id of the keyframe [out] bowDesc bow descriptor
- Returns
- FrameworkReturnCode::SUCCESS if the addition succeed, else FrameworkReturnCode::_ERROR.
◆ getBoWLevelFeature()
| FrameworkReturnCode SolAR::datastructure::KeyframeRetrieval::getBoWLevelFeature | ( | uint32_t | id, |
| SolAR::datastructure::BoWLevelFeature & | bowLevelDesc | ||
| ) |
This method allow to get bow descirptor at the desired level.
- Parameters
-
[in] id the id of the keyframe [out] bowLevelDesc bow level descriptor
- Returns
- FrameworkReturnCode::SUCCESS if the addition succeed, else FrameworkReturnCode::_ERROR.
◆ getInvertedIndex()
| FrameworkReturnCode SolAR::datastructure::KeyframeRetrieval::getInvertedIndex | ( | uint32_t | nodeId, |
| std::set< uint32_t > & | invertedIndex | ||
| ) |
This method allow to get inverted index at each node.
- Parameters
-
[in] nodeId the id of node [out] invertedIndex inverted index at each node
- Returns
- FrameworkReturnCode::SUCCESS if the addition succeed, else FrameworkReturnCode::_ERROR.
◆ removeDescriptor()
| FrameworkReturnCode SolAR::datastructure::KeyframeRetrieval::removeDescriptor | ( | uint32_t | id | ) |
This method allow to remove a keyframe descriptor in keyframe retrieval.
- Parameters
-
[in] id the id of the keyframe
- Returns
- FrameworkReturnCode::SUCCESS if the addition succeed, else FrameworkReturnCode::_ERROR.
The documentation for this class was generated from the following files:
- interfaces/datastructure/KeyframeRetrieval.h
- src/datastructure/KeyframeRetrieval.cpp
