ITK  4.13.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::FastMarchingStoppingCriterionBase< TInput, TOutput > Class Template Referenceabstract
Module ITKFastMarching

#include <itkFastMarchingStoppingCriterionBase.h>

+ Inheritance diagram for itk::FastMarchingStoppingCriterionBase< TInput, TOutput >:
+ Collaboration diagram for itk::FastMarchingStoppingCriterionBase< TInput, TOutput >:

Detailed Description

template<typename TInput, typename TOutput>
class itk::FastMarchingStoppingCriterionBase< TInput, TOutput >

Abstract Stopping Criterion dedicated for Fast Marching Methods.

Definition at line 35 of file itkFastMarchingStoppingCriterionBase.h.

Public Types

typedef SmartPointer< const Self > ConstPointer
 
typedef Traits::NodePairType NodePairType
 
typedef Traits::NodeType NodeType
 
typedef Traits::OutputDomainPointer OutputDomainPointer
 
typedef Traits::OutputDomainType OutputDomainType
 
typedef Traits::OutputPixelType OutputPixelType
 
typedef SmartPointer< Self > Pointer
 
typedef
FastMarchingStoppingCriterionBase 		Self
 
typedef StoppingCriterionBase Superclass
 
typedef FastMarchingTraits
< TInput, TOutput > 		Traits
 
- Public Types inherited from itk::StoppingCriterionBase
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef StoppingCriterionBase Self
 
typedef Object Superclass
 
- Public Types inherited from itk::Object
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const Self > ConstPointer
 
typedef SmartPointer< Self > Pointer
 
typedef LightObject Self
 

Public Member Functions

virtual const char * GetNameOfClass () const
 
- Public Member Functions inherited from itk::StoppingCriterionBase
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 override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
Command * GetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionary & GetMetaDataDictionary ()
 
const MetaDataDictionary & GetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStamp & GetTimeStamp () 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

virtual void Reset ()=0
 
virtual void SetCurrentNode (const NodeType &iNode)=0
 
virtual void SetCurrentValue (const OutputPixelType &iValue)
 
virtual ~FastMarchingStoppingCriterionBase () override
 
- Protected Member Functions inherited from itk::StoppingCriterionBase
 StoppingCriterionBase ()
 
virtual ~StoppingCriterionBase () override
 
- 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 override
 
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 ()
 

Protected Attributes

OutputPixelType m_CurrentValue
 
OutputDomainPointer m_Domain
 
OutputPixelType m_PreviousValue
 
- Protected Attributes inherited from itk::LightObject
AtomicInt< int > m_ReferenceCount
 

Private Member Functions

 FastMarchingStoppingCriterionBase (const Self &)
 
void operator= (const Self &)
 
void Reinitialize ()
 
void SetCurrentNodePair (const NodePairType &iNodePair)
 
virtual void SetDomain (OutputDomainType *_arg)
 
virtual OutputDomainType * GetModifiableDomain ()
 
virtual const OutputDomainType * GetDomain () const
 
 FastMarchingStoppingCriterionBase ()
 

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

Member Typedef Documentation

template<typename TInput , typename TOutput >
typedef SmartPointer< const Self > itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::ConstPointer

Definition at line 41 of file itkFastMarchingStoppingCriterionBase.h.

template<typename TInput , typename TOutput >
typedef Traits::NodePairType itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::NodePairType

Definition at line 46 of file itkFastMarchingStoppingCriterionBase.h.

template<typename TInput , typename TOutput >
typedef Traits::NodeType itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::NodeType

Definition at line 44 of file itkFastMarchingStoppingCriterionBase.h.

template<typename TInput , typename TOutput >
typedef Traits::OutputDomainPointer itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::OutputDomainPointer

Definition at line 48 of file itkFastMarchingStoppingCriterionBase.h.

template<typename TInput , typename TOutput >
typedef Traits::OutputDomainType itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::OutputDomainType

Definition at line 47 of file itkFastMarchingStoppingCriterionBase.h.

template<typename TInput , typename TOutput >
typedef Traits::OutputPixelType itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::OutputPixelType

Definition at line 45 of file itkFastMarchingStoppingCriterionBase.h.

template<typename TInput , typename TOutput >
typedef SmartPointer< Self > itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Pointer

Definition at line 40 of file itkFastMarchingStoppingCriterionBase.h.

template<typename TInput , typename TOutput >
typedef FastMarchingStoppingCriterionBase itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Self

Definition at line 38 of file itkFastMarchingStoppingCriterionBase.h.

template<typename TInput , typename TOutput >
typedef StoppingCriterionBase itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Superclass

Definition at line 39 of file itkFastMarchingStoppingCriterionBase.h.

template<typename TInput , typename TOutput >
typedef FastMarchingTraits< TInput, TOutput > itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Traits

Definition at line 42 of file itkFastMarchingStoppingCriterionBase.h.

Constructor & Destructor Documentation

template<typename TInput , typename TOutput >
itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::FastMarchingStoppingCriterionBase ( )
inlineprotected

Constructor

Definition at line 74 of file itkFastMarchingStoppingCriterionBase.h.

References itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_CurrentValue, itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_PreviousValue, and itk::NumericTraits< T >::ZeroValue().

template<typename TInput , typename TOutput >
virtual itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::~FastMarchingStoppingCriterionBase ( )
inlineoverrideprotectedvirtual

Destructor

Definition at line 82 of file itkFastMarchingStoppingCriterionBase.h.

template<typename TInput , typename TOutput >
itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::FastMarchingStoppingCriterionBase ( const Self &  )
private

Member Function Documentation

template<typename TInput , typename TOutput >
virtual const OutputDomainType* itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::GetDomain ( ) const
virtual

Reinitialize internal values.

template<typename TInput , typename TOutput >
virtual OutputDomainType* itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::GetModifiableDomain ( )
virtual

Reinitialize internal values.

template<typename TInput , typename TOutput >
virtual const char* itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

Reimplemented from itk::StoppingCriterionBase.

Reimplemented in itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >, and itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >.

template<typename TInput , typename TOutput >
void itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::operator= ( const Self &  )
private
template<typename TInput , typename TOutput >
void itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Reinitialize ( )
inline

Reinitialize internal values.

Definition at line 54 of file itkFastMarchingStoppingCriterionBase.h.

References itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_CurrentValue, itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_PreviousValue, itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Reset(), and itk::NumericTraits< T >::ZeroValue().

template<typename TInput , typename TOutput >
virtual void itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Reset ( )
protectedpure virtual

Inherited classes must implement this method and make sure member variables got reinitialized.

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

Referenced by itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Reinitialize().

template<typename TInput , typename TOutput >
virtual void itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::SetCurrentNode ( const NodeType &  iNode)
protectedpure virtual

Set the Current Node

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

Referenced by itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::SetCurrentNodePair().

template<typename TInput , typename TOutput >
void itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::SetCurrentNodePair ( const NodePairType &  iNodePair)
inline

Reinitialize internal values.

Definition at line 63 of file itkFastMarchingStoppingCriterionBase.h.

References itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::SetCurrentNode(), and itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::SetCurrentValue().

template<typename TInput , typename TOutput >
virtual void itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::SetCurrentValue ( const OutputPixelType &  iValue)
inlineprotectedvirtual

Set the Current Value

Definition at line 97 of file itkFastMarchingStoppingCriterionBase.h.

References itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_CurrentValue, and itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_PreviousValue.

Referenced by itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::SetCurrentNodePair().

template<typename TInput , typename TOutput >
virtual void itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::SetDomain ( OutputDomainType *  _arg)
virtual

Reinitialize internal values.

Member Data Documentation

template<typename TInput , typename TOutput >
OutputPixelType itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_CurrentValue
protected

Definition at line 87 of file itkFastMarchingStoppingCriterionBase.h.

Referenced by itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::FastMarchingStoppingCriterionBase(), itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::IsSatisfied(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::IsSatisfied(), itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Reinitialize(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetCurrentNode(), and itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::SetCurrentValue().

template<typename TInput , typename TOutput >
OutputDomainPointer itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_Domain
protected

Definition at line 84 of file itkFastMarchingStoppingCriterionBase.h.

template<typename TInput , typename TOutput >
OutputPixelType itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_PreviousValue
protected

Definition at line 86 of file itkFastMarchingStoppingCriterionBase.h.

Referenced by itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::FastMarchingStoppingCriterionBase(), itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Reinitialize(), and itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::SetCurrentValue().

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Tue Dec 19 2017 05:27:56 for ITK by   doxygen 1.8.5