itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput > Class Template Reference

#include <itkFastMarchingThresholdStoppingCriterion.h>

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

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

Detailed Description

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

Stopping Criterion is verified when Current Value is equal to or greater than the provided threshold.

Examples:

SphinxExamples/src/Filtering/FastMarching/ComputeGeodesicDistanceOnMesh/Code.cxx, and SphinxExamples/src/Filtering/FastMarching/CreateDistanceMapFromSeeds/Code.cxx.

Definition at line 35 of file itkFastMarchingThresholdStoppingCriterion.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::NodeType	NodeType
typedef Superclass::OutputPixelType	OutputPixelType
typedef SmartPointer< Self >	Pointer
typedef FastMarchingThresholdStoppingCriterion	Self
typedef FastMarchingStoppingCriterionBase < TInput, TOutput >	Superclass
Public Types inherited from itk::FastMarchingStoppingCriterionBase< TInput, TOutput >
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 ::itk::LightObject::Pointer	CreateAnother () const
std::string	GetDescription () const override
virtual const char *	GetNameOfClass () const
bool	IsSatisfied () const override
virtual void	SetThreshold (OutputPixelType _arg)
virtual OutputPixelType	GetThreshold ()
Public Member Functions inherited from itk::FastMarchingStoppingCriterionBase< TInput, TOutput >
void	Reinitialize ()
void	SetCurrentNodePair (const NodePairType &iNodePair)
virtual void	SetDomain (OutputDomainType *_arg)
virtual OutputDomainType *	GetModifiableDomain ()
virtual const OutputDomainType *	GetDomain () const
Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)
unsigned long	AddObserver (const EventObject &event, Command *) const
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

Static Public Member Functions
static Pointer	New ()
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 ()

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

Protected Attributes
OutputPixelType	m_Threshold
Protected Attributes inherited from itk::FastMarchingStoppingCriterionBase< TInput, TOutput >
OutputPixelType	m_CurrentValue
OutputDomainPointer	m_Domain
OutputPixelType	m_PreviousValue
Protected Attributes inherited from itk::LightObject
AtomicInt< int >	m_ReferenceCount

Private Member Functions
	FastMarchingThresholdStoppingCriterion (const Self &)
void	operator= (const Self &)

Member Typedef Documentation

template<typename TInput , typename TOutput >

typedef SmartPointer< const Self > itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::ConstPointer

Definition at line 42 of file itkFastMarchingThresholdStoppingCriterion.h.

template<typename TInput , typename TOutput >

typedef Superclass::NodeType itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::NodeType

Definition at line 52 of file itkFastMarchingThresholdStoppingCriterion.h.

template<typename TInput , typename TOutput >

typedef Superclass::OutputPixelType itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::OutputPixelType

Definition at line 49 of file itkFastMarchingThresholdStoppingCriterion.h.

template<typename TInput , typename TOutput >

typedef SmartPointer< Self > itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::Pointer

Definition at line 41 of file itkFastMarchingThresholdStoppingCriterion.h.

template<typename TInput , typename TOutput >

typedef FastMarchingThresholdStoppingCriterion itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::Self

Definition at line 39 of file itkFastMarchingThresholdStoppingCriterion.h.

template<typename TInput , typename TOutput >

typedef FastMarchingStoppingCriterionBase< TInput, TOutput > itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::Superclass

Definition at line 40 of file itkFastMarchingThresholdStoppingCriterion.h.

Constructor & Destructor Documentation

template<typename TInput , typename TOutput >

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

inlineprotected

Definition at line 70 of file itkFastMarchingThresholdStoppingCriterion.h.

template<typename TInput , typename TOutput >

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

inlineprotected

Definition at line 74 of file itkFastMarchingThresholdStoppingCriterion.h.

template<typename TInput , typename TOutput >

itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::FastMarchingThresholdStoppingCriterion ( const Self &  )

private

Member Function Documentation

template<typename TInput , typename TOutput >

virtual::itk::LightObject::Pointer itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::CreateAnother ( ) const

virtual

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

template<typename TInput , typename TOutput >

std::string itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::GetDescription ( ) const

inlineoverridevirtual

Returns

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

fasle else.

Implements itk::StoppingCriterionBase.

Definition at line 64 of file itkFastMarchingThresholdStoppingCriterion.h.

template<typename TInput , typename TOutput >

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

virtual

Run-time type information (and related methods).

Reimplemented from itk::FastMarchingStoppingCriterionBase< TInput, TOutput >.

template<typename TInput , typename TOutput >

virtual OutputPixelType itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::GetThreshold ( )

virtual

Get/set the threshold used by the stopping criteria.

template<typename TInput , typename TOutput >

bool itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::IsSatisfied ( ) const

inlineoverridevirtual

Returns

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

fasle else.

Implements itk::StoppingCriterionBase.

Definition at line 59 of file itkFastMarchingThresholdStoppingCriterion.h.

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

template<typename TInput , typename TOutput >

static Pointer itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::New ( )

static

Method for creation through the object factory.

template<typename TInput , typename TOutput >

void itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::operator= ( const Self &  )

private

template<typename TInput , typename TOutput >

void itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::Reset ( )

inlineoverrideprotectedvirtual

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

Implements itk::FastMarchingStoppingCriterionBase< TInput, TOutput >.

Definition at line 80 of file itkFastMarchingThresholdStoppingCriterion.h.

template<typename TInput , typename TOutput >

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

inlineoverrideprotectedvirtual

Set the Current Node

Implements itk::FastMarchingStoppingCriterionBase< TInput, TOutput >.

Definition at line 78 of file itkFastMarchingThresholdStoppingCriterion.h.

template<typename TInput , typename TOutput >

virtual void itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::SetThreshold ( OutputPixelType  _arg )

virtual

Get/set the threshold used by the stopping criteria.

Member Data Documentation

template<typename TInput , typename TOutput >

OutputPixelType itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::m_Threshold

protected

Definition at line 76 of file itkFastMarchingThresholdStoppingCriterion.h.

Referenced by itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::IsSatisfied().

---

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

• itkFastMarchingThresholdStoppingCriterion.h