itk::Statistics::QuickPropLearningRule< LayerType, TOutput > Class Template Reference

#include <itkQuickPropLearningRule.h>

Inheritance diagram for itk::Statistics::QuickPropLearningRule< LayerType, TOutput >:

[legend]Collaboration diagram for itk::Statistics::QuickPropLearningRule< LayerType, TOutput >:

[legend]List of all members.

template<class LayerType, class TOutput>
class itk::Statistics::QuickPropLearningRule< LayerType, TOutput >

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef QuickPropLearningRule	Self
typedef LearningFunctionBase< LayerType, TOutput >	Superclass
typedef Superclass::ValueType	ValueType
Public Member Functions
virtual void	AbortGenerateDataOff ()
virtual void	AbortGenerateDataOn ()
Get the execution progress of a process object The progress is *a floating number	between (0, 1)
Set the execution progress of a process object The progress is *a floating number	between (0, 1)
virtual LightObject::Pointer	CreateAnother () const
virtual void	DebugOff () const
virtual void	DebugOn () const
virtual void	Delete ()
virtual const bool &	GetAbortGenerateData ()
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
virtual const ValueType &	GetDecay ()
virtual const ValueType &	GetMax_Growth_Factor ()
const MetaDataDictionary &	GetMetaDataDictionary (void) const
MetaDataDictionary &	GetMetaDataDictionary (void)
virtual unsigned long	GetMTime () const
virtual const char *	GetNameOfClass () const
meaning *the filter has completed execution *virtual const float &	GetProgress ()
virtual int	GetReferenceCount () const
bool	HasObserver (const EventObject &event) const
void	InvokeEvent (const EventObject &) const
void	InvokeEvent (const EventObject &)
void	Learn (LayerType *layer, TOutput errors, ValueType learningrate)
void	Learn (LayerType *layer, ValueType learningrate)
virtual void	Modified () const
void	Print (std::ostream &os, Indent indent=0) const
virtual void	Register () const
void	RemoveAllObservers ()
void	RemoveObserver (unsigned long tag)
virtual void	SetAbortGenerateData (bool _arg)
void	SetDebug (bool debugFlag) const
virtual void	SetDecay (ValueType _arg)
virtual void	SetMax_Growth_Factor (ValueType _arg)
void	SetMetaDataDictionary (const MetaDataDictionary &rhs)
meaning *the filter has completed execution *virtual void	SetProgress (float _arg)
virtual void	SetReferenceCount (int)
virtual void	UnRegister () const
virtual void	UpdateOutputData ()
void	UpdateProgress (float amount)
Static Public Member Functions
static void	BreakOnError ()
static bool	GetGlobalWarningDisplay ()
static void	GlobalWarningDisplayOff ()
static void	GlobalWarningDisplayOn ()
static Pointer	New ()
This is a global flag that controls whether any warning *or error messages are displayed *static void	SetGlobalWarningDisplay (bool flag)
Public Attributes
Allow people to add remove invoke observers(callbacks) to any ITK *object.This is an implementation of the subject/observer design *pattern.An observer is added by specifying an event to respond to *and an itk unsigned lon	AddObserver )(const EventObject &event, Command *) const
This is a global flag that controls whether any	debug
Get the execution progress of a process object The progress is *a floating number meaning no	progress
Set the execution progress of a process object The progress is *a floating number meaning no	progress
Protected Member Functions
virtual void	GenerateData ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	PrintSelf (std::ostream &os, Indent indent) const
virtual void	PrintTrailer (std::ostream &os, Indent indent) const
	QuickPropLearningRule ()
	~QuickPropLearningRule ()
Protected Attributes
ValueType	m_Decay
ValueType	m_Epsilon
ValueType	m_Max_Growth_Factor
ValueType	m_Momentum
int	m_ReferenceCount
SimpleFastMutexLock	m_ReferenceCountLock
ValueType	m_SigmoidPrimeOffset
ValueType	m_SplitEpsilon
ValueType	m_Threshold
Methods invoked by virtual Print() to print information about the object *including superclasses.Typically not called by the user(use Print()*instead) but used in the hierarchical print process to combine the *output of several classes.*/virtual void PrintSelf(std voi	PrintHeader )(std::ostream &os, Indent indent) const

---

Member Typedef Documentation

template<class LayerType, class TOutput> typedef SmartPointer<const Self> itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::ConstPointer

Reimplemented from itk::Statistics::LearningFunctionBase< LayerType, TOutput >. Definition at line 45 of file itkQuickPropLearningRule.h.

template<class LayerType, class TOutput> typedef SmartPointer<Self> itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::Pointer

Reimplemented from itk::Statistics::LearningFunctionBase< LayerType, TOutput >. Definition at line 44 of file itkQuickPropLearningRule.h.

template<class LayerType, class TOutput> typedef QuickPropLearningRule itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::Self

Standard class typedefs. Reimplemented from itk::Statistics::LearningFunctionBase< LayerType, TOutput >. Definition at line 42 of file itkQuickPropLearningRule.h.

template<class LayerType, class TOutput> typedef LearningFunctionBase<LayerType, TOutput> itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::Superclass

Reimplemented from itk::Statistics::LearningFunctionBase< LayerType, TOutput >. Definition at line 43 of file itkQuickPropLearningRule.h.

template<class LayerType, class TOutput> typedef Superclass::ValueType itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::ValueType

Reimplemented from itk::Statistics::LearningFunctionBase< LayerType, TOutput >. Definition at line 51 of file itkQuickPropLearningRule.h.

---

Constructor & Destructor Documentation

template<class LayerType, class TOutput> itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::QuickPropLearningRule (   )  [protected]

template<class LayerType, class TOutput> itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::~QuickPropLearningRule (   )  [inline, protected]

Definition at line 66 of file itkQuickPropLearningRule.h.

---

Member Function Documentation

virtual void itk::LightProcessObject::AbortGenerateDataOff (   )  [virtual, inherited]

virtual void itk::LightProcessObject::AbortGenerateDataOn (   )  [virtual, inherited]

Turn on and off the AbortGenerateData flag.

Get the execution progress of a process object The progress is* a floating number itk::LightProcessObject::between (  0  , 1  )  [inherited]

Set the execution progress of a process object The progress is* a floating number itk::LightProcessObject::between (  0  , 1  )  [inherited]

static void itk::LightObject::BreakOnError (   )  [static, inherited]

This method is called when itkExceptionMacro executes. It allows the debugger to break on error.

virtual LightObject::Pointer itk::Object::CreateAnother (   )  const [virtual, inherited]

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::LightObject.

virtual void itk::Object::DebugOff (   )  const [virtual, inherited]

Turn debugging output off.

virtual void itk::Object::DebugOn (   )  const [virtual, inherited]

Turn debugging output on.

virtual void itk::LightObject::Delete (   )  [virtual, inherited]

Delete an itk object. This method should always be used to delete an object when the new operator was used to create it. Using the C delete method will not work with reference counting.

virtual void itk::LightProcessObject::GenerateData (  void   )  [inline, protected, virtual, inherited]

This method causes the filter to generate its output. Reimplemented in itk::ClassifierBase< TDataContainer >, itk::ImageClassifierBase< TInputImage, TClassifiedImage >, itk::ImageGaussianModelEstimator< TInputImage, TMembershipFunction, TTrainingImage >, itk::ImageKmeansModelEstimator< TInputImage, TMembershipFunction >, itk::ImageModelEstimatorBase< TInputImage, TMembershipFunction >, itk::LevelSetNeighborhoodExtractor< TLevelSet >, itk::Statistics::SampleClassifier< TSample >, itk::Statistics::SampleClassifierWithMask< TSample, TMaskSample >, itk::ClassifierBase< TInputImage >, and itk::ClassifierBase< TSample >. Definition at line 123 of file itkLightProcessObject.h.

virtual const bool& itk::LightProcessObject::GetAbortGenerateData (   )  [virtual, inherited]

Get the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

Command* itk::Object::GetCommand (  unsigned long  tag  )  [inherited]

Get the command associated with the given tag. NOTE: This returns a pointer to a Command, but it is safe to asign this to a Command::Pointer. Since Command inherits from LightObject, at this point in the code, only a pointer or a reference to the Command can be used.

bool itk::Object::GetDebug (   )  const [inherited]

Get the value of the debug flag.

template<class LayerType, class TOutput> virtual const ValueType& itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::GetDecay (   )  [virtual]

static bool itk::Object::GetGlobalWarningDisplay (   )  [static, inherited]

template<class LayerType, class TOutput> virtual const ValueType& itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::GetMax_Growth_Factor (   )  [virtual]

const MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  const [inherited]

Returns: A constant reference to this objects MetaDataDictionary.

MetaDataDictionary& itk::Object::GetMetaDataDictionary (  void   )  [inherited]

Returns: A reference to this objects MetaDataDictionary. Warning: This reference may be changed.

virtual unsigned long itk::Object::GetMTime (   )  const [virtual, inherited]

Return this objects modified time. Reimplemented in itk::ImageRegistrationMethod< TFixedImage, TMovingImage >, itk::DeformationFieldSource< TOutputImage >, itk::InverseDeformationFieldImageFilter< TInputImage, TOutputImage >, itk::ResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::VectorResampleImageFilter< TInputImage, TOutputImage, TInterpolatorPrecisionType >, itk::BoundingBox< TPointIdentifier, VPointDimension, TCoordRep, TPointsContainer >, itk::SceneSpatialObject< SpaceDimension >, and itk::SceneSpatialObject< NDimensions >.

template<class LayerType, class TOutput> virtual const char* itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::GetNameOfClass (   )  const [virtual]

Method for creation through the object factory. Reimplemented from itk::Statistics::LearningFunctionBase< LayerType, TOutput >.

meaning* the filter has completed execution* virtual const float& itk::LightProcessObject::GetProgress (   )  [virtual, inherited]

virtual int itk::LightObject::GetReferenceCount (   )  const [inline, virtual, inherited]

Gets the reference count on this object. Definition at line 98 of file itkLightObject.h.

static void itk::Object::GlobalWarningDisplayOff (   )  [inline, static, inherited]

Definition at line 100 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

static void itk::Object::GlobalWarningDisplayOn (   )  [inline, static, inherited]

Definition at line 98 of file itkObject.h. References itk::Object::SetGlobalWarningDisplay().

bool itk::Object::HasObserver (  const EventObject &  event  )  const [inherited]

Return true if an observer is registered for this event.

void itk::Object::InvokeEvent (  const EventObject &   )  const [inherited]

Call Execute on all the Commands observing this event id. The actions triggered by this call doesn't modify this object.

void itk::Object::InvokeEvent (  const EventObject &   )  [inherited]

Call Execute on all the Commands observing this event id.

template<class LayerType, class TOutput> void itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::Learn (  LayerType *  layer, TOutput  errors, ValueType  learningrate )  [virtual]

Implements itk::Statistics::LearningFunctionBase< LayerType, TOutput >.

template<class LayerType, class TOutput> void itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::Learn (  LayerType *  layer, ValueType  learningrate )  [virtual]

Implements itk::Statistics::LearningFunctionBase< LayerType, TOutput >.

virtual void itk::Object::Modified (   )  const [virtual, inherited]

Update the modification time for this object. Many filters rely on the modification time to determine if they need to recompute their data. Referenced by itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetCenter(), itk::HistogramAlgorithmBase< TInputHistogram >::SetInputHistogram(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetMatrix(), itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetOffset(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetRealThresholds(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints1(), itk::CollidingFrontsImageFilter< TInputImage, TOutputImage >::SetSeedPoints2(), itk::NonUniformBSpline< TDimension >::SetSplineOrder(), itk::ThresholdLabelerImageFilter< TInputImage, TOutputImage >::SetThresholds(), itk::Statistics::GoodnessOfFitFunctionBase< typename ComponentType::HistogramType >::SetTotalObservedScale(), and itk::MatrixOffsetTransformBase< TScalarType, 3, 3 >::SetTranslation().

template<class LayerType, class TOutput> static Pointer itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::New (   )  [static]

Method for creation through the object factory. Reimplemented from itk::LightProcessObject.

void itk::LightObject::Print (  std::ostream &  os, Indent  indent = 0 )  const [inherited]

Cause the object to print itself out.

bool itk::Object::PrintObservers (  std::ostream &  os, Indent  indent )  const [protected, inherited]

template<class LayerType, class TOutput> virtual void itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::PrintSelf (  std::ostream &  os, Indent  indent )  const [protected, virtual]

Method to print the object. Reimplemented from itk::Statistics::LearningFunctionBase< LayerType, TOutput >.

virtual void itk::LightObject::PrintTrailer (  std::ostream &  os, Indent  indent )  const [protected, virtual, inherited]

virtual void itk::Object::Register (   )  const [virtual, inherited]

Increase the reference count (mark as used by another object). Reimplemented from itk::LightObject.

void itk::Object::RemoveAllObservers (   )  [inherited]

Remove all observers .

void itk::Object::RemoveObserver (  unsigned long  tag  )  [inherited]

Remove the observer with this tag value.

virtual void itk::LightProcessObject::SetAbortGenerateData (  bool  _arg  )  [virtual, inherited]

Set the AbortGenerateData flag for the process object. Process objects may handle premature termination of execution in different ways.

void itk::Object::SetDebug (  bool  debugFlag  )  const [inherited]

Set the value of the debug flag. A non-zero value turns debugging on.

template<class LayerType, class TOutput> virtual void itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::SetDecay (  ValueType  _arg  )  [virtual]

This is a global flag that controls whether any warning* or error messages are displayed* static void itk::Object::SetGlobalWarningDisplay (  bool  flag  )  [static, inherited]

Referenced by itk::Object::GlobalWarningDisplayOff(), and itk::Object::GlobalWarningDisplayOn().

template<class LayerType, class TOutput> virtual void itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::SetMax_Growth_Factor (  ValueType  _arg  )  [virtual]

void itk::Object::SetMetaDataDictionary (  const MetaDataDictionary &  rhs  )  [inherited]

Returns: Set the MetaDataDictionary

meaning* the filter has completed execution* virtual void itk::LightProcessObject::SetProgress (  float  _arg  )  [virtual, inherited]

virtual void itk::Object::SetReferenceCount (  int   )  [virtual, inherited]

Sets the reference count (use with care) Reimplemented from itk::LightObject.

virtual void itk::Object::UnRegister (   )  const [virtual, inherited]

Decrease the reference count (release by another object). Reimplemented from itk::LightObject.

virtual void itk::LightProcessObject::UpdateOutputData (   )  [virtual, inherited]

Actually generate new output.

void itk::LightProcessObject::UpdateProgress (  float  amount  )  [inherited]

Update the progress of the process object. If a ProgressMethod exists, executes it. Then set the Progress ivar to amount. The parameter amount should range between (0,1).

---

Member Data Documentation

Allow people to add remove invoke observers (callbacks) to any ITK * object. This is an implementation of the subject/observer design * pattern. An observer is added by specifying an event to respond to * and an itk unsigned lon itk::Object::AddObserver)(const EventObject &event, Command *) const [inherited]

This is a global flag that controls whether any itk::Object::debug [inherited]

Definition at line 94 of file itkObject.h.

template<class LayerType, class TOutput> ValueType itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::m_Decay [protected]

Definition at line 70 of file itkQuickPropLearningRule.h.

template<class LayerType, class TOutput> ValueType itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::m_Epsilon [protected]

Definition at line 72 of file itkQuickPropLearningRule.h.

template<class LayerType, class TOutput> ValueType itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::m_Max_Growth_Factor [protected]

Definition at line 69 of file itkQuickPropLearningRule.h.

template<class LayerType, class TOutput> ValueType itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::m_Momentum [protected]

Definition at line 66 of file itkQuickPropLearningRule.h.

int itk::LightObject::m_ReferenceCount [mutable, protected, inherited]

Number of uses of this object by other objects. Definition at line 119 of file itkLightObject.h.

SimpleFastMutexLock itk::LightObject::m_ReferenceCountLock [mutable, protected, inherited]

Mutex lock to protect modification to the reference count Definition at line 122 of file itkLightObject.h.

template<class LayerType, class TOutput> ValueType itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::m_SigmoidPrimeOffset [protected]

Definition at line 73 of file itkQuickPropLearningRule.h.

template<class LayerType, class TOutput> ValueType itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::m_SplitEpsilon [protected]

Definition at line 74 of file itkQuickPropLearningRule.h.

template<class LayerType, class TOutput> ValueType itk::Statistics::QuickPropLearningRule< LayerType, TOutput >::m_Threshold [protected]

Definition at line 71 of file itkQuickPropLearningRule.h.

Methods invoked by virtual Print () to print information about the object * including superclasses. Typically not called by the user (use Print() * instead) but used in the hierarchical print process to combine the * output of several classes. */ virtual void PrintSelf(std voi itk::LightObject::PrintHeader)(std::ostream &os, Indent indent) const [protected, inherited]

Get the execution progress of a process object The progress is* a floating number meaning no itk::LightProcessObject::progress [inherited]

Definition at line 104 of file itkLightProcessObject.h.

Set the execution progress of a process object The progress is* a floating number meaning no itk::LightProcessObject::progress [inherited]

Definition at line 98 of file itkLightProcessObject.h.

---

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

• itkQuickPropLearningRule.h

---