1 /*M///////////////////////////////////////////////////////////////////////////////////////
2 //
3 //  IMPORTANT: READ BEFORE DOWNLOADING, COPYING, INSTALLING OR USING.
4 //
5 //  By downloading, copying, installing or using the software you agree to this license.
6 //  If you do not agree to this license, do not download, install,
7 //  copy or use the software.
8 //
9 //
10 //                          License Agreement
11 //                For Open Source Computer Vision Library
12 //
13 // Copyright (C) 2000-2008, Intel Corporation, all rights reserved.
14 // Copyright (C) 2009, Willow Garage Inc., all rights reserved.
15 // Copyright (C) 2013, OpenCV Foundation, all rights reserved.
16 // Third party copyrights are property of their respective owners.
17 //
18 // Redistribution and use in source and binary forms, with or without modification,
19 // are permitted provided that the following conditions are met:
20 //
21 //   * Redistribution's of source code must retain the above copyright notice,
22 //     this list of conditions and the following disclaimer.
23 //
24 //   * Redistribution's in binary form must reproduce the above copyright notice,
25 //     this list of conditions and the following disclaimer in the documentation
26 //     and/or other materials provided with the distribution.
27 //
28 //   * The name of the copyright holders may not be used to endorse or promote products
29 //     derived from this software without specific prior written permission.
30 //
31 // This software is provided by the copyright holders and contributors "as is" and
32 // any express or implied warranties, including, but not limited to, the implied
33 // warranties of merchantability and fitness for a particular purpose are disclaimed.
34 // In no event shall the Intel Corporation or contributors be liable for any direct,
35 // indirect, incidental, special, exemplary, or consequential damages
36 // (including, but not limited to, procurement of substitute goods or services;
37 // loss of use, data, or profits; or business interruption) however caused
38 // and on any theory of liability, whether in contract, strict liability,
39 // or tort (including negligence or otherwise) arising in any way out of
40 // the use of this software, even if advised of the possibility of such damage.
41 //
42 //M*/
43 
44 #ifndef __OPENCV_HIST_COST_HPP__
45 #define __OPENCV_HIST_COST_HPP__
46 
47 #include "opencv2/imgproc.hpp"
48 
49 namespace cv
50 {
51 
52 //! @addtogroup shape
53 //! @{
54 
55 /** @brief Abstract base class for histogram cost algorithms.
56  */
57 class CV_EXPORTS_W HistogramCostExtractor : public Algorithm
58 {
59 public:
60     CV_WRAP virtual void buildCostMatrix(InputArray descriptors1, InputArray descriptors2, OutputArray costMatrix) = 0;
61 
62     CV_WRAP virtual void setNDummies(int nDummies) = 0;
63     CV_WRAP virtual int getNDummies() const = 0;
64 
65     CV_WRAP virtual void setDefaultCost(float defaultCost) = 0;
66     CV_WRAP virtual float getDefaultCost() const = 0;
67 };
68 
69 /** @brief A norm based cost extraction. :
70  */
71 class CV_EXPORTS_W NormHistogramCostExtractor : public HistogramCostExtractor
72 {
73 public:
74     CV_WRAP virtual void setNormFlag(int flag) = 0;
75     CV_WRAP virtual int getNormFlag() const = 0;
76 };
77 
78 CV_EXPORTS_W Ptr<HistogramCostExtractor>
79     createNormHistogramCostExtractor(int flag=DIST_L2, int nDummies=25, float defaultCost=0.2f);
80 
81 /** @brief An EMD based cost extraction. :
82  */
83 class CV_EXPORTS_W EMDHistogramCostExtractor : public HistogramCostExtractor
84 {
85 public:
86     CV_WRAP virtual void setNormFlag(int flag) = 0;
87     CV_WRAP virtual int getNormFlag() const = 0;
88 };
89 
90 CV_EXPORTS_W Ptr<HistogramCostExtractor>
91     createEMDHistogramCostExtractor(int flag=DIST_L2, int nDummies=25, float defaultCost=0.2f);
92 
93 /** @brief An Chi based cost extraction. :
94  */
95 class CV_EXPORTS_W ChiHistogramCostExtractor : public HistogramCostExtractor
96 {};
97 
98 CV_EXPORTS_W Ptr<HistogramCostExtractor> createChiHistogramCostExtractor(int nDummies=25, float defaultCost=0.2f);
99 
100 /** @brief An EMD-L1 based cost extraction. :
101  */
102 class CV_EXPORTS_W EMDL1HistogramCostExtractor : public HistogramCostExtractor
103 {};
104 
105 CV_EXPORTS_W Ptr<HistogramCostExtractor>
106     createEMDL1HistogramCostExtractor(int nDummies=25, float defaultCost=0.2f);
107 
108 //! @}
109 
110 } // cv
111 #endif
112