otb::MachineLearningModelFactory< TInputValue, TOutputValue > Class Template Reference

#include <otbMachineLearningModelFactory.h>

Inheritance diagram for otb::MachineLearningModelFactory< TInputValue, TOutputValue >:

Collaboration diagram for otb::MachineLearningModelFactory< TInputValue, TOutputValue >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
enum	FileModeType {   ReadMode,   WriteMode }
typedef otb::MachineLearningModel< TInputValue, TOutputValue >	MachineLearningModelType
typedef MachineLearningModelType::Pointer	MachineLearningModelTypePointer
typedef itk::SmartPointer< Self >	Pointer
typedef MachineLearningModelFactory	Self
typedef itk::Object	Superclass
Public Types inherited from otb::MachineLearningModelFactoryBase
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::SmartPointer< Self >	Pointer
typedef MachineLearningModelFactoryBase	Self
typedef itk::Object	Superclass

Public Member Functions
virtual const char *	GetNameOfClass () const

Static Public Member Functions
static void	CleanFactories ()
static MachineLearningModelTypePointer	CreateMachineLearningModel (const std::string &path, FileModeType mode)

Protected Member Functions
	MachineLearningModelFactory ()
	~MachineLearningModelFactory () override
Protected Member Functions inherited from otb::MachineLearningModelFactoryBase
	MachineLearningModelFactoryBase ()
	~MachineLearningModelFactoryBase () override

Private Member Functions
	MachineLearningModelFactory (const Self &)=delete
void	operator= (const Self &)=delete

Static Private Member Functions
static void	RegisterBuiltInFactories ()
static void	RegisterFactory (itk::ObjectFactoryBase *factory)

Additional Inherited Members
Static Protected Attributes inherited from otb::MachineLearningModelFactoryBase
static itk::SimpleMutexLock	mutex

Detailed Description

template<class TInputValue, class TOutputValue>
class otb::MachineLearningModelFactory< TInputValue, TOutputValue >

Creation of object instance using object factory.

Definition at line 35 of file otbMachineLearningModelFactory.h.

Member Typedef Documentation

ConstPointer

template<class TInputValue , class TOutputValue >

typedef itk::SmartPointer<const Self> otb::MachineLearningModelFactory< TInputValue, TOutputValue >::ConstPointer

Definition at line 42 of file otbMachineLearningModelFactory.h.

MachineLearningModelType

template<class TInputValue , class TOutputValue >

typedef otb::MachineLearningModel<TInputValue, TOutputValue> otb::MachineLearningModelFactory< TInputValue, TOutputValue >::MachineLearningModelType

Convenient typedefs.

Definition at line 47 of file otbMachineLearningModelFactory.h.

MachineLearningModelTypePointer

template<class TInputValue , class TOutputValue >

typedef MachineLearningModelType::Pointer otb::MachineLearningModelFactory< TInputValue, TOutputValue >::MachineLearningModelTypePointer

Definition at line 51 of file otbMachineLearningModelFactory.h.

Pointer

template<class TInputValue , class TOutputValue >

typedef itk::SmartPointer<Self> otb::MachineLearningModelFactory< TInputValue, TOutputValue >::Pointer

Definition at line 41 of file otbMachineLearningModelFactory.h.

Self

template<class TInputValue , class TOutputValue >

typedef MachineLearningModelFactory otb::MachineLearningModelFactory< TInputValue, TOutputValue >::Self

Standard class typedefs.

Definition at line 39 of file otbMachineLearningModelFactory.h.

Superclass

template<class TInputValue , class TOutputValue >

typedef itk::Object otb::MachineLearningModelFactory< TInputValue, TOutputValue >::Superclass

Definition at line 40 of file otbMachineLearningModelFactory.h.

Member Enumeration Documentation

FileModeType

template<class TInputValue , class TOutputValue >

enum otb::MachineLearningModelFactory::FileModeType

Mode in which the files is intended to be used

Enumerator
ReadMode
WriteMode

Definition at line 54 of file otbMachineLearningModelFactory.h.

Constructor & Destructor Documentation

MachineLearningModelFactory() [1/2]

template<class TInputValue , class TOutputValue >

otb::MachineLearningModelFactory< TInputValue, TOutputValue >::MachineLearningModelFactory ( )

protected

~MachineLearningModelFactory()

template<class TInputValue , class TOutputValue >

otb::MachineLearningModelFactory< TInputValue, TOutputValue >::~MachineLearningModelFactory ( )

overrideprotected

MachineLearningModelFactory() [2/2]

template<class TInputValue , class TOutputValue >

otb::MachineLearningModelFactory< TInputValue, TOutputValue >::MachineLearningModelFactory ( const Self &  )

privatedelete

Member Function Documentation

CleanFactories()

template<class TInputValue , class TOutputValue >

void otb::MachineLearningModelFactory< TInputValue, TOutputValue >::CleanFactories

static

Definition at line 127 of file otbMachineLearningModelFactory.hxx.

Referenced by otb::Wrapper::VectorPrediction< RegressionMode >::~VectorPrediction().

CreateMachineLearningModel()

template<class TInputValue , class TOutputValue >

MachineLearningModel< TInputValue, TOutputValue >::Pointer otb::MachineLearningModelFactory< TInputValue, TOutputValue >::CreateMachineLearningModel ( const std::string &  path, FileModeType  mode  )

static

Create the appropriate MachineLearningModel depending on the particulars of the file.

Definition at line 53 of file otbMachineLearningModelFactory.hxx.

GetNameOfClass()

template<class TInputValue , class TOutputValue >

virtual const char* otb::MachineLearningModelFactory< TInputValue, TOutputValue >::GetNameOfClass ( ) const

virtual

Class Methods used to interface with the registered factories Run-time type information (and related methods).

Reimplemented from otb::MachineLearningModelFactoryBase.

operator=()

template<class TInputValue , class TOutputValue >

void otb::MachineLearningModelFactory< TInputValue, TOutputValue >::operator= ( const Self &  )

privatedelete

RegisterBuiltInFactories()

template<class TInputValue , class TOutputValue >

void otb::MachineLearningModelFactory< TInputValue, TOutputValue >::RegisterBuiltInFactories

staticprivate

Register Built-in factories

Definition at line 92 of file otbMachineLearningModelFactory.hxx.

RegisterFactory()

template<class TInputValue , class TOutputValue >

void otb::MachineLearningModelFactory< TInputValue, TOutputValue >::RegisterFactory ( itk::ObjectFactoryBase *  factory )

staticprivate

Register a single factory, ensuring it has not been registered twice

Definition at line 117 of file otbMachineLearningModelFactory.hxx.

---

The documentation for this class was generated from the following files:

• otbMachineLearningModelFactory.h
• otbMachineLearningModelFactory.hxx