#include <itkFastMarchingStoppingCriterionBase.h>

Detailed Description

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

Abstract Stopping Criterion dedicated for Fast Marching Methods.

Definition at line 36 of file itkFastMarchingStoppingCriterionBase.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>

using	NodePairType = typename Traits::NodePairType

using	NodeType = typename Traits::NodeType

using	OutputDomainPointer = typename Traits::OutputDomainPointer

using	OutputDomainType = typename Traits::OutputDomainType

using	OutputPixelType = typename Traits::OutputPixelType

using	Pointer = SmartPointer<Self>

using	Self = FastMarchingStoppingCriterionBase

using	Superclass = StoppingCriterionBase

using	Traits = FastMarchingTraits<TInput, TOutput>

Public Types inherited from itk::StoppingCriterionBase
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = StoppingCriterionBase

using	Superclass = Object

Public Types inherited from itk::Object
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = Object

using	Superclass = LightObject

Public Types inherited from itk::LightObject
using	ConstPointer = SmartPointer<const Self>

using	Pointer = SmartPointer<Self>

using	Self = LightObject

Public Member Functions
virtual const OutputDomainType *	GetDomain () const

virtual OutputDomainType *	GetModifiableDomain ()

const char *	GetNameOfClass () const override

void	Reinitialize ()

void	SetCurrentNodePair (const NodePairType &iNodePair)

virtual void	SetDomain (OutputDomainType *_arg)

Public Member Functions inherited from itk::StoppingCriterionBase
const char *	GetNameOfClass () const override

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 *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual void	Delete ()

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

Protected Member Functions
	FastMarchingStoppingCriterionBase ()

virtual void	Reset ()=0

virtual void	SetCurrentNode (const NodeType &iNode)=0

virtual void	SetCurrentValue (const OutputPixelType &iValue)

	~FastMarchingStoppingCriterionBase () override=default

Protected Member Functions inherited from itk::StoppingCriterionBase
	StoppingCriterionBase ()

	~StoppingCriterionBase () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~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
std::atomic< int >	m_ReferenceCount {}

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

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

Member Typedef Documentation

◆ ConstPointer

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::ConstPointer = SmartPointer<const Self>

Definition at line 44 of file itkFastMarchingStoppingCriterionBase.h.

◆ NodePairType

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::NodePairType = typename Traits::NodePairType

Definition at line 49 of file itkFastMarchingStoppingCriterionBase.h.

◆ NodeType

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::NodeType = typename Traits::NodeType

Definition at line 47 of file itkFastMarchingStoppingCriterionBase.h.

◆ OutputDomainPointer

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::OutputDomainPointer = typename Traits::OutputDomainPointer

Definition at line 51 of file itkFastMarchingStoppingCriterionBase.h.

◆ OutputDomainType

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::OutputDomainType = typename Traits::OutputDomainType

Definition at line 50 of file itkFastMarchingStoppingCriterionBase.h.

◆ OutputPixelType

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::OutputPixelType = typename Traits::OutputPixelType

Definition at line 48 of file itkFastMarchingStoppingCriterionBase.h.

◆ Pointer

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Pointer = SmartPointer<Self>

Definition at line 43 of file itkFastMarchingStoppingCriterionBase.h.

◆ Self

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Self = FastMarchingStoppingCriterionBase

Definition at line 41 of file itkFastMarchingStoppingCriterionBase.h.

◆ Superclass

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Superclass = StoppingCriterionBase

Definition at line 42 of file itkFastMarchingStoppingCriterionBase.h.

◆ Traits

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Traits = FastMarchingTraits<TInput, TOutput>

Definition at line 45 of file itkFastMarchingStoppingCriterionBase.h.

Constructor & Destructor Documentation

◆ FastMarchingStoppingCriterionBase()

template<typename TInput, typename TOutput>

itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::FastMarchingStoppingCriterionBase ( )

inlineprotected

Constructor

Definition at line 78 of file itkFastMarchingStoppingCriterionBase.h.

References m_CurrentValue, m_Domain, and m_PreviousValue.

Referenced by GetNameOfClass().

◆ ~FastMarchingStoppingCriterionBase()

template<typename TInput, typename TOutput>

itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::~FastMarchingStoppingCriterionBase ( )

overrideprotecteddefault

Destructor

Member Function Documentation

◆ GetDomain()

template<typename TInput, typename TOutput>

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

virtual

◆ GetModifiableDomain()

template<typename TInput, typename TOutput>

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

virtual

◆ GetNameOfClass()

template<typename TInput, typename TOutput>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

Reimplemented in itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >.

References FastMarchingStoppingCriterionBase().

◆ Reinitialize()

template<typename TInput, typename TOutput>

void itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::Reinitialize ( )

inline

Reinitialize internal values.

Definition at line 58 of file itkFastMarchingStoppingCriterionBase.h.

References m_CurrentValue, m_PreviousValue, and Reset().

◆ Reset()

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::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >, and itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >.

Referenced by Reinitialize().

◆ SetCurrentNode()

template<typename TInput, typename TOutput>

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

protectedpure virtual

Set the Current Node

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

Referenced by SetCurrentNodePair().

◆ SetCurrentNodePair()

template<typename TInput, typename TOutput>

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

inline

Definition at line 67 of file itkFastMarchingStoppingCriterionBase.h.

References SetCurrentNode(), and SetCurrentValue().

◆ SetCurrentValue()

template<typename TInput, typename TOutput>

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

inlineprotectedvirtual

Set the Current Value

Definition at line 105 of file itkFastMarchingStoppingCriterionBase.h.

References m_CurrentValue, and m_PreviousValue.

Referenced by SetCurrentNodePair().

◆ SetDomain()

template<typename TInput, typename TOutput>

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

virtual

Member Data Documentation

◆ m_CurrentValue

template<typename TInput, typename TOutput>

OutputPixelType itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_CurrentValue {}

protected

Definition at line 92 of file itkFastMarchingStoppingCriterionBase.h.

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

◆ m_Domain

template<typename TInput, typename TOutput>

OutputDomainPointer itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_Domain {}

protected

Definition at line 89 of file itkFastMarchingStoppingCriterionBase.h.

Referenced by FastMarchingStoppingCriterionBase().

◆ m_PreviousValue

template<typename TInput, typename TOutput>

OutputPixelType itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_PreviousValue {}

protected

Definition at line 91 of file itkFastMarchingStoppingCriterionBase.h.

Referenced by FastMarchingStoppingCriterionBase(), Reinitialize(), and SetCurrentValue().

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

itkFastMarchingStoppingCriterionBase.h

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ NodePairType

◆ NodeType

◆ OutputDomainPointer

◆ OutputDomainType

◆ OutputPixelType

◆ Pointer

◆ Self

◆ Superclass

◆ Traits

Constructor & Destructor Documentation

◆ FastMarchingStoppingCriterionBase()

◆ ~FastMarchingStoppingCriterionBase()

Member Function Documentation

◆ GetDomain()

◆ GetModifiableDomain()

◆ GetNameOfClass()

◆ Reinitialize()

◆ Reset()

◆ SetCurrentNode()

◆ SetCurrentNodePair()

◆ SetCurrentValue()

◆ SetDomain()

Member Data Documentation

◆ m_CurrentValue

◆ m_Domain

◆ m_PreviousValue