ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput > Class Template Reference

#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 Pointer = SmartPointer< Self >
 
using Self = FastMarchingReachedTargetNodesStoppingCriterion
 
using Superclass = FastMarchingStoppingCriterionBase< TInput, TOutput >
 
using TargetConditionEnum = FastMarchingReachedTargetNodesStoppingCriterionEnums::TargetCondition
 

Public Member Functions

std::string GetDescription () const override
 
virtual const TargetConditionEnumGetTargetCondition () const
 
bool IsSatisfied () const override
 
 itkOverrideGetNameOfClassMacro (FastMarchingReachedTargetNodesStoppingCriterion)
 
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 void SetTargetOffset (OutputPixelType _arg)
 
virtual OutputPixelType GetTargetOffset ()
 

Static Public Member Functions

static Pointer New ()
 

Protected Member Functions

void Initialize ()
 
void Reset () override
 
 ~FastMarchingReachedTargetNodesStoppingCriterion () override=default
 
 FastMarchingReachedTargetNodesStoppingCriterion ()
 

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 {}
 

Member Typedef Documentation

◆ ConstPointer

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

◆ Pointer

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

◆ Self

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

◆ Superclass

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

◆ TargetConditionEnum

Constructor & Destructor Documentation

◆ FastMarchingReachedTargetNodesStoppingCriterion()

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

Constructor

Definition at line 181 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

◆ ~FastMarchingReachedTargetNodesStoppingCriterion()

template<typename TInput , typename TOutput >
itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::~FastMarchingReachedTargetNodesStoppingCriterion ( )
overrideprotecteddefault

Destructor

Member Function Documentation

◆ GetDescription()

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

Get a short description of the stopping criterion.

Definition at line 174 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

◆ GetTargetCondition()

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

◆ 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

◆ IsSatisfied()

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

◆ itkOverrideGetNameOfClassMacro()

template<typename TInput , typename TOutput >
itk::FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >::itkOverrideGetNameOfClassMacro ( FastMarchingReachedTargetNodesStoppingCriterion< TInput, TOutput >  )

Run-time type information (and related methods).

◆ 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 ( )
inlineoverrideprotected

◆ SetCurrentNode()

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

Set the current node.

Definition at line 127 of file itkFastMarchingReachedTargetNodesStoppingCriterion.h.

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

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

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

◆ 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

◆ m_NumberOfTargetsToBeReached

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

◆ m_ReachedTargetNodes

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

◆ m_Satisfied

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

◆ m_StoppingValue

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

◆ m_TargetCondition

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

◆ m_TargetNodes

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

◆ m_TargetOffset

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

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