ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Private Member Functions | List of all members
itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput > Class Template Reference
Module ITKFastMarching

#include <itkFastMarchingNumberOfElementsStoppingCriterion.h>

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

Detailed Description

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

Stopping Criterion is verified when Current Number of Elements is equal to or greater than the provided Target Number Of Elements.

Note
For itk::Image, one element is one pixel. So the number of elements is directly linked to the physical size of the object, i.e. $ PhysicalSize = TargetNumberOfElements \cdot \prod_{i=1}{dim} Spacing_{i} $
For itk::QuadEdgeMesh, one element is one vertex.

Definition at line 41 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

Public Types

typedef SmartPointer< const Self > ConstPointer
 
typedef Superclass::NodeType NodeType
 
typedef Superclass::OutputPixelType OutputPixelType
 
typedef SmartPointer< Self > Pointer
 
typedef
FastMarchingNumberOfElementsStoppingCriterion 		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 SetTargetNumberOfElements (IdentifierType _arg)
 
virtual IdentifierType GetTargetNumberOfElements ()
 
- 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

 FastMarchingNumberOfElementsStoppingCriterion ()
 
void Reset () override
 
void SetCurrentNode (const NodeType &) override
 
 ~FastMarchingNumberOfElementsStoppingCriterion ()
 
- Protected Member Functions inherited from itk::FastMarchingStoppingCriterionBase< TInput, TOutput >
virtual void SetCurrentNode (const NodeType &iNode)=0
 
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

IdentifierType m_CurrentNumberOfElements
 
IdentifierType m_TargetNumberOfElements
 
- 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

 FastMarchingNumberOfElementsStoppingCriterion (const Self &)
 
void operator= (const Self &)
 

Member Typedef Documentation

template<typename TInput , typename TOutput >
typedef SmartPointer< const Self > itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::ConstPointer

Definition at line 48 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

template<typename TInput , typename TOutput >
typedef Superclass::NodeType itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::NodeType

Definition at line 58 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

template<typename TInput , typename TOutput >
typedef Superclass::OutputPixelType itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::OutputPixelType

Definition at line 55 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

template<typename TInput , typename TOutput >
typedef SmartPointer< Self > itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::Pointer

Definition at line 47 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

template<typename TInput , typename TOutput >
typedef FastMarchingNumberOfElementsStoppingCriterion itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::Self

Definition at line 45 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

template<typename TInput , typename TOutput >
typedef FastMarchingStoppingCriterionBase< TInput, TOutput > itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::Superclass

Definition at line 46 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

Constructor & Destructor Documentation

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

Definition at line 76 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

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

Definition at line 81 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

template<typename TInput , typename TOutput >
itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::FastMarchingNumberOfElementsStoppingCriterion ( const Self &  )
private

Member Function Documentation

template<typename TInput , typename TOutput >
virtual::itk::LightObject::Pointer itk::FastMarchingNumberOfElementsStoppingCriterion< 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::FastMarchingNumberOfElementsStoppingCriterion< 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 70 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

template<typename TInput , typename TOutput >
virtual const char* itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods).

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

template<typename TInput , typename TOutput >
virtual IdentifierType itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::GetTargetNumberOfElements ( )
virtual

Get/set the threshold used by the stopping criteria.

template<typename TInput , typename TOutput >
bool itk::FastMarchingNumberOfElementsStoppingCriterion< 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 65 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

References itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::m_CurrentNumberOfElements, and itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::m_TargetNumberOfElements.

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

Method for creation through the object factory.

template<typename TInput , typename TOutput >
void itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::operator= ( const Self &  )
private
template<typename TInput , typename TOutput >
void itk::FastMarchingNumberOfElementsStoppingCriterion< 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 91 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

References itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::m_CurrentNumberOfElements, and itk::NumericTraits< T >::ZeroValue().

template<typename TInput , typename TOutput >
void itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::SetCurrentNode ( const NodeType &  )
inlineoverrideprotected

Definition at line 86 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

References itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::m_CurrentNumberOfElements.

template<typename TInput , typename TOutput >
virtual void itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::SetTargetNumberOfElements ( IdentifierType  _arg)
virtual

Get/set the threshold used by the stopping criteria.

Member Data Documentation

template<typename TInput , typename TOutput >
IdentifierType itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::m_CurrentNumberOfElements
protected

Definition at line 83 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

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

template<typename TInput , typename TOutput >
IdentifierType itk::FastMarchingNumberOfElementsStoppingCriterion< TInput, TOutput >::m_TargetNumberOfElements
protected

Definition at line 84 of file itkFastMarchingNumberOfElementsStoppingCriterion.h.

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

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Fri Jul 3 2015 04:15:17 for ITK by   doxygen 1.8.5