ITK  4.2.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Member Functions
itk::StoppingCriterionBase Class Reference

#include <itkStoppingCriterionBase.h>

+ Inheritance diagram for itk::StoppingCriterionBase:
+ Collaboration diagram for itk::StoppingCriterionBase:

List of all members.

Public Types

typedef SmartPointer< const SelfConstPointer
typedef SmartPointer< SelfPointer
typedef StoppingCriterionBase Self
typedef Object Superclass
- Public Types inherited from itk::Object
- Public Types inherited from itk::LightObject

Public Member Functions

virtual const char * GetNameOfClass () const
virtual bool IsSatisfied () const =0
virtual std::string GetDescription () const =0
- 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
virtual void DebugOff () const
virtual void DebugOn () const
CommandGetCommand (unsigned long tag)
bool GetDebug () const
MetaDataDictionaryGetMetaDataDictionary (void)
const MetaDataDictionaryGetMetaDataDictionary (void) const
virtual unsigned long 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
void RemoveAllObservers ()
void RemoveObserver (unsigned long tag)
void SetDebug (bool debugFlag) const
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
virtual void SetReferenceCount (int)
virtual void UnRegister () 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

 StoppingCriterionBase ()
virtual ~StoppingCriterionBase ()
- 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
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

void operator= (const Self &)
 StoppingCriterionBase (const Self &)

Additional Inherited Members

- 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 ()

Detailed Description

An abstract base class to represent a stopping criterion for an iterative algorithm.

The main method is StoppingCriterionBase::IsSatisfied that must be reimplemented in inheriting classes.

Definition at line 38 of file itkStoppingCriterionBase.h.


Member Typedef Documentation


Constructor & Destructor Documentation

itk::StoppingCriterionBase::StoppingCriterionBase ( )
protected

Constructor.

virtual itk::StoppingCriterionBase::~StoppingCriterionBase ( )
protectedvirtual

Destructor.

itk::StoppingCriterionBase::StoppingCriterionBase ( const Self )
private

Member Function Documentation

virtual std::string itk::StoppingCriterionBase::GetDescription ( ) const
pure virtual
virtual const char* itk::StoppingCriterionBase::GetNameOfClass ( ) const
virtual
virtual bool itk::StoppingCriterionBase::IsSatisfied ( ) const
pure virtual
void itk::StoppingCriterionBase::operator= ( const Self )
private

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