OTB  6.7.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Private Member Functions | Static Private Member Functions | List of all members
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< SelfPointer
 
typedef MachineLearningModelFactory Self
 
typedef itk::Object Superclass
 
- Public Types inherited from otb::MachineLearningModelFactoryBase
typedef itk::SmartPointer
< const Self
ConstPointer
 
typedef itk::SmartPointer< SelfPointer
 
typedef
MachineLearningModelFactoryBase 
Self
 
typedef itk::Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
virtual ModifiedTimeType GetMTime () const
 
virtual const std::string & GetObjectName () const
 
virtual const TimeStampGetTimeStamp () const
 
bool HasObserver (const EventObject &event) const
 
void InvokeEvent (const EventObject &)
 
void InvokeEvent (const EventObject &) const
 
virtual void Modified () const
 
virtual void Register () const override
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual void SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
- Public Member Functions inherited from itk::LightObject
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static void CleanFactories ()
 
static
MachineLearningModelTypePointer 
CreateMachineLearningModel (const std::string &path, FileModeType mode)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool flag)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 

Protected Member Functions

 MachineLearningModelFactory ()
 
 ~MachineLearningModelFactory () override
 
- Protected Member Functions inherited from otb::MachineLearningModelFactoryBase
 MachineLearningModelFactoryBase ()
 
 ~MachineLearningModelFactoryBase () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object ()
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

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

- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 
- 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

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

Definition at line 42 of file otbMachineLearningModelFactory.h.

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.

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

Definition at line 51 of file otbMachineLearningModelFactory.h.

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

Definition at line 41 of file otbMachineLearningModelFactory.h.

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

Standard class typedefs.

Definition at line 39 of file otbMachineLearningModelFactory.h.

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

Definition at line 40 of file otbMachineLearningModelFactory.h.

Member Enumeration Documentation

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

template<class TInputValue , class TOutputValue >
otb::MachineLearningModelFactory< TInputValue, TOutputValue >::MachineLearningModelFactory ( )
protected
template<class TInputValue , class TOutputValue >
otb::MachineLearningModelFactory< TInputValue, TOutputValue >::~MachineLearningModelFactory ( )
overrideprotected
template<class TInputValue , class TOutputValue >
otb::MachineLearningModelFactory< TInputValue, TOutputValue >::MachineLearningModelFactory ( const Self )
privatedelete

Member Function Documentation

template<class TInputValue , class TOutputValue >
void otb::MachineLearningModelFactory< TInputValue, TOutputValue >::CleanFactories ( )
static
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 54 of file otbMachineLearningModelFactory.hxx.

References itk::ObjectFactoryBase::CreateAllInstance(), ReadMode, and WriteMode.

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.

template<class TInputValue , class TOutputValue >
void otb::MachineLearningModelFactory< TInputValue, TOutputValue >::operator= ( const Self )
privatedelete
template<class TInputValue , class TOutputValue >
void otb::MachineLearningModelFactory< TInputValue, TOutputValue >::RegisterBuiltInFactories ( )
staticprivate

Register Built-in factories

Definition at line 101 of file otbMachineLearningModelFactory.hxx.

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 128 of file otbMachineLearningModelFactory.hxx.

References itk::ObjectFactoryBase::RegisterFactory(), and itk::ObjectFactoryBase::UnRegisterFactory().


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