itk::StoppingCriterionBase Class Reference

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

#include <itkStoppingCriterionBase.h>

Inheritance diagram for itk::StoppingCriterionBase:

Collaboration diagram for itk::StoppingCriterionBase:

List of all members.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef SmartPointer< Self >	Pointer
typedef StoppingCriterionBase	Self
typedef Object	Superclass
Public Member Functions
virtual const char *	GetNameOfClass () const
virtual bool	IsSatisfied () const =0
virtual std::string	GetDescription () const =0
Protected Member Functions
	StoppingCriterionBase ()
virtual	~StoppingCriterionBase ()
Private Member Functions
void	operator= (const Self &)
	StoppingCriterionBase (const Self &)

---

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

typedef SmartPointer< const Self > itk::StoppingCriterionBase::ConstPointer

Reimplemented from itk::Object.

Reimplemented in itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >, itk::FastMarchingStoppingCriterionBase< TInput, TOutput >, itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >, itk::LevelSetEvolutionNumberOfIterationsStoppingCriterion< TLevelSetContainer >, and itk::LevelSetEvolutionStoppingCriterionBase< TLevelSetContainer >.

Definition at line 44 of file itkStoppingCriterionBase.h.

typedef SmartPointer< Self > itk::StoppingCriterionBase::Pointer

Reimplemented from itk::Object.

Reimplemented in itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >, itk::FastMarchingStoppingCriterionBase< TInput, TOutput >, itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >, itk::LevelSetEvolutionNumberOfIterationsStoppingCriterion< TLevelSetContainer >, and itk::LevelSetEvolutionStoppingCriterionBase< TLevelSetContainer >.

Definition at line 43 of file itkStoppingCriterionBase.h.

typedef StoppingCriterionBase itk::StoppingCriterionBase::Self

Smart pointer typedef support.

Reimplemented from itk::Object.

Reimplemented in itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >, itk::FastMarchingStoppingCriterionBase< TInput, TOutput >, itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >, itk::LevelSetEvolutionNumberOfIterationsStoppingCriterion< TLevelSetContainer >, and itk::LevelSetEvolutionStoppingCriterionBase< TLevelSetContainer >.

Definition at line 41 of file itkStoppingCriterionBase.h.

typedef Object itk::StoppingCriterionBase::Superclass

Reimplemented from itk::Object.

Reimplemented in itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >, itk::FastMarchingStoppingCriterionBase< TInput, TOutput >, itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >, itk::LevelSetEvolutionNumberOfIterationsStoppingCriterion< TLevelSetContainer >, and itk::LevelSetEvolutionStoppingCriterionBase< TLevelSetContainer >.

Definition at line 42 of file itkStoppingCriterionBase.h.

---

Constructor & Destructor Documentation

itk::StoppingCriterionBase::StoppingCriterionBase

(

)

[protected]

Constructor.

virtual itk::StoppingCriterionBase::~StoppingCriterionBase

(

)

[protected, virtual]

Destructor.

itk::StoppingCriterionBase::StoppingCriterionBase

(

const Self &

)

[private]

---

Member Function Documentation

virtual std::string itk::StoppingCriterionBase::GetDescription

(

)

const [pure virtual]

Returns:

true if the stopping criterion is reached (and the algorithm must stop).

fasle else.

Implemented in itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >, itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >, and itk::LevelSetEvolutionNumberOfIterationsStoppingCriterion< TLevelSetContainer >.

virtual const char* itk::StoppingCriterionBase::GetNameOfClass

(

)

const [virtual]

Standard part of all itk objects.

Reimplemented from itk::Object.

Reimplemented in itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >, itk::FastMarchingStoppingCriterionBase< TInput, TOutput >, itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >, itk::LevelSetEvolutionNumberOfIterationsStoppingCriterion< TLevelSetContainer >, and itk::LevelSetEvolutionStoppingCriterionBase< TLevelSetContainer >.

virtual bool itk::StoppingCriterionBase::IsSatisfied

(

)

const [pure virtual]

Returns:

true if the stopping criterion is reached (and the algorithm must stop).

fasle else.

Implemented in itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >, itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >, and itk::LevelSetEvolutionNumberOfIterationsStoppingCriterion< TLevelSetContainer >.

void itk::StoppingCriterionBase::operator=

(

const Self &

)

[private]

Mutex lock to protect modification to the reference count

Reimplemented from itk::Object.

Reimplemented in itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >, itk::FastMarchingStoppingCriterionBase< TInput, TOutput >, itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >, itk::LevelSetEvolutionNumberOfIterationsStoppingCriterion< TLevelSetContainer >, and itk::LevelSetEvolutionStoppingCriterionBase< TLevelSetContainer >.

---

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

• itkStoppingCriterionBase.h