OTB  6.7.0
Orfeo Toolbox
otbKNearestNeighborsMachineLearningModel.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2005-2019 Centre National d'Etudes Spatiales (CNES)
3  *
4  * This file is part of Orfeo Toolbox
5  *
6  * https://www.orfeo-toolbox.org/
7  *
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  */
20 
21 #ifndef otbKNearestNeighborsMachineLearningModel_h
22 #define otbKNearestNeighborsMachineLearningModel_h
23 
24 #include "otbRequiresOpenCVCheck.h"
25 
26 #include "itkLightObject.h"
27 #include "itkFixedArray.h"
29 
30 #ifdef OTB_OPENCV_3
31 #include "otbOpenCVUtils.h"
32 #else
33 class CvKNearest;
34 #endif
35 
36 namespace otb
37 {
38 template <class TInputValue, class TTargetValue>
40  : public MachineLearningModel <TInputValue, TTargetValue>
41 {
42 public:
48 
49  typedef typename Superclass::InputValueType InputValueType;
50  typedef typename Superclass::InputSampleType InputSampleType;
51  typedef typename Superclass::InputListSampleType InputListSampleType;
52  typedef typename Superclass::TargetValueType TargetValueType;
54  typedef typename Superclass::TargetListSampleType TargetListSampleType;
55  typedef typename Superclass::ConfidenceValueType ConfidenceValueType;
56  typedef typename Superclass::ProbaSampleType ProbaSampleType;
58  itkNewMacro(Self);
61 
66  itkGetMacro(K, int);
67  itkSetMacro(K, int);
69 
77  enum {KNN_VOTING, KNN_MEAN, KNN_MEDIAN};
78 
80  itkGetMacro(DecisionRule, int);
81  itkSetMacro(DecisionRule, int);
83 
85  void Train() override;
86 
88  void Save(const std::string & filename, const std::string & name="") override;
89 
91  void Load(const std::string & filename, const std::string & name="") override;
92 
95 
97  bool CanReadFile(const std::string &) override;
98 
100  bool CanWriteFile(const std::string &) override;
102 
103 protected:
106 
109 
111  TargetSampleType DoPredict(const InputSampleType& input, ConfidenceValueType *quality=nullptr, ProbaSampleType *proba=nullptr) const override;
112 
114  void PrintSelf(std::ostream& os, itk::Indent indent) const override;
115 
116 private:
117  KNearestNeighborsMachineLearningModel(const Self &) = delete;
118  void operator =(const Self&) = delete;
119 
120 #ifdef OTB_OPENCV_3
121  cv::Ptr<cv::ml::KNearest> m_KNearestModel;
122 #else
123  CvKNearest * m_KNearestModel;
124 #endif
125  int m_K;
126 
128 };
129 } // end namespace otb
130 
131 #ifndef OTB_MANUAL_INSTANTIATION
133 #endif
134 
135 #endif
MachineLearningModel is the base class for all classifier objects (SVM, KNN, Random Forests...
MLMTargetTraits< TTargetValue >::SampleType TargetSampleType
MachineLearningModel< TInputValue, TTargetValue > Superclass