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

#include <itkFastMarchingReachedTargetNodesStoppingCriterion.h>

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

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

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 37 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Public Types
using	ConstPointer = SmartPointer< const Self >
using	NodeType = typename Superclass::NodeType
using	OutputPixelType = typename Superclass::OutputPixelType
using	Pointer = SmartPointer< Self >
using	Self = FastMarchingReachedTargetNodesStoppingCriterion
using	Superclass = FastMarchingStoppingCriterionBase< TInput, TOutput >
enum	TargetConditionType {   OneTarget = 1,   SomeTargets,   AllTargets }
using	Traits = typename Superclass::Traits

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother () const
std::string	GetDescription () const override
virtual const char *	GetNameOfClass () const
virtual const TargetConditionType &	GetTargetCondition () const
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 TargetConditionType &iCondition)
virtual void	SetTargetOffset (OutputPixelType _arg)
virtual OutputPixelType	GetTargetOffset ()

Static Public Member Functions
static Pointer	New ()

Protected Member Functions
	FastMarchingReachedTargetNodesStoppingCriterion ()
void	Initialize ()
void	Reset () override
	~FastMarchingReachedTargetNodesStoppingCriterion () override=default

Protected Attributes
bool	m_Initialized {false}
vcl_size_t	m_NumberOfTargetsToBeReached {0}
std::vector< NodeType >	m_ReachedTargetNodes
bool	m_Satisfied {false}
OutputPixelType	m_StoppingValue
TargetConditionType	m_TargetCondition
std::vector< NodeType >	m_TargetNodes
OutputPixelType	m_TargetOffset

Member Typedef Documentation

template<typename TInput , typename TOutput >

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

Definition at line 46 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

template<typename TInput , typename TOutput >

using itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::NodeType = typename Superclass::NodeType

Definition at line 57 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

template<typename TInput , typename TOutput >

using itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::OutputPixelType = typename Superclass::OutputPixelType

Definition at line 56 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

template<typename TInput , typename TOutput >

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

Definition at line 45 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

template<typename TInput , typename TOutput >

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

Definition at line 43 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

template<typename TInput , typename TOutput >

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

Definition at line 44 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

template<typename TInput , typename TOutput >

using itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::Traits = typename Superclass::Traits

Definition at line 47 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Member Enumeration Documentation

template<typename TInput , typename TOutput >

enum itk::FastMarchingReachedTargetNodesStoppingCriterion::TargetConditionType

Enumerator
OneTarget
SomeTargets
AllTargets

Definition at line 60 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Constructor & Destructor Documentation

template<typename TInput , typename TOutput >

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

inlineprotected

Constructor

Definition at line 154 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

template<typename TInput , typename TOutput >

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

overrideprotecteddefault

Destructor

Member Function Documentation

template<typename TInput , typename TOutput >

virtual::itk::LightObject::Pointer itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::CreateAnother

(

)

const

template<typename TInput , typename TOutput >

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

inlineoverride

Get a short description of the stopping criterion.

Definition at line 146 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

template<typename TInput , typename TOutput >

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

virtual

Run-time type information (and related methods).

template<typename TInput , typename TOutput >

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

virtual

template<typename TInput , typename TOutput >

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

virtual

Set/Get TargetOffset

template<typename TInput , typename TOutput >

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

inlineprotected

Definition at line 180 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::AllTargets, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_Initialized, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_NumberOfTargetsToBeReached, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_ReachedTargetNodes, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_Satisfied, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_TargetCondition, itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_TargetNodes, and itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::OneTarget.

Referenced by itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::Reset(), and itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetCurrentNode().

template<typename TInput , typename TOutput >

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

inlineoverride

returns if the stopping condition is satisfied or not.

Definition at line 140 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

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

template<typename TInput , typename TOutput >

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

static

Method for creation through the object factory.

template<typename TInput , typename TOutput >

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

inlineoverrideprotected

Definition at line 175 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::Initialize().

template<typename TInput , typename TOutput >

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

inlineoverride

Set the current node.

Definition at line 98 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

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

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 82 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_Initialized, and itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_NumberOfTargetsToBeReached.

template<typename TInput , typename TOutput >

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

inline

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

Definition at line 66 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_Initialized, and itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_TargetCondition.

template<typename TInput , typename TOutput >

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

inlinevirtual

Set Target Nodes.

Definition at line 90 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

References itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_Initialized, and itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_TargetNodes.

template<typename TInput , typename TOutput >

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

virtual

Set/Get TargetOffset

Member Data Documentation

template<typename TInput , typename TOutput >

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

protected

Definition at line 173 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::Initialize(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetCurrentNode(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetNumberOfTargetsToBeReached(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetTargetCondition(), and itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetTargetNodes().

template<typename TInput , typename TOutput >

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

protected

Definition at line 169 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::Initialize(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetCurrentNode(), and itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetNumberOfTargetsToBeReached().

template<typename TInput , typename TOutput >

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

protected

Definition at line 168 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::Initialize(), and itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetCurrentNode().

template<typename TInput , typename TOutput >

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

protected

Definition at line 172 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::Initialize(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::IsSatisfied(), and itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetCurrentNode().

template<typename TInput , typename TOutput >

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

protected

Definition at line 171 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

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

template<typename TInput , typename TOutput >

TargetConditionType itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::m_TargetCondition

protected

Definition at line 166 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::Initialize(), and itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetTargetCondition().

template<typename TInput , typename TOutput >

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

protected

Definition at line 167 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::Initialize(), itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetCurrentNode(), and itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetTargetNodes().

template<typename TInput , typename TOutput >

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

protected

Definition at line 170 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

Referenced by itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::SetCurrentNode().

---

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

• itkFastMarchingReachedTargetNodesStoppingCriterion.h