OTB  9.0.0
Orfeo Toolbox
otbMachineLearningModelFactory.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2005-2022 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 otbMachineLearningModelFactory_h
22 #define otbMachineLearningModelFactory_h
23 
26 
27 namespace otb
28 {
34 template <class TInputValue, class TOutputValue>
36 {
37 public:
40  typedef itk::Object Superclass;
41  typedef itk::SmartPointer<Self> Pointer;
42  typedef itk::SmartPointer<const Self> ConstPointer;
43 
47  itkTypeMacro(MachineLearningModelFactory, itk::Object);
48 
52 
54  typedef enum { ReadMode, WriteMode } FileModeType;
55 
57  static MachineLearningModelTypePointer CreateMachineLearningModel(const std::string& path, FileModeType mode);
58 
59  static void CleanFactories();
60 
61 protected:
64 
65 private:
66  MachineLearningModelFactory(const Self&) = delete;
67  void operator=(const Self&) = delete;
68 
70  static void RegisterBuiltInFactories();
71 
74  static void RegisterFactory(itk::ObjectFactoryBase* factory);
75 };
76 
77 } // end namespace otb
78 
79 #ifndef OTB_MANUAL_INSTANTIATION
81 #endif
82 
83 #endif
otb::MachineLearningModelFactory::CleanFactories
static void CleanFactories()
Definition: otbMachineLearningModelFactory.hxx:127
otb::MachineLearningModelFactory
Creation of object instance using object factory.
Definition: otbMachineLearningModelFactory.h:35
otb::MachineLearningModelFactory::operator=
void operator=(const Self &)=delete
otb::MachineLearningModelFactory::ReadMode
@ ReadMode
Definition: otbMachineLearningModelFactory.h:54
otb::MachineLearningModelFactory::~MachineLearningModelFactory
~MachineLearningModelFactory() override
otb::MachineLearningModelFactory::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbMachineLearningModelFactory.h:41
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::MachineLearningModelFactory::Superclass
itk::Object Superclass
Definition: otbMachineLearningModelFactory.h:40
otb::MachineLearningModelFactory::RegisterBuiltInFactories
static void RegisterBuiltInFactories()
Definition: otbMachineLearningModelFactory.hxx:92
otb::MachineLearningModelFactory::MachineLearningModelTypePointer
MachineLearningModelType::Pointer MachineLearningModelTypePointer
Definition: otbMachineLearningModelFactory.h:51
otb::MachineLearningModelFactory::CreateMachineLearningModel
static MachineLearningModelTypePointer CreateMachineLearningModel(const std::string &path, FileModeType mode)
Definition: otbMachineLearningModelFactory.hxx:53
otb::MachineLearningModelFactory::Self
MachineLearningModelFactory Self
Definition: otbMachineLearningModelFactory.h:39
otb::MachineLearningModelFactory::MachineLearningModelType
otb::MachineLearningModel< TInputValue, TOutputValue > MachineLearningModelType
Definition: otbMachineLearningModelFactory.h:47
otbMachineLearningModelFactory.hxx
otbMachineLearningModel.h
otb::MachineLearningModelFactory::WriteMode
@ WriteMode
Definition: otbMachineLearningModelFactory.h:54
otb::MachineLearningModelFactory::MachineLearningModelFactory
MachineLearningModelFactory()
otb::MachineLearningModel::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbMachineLearningModel.h:77
otb::MachineLearningModel
MachineLearningModel is the base class for all classifier objects (SVM, KNN, Random Forests,...
Definition: otbMachineLearningModel.h:70
otb::MachineLearningModelFactoryBase
Base class for the MachinelearningModelFactory.
Definition: otbMachineLearningModelFactoryBase.h:37
otb::MachineLearningModelFactory::RegisterFactory
static void RegisterFactory(itk::ObjectFactoryBase *factory)
Definition: otbMachineLearningModelFactory.hxx:117
otb::MachineLearningModelFactory::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbMachineLearningModelFactory.h:42
otbMachineLearningModelFactoryBase.h
otb::MachineLearningModelFactory::FileModeType
FileModeType
Definition: otbMachineLearningModelFactory.h:54