ITK 6.0.0
Insight Toolkit
 
Loading...
Searching...
No Matches
itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput > Class Template Reference

#include <itkFastMarchingThresholdStoppingCriterion.h>

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.

Definition at line 35 of file itkFastMarchingThresholdStoppingCriterion.h.

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

Public Types

using ConstPointer = SmartPointer<const Self>
 
using NodeType
 
using OutputPixelType
 
using Pointer = SmartPointer<Self>
 
using Self = FastMarchingThresholdStoppingCriterion
 
using Superclass = FastMarchingStoppingCriterionBase<TInput, TOutput>
 
- 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
 
virtual void SetThreshold (OutputPixelType _arg)
 
virtual OutputPixelType GetThreshold ()
 
- Public Member Functions inherited from itk::FastMarchingStoppingCriterionBase< TInput, TOutput >
virtual const OutputDomainTypeGetDomain () const
 
virtual OutputDomainTypeGetModifiableDomain ()
 
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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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

 FastMarchingThresholdStoppingCriterion ()
 
void Reset () override
 
void SetCurrentNode (const NodeType &) override
 
 ~FastMarchingThresholdStoppingCriterion () 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

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

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 44 of file itkFastMarchingThresholdStoppingCriterion.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::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::Pointer = SmartPointer<Self>

Definition at line 43 of file itkFastMarchingThresholdStoppingCriterion.h.

◆ Self

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

Definition at line 41 of file itkFastMarchingThresholdStoppingCriterion.h.

◆ Superclass

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

Definition at line 42 of file itkFastMarchingThresholdStoppingCriterion.h.

Constructor & Destructor Documentation

◆ FastMarchingThresholdStoppingCriterion()

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

Definition at line 73 of file itkFastMarchingThresholdStoppingCriterion.h.

References m_Threshold.

Referenced by GetNameOfClass().

◆ ~FastMarchingThresholdStoppingCriterion()

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

Member Function Documentation

◆ CreateAnother()

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

◆ GetDescription()

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).
false else.

Implements itk::StoppingCriterionBase.

Definition at line 67 of file itkFastMarchingThresholdStoppingCriterion.h.

◆ GetNameOfClass()

template<typename TInput, typename TOutput>
const char * itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::GetNameOfClass ( ) const
overridevirtual

◆ GetThreshold()

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

Get/set the threshold used by the stopping criteria.

◆ IsSatisfied()

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).
false else.

Implements itk::StoppingCriterionBase.

Definition at line 61 of file itkFastMarchingThresholdStoppingCriterion.h.

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

◆ New()

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

Method for creation through the object factory.

◆ Reset()

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 87 of file itkFastMarchingThresholdStoppingCriterion.h.

◆ SetCurrentNode()

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

◆ SetThreshold()

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

◆ m_Threshold

template<typename TInput, typename TOutput>
OutputPixelType itk::FastMarchingThresholdStoppingCriterion< TInput, TOutput >::m_Threshold {}
protected

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