VWDictionary.cpp

Go to the documentation of this file.

/*
Copyright (c) 2010-2016, Mathieu Labbe - IntRoLab - Universite de Sherbrooke
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
    * Redistributions of source code must retain the above copyright
      notice, this list of conditions and the following disclaimer.
    * Redistributions in binary form must reproduce the above copyright
      notice, this list of conditions and the following disclaimer in the
      documentation and/or other materials provided with the distribution.
    * Neither the name of the Universite de Sherbrooke nor the
      names of its contributors may be used to endorse or promote products
      derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

#include "rtabmap/core/VWDictionary.h"
#include "rtabmap/core/VisualWord.h"

#include "rtabmap/core/Signature.h"
#include "rtabmap/core/DBDriver.h"
#include "rtabmap/core/Parameters.h"

#include "rtabmap/utilite/UtiLite.h"

#include <opencv2/opencv_modules.hpp>

#if CV_MAJOR_VERSION < 3
#include <opencv2/gpu/gpu.hpp>
#else
#include <opencv2/core/cuda.hpp>
#ifdef HAVE_OPENCV_CUDAFEATURES2D
#include <opencv2/cudafeatures2d.hpp>
#endif
#endif

#include "rtflann/flann.hpp"

#include <fstream>
#include <string>

namespace rtabmap
{

class FlannIndex
{
public:
        FlannIndex():
                index_(0),
                nextIndex_(0),
                featuresType_(0),
                featuresDim_(0),
                isLSH_(false),
                useDistanceL1_(false)
        {
        }
        virtual ~FlannIndex()
        {
                this->release();
        }

        void release()
        {
                if(index_)
                {
                        if(featuresType_ == CV_8UC1)
                        {
                                delete (rtflann::Index<rtflann::Hamming<unsigned char> >*)index_;
                        }
                        else
                        {
                                if(useDistanceL1_)
                                {
                                        delete (rtflann::Index<rtflann::L1<float> >*)index_;
                                }
                                else
                                {
                                        delete (rtflann::Index<rtflann::L2<float> >*)index_;
                                }
                        }
                        index_ = 0;
                }
                nextIndex_ = 0;
                isLSH_ = false;
                addedDescriptors_.clear();
                removedIndexes_.clear();
        }

        unsigned int indexedFeatures() const
        {
                if(!index_)
                {
                        return 0;
                }
                if(featuresType_ == CV_8UC1)
                {
                        return ((const rtflann::Index<rtflann::Hamming<unsigned char> >*)index_)->size();
                }
                else
                {
                        if(useDistanceL1_)
                        {
                                return ((const rtflann::Index<rtflann::L1<float> >*)index_)->size();
                        }
                        else
                        {
                                return ((const rtflann::Index<rtflann::L2<float> >*)index_)->size();
                        }
                }
        }

        // return KB
        unsigned int memoryUsed() const
        {
                if(!index_)
                {
                        return 0;
                }
                if(featuresType_ == CV_8UC1)
                {       
                        return ((const rtflann::Index<rtflann::Hamming<unsigned char> >*)index_)->usedMemory()/1000;
                }
                else
                {
                        if(useDistanceL1_)
                        {
                                return ((const rtflann::Index<rtflann::L1<float> >*)index_)->usedMemory()/1000;
                        }
                        else
                        {
                                return ((const rtflann::Index<rtflann::L2<float> >*)index_)->usedMemory()/1000;
                        }
                }
        }

        // Note that useDistanceL1 doesn't have any effect if LSH is used
        void build(
                        const cv::Mat & features,
                        const rtflann::IndexParams& params,
                        bool useDistanceL1)
        {
                this->release();
                UASSERT(index_ == 0);
                UASSERT(features.type() == CV_32FC1 || features.type() == CV_8UC1);
                featuresType_ = features.type();
                featuresDim_ = features.cols;
                useDistanceL1_ = useDistanceL1;

                if(featuresType_ == CV_8UC1)
                {
                        rtflann::Matrix<unsigned char> dataset(features.data, features.rows, features.cols);
                        index_ = new rtflann::Index<rtflann::Hamming<unsigned char> >(dataset, params);
                        ((rtflann::Index<rtflann::Hamming<unsigned char> >*)index_)->buildIndex();
                }
                else
                {
                        rtflann::Matrix<float> dataset((float*)features.data, features.rows, features.cols);
                        if(useDistanceL1_)
                        {
                                index_ = new rtflann::Index<rtflann::L1<float> >(dataset, params);
                                ((rtflann::Index<rtflann::L1<float> >*)index_)->buildIndex();
                        }
                        else
                        {
                                index_ = new rtflann::Index<rtflann::L2<float> >(dataset, params);
                                ((rtflann::Index<rtflann::L2<float> >*)index_)->buildIndex();
                        }
                }

                if(features.rows == 1)
                {
                        // incremental FLANN
                        addedDescriptors_.insert(std::make_pair(nextIndex_, features));
                }
                // else assume that the features are kept in memory outside this class (e.g., dataTree_)

                nextIndex_ = features.rows;
        }

        bool isBuilt()
        {
                return index_!=0;
        }

        int featuresType() const {return featuresType_;}
        int featuresDim() const {return featuresDim_;}

        unsigned int addPoint(const cv::Mat & feature)
        {
                if(!index_)
                {
                        UERROR("Flann index not yet created!");
                        return 0;
                }
                UASSERT(feature.type() == featuresType_);
                UASSERT(feature.cols == featuresDim_);
                UASSERT(feature.rows == 1);
                if(featuresType_ == CV_8UC1)
                {
                        rtflann::Matrix<unsigned char> point(feature.data, feature.rows, feature.cols);
                        rtflann::Index<rtflann::Hamming<unsigned char> > * index = (rtflann::Index<rtflann::Hamming<unsigned char> >*)index_;
                        index->addPoints(point, 0);
                        // Rebuild index if it doubles in size
                        if(index->sizeAtBuild() * 2 < index->size()+index->removedCount())
                        {
                                // clean not used features
                                for(std::list<int>::iterator iter=removedIndexes_.begin(); iter!=removedIndexes_.end(); ++iter)
                                {
                                        addedDescriptors_.erase(*iter);
                                }
                                removedIndexes_.clear();
                                index->buildIndex();
                        }
                }
                else
                {
                        rtflann::Matrix<float> point((float*)feature.data, feature.rows, feature.cols);
                        if(useDistanceL1_)
                        {
                                rtflann::Index<rtflann::L1<float> > * index = (rtflann::Index<rtflann::L1<float> >*)index_;
                                index->addPoints(point, 0);
                                // Rebuild index if it doubles in size
                                if(index->sizeAtBuild() * 2 < index->size()+index->removedCount())
                                {
                                        // clean not used features
                                        for(std::list<int>::iterator iter=removedIndexes_.begin(); iter!=removedIndexes_.end(); ++iter)
                                        {
                                                addedDescriptors_.erase(*iter);
                                        }
                                        removedIndexes_.clear();
                                        index->buildIndex();
                                }
                        }
                        else
                        {
                                rtflann::Index<rtflann::L2<float> > * index = (rtflann::Index<rtflann::L2<float> >*)index_;
                                index->addPoints(point, 0);
                                // Rebuild index if it doubles in size
                                if(index->sizeAtBuild() * 2 < index->size()+index->removedCount())
                                {
                                        // clean not used features
                                        for(std::list<int>::iterator iter=removedIndexes_.begin(); iter!=removedIndexes_.end(); ++iter)
                                        {
                                                addedDescriptors_.erase(*iter);
                                        }
                                        removedIndexes_.clear();
                                        index->buildIndex();
                                }
                        }
                }

                addedDescriptors_.insert(std::make_pair(nextIndex_, feature));

                return nextIndex_++;
        }

        void removePoint(unsigned int index)
        {
                if(!index_)
                {
                        UERROR("Flann index not yet created!");
                        return;
                }

                // If a Segmentation fault occurs in removePoint(), verify that you have this fix in your installed "flann/algorithms/nn_index.h":
                // 707 - if (ids_[id]==id) {
                // 707 + if (id < ids_.size() && ids_[id]==id) {
                // ref: https://github.com/mariusmuja/flann/commit/23051820b2314f07cf40ba633a4067782a982ff3#diff-33762b7383f957c2df17301639af5151

                if(featuresType_ == CV_8UC1)
                {
                        ((rtflann::Index<rtflann::Hamming<unsigned char> >*)index_)->removePoint(index);
                }
                else if(useDistanceL1_)
                {
                        ((rtflann::Index<rtflann::L1<float> >*)index_)->removePoint(index);
                }
                else
                {
                        ((rtflann::Index<rtflann::L2<float> >*)index_)->removePoint(index);
                }

                removedIndexes_.push_back(index);
        }

        void knnSearch(
                        const cv::Mat & query,
                        cv::Mat & indices,
                        cv::Mat & dists,
                int knn,
                const rtflann::SearchParams& params=rtflann::SearchParams())
        {
                if(!index_)
                {
                        UERROR("Flann index not yet created!");
                        return;
                }
                indices.create(query.rows, knn, CV_32S);
                dists.create(query.rows, knn, featuresType_ == CV_8UC1?CV_32S:CV_32F);

                rtflann::Matrix<int> indicesF((int*)indices.data, indices.rows, indices.cols);

                if(featuresType_ == CV_8UC1)
                {
                        rtflann::Matrix<unsigned int> distsF((unsigned int*)dists.data, dists.rows, dists.cols);
                        rtflann::Matrix<unsigned char> queryF(query.data, query.rows, query.cols);
                        ((rtflann::Index<rtflann::Hamming<unsigned char> >*)index_)->knnSearch(queryF, indicesF, distsF, knn, params);
                }
                else
                {
                        rtflann::Matrix<float> distsF((float*)dists.data, dists.rows, dists.cols);
                        rtflann::Matrix<float> queryF((float*)query.data, query.rows, query.cols);
                        if(useDistanceL1_)
                        {
                                ((rtflann::Index<rtflann::L1<float> >*)index_)->knnSearch(queryF, indicesF, distsF, knn, params);
                        }
                        else
                        {
                                ((rtflann::Index<rtflann::L2<float> >*)index_)->knnSearch(queryF, indicesF, distsF, knn, params);
                        }
                }
        }

private:
        void * index_;
        unsigned int nextIndex_;
        int featuresType_;
        int featuresDim_;
        bool isLSH_;
        bool useDistanceL1_; // true=EUCLEDIAN_L2 false=MANHATTAN_L1

        // keep feature in memory until the tree is rebuilt
        // (in case the word is deleted when removed from the VWDictionary)
        std::map<int, cv::Mat> addedDescriptors_;
        std::list<int> removedIndexes_;
};

const int VWDictionary::ID_START = 1;
const int VWDictionary::ID_INVALID = 0;

VWDictionary::VWDictionary(const ParametersMap & parameters) :
        _totalActiveReferences(0),
        _incrementalDictionary(Parameters::defaultKpIncrementalDictionary()),
        _incrementalFlann(Parameters::defaultKpIncrementalFlann()),
        _nndrRatio(Parameters::defaultKpNndrRatio()),
        _dictionaryPath(Parameters::defaultKpDictionaryPath()),
        _newWordsComparedTogether(Parameters::defaultKpNewWordsComparedTogether()),
        _lastWordId(0),
        useDistanceL1_(false),
        _flannIndex(new FlannIndex()),
        _strategy(kNNBruteForce)
{
        this->setNNStrategy((NNStrategy)Parameters::defaultKpNNStrategy());
        this->parseParameters(parameters);
}

VWDictionary::~VWDictionary()
{
        this->clear();
        delete _flannIndex;
}

void VWDictionary::parseParameters(const ParametersMap & parameters)
{
        ParametersMap::const_iterator iter;
        Parameters::parse(parameters, Parameters::kKpNndrRatio(), _nndrRatio);
        Parameters::parse(parameters, Parameters::kKpNewWordsComparedTogether(), _newWordsComparedTogether);
        Parameters::parse(parameters, Parameters::kKpIncrementalFlann(), _incrementalFlann);

        UASSERT_MSG(_nndrRatio > 0.0f, uFormat("String=%s value=%f", uContains(parameters, Parameters::kKpNndrRatio())?parameters.at(Parameters::kKpNndrRatio()).c_str():"", _nndrRatio).c_str());

        std::string dictionaryPath = _dictionaryPath;
        bool incrementalDictionary = _incrementalDictionary;
        if((iter=parameters.find(Parameters::kKpDictionaryPath())) != parameters.end())
        {
                dictionaryPath = (*iter).second.c_str();
        }
        if((iter=parameters.find(Parameters::kKpIncrementalDictionary())) != parameters.end())
        {
                incrementalDictionary = uStr2Bool((*iter).second.c_str());
        }

        // Verifying hypotheses strategy
        if((iter=parameters.find(Parameters::kKpNNStrategy())) != parameters.end())
        {
                NNStrategy nnStrategy = (NNStrategy)std::atoi((*iter).second.c_str());
                this->setNNStrategy(nnStrategy);
        }

        if(incrementalDictionary)
        {
                this->setIncrementalDictionary();
        }
        else
        {
                this->setFixedDictionary(dictionaryPath);
        }

}

void VWDictionary::setIncrementalDictionary()
{
        if(!_incrementalDictionary)
        {
                _incrementalDictionary = true;
                if(_visualWords.size())
                {
                        UWARN("Incremental dictionary set: already loaded visual words (%d) from the fixed dictionary will be included in the incremental one.", _visualWords.size());
                }
        }
        _dictionaryPath = "";
}

void VWDictionary::setFixedDictionary(const std::string & dictionaryPath)
{
        if(!dictionaryPath.empty())
        {
                if((!_incrementalDictionary && _dictionaryPath.compare(dictionaryPath) != 0) ||
                   _visualWords.size() == 0)
                {
                        std::ifstream file;
                        file.open(dictionaryPath.c_str(), std::ifstream::in);
                        if(file.good())
                        {
                                UDEBUG("Deleting old dictionary and loading the new one from \"%s\"", dictionaryPath.c_str());
                                UTimer timer;

                                // first line is the header
                                std::string str;
                                std::list<std::string> strList;
                                std::getline(file, str);
                                strList = uSplitNumChar(str);
                                unsigned int dimension  = 0;
                                for(std::list<std::string>::iterator iter = strList.begin(); iter != strList.end(); ++iter)
                                {
                                        if(uIsDigit(iter->at(0)))
                                        {
                                                dimension = std::atoi(iter->c_str());
                                                break;
                                        }
                                }

                                if(dimension == 0 || dimension > 1000)
                                {
                                        UERROR("Invalid dictionary file, visual word dimension (%d) is not valid, \"%s\"", dimension, dictionaryPath.c_str());
                                }
                                else
                                {
                                        // Process all words
                                        while(file.good())
                                        {
                                                std::getline(file, str);
                                                strList = uSplit(str);
                                                if(strList.size() == dimension+1)
                                                {
                                                        //first one is the visual word id
                                                        std::list<std::string>::iterator iter = strList.begin();
                                                        int id = std::atoi(iter->c_str());
                                                        cv::Mat descriptor(1, dimension, CV_32F);
                                                        ++iter;
                                                        unsigned int i=0;

                                                        //get descriptor
                                                        for(;i<dimension && iter != strList.end(); ++i, ++iter)
                                                        {
                                                                descriptor.at<float>(i) = uStr2Float(*iter);
                                                        }
                                                        if(i != dimension)
                                                        {
                                                                UERROR("");
                                                        }

                                                        VisualWord * vw = new VisualWord(id, descriptor, 0);
                                                        _visualWords.insert(_visualWords.end(), std::pair<int, VisualWord*>(id, vw));
                                                        _notIndexedWords.insert(_notIndexedWords.end(), id);
                                                }
                                                else
                                                {
                                                        UWARN("Cannot parse line \"%s\"", str.c_str());
                                                }
                                        }
                                        this->update();
                                        _incrementalDictionary = false;
                                }


                                UDEBUG("Time changing dictionary = %fs", timer.ticks());
                        }
                        else
                        {
                                UERROR("Cannot open dictionary file \"%s\"", dictionaryPath.c_str());
                        }
                        file.close();
                }
                else if(!_incrementalDictionary)
                {
                        UDEBUG("Dictionary \"%s\" already loaded...", dictionaryPath.c_str());
                }
                else
                {
                        UERROR("Cannot change to a fixed dictionary if there are already words (%d) in the incremental one.", _visualWords.size());
                }
        }
        else if(_visualWords.size() == 0)
        {
                _incrementalDictionary = false;
        }
        else if(_incrementalDictionary)
        {
                UWARN("Cannot change to fixed dictionary, %d words already loaded as incremental", (int)_visualWords.size());
        }
        _dictionaryPath = dictionaryPath;
}

void VWDictionary::setNNStrategy(NNStrategy strategy)
{
        if(strategy!=kNNUndef)
        {
#if CV_MAJOR_VERSION < 3
#ifdef HAVE_OPENCV_GPU
                if(strategy == kNNBruteForceGPU && !cv::gpu::getCudaEnabledDeviceCount())
                {
                        UERROR("Nearest neighobr strategy \"kNNBruteForceGPU\" chosen but no CUDA devices found! Doing \"kNNBruteForce\" instead.");
                        strategy = kNNBruteForce;
                }
#else
                if(strategy == kNNBruteForceGPU)
                {
                        UERROR("Nearest neighobr strategy \"kNNBruteForceGPU\" chosen but OpenCV is not built with GPU/cuda module! Doing \"kNNBruteForce\" instead.");
                        strategy = kNNBruteForce;
                }
#endif
#else
#ifdef HAVE_OPENCV_CUDAFEATURES2D
                if(strategy == kNNBruteForceGPU && !cv::cuda::getCudaEnabledDeviceCount())
                {
                        UERROR("Nearest neighobr strategy \"kNNBruteForceGPU\" chosen but no CUDA devices found! Doing \"kNNBruteForce\" instead.");
                        strategy = kNNBruteForce;
                }
#else
                if(strategy == kNNBruteForceGPU)
                {
                        UERROR("Nearest neighobr strategy \"kNNBruteForceGPU\" chosen but OpenCV cudafeatures2d module is not found! Doing \"kNNBruteForce\" instead.");
                        strategy = kNNBruteForce;
                }
#endif
#endif

                bool update = _strategy != strategy;
                _strategy = strategy;
                if(update)
                {
                        _dataTree = cv::Mat();
                        _notIndexedWords = uKeysSet(_visualWords);
                        _removedIndexedWords.clear();
                        this->update();
                }
        }
}

int VWDictionary::getLastIndexedWordId() const
{
        if(_mapIndexId.size())
        {
                return _mapIndexId.rbegin()->second;
        }
        else
        {
                return 0;
        }
}

unsigned int VWDictionary::getIndexedWordsCount() const
{
        return _flannIndex->indexedFeatures();
}

unsigned int VWDictionary::getIndexMemoryUsed() const
{
        return _flannIndex->memoryUsed();
}

void VWDictionary::update()
{
        ULOGGER_DEBUG("");
        if(!_incrementalDictionary && !_notIndexedWords.size())
        {
                // No need to update the search index if we
                // use a fixed dictionary and the index is
                // already built
                return;
        }

        if(_notIndexedWords.size() || _visualWords.size() == 0 || _removedIndexedWords.size())
        {
                if(_incrementalFlann &&
                   _strategy < kNNBruteForce &&
                   _visualWords.size())
                {
                        ULOGGER_DEBUG("Incremental FLANN: Removing %d words...", (int)_removedIndexedWords.size());
                        for(std::set<int>::iterator iter=_removedIndexedWords.begin(); iter!=_removedIndexedWords.end(); ++iter)
                        {
                                UASSERT(uContains(_mapIdIndex, *iter));
                                UASSERT(uContains(_mapIndexId, _mapIdIndex.at(*iter)));
                                _flannIndex->removePoint(_mapIdIndex.at(*iter));
                                _mapIndexId.erase(_mapIdIndex.at(*iter));
                                _mapIdIndex.erase(*iter);
                        }
                        ULOGGER_DEBUG("Incremental FLANN: Removing %d words... done!", (int)_removedIndexedWords.size());

                        if(_notIndexedWords.size())
                        {
                                ULOGGER_DEBUG("Incremental FLANN: Inserting %d words...", (int)_notIndexedWords.size());
                                for(std::set<int>::iterator iter=_notIndexedWords.begin(); iter!=_notIndexedWords.end(); ++iter)
                                {
                                        VisualWord* w = uValue(_visualWords, *iter, (VisualWord*)0);
                                        UASSERT(w);

                                        cv::Mat descriptor;
                                        if(w->getDescriptor().type() == CV_8U)
                                        {
                                                useDistanceL1_ = true;
                                                if(_strategy == kNNFlannKdTree || _strategy == kNNFlannNaive)
                                                {
                                                        w->getDescriptor().convertTo(descriptor, CV_32F);
                                                }
                                                else
                                                {
                                                        descriptor = w->getDescriptor();
                                                }
                                        }
                                        else
                                        {
                                                descriptor = w->getDescriptor();
                                        }

                                        int index = 0;
                                        if(!_flannIndex->isBuilt())
                                        {
                                                UDEBUG("Building FLANN index...");
                                                switch(_strategy)
                                                {
                                                case kNNFlannNaive:
                                                        _flannIndex->build(descriptor, rtflann::LinearIndexParams(), useDistanceL1_);
                                                        break;
                                                case kNNFlannKdTree:
                                                        UASSERT_MSG(descriptor.type() == CV_32F, "To use KdTree dictionary, float descriptors are required!");
                                                        _flannIndex->build(descriptor, rtflann::KDTreeIndexParams(), useDistanceL1_);
                                                        break;
                                                case kNNFlannLSH:
                                                        UASSERT_MSG(descriptor.type() == CV_8U, "To use LSH dictionary, binary descriptors are required!");
                                                        _flannIndex->build(descriptor, rtflann::LshIndexParams(12, 20, 2), useDistanceL1_);
                                                        break;
                                                default:
                                                        UFATAL("Not supposed to be here!");
                                                        break;
                                                }
                                                UDEBUG("Building FLANN index... done!");
                                        }
                                        else
                                        {
                                                UASSERT(descriptor.cols == _flannIndex->featuresDim());
                                                UASSERT(descriptor.type() == _flannIndex->featuresType());
                                                index = _flannIndex->addPoint(descriptor);
                                        }
                                        std::pair<std::map<int, int>::iterator, bool> inserted;
                                        inserted = _mapIndexId.insert(std::pair<int, int>(index, w->id()));
                                        UASSERT(inserted.second);
                                        inserted = _mapIdIndex.insert(std::pair<int, int>(w->id(), index));
                                        UASSERT(inserted.second);
                                }
                                ULOGGER_DEBUG("Incremental FLANN: Inserting %d words... done!", (int)_notIndexedWords.size());
                        }
                }
                else if(_strategy >= kNNBruteForce &&
                                _notIndexedWords.size() &&
                                _removedIndexedWords.size() == 0 &&
                                _visualWords.size() &&
                                _dataTree.rows)
                {
                        //just add not indexed words
                        int i = _dataTree.rows;
                        _dataTree.reserve(_dataTree.rows + _notIndexedWords.size());
                        for(std::set<int>::iterator iter=_notIndexedWords.begin(); iter!=_notIndexedWords.end(); ++iter)
                        {
                                VisualWord* w = uValue(_visualWords, *iter, (VisualWord*)0);
                                UASSERT(w);
                                UASSERT(w->getDescriptor().cols == _dataTree.cols);
                                UASSERT(w->getDescriptor().type() == _dataTree.type());
                                _dataTree.push_back(w->getDescriptor());
                                _mapIndexId.insert(_mapIndexId.end(), std::pair<int, int>(i, w->id()));
                                std::pair<std::map<int, int>::iterator, bool> inserted = _mapIdIndex.insert(std::pair<int, int>(w->id(), i));
                                UASSERT(inserted.second);
                                ++i;
                        }
                }
                else
                {
                        _mapIndexId.clear();
                        _mapIdIndex.clear();
                        _dataTree = cv::Mat();
                        _flannIndex->release();

                        if(_visualWords.size())
                        {
                                UTimer timer;
                                timer.start();

                                int type;
                                if(_visualWords.begin()->second->getDescriptor().type() == CV_8U)
                                {
                                        useDistanceL1_ = true;
                                        if(_strategy == kNNFlannKdTree || _strategy == kNNFlannNaive)
                                        {
                                                type = CV_32F;
                                        }
                                        else
                                        {
                                                type = _visualWords.begin()->second->getDescriptor().type();
                                        }
                                }
                                else
                                {
                                        type = _visualWords.begin()->second->getDescriptor().type();
                                }
                                int dim = _visualWords.begin()->second->getDescriptor().cols;

                                UASSERT(type == CV_32F || type == CV_8U);
                                UASSERT(dim > 0);

                                // Create the data matrix
                                _dataTree = cv::Mat(_visualWords.size(), dim, type); // SURF descriptors are CV_32F
                                std::map<int, VisualWord*>::const_iterator iter = _visualWords.begin();
                                for(unsigned int i=0; i < _visualWords.size(); ++i, ++iter)
                                {
                                        cv::Mat descriptor;
                                        if(iter->second->getDescriptor().type() == CV_8U)
                                        {
                                                if(_strategy == kNNFlannKdTree || _strategy == kNNFlannNaive)
                                                {
                                                        iter->second->getDescriptor().convertTo(descriptor, CV_32F);
                                                }
                                                else
                                                {
                                                        descriptor = iter->second->getDescriptor();
                                                }
                                        }
                                        else
                                        {
                                                descriptor = iter->second->getDescriptor();
                                        }

                                        UASSERT(descriptor.cols == dim);
                                        UASSERT(descriptor.type() == type);

                                        descriptor.copyTo(_dataTree.row(i));
                                        _mapIndexId.insert(_mapIndexId.end(), std::pair<int, int>(i, iter->second->id()));
                                        _mapIdIndex.insert(_mapIdIndex.end(), std::pair<int, int>(iter->second->id(), i));
                                }

                                ULOGGER_DEBUG("_mapIndexId.size() = %d, words.size()=%d, _dim=%d",_mapIndexId.size(), _visualWords.size(), dim);
                                ULOGGER_DEBUG("copying data = %f s", timer.ticks());

                                switch(_strategy)
                                {
                                case kNNFlannNaive:
                                        _flannIndex->build(_dataTree, rtflann::LinearIndexParams(), useDistanceL1_);
                                        break;
                                case kNNFlannKdTree:
                                        UASSERT_MSG(type == CV_32F, "To use KdTree dictionary, float descriptors are required!");
                                        _flannIndex->build(_dataTree, rtflann::KDTreeIndexParams(), useDistanceL1_);
                                        break;
                                case kNNFlannLSH:
                                        UASSERT_MSG(type == CV_8U, "To use LSH dictionary, binary descriptors are required!");
                                        _flannIndex->build(_dataTree, rtflann::LshIndexParams(12, 20, 2), useDistanceL1_);
                                        break;
                                default:
                                        break;
                                }

                                ULOGGER_DEBUG("Time to create kd tree = %f s", timer.ticks());
                        }
                }
                UDEBUG("Dictionary updated! (size=%d added=%d removed=%d)",
                                _dataTree.rows, _notIndexedWords.size(), _removedIndexedWords.size());
        }
        else
        {
                UDEBUG("Dictionary has not changed, so no need to update it! (size=%d)", _dataTree.rows);
        }
        _notIndexedWords.clear();
        _removedIndexedWords.clear();
        UDEBUG("");
}

void VWDictionary::clear(bool printWarningsIfNotEmpty)
{
        ULOGGER_DEBUG("");
        if(printWarningsIfNotEmpty)
        {
                if(_visualWords.size() && _incrementalDictionary)
                {
                        UWARN("Visual dictionary would be already empty here (%d words still in dictionary).", (int)_visualWords.size());
                }
                if(_notIndexedWords.size())
                {
                        UWARN("Not indexed words should be empty here (%d words still not indexed)", (int)_notIndexedWords.size());
                }
        }
        for(std::map<int, VisualWord *>::iterator i=_visualWords.begin(); i!=_visualWords.end(); ++i)
        {
                delete (*i).second;
        }
        _visualWords.clear();
        _notIndexedWords.clear();
        _removedIndexedWords.clear();
        _totalActiveReferences = 0;
        _lastWordId = 0;
        _dataTree = cv::Mat();
        _mapIndexId.clear();
        _mapIdIndex.clear();
        _unusedWords.clear();
        _flannIndex->release();
        useDistanceL1_ = false;
}

int VWDictionary::getNextId()
{
        return ++_lastWordId;
}

void VWDictionary::addWordRef(int wordId, int signatureId)
{
        if(signatureId > 0 && wordId > 0)
        {
                VisualWord * vw = 0;
                vw = uValue(_visualWords, wordId, vw);
                if(vw)
                {
                        vw->addRef(signatureId);
                        _totalActiveReferences += 1;

                        _unusedWords.erase(vw->id());
                }
                else
                {
                        UERROR("Not found word %d", wordId);
                }
        }
}

void VWDictionary::removeAllWordRef(int wordId, int signatureId)
{
        VisualWord * vw = 0;
        vw = uValue(_visualWords, wordId, vw);
        if(vw)
        {
                _totalActiveReferences -= vw->removeAllRef(signatureId);
                if(vw->getReferences().size() == 0)
                {
                        _unusedWords.insert(std::pair<int, VisualWord*>(vw->id(), vw));
                }
        }
}

std::list<int> VWDictionary::addNewWords(const cv::Mat & descriptorsIn,
                                                           int signatureId)
{
        UASSERT(signatureId > 0);

        UDEBUG("id=%d descriptors=%d", signatureId, descriptorsIn.rows);
        UTimer timer;
        std::list<int> wordIds;
        if(descriptorsIn.rows == 0 || descriptorsIn.cols == 0)
        {
                UERROR("Descriptors size is null!");
                return wordIds;
        }

        if(!_incrementalDictionary && _visualWords.empty())
        {
                UERROR("Dictionary mode is set to fixed but no words are in it!");
                return wordIds;
        }

        // verify we have the same features
        int dim = 0;
        int type = -1;
        if(_visualWords.size())
        {
                dim = _visualWords.begin()->second->getDescriptor().cols;
                type = _visualWords.begin()->second->getDescriptor().type();
                UASSERT(type == CV_32F || type == CV_8U);
        }
        if(dim && dim != descriptorsIn.cols)
        {
                UERROR("Descriptors (size=%d) are not the same size as already added words in dictionary(size=%d)", descriptorsIn.cols, dim);
                return wordIds;
        }
        if(type>=0 && type != descriptorsIn.type())
        {
                UERROR("Descriptors (type=%d) are not the same type as already added words in dictionary(type=%d)", descriptorsIn.type(), type);
                return wordIds;
        }

        // now compare with the actual index
        cv::Mat descriptors;
        if(descriptorsIn.type() == CV_8U)
        {
                useDistanceL1_ = true;
                if(_strategy == kNNFlannKdTree || _strategy == kNNFlannNaive)
                {
                        descriptorsIn.convertTo(descriptors, CV_32F);
                }
                else
                {
                        descriptors = descriptorsIn;
                }
        }
        else
        {
                descriptors = descriptorsIn;
        }
        dim = 0;
        type = -1;
        if(_dataTree.rows || _flannIndex->isBuilt())
        {
                dim = _flannIndex->isBuilt()?_flannIndex->featuresDim():_dataTree.cols;
                type = _flannIndex->isBuilt()?_flannIndex->featuresType():_dataTree.type();
                UASSERT(type == CV_32F || type == CV_8U);
        }

        if(dim && dim != descriptors.cols)
        {
                UERROR("Descriptors (size=%d) are not the same size as already added words in dictionary(size=%d)", descriptors.cols, dim);
                return wordIds;
        }

        if(type>=0 && type != descriptors.type())
        {
                UERROR("Descriptors (type=%d) are not the same type as already added words in dictionary(type=%d)", descriptors.type(), type);
                return wordIds;
        }

        int dupWordsCountFromDict= 0;
        int dupWordsCountFromLast= 0;

        unsigned int k=2; // k nearest neighbors

        cv::Mat newWords;
        std::vector<int> newWordsId;

        cv::Mat results;
        cv::Mat dists;
        std::vector<std::vector<cv::DMatch> > matches;
        bool bruteForce = false;

        UTimer timerLocal;
        timerLocal.start();

        if(_flannIndex->isBuilt() || (!_dataTree.empty() && _dataTree.rows >= (int)k))
        {
                //Find nearest neighbors
                UDEBUG("newPts.total()=%d ", descriptors.rows);

                if(_strategy == kNNFlannNaive || _strategy == kNNFlannKdTree || _strategy == kNNFlannLSH)
                {
                        _flannIndex->knnSearch(descriptors, results, dists, k);
                }
                else if(_strategy == kNNBruteForce)
                {
                        bruteForce = true;
                        cv::BFMatcher matcher(descriptors.type()==CV_8U?cv::NORM_HAMMING:cv::NORM_L2SQR);
                        matcher.knnMatch(descriptors, _dataTree, matches, k);
                }
                else if(_strategy == kNNBruteForceGPU)
                {
                        bruteForce = true;
#if CV_MAJOR_VERSION < 3
#ifdef HAVE_OPENCV_GPU
                        cv::gpu::GpuMat newDescriptorsGpu(descriptors);
                        cv::gpu::GpuMat lastDescriptorsGpu(_dataTree);
                        if(descriptors.type()==CV_8U)
                        {
                                cv::gpu::BruteForceMatcher_GPU<cv::Hamming> gpuMatcher;
                                gpuMatcher.knnMatch(newDescriptorsGpu, lastDescriptorsGpu, matches, k);
                        }
                        else
                        {
                                cv::gpu::BruteForceMatcher_GPU<cv::L2<float> > gpuMatcher;
                                gpuMatcher.knnMatch(newDescriptorsGpu, lastDescriptorsGpu, matches, k);
                        }
#else
                        UERROR("Cannot use brute Force GPU because OpenCV is not built with gpu module.");
#endif
#else
#ifdef HAVE_OPENCV_CUDAFEATURES2D
                        cv::cuda::GpuMat newDescriptorsGpu(descriptors);
                        cv::cuda::GpuMat lastDescriptorsGpu(_dataTree);
                        cv::Ptr<cv::cuda::DescriptorMatcher> gpuMatcher;
                        if(descriptors.type()==CV_8U)
                        {
                                gpuMatcher = cv::cuda::DescriptorMatcher::createBFMatcher(cv::NORM_HAMMING);
                                gpuMatcher->knnMatch(newDescriptorsGpu, lastDescriptorsGpu, matches, k);
                        }
                        else
                        {
                                gpuMatcher = cv::cuda::DescriptorMatcher::createBFMatcher(cv::NORM_L2);
                                gpuMatcher->knnMatch(newDescriptorsGpu, lastDescriptorsGpu, matches, k);
                        }
#else
                        UERROR("Cannot use brute Force GPU because OpenCV is not built with cuda module.");
#endif
#endif
                }
                else
                {
                        UFATAL("");
                }

                // In case of binary descriptors
                if(dists.type() == CV_32S)
                {
                        cv::Mat temp;
                        dists.convertTo(temp, CV_32F);
                        dists = temp;
                }

                UDEBUG("Time to find nn = %f s", timerLocal.ticks());
        }

        // Process results
        for(int i = 0; i < descriptors.rows; ++i)
        {
                std::multimap<float, int> fullResults; // Contains results from the kd-tree search and the naive search in new words
                if(!bruteForce && dists.cols)
                {
                        for(int j=0; j<dists.cols; ++j)
                        {
                                float d = dists.at<float>(i,j);
                                int id = uValue(_mapIndexId, results.at<int>(i,j));
                                if(d >= 0.0f && id > 0)
                                {
                                        fullResults.insert(std::pair<float, int>(d, id));
                                }
                                else
                                {
                                        break;
                                }
                        }
                }
                else if(bruteForce && matches.size())
                {
                        for(unsigned int j=0; j<matches.at(i).size(); ++j)
                        {
                                float d = matches.at(i).at(j).distance;
                                int id = uValue(_mapIndexId, matches.at(i).at(j).trainIdx);
                                if(d >= 0.0f && id > 0)
                                {
                                        fullResults.insert(std::pair<float, int>(d, id));
                                }
                                else
                                {
                                        break;
                                }
                        }
                }

                // Check if this descriptor matches with a word from the last signature (a word not already added to the tree)
                if(_newWordsComparedTogether && newWords.rows)
                {
                        std::vector<std::vector<cv::DMatch> > matchesNewWords;
                        cv::BFMatcher matcher(descriptors.type()==CV_8U?cv::NORM_HAMMING:useDistanceL1_?cv::NORM_L1:cv::NORM_L2SQR);
                        UASSERT(descriptors.cols == newWords.cols && descriptors.type() == newWords.type());
                        matcher.knnMatch(descriptors.row(i), newWords, matchesNewWords, newWords.rows>1?2:1);
                        UASSERT(matchesNewWords.size() == 1);
                        for(unsigned int j=0; j<matchesNewWords.at(0).size(); ++j)
                        {
                                float d = matchesNewWords.at(0).at(j).distance;
                                int id = newWordsId[matchesNewWords.at(0).at(j).trainIdx];
                                if(d >= 0.0f && id > 0)
                                {
                                        fullResults.insert(std::pair<float, int>(d, id));
                                }
                                else
                                {
                                        break;
                                }
                        }
                }

                if(_incrementalDictionary)
                {
                        bool badDist = false;
                        if(fullResults.size() == 0)
                        {
                                badDist = true;
                        }
                        if(!badDist)
                        {
                                if(fullResults.size() >= 2)
                                {
                                        // Apply NNDR
                                        if(fullResults.begin()->first > _nndrRatio * (++fullResults.begin())->first)
                                        {
                                                badDist = true; // Rejected
                                        }
                                }
                                else
                                {
                                        badDist = true; // Rejected
                                }
                        }

                        if(badDist)
                        {
                                // use original descriptor
                                VisualWord * vw = new VisualWord(getNextId(), descriptorsIn.row(i), signatureId);
                                _visualWords.insert(_visualWords.end(), std::pair<int, VisualWord *>(vw->id(), vw));
                                _notIndexedWords.insert(_notIndexedWords.end(), vw->id());
                                newWords.push_back(descriptors.row(i));
                                newWordsId.push_back(vw->id());
                                wordIds.push_back(vw->id());
                                UASSERT(vw->id()>0);
                        }
                        else
                        {
                                if(_notIndexedWords.find(fullResults.begin()->second) != _notIndexedWords.end())
                                {
                                        ++dupWordsCountFromLast;
                                }
                                else
                                {
                                        ++dupWordsCountFromDict;
                                }

                                this->addWordRef(fullResults.begin()->second, signatureId);
                                wordIds.push_back(fullResults.begin()->second);
                        }
                }
                else if(fullResults.size())
                {
                        // If the dictionary is not incremental, just take the nearest word
                        ++dupWordsCountFromDict;
                        this->addWordRef(fullResults.begin()->second, signatureId);
                        wordIds.push_back(fullResults.begin()->second);
                        UASSERT(fullResults.begin()->second>0);
                }
        }
        ULOGGER_DEBUG("naive search and add ref/words time = %f s", timerLocal.ticks());

        ULOGGER_DEBUG("%d new words added...", _notIndexedWords.size());
        ULOGGER_DEBUG("%d duplicated words added (from current image = %d)...",
                        dupWordsCountFromDict+dupWordsCountFromLast, dupWordsCountFromLast);
        UDEBUG("total time %fs", timer.ticks());

        _totalActiveReferences += _notIndexedWords.size();
        return wordIds;
}

std::vector<int> VWDictionary::findNN(const std::list<VisualWord *> & vws) const
{
        UTimer timer;
        timer.start();

        if(_visualWords.size() && vws.size())
        {
                int type = (*vws.begin())->getDescriptor().type();
                int dim = (*vws.begin())->getDescriptor().cols;

                if(dim != _visualWords.begin()->second->getDescriptor().cols)
                {
                        UERROR("Descriptors (size=%d) are not the same size as already added words in dictionary(size=%d)", (*vws.begin())->getDescriptor().cols, dim);
                        return std::vector<int>(vws.size(), 0);
                }

                if(type != _visualWords.begin()->second->getDescriptor().type())
                {
                        UERROR("Descriptors (type=%d) are not the same type as already added words in dictionary(type=%d)", (*vws.begin())->getDescriptor().type(), type);
                        return std::vector<int>(vws.size(), 0);
                }

                // fill the request matrix
                int index = 0;
                VisualWord * vw;
                cv::Mat query(vws.size(), dim, type);
                for(std::list<VisualWord *>::const_iterator iter=vws.begin(); iter!=vws.end(); ++iter, ++index)
                {
                        vw = *iter;
                        UASSERT(vw);

                        UASSERT(vw->getDescriptor().cols == dim);
                        UASSERT(vw->getDescriptor().type() == type);

                        vw->getDescriptor().copyTo(query.row(index));
                }
                ULOGGER_DEBUG("Preparation time = %fs", timer.ticks());

                return findNN(query);
        }
        return std::vector<int>(vws.size(), 0);
}
std::vector<int> VWDictionary::findNN(const cv::Mat & queryIn) const
{
        UTimer timer;
        timer.start();
        std::vector<int> resultIds(queryIn.rows, 0);
        unsigned int k=2; // k nearest neighbor

        if(_visualWords.size() && queryIn.rows)
        {
                // verify we have the same features
                int dim = _visualWords.begin()->second->getDescriptor().cols;
                int type = _visualWords.begin()->second->getDescriptor().type();
                UASSERT(type == CV_32F || type == CV_8U);

                if(dim != queryIn.cols)
                {
                        UERROR("Descriptors (size=%d) are not the same size as already added words in dictionary(size=%d)", queryIn.cols, dim);
                        return resultIds;
                }
                if(type != queryIn.type())
                {
                        UERROR("Descriptors (type=%d) are not the same type as already added words in dictionary(type=%d)", queryIn.type(), type);
                        return resultIds;
                }

                // now compare with the actual index
                cv::Mat query;
                if(queryIn.type() == CV_8U)
                {
                        if(_strategy == kNNFlannKdTree || _strategy == kNNFlannNaive)
                        {
                                queryIn.convertTo(query, CV_32F);
                        }
                        else
                        {
                                query = queryIn;
                        }
                }
                else
                {
                        query = queryIn;
                }
                dim = 0;
                type = -1;
                if(_dataTree.rows || _flannIndex->isBuilt())
                {
                        dim = _flannIndex->isBuilt()?_flannIndex->featuresDim():_dataTree.cols;
                        type = _flannIndex->isBuilt()?_flannIndex->featuresType():_dataTree.type();
                        UASSERT(type == CV_32F || type == CV_8U);
                }

                if(dim && dim != query.cols)
                {
                        UERROR("Descriptors (size=%d) are not the same size as already added words in dictionary(size=%d)", query.cols, dim);
                        return resultIds;
                }

                if(type>=0 && type != query.type())
                {
                        UERROR("Descriptors (type=%d) are not the same type as already added words in dictionary(type=%d)", query.type(), type);
                        return resultIds;
                }

                std::vector<std::vector<cv::DMatch> > matches;
                bool bruteForce = false;
                cv::Mat results;
                cv::Mat dists;

                if(_flannIndex->isBuilt() || (!_dataTree.empty() && _dataTree.rows >= (int)k))
                {
                        //Find nearest neighbors
                        UDEBUG("query.rows=%d ", query.rows);

                        if(_strategy == kNNFlannNaive || _strategy == kNNFlannKdTree || _strategy == kNNFlannLSH)
                        {
                                _flannIndex->knnSearch(query, results, dists, k);
                        }
                        else if(_strategy == kNNBruteForce)
                        {
                                bruteForce = true;
                                cv::BFMatcher matcher(query.type()==CV_8U?cv::NORM_HAMMING:cv::NORM_L2SQR);
                                matcher.knnMatch(query, _dataTree, matches, k);
                        }
                        else if(_strategy == kNNBruteForceGPU)
                        {
                                bruteForce = true;
#if CV_MAJOR_VERSION < 3
#ifdef HAVE_OPENCV_GPU
                                cv::gpu::GpuMat newDescriptorsGpu(query);
                                cv::gpu::GpuMat lastDescriptorsGpu(_dataTree);
                                if(query.type()==CV_8U)
                                {
                                        cv::gpu::BruteForceMatcher_GPU<cv::Hamming> gpuMatcher;
                                        gpuMatcher.knnMatch(newDescriptorsGpu, lastDescriptorsGpu, matches, k);
                                }
                                else
                                {
                                        cv::gpu::BruteForceMatcher_GPU<cv::L2<float> > gpuMatcher;
                                        gpuMatcher.knnMatch(newDescriptorsGpu, lastDescriptorsGpu, matches, k);
                                }
#else
                        UERROR("Cannot use brute Force GPU because OpenCV is not built with gpu module.");
#endif
#else
#ifdef HAVE_OPENCV_CUDAFEATURES2D
                                cv::cuda::GpuMat newDescriptorsGpu(query);
                                cv::cuda::GpuMat lastDescriptorsGpu(_dataTree);
                                cv::Ptr<cv::cuda::DescriptorMatcher> gpuMatcher;
                                if(query.type()==CV_8U)
                                {
                                        gpuMatcher = cv::cuda::DescriptorMatcher::createBFMatcher(cv::NORM_HAMMING);
                                        gpuMatcher->knnMatchAsync(newDescriptorsGpu, lastDescriptorsGpu, matches, k);
                                }
                                else
                                {
                                        gpuMatcher = cv::cuda::DescriptorMatcher::createBFMatcher(cv::NORM_L2);
                                        gpuMatcher->knnMatchAsync(newDescriptorsGpu, lastDescriptorsGpu, matches, k);
                                }
#else
                        UERROR("Cannot use brute Force GPU because OpenCV is not built with cuda module.");
#endif
#endif
                        }
                        else
                        {
                                UFATAL("");
                        }

                        // In case of binary descriptors
                        if(dists.type() == CV_32S)
                        {
                                cv::Mat temp;
                                dists.convertTo(temp, CV_32F);
                                dists = temp;
                        }
                }
                ULOGGER_DEBUG("Search dictionary time = %fs", timer.ticks());

                std::map<int, int> mapIndexIdNotIndexed;
                std::vector<std::vector<cv::DMatch> > matchesNotIndexed;
                if(_notIndexedWords.size())
                {
                        cv::Mat dataNotIndexed = cv::Mat::zeros(_notIndexedWords.size(), query.cols, query.type());
                        unsigned int index = 0;
                        VisualWord * vw;
                        for(std::set<int>::iterator iter = _notIndexedWords.begin(); iter != _notIndexedWords.end(); ++iter, ++index)
                        {
                                vw = _visualWords.at(*iter);

                                cv::Mat descriptor;
                                if(vw->getDescriptor().type() == CV_8U)
                                {
                                        if(_strategy == kNNFlannKdTree || _strategy == kNNFlannNaive)
                                        {
                                                vw->getDescriptor().convertTo(descriptor, CV_32F);
                                        }
                                        else
                                        {
                                                descriptor = vw->getDescriptor();
                                        }
                                }
                                else
                                {
                                        descriptor = vw->getDescriptor();
                                }

                                UASSERT(vw != 0 && descriptor.cols == query.cols && descriptor.type() == query.type());
                                vw->getDescriptor().copyTo(dataNotIndexed.row(index));
                                mapIndexIdNotIndexed.insert(mapIndexIdNotIndexed.end(), std::pair<int,int>(index, vw->id()));
                        }

                        // Find nearest neighbor
                        ULOGGER_DEBUG("Searching in words not indexed...");
                        cv::BFMatcher matcher(query.type()==CV_8U?cv::NORM_HAMMING:useDistanceL1_?cv::NORM_L1:cv::NORM_L2SQR);
                        matcher.knnMatch(query, dataNotIndexed, matchesNotIndexed, dataNotIndexed.rows>1?2:1);
                }
                ULOGGER_DEBUG("Search not yet indexed words time = %fs", timer.ticks());

                for(int i=0; i<query.rows; ++i)
                {
                        std::multimap<float, int> fullResults; // Contains results from the kd-tree search [and the naive search in new words]
                        if(!bruteForce && dists.cols)
                        {
                                for(int j=0; j<dists.cols; ++j)
                                {
                                        float d = dists.at<float>(i,j);
                                        int id = uValue(_mapIndexId, results.at<int>(i,j));
                                        if(d >= 0.0f && id > 0)
                                        {
                                                fullResults.insert(std::pair<float, int>(d, id));
                                        }
                                }
                        }
                        else if(bruteForce && matches.size())
                        {
                                for(unsigned int j=0; j<matches.at(i).size(); ++j)
                                {
                                        float d = matches.at(i).at(j).distance;
                                        int id = uValue(_mapIndexId, matches.at(i).at(j).trainIdx);
                                        if(d >= 0.0f && id > 0)
                                        {
                                                fullResults.insert(std::pair<float, int>(d, id));
                                        }
                                }
                        }

                        // not indexed..
                        if(matchesNotIndexed.size())
                        {
                                for(unsigned int j=0; j<matchesNotIndexed.at(i).size(); ++j)
                                {
                                        float d = matchesNotIndexed.at(i).at(j).distance;
                                        int id = uValue(mapIndexIdNotIndexed, matchesNotIndexed.at(i).at(j).trainIdx);
                                        if(d >= 0.0f && id > 0)
                                        {
                                                fullResults.insert(std::pair<float, int>(d, id));
                                        }
                                        else
                                        {
                                                break;
                                        }
                                }
                        }

                        if(_incrementalDictionary)
                        {
                                bool badDist = false;
                                if(fullResults.size() == 0)
                                {
                                        badDist = true;
                                }
                                if(!badDist)
                                {
                                        if(fullResults.size() >= 2)
                                        {
                                                // Apply NNDR
                                                if(fullResults.begin()->first > _nndrRatio * (++fullResults.begin())->first)
                                                {
                                                        badDist = true; // Rejected
                                                }
                                        }
                                        else
                                        {
                                                badDist = true; // Rejected
                                        }
                                }

                                if(!badDist)
                                {
                                        resultIds[i] = fullResults.begin()->second; // Accepted
                                }
                        }
                        else if(fullResults.size())
                        {
                                //Just take the nearest if the dictionary is not incremental
                                resultIds[i] = fullResults.begin()->second; // Accepted
                        }
                }
                ULOGGER_DEBUG("badDist check time = %fs", timer.ticks());
        }
        return resultIds;
}

void VWDictionary::addWord(VisualWord * vw)
{
        if(vw)
        {
                _visualWords.insert(std::pair<int, VisualWord *>(vw->id(), vw));
                _notIndexedWords.insert(vw->id());
                if(vw->getReferences().size())
                {
                        _totalActiveReferences += uSum(uValues(vw->getReferences()));
                }
                else
                {
                        _unusedWords.insert(std::pair<int, VisualWord *>(vw->id(), vw));
                }
        }
}

const VisualWord * VWDictionary::getWord(int id) const
{
        return uValue(_visualWords, id, (VisualWord *)0);
}

VisualWord * VWDictionary::getUnusedWord(int id) const
{
        return uValue(_unusedWords, id, (VisualWord *)0);
}

std::vector<VisualWord*> VWDictionary::getUnusedWords() const
{
        if(!_incrementalDictionary)
        {
                ULOGGER_WARN("This method does nothing on a fixed dictionary");
                return std::vector<VisualWord*>();
        }
        return uValues(_unusedWords);
}

std::vector<int> VWDictionary::getUnusedWordIds() const
{
        if(!_incrementalDictionary)
        {
                ULOGGER_WARN("This method does nothing on a fixed dictionary");
                return std::vector<int>();
        }
        return uKeys(_unusedWords);
}

void VWDictionary::removeWords(const std::vector<VisualWord*> & words)
{
        for(unsigned int i=0; i<words.size(); ++i)
        {
                _visualWords.erase(words[i]->id());
                _unusedWords.erase(words[i]->id());
                if(_notIndexedWords.erase(words[i]->id()) == 0)
                {
                        _removedIndexedWords.insert(words[i]->id());
                }
        }
}

void VWDictionary::deleteUnusedWords()
{
        std::vector<VisualWord*> unusedWords = uValues(_unusedWords);
        removeWords(unusedWords);
        for(unsigned int i=0; i<unusedWords.size(); ++i)
        {
                delete unusedWords[i];
        }
}

void VWDictionary::exportDictionary(const char * fileNameReferences, const char * fileNameDescriptors) const
{
        UDEBUG("");
        if(_visualWords.empty())
        {
                UWARN("Dictionary is empty, cannot export it!");
                return;
        }
        if(_visualWords.begin()->second->getDescriptor().type() != CV_32FC1)
        {
                UERROR("Exporting binary descriptors is not implemented!");
                return;
        }
    FILE* foutRef = 0;
    FILE* foutDesc = 0;
#ifdef _MSC_VER
    fopen_s(&foutRef, fileNameReferences, "w");
    fopen_s(&foutDesc, fileNameDescriptors, "w");
#else
    foutRef = fopen(fileNameReferences, "w");
    foutDesc = fopen(fileNameDescriptors, "w");
#endif

    if(foutRef)
    {
        fprintf(foutRef, "WordID SignaturesID...\n");
    }
        if(foutDesc)
        {
                if(_visualWords.begin() == _visualWords.end())
                {
                        fprintf(foutDesc, "WordID Descriptors...\n");
                }
                else
                {
                        UDEBUG("");
                        fprintf(foutDesc, "WordID Descriptors...%d\n", (*_visualWords.begin()).second->getDescriptor().cols);
                }
        }

        UDEBUG("Export %d words...", _visualWords.size());
    for(std::map<int, VisualWord *>::const_iterator iter=_visualWords.begin(); iter!=_visualWords.end(); ++iter)
    {
        // References
        if(foutRef)
        {
                        fprintf(foutRef, "%d ", (*iter).first);
                        const std::map<int, int> ref = (*iter).second->getReferences();
                        for(std::map<int, int>::const_iterator jter=ref.begin(); jter!=ref.end(); ++jter)
                        {
                                for(int i=0; i<(*jter).second; ++i)
                                {
                                        fprintf(foutRef, "%d ", (*jter).first);
                                }
                        }
                        fprintf(foutRef, "\n");
        }

        //Descriptors
        if(foutDesc)
        {
                        fprintf(foutDesc, "%d ", (*iter).first);
                        const float * desc = (const float *)(*iter).second->getDescriptor().data;
                        int dim = (*iter).second->getDescriptor().cols;

                        for(int i=0; i<dim; i++)
                        {
                                fprintf(foutDesc, "%f ", desc[i]);
                        }
                        fprintf(foutDesc, "\n");
        }
    }

        if(foutRef)
                fclose(foutRef);
        if(foutDesc)
                fclose(foutDesc);
}

} // namespace rtabmap