modules/flann/include/opencv2/flann/params.h

   1 /***********************************************************************
   2  * Software License Agreement (BSD License)
   3  *
   4  * Copyright 2008-2011  Marius Muja (mariusm@cs.ubc.ca). All rights reserved.
   5  * Copyright 2008-2011  David G. Lowe (lowe@cs.ubc.ca). All rights reserved.
   6  *
   7  * Redistribution and use in source and binary forms, with or without
   8  * modification, are permitted provided that the following conditions
   9  * are met:
  10  *
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  *
  17  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  18  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  19  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  20  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  21  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  22  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  23  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  24  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  27  *************************************************************************/
  28
  29
  30 #ifndef OPENCV_FLANN_PARAMS_H_
  31 #define OPENCV_FLANN_PARAMS_H_
  32
  33 #include "any.h"
  34 #include "general.h"
  35 #include <iostream>
  36 #include <map>
  37
  38
  39 namespace cvflann
  40 {
  41
  42 typedef std::map<std::string, any> IndexParams;
  43
  44 struct SearchParams : public IndexParams
  45 {
  46     SearchParams(int checks = 32, float eps = 0, bool sorted = true )
  47     {
  48         // how many leafs to visit when searching for neighbours (-1 for unlimited)
  49         (*this)["checks"] = checks;
  50         // search for eps-approximate neighbours (default: 0)
  51         (*this)["eps"] = eps;
  52         // only for radius search, require neighbours sorted by distance (default: true)
  53         (*this)["sorted"] = sorted;
  54     }
  55 };
  56
  57
  58 template<typename T>
  59 T get_param(const IndexParams& params, std::string name, const T& default_value)
  60 {
  61     IndexParams::const_iterator it = params.find(name);
  62     if (it != params.end()) {
  63         return it->second.cast<T>();
  64     }
  65     else {
  66         return default_value;
  67     }
  68 }
  69
  70 template<typename T>
  71 T get_param(const IndexParams& params, std::string name)
  72 {
  73     IndexParams::const_iterator it = params.find(name);
  74     if (it != params.end()) {
  75         return it->second.cast<T>();
  76     }
  77     else {
  78         throw FLANNException(std::string("Missing parameter '")+name+std::string("' in the parameters given"));
  79     }
  80 }
  81
  82 inline void print_params(const IndexParams& params)
  83 {
  84     IndexParams::const_iterator it;
  85
  86     for(it=params.begin(); it!=params.end(); ++it) {
  87         std::cout << it->first << " : " << it->second << std::endl;
  88     }
  89 }
  90
  91
  92
  93 }
  94
  95
  96 #endif /* OPENCV_FLANN_PARAMS_H_ */