#include <itkFastMarchingReachedTargetNodesStoppingCriterion.h>

Detailed Description

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

Stopping criterion for FastMarchingFilterBase.

Stopping criterion where the condition is satisfied when the front reaches one, several or all target nodes (provided by the user).

Definition at line 60 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

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

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

Public Types
using	ConstPointer = SmartPointer<const Self>

using	NodeType

using	OutputPixelType

using	Pointer = SmartPointer<Self>

using	Self = FastMarchingReachedTargetNodesStoppingCriterion

using	Superclass = FastMarchingStoppingCriterionBase<TInput, TOutput>

using	TargetConditionEnum = FastMarchingReachedTargetNodesStoppingCriterionEnums::TargetCondition

using	Traits

Public Types inherited from itk::FastMarchingStoppingCriterionBase< TInput, TOutput >
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::itk::LightObject::Pointer	CreateAnother () const

std::string	GetDescription () const override

const char *	GetNameOfClass () const override

bool	IsSatisfied () const override

void	SetCurrentNode (const NodeType &iNode) override

void	SetNumberOfTargetsToBeReached (const vcl_size_t &iN)

virtual void	SetTargetNodes (const std::vector< NodeType > &iNodes)


void	SetTargetCondition (const TargetConditionEnum &iCondition)

virtual const TargetConditionEnum &	GetTargetCondition () const


virtual void	SetTargetOffset (OutputPixelType _arg)

virtual OutputPixelType	GetTargetOffset ()

Public Member Functions inherited from itk::FastMarchingStoppingCriterionBase< TInput, TOutput >
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

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

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

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

static Pointer	New ()

Protected Member Functions
	FastMarchingReachedTargetNodesStoppingCriterion ()

void	Initialize ()

void	Reset () override

	~FastMarchingReachedTargetNodesStoppingCriterion () override=default

Protected Member Functions inherited from itk::FastMarchingStoppingCriterionBase< TInput, TOutput >
	FastMarchingStoppingCriterionBase ()

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
bool	m_Initialized { false }

vcl_size_t	m_NumberOfTargetsToBeReached { 0 }

std::vector< NodeType >	m_ReachedTargetNodes {}

bool	m_Satisfied { false }

OutputPixelType	m_StoppingValue {}

TargetConditionEnum	m_TargetCondition { TargetConditionEnum::AllTargets }

std::vector< NodeType >	m_TargetNodes {}

OutputPixelType	m_TargetOffset {}

Protected Attributes inherited from itk::FastMarchingStoppingCriterionBase< TInput, TOutput >
OutputPixelType	m_CurrentValue {}

OutputDomainPointer	m_Domain {}

OutputPixelType	m_PreviousValue {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Member Typedef Documentation

◆ ConstPointer

template<typename TInput, typename TOutput>

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

Definition at line 69 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

◆ NodeType

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::NodeType

Definition at line 47 of file itkFastMarchingStoppingCriterionBase.h.

◆ OutputPixelType

template<typename TInput, typename TOutput>

using itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::OutputPixelType

Definition at line 48 of file itkFastMarchingStoppingCriterionBase.h.

◆ Pointer

template<typename TInput, typename TOutput>

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

Definition at line 68 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

◆ Self

template<typename TInput, typename TOutput>

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

Definition at line 66 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

◆ Superclass

template<typename TInput, typename TOutput>

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

Definition at line 67 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

◆ TargetConditionEnum

template<typename TInput, typename TOutput>

using itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::TargetConditionEnum = FastMarchingReachedTargetNodesStoppingCriterionEnums::TargetCondition

Definition at line 81 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

◆ Traits

template<typename TInput, typename TOutput>

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

Definition at line 45 of file itkFastMarchingStoppingCriterionBase.h.

Constructor & Destructor Documentation

◆ FastMarchingReachedTargetNodesStoppingCriterion()

template<typename TInput, typename TOutput>

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

inlineprotected

Constructor

Definition at line 183 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References m_StoppingValue, and m_TargetOffset.

Referenced by GetNameOfClass().

◆ ~FastMarchingReachedTargetNodesStoppingCriterion()

template<typename TInput, typename TOutput>

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

overrideprotecteddefault

Destructor

Member Function Documentation

◆ CreateAnother()

template<typename TInput, typename TOutput>

virtual::itk::LightObject::Pointer itk::FastMarchingReachedTargetNodesStoppingCriterion< 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::LightObject.

◆ GetDescription()

template<typename TInput, typename TOutput>

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

inlineoverridevirtual

Get a short description of the stopping criterion.

Implements itk::StoppingCriterionBase.

Definition at line 176 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

◆ GetNameOfClass()

template<typename TInput, typename TOutput>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

References FastMarchingReachedTargetNodesStoppingCriterion().

◆ GetTargetCondition()

template<typename TInput, typename TOutput>

virtual const TargetConditionEnum & itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::GetTargetCondition ( ) const

virtual

Set/Get TargetCondition to indicate if the user wants the front to reach one, some or all target nodes.

◆ GetTargetOffset()

template<typename TInput, typename TOutput>

virtual OutputPixelType itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::GetTargetOffset ( )

virtual

Set/Get TargetOffset

◆ Initialize()

template<typename TInput, typename TOutput>

void itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::Initialize ( )

inlineprotected

Definition at line 208 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References m_Initialized, m_NumberOfTargetsToBeReached, m_ReachedTargetNodes, m_Satisfied, m_TargetCondition, and m_TargetNodes.

Referenced by Reset(), and SetCurrentNode().

◆ IsSatisfied()

template<typename TInput, typename TOutput>

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

inlineoverridevirtual

returns if the stopping condition is satisfied or not.

Implements itk::StoppingCriterionBase.

Definition at line 169 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

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

◆ New()

template<typename TInput, typename TOutput>

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

static

Method for creation through the object factory.

◆ Reset()

template<typename TInput, typename TOutput>

void itk::FastMarchingReachedTargetNodesStoppingCriterion< 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 202 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References Initialize().

◆ SetCurrentNode()

template<typename TInput, typename TOutput>

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

inlineoverridevirtual

Set the current node.

Implements itk::FastMarchingStoppingCriterionBase< TInput, TOutput >.

Definition at line 129 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References Initialize(), itk::FastMarchingStoppingCriterionBase< TInput, TOutput >::m_CurrentValue, m_Initialized, m_NumberOfTargetsToBeReached, m_ReachedTargetNodes, m_Satisfied, m_StoppingValue, m_TargetNodes, and m_TargetOffset.

◆ SetNumberOfTargetsToBeReached()

template<typename TInput, typename TOutput>

void itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetNumberOfTargetsToBeReached ( const vcl_size_t & iN )

inline

Set the number of target nodes to be reached.

Definition at line 111 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References m_Initialized, m_NumberOfTargetsToBeReached, and itk::Object::Modified().

◆ SetTargetCondition()

template<typename TInput, typename TOutput>

void itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetTargetCondition ( const TargetConditionEnum & iCondition )

inline

Set/Get TargetCondition to indicate if the user wants the front to reach one, some or all target nodes.

Definition at line 93 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References m_Initialized, m_TargetCondition, and itk::Object::Modified().

◆ SetTargetNodes()

template<typename TInput, typename TOutput>

virtual void itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetTargetNodes ( const std::vector< NodeType > & iNodes )

inlinevirtual

Set Target Nodes.

Definition at line 120 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References m_Initialized, m_TargetNodes, and itk::Object::Modified().

◆ SetTargetOffset()

template<typename TInput, typename TOutput>

virtual void itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetTargetOffset ( OutputPixelType _arg )

virtual

Set/Get TargetOffset

Member Data Documentation

◆ m_Initialized

template<typename TInput, typename TOutput>

bool itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_Initialized { false }

protected

Definition at line 199 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by Initialize(), SetCurrentNode(), SetNumberOfTargetsToBeReached(), SetTargetCondition(), and SetTargetNodes().

◆ m_NumberOfTargetsToBeReached

template<typename TInput, typename TOutput>

vcl_size_t itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_NumberOfTargetsToBeReached { 0 }

protected

Definition at line 195 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by Initialize(), SetCurrentNode(), and SetNumberOfTargetsToBeReached().

◆ m_ReachedTargetNodes

template<typename TInput, typename TOutput>

std::vector<NodeType> itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_ReachedTargetNodes {}

protected

Definition at line 194 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by Initialize(), and SetCurrentNode().

◆ m_Satisfied

template<typename TInput, typename TOutput>

bool itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_Satisfied { false }

protected

Definition at line 198 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by Initialize(), IsSatisfied(), and SetCurrentNode().

◆ m_StoppingValue

template<typename TInput, typename TOutput>

OutputPixelType itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_StoppingValue {}

protected

Definition at line 197 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by FastMarchingReachedTargetNodesStoppingCriterion(), IsSatisfied(), and SetCurrentNode().

◆ m_TargetCondition

template<typename TInput, typename TOutput>

TargetConditionEnum itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_TargetCondition { TargetConditionEnum::AllTargets }

protected

Definition at line 192 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by Initialize(), and SetTargetCondition().

◆ m_TargetNodes

template<typename TInput, typename TOutput>

std::vector<NodeType> itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_TargetNodes {}

protected

Definition at line 193 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by Initialize(), SetCurrentNode(), and SetTargetNodes().

◆ m_TargetOffset

template<typename TInput, typename TOutput>

OutputPixelType itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_TargetOffset {}

protected

Definition at line 196 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by FastMarchingReachedTargetNodesStoppingCriterion(), and SetCurrentNode().

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

itkFastMarchingReachedTargetNodesStoppingCriterion.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ ConstPointer

◆ NodeType

◆ OutputPixelType

◆ Pointer

◆ Self

◆ Superclass

◆ TargetConditionEnum

◆ Traits

Constructor & Destructor Documentation

◆ FastMarchingReachedTargetNodesStoppingCriterion()

◆ ~FastMarchingReachedTargetNodesStoppingCriterion()

Member Function Documentation

◆ CreateAnother()

◆ GetDescription()

◆ GetNameOfClass()

◆ GetTargetCondition()

◆ GetTargetOffset()

◆ Initialize()

◆ IsSatisfied()

◆ New()

◆ Reset()

◆ SetCurrentNode()

◆ SetNumberOfTargetsToBeReached()

◆ SetTargetCondition()

◆ SetTargetNodes()

◆ SetTargetOffset()

Member Data Documentation

◆ m_Initialized

◆ m_NumberOfTargetsToBeReached

◆ m_ReachedTargetNodes

◆ m_Satisfied

◆ m_StoppingValue

◆ m_TargetCondition

◆ m_TargetNodes

◆ m_TargetOffset