ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | List of all members
itk::Statistics::LearningFunctionBase< LayerType, TTargetVector > Class Template Referenceabstract

#include <itkLearningFunctionBase.h>

+ Inheritance diagram for itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >:
+ Collaboration diagram for itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >:

Detailed Description

template<typename LayerType, typename TTargetVector>
class itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >

The LearningFunctionBase is the base class for all the learning strategies.

These include error back propagation, bp+momentum, conjugte gradient descent, quick prop.

This class specifies how the errors are backpropagated for a layer. They take a LayerBase object as input and compute the input for the layers input weightset.

Definition at line 39 of file itkLearningFunctionBase.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LearningFunctionBase Self
 
typedef LightProcessObject Superclass
 
typedef LayerType::ValueType ValueType
 
- Public Types inherited from itk::LightProcessObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightProcessObject Self
 
typedef 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
 
virtual void Learn (LayerType *layer, ValueType)=0
 
virtual void Learn (LayerType *layer, TTargetVector error, ValueType)=0
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
virtual ::itk::LightObject::Pointer CreateAnother () const
 
virtual const bool & GetAbortGenerateData () const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void UpdateOutputData ()
 
void UpdateProgress (float amount)
 
virtual void SetProgress (float _arg)
 
virtual const float & GetProgress () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () 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 SetReferenceCount (int) override
 
virtual void UnRegister () const noexceptoverride
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- 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
 

Protected Member Functions

 LearningFunctionBase ()
 
 ~LearningFunctionBase () override
 
virtual void PrintSelf (std::ostream &os, Indent indent) const override
 
- Protected Member Functions inherited from itk::LightProcessObject
virtual void GenerateData ()
 
 LightProcessObject ()
 
 ~LightProcessObject () override
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
virtual ~Object () override
 
- 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 ()
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::LightProcessObject
static Pointer New ()
 
- 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 Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

template<typename LayerType, typename TTargetVector>
typedef SmartPointer<const Self> itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >::ConstPointer

Definition at line 46 of file itkLearningFunctionBase.h.

template<typename LayerType, typename TTargetVector>
typedef SmartPointer<Self> itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >::Pointer

Definition at line 45 of file itkLearningFunctionBase.h.

template<typename LayerType, typename TTargetVector>
typedef LearningFunctionBase itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >::Self

Definition at line 43 of file itkLearningFunctionBase.h.

template<typename LayerType, typename TTargetVector>
typedef LightProcessObject itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >::Superclass

Definition at line 44 of file itkLearningFunctionBase.h.

template<typename LayerType, typename TTargetVector>
typedef LayerType::ValueType itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >::ValueType

Definition at line 49 of file itkLearningFunctionBase.h.

Constructor & Destructor Documentation

template<typename LayerType, typename TTargetVector>
itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >::LearningFunctionBase ( )
inlineprotected

Definition at line 57 of file itkLearningFunctionBase.h.

template<typename LayerType, typename TTargetVector>
itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >::~LearningFunctionBase ( )
inlineoverrideprotected

Definition at line 58 of file itkLearningFunctionBase.h.

Member Function Documentation

template<typename LayerType, typename TTargetVector>
virtual const char* itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >::GetNameOfClass ( ) const
virtual
template<typename LayerType, typename TTargetVector>
virtual void itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >::Learn ( LayerType *  layer,
ValueType   
)
pure virtual
template<typename LayerType, typename TTargetVector>
virtual void itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >::Learn ( LayerType *  layer,
TTargetVector  error,
ValueType   
)
pure virtual
template<typename LayerType, typename TTargetVector>
virtual void itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
inlineoverrideprotectedvirtual

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