ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector > Class Template Reference

#include <itkQuickPropLearningRule.h>

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

Detailed Description

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

The QuickPropLearningRule is the base class for all the ErrorBackPropagationLearning strategies.

ErrorBackPropagationLearning strategies include error back propagation, bp+momentum, conjugte gradient descent, and 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 43 of file itkQuickPropLearningRule.h.

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef QuickPropLearningRule Self
 
typedef LearningFunctionBase
< LayerType, TTargetVector > 
Superclass
 
typedef Superclass::ValueType ValueType
 
- Public Types inherited from itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >
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 ::itk::LightObject::Pointer CreateAnother () const
 
virtual const ValueTypeGetDecay () const
 
virtual const ValueTypeGetMax_Growth_Factor () const
 
virtual const char * GetNameOfClass () const
 
virtual void Learn (LayerType *layer, ValueType learningrate) override
 
virtual void Learn (LayerType *layer, TTargetVector errors, ValueType learningrate) override
 
virtual void SetDecay (ValueType _arg)
 
virtual void SetMax_Growth_Factor (ValueType _arg)
 
- Public Member Functions inherited from itk::LightProcessObject
virtual void AbortGenerateDataOff ()
 
virtual void AbortGenerateDataOn ()
 
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
 

Static Public Member Functions

static Pointer New ()
 
- 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 Member Functions

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

Protected Attributes

ValueType m_Decay
 
ValueType m_Epsilon
 
ValueType m_Max_Growth_Factor
 
ValueType m_Momentum
 
ValueType m_Threshold
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Member Typedef Documentation

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

Definition at line 50 of file itkQuickPropLearningRule.h.

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

Definition at line 49 of file itkQuickPropLearningRule.h.

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

Definition at line 47 of file itkQuickPropLearningRule.h.

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

Definition at line 48 of file itkQuickPropLearningRule.h.

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

Definition at line 56 of file itkQuickPropLearningRule.h.

Constructor & Destructor Documentation

template<typename LayerType , typename TTargetVector >
itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::QuickPropLearningRule ( )
protected
template<typename LayerType , typename TTargetVector >
virtual itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::~QuickPropLearningRule ( )
inlineprotectedvirtual

Definition at line 70 of file itkQuickPropLearningRule.h.

Member Function Documentation

template<typename LayerType , typename TTargetVector >
virtual::itk::LightObject::Pointer itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::LightProcessObject.

template<typename LayerType , typename TTargetVector >
virtual const ValueType& itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::GetDecay ( ) const
virtual
template<typename LayerType , typename TTargetVector >
virtual const ValueType& itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::GetMax_Growth_Factor ( ) const
virtual
template<typename LayerType , typename TTargetVector >
virtual const char* itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::GetNameOfClass ( ) const
virtual

Method for creation through the object factory.

Reimplemented from itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >.

template<typename LayerType , typename TTargetVector >
virtual void itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::Learn ( LayerType *  layer,
ValueType  learningrate 
)
overridevirtual
template<typename LayerType , typename TTargetVector >
virtual void itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::Learn ( LayerType *  layer,
TTargetVector  errors,
ValueType  learningrate 
)
overridevirtual
template<typename LayerType , typename TTargetVector >
static Pointer itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::New ( )
static

Method for creation through the object factory.

template<typename LayerType , typename TTargetVector >
virtual void itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Method to print the object.

Reimplemented from itk::Statistics::LearningFunctionBase< LayerType, TTargetVector >.

template<typename LayerType , typename TTargetVector >
virtual void itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::SetDecay ( ValueType  _arg)
virtual
template<typename LayerType , typename TTargetVector >
virtual void itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::SetMax_Growth_Factor ( ValueType  _arg)
virtual

Member Data Documentation

template<typename LayerType , typename TTargetVector >
ValueType itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::m_Decay
protected

Definition at line 74 of file itkQuickPropLearningRule.h.

template<typename LayerType , typename TTargetVector >
ValueType itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::m_Epsilon
protected

Definition at line 76 of file itkQuickPropLearningRule.h.

template<typename LayerType , typename TTargetVector >
ValueType itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::m_Max_Growth_Factor
protected

Definition at line 73 of file itkQuickPropLearningRule.h.

template<typename LayerType , typename TTargetVector >
ValueType itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::m_Momentum
protected

Definition at line 70 of file itkQuickPropLearningRule.h.

template<typename LayerType , typename TTargetVector >
ValueType itk::Statistics::QuickPropLearningRule< LayerType, TTargetVector >::m_Threshold
protected

Definition at line 75 of file itkQuickPropLearningRule.h.


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