ITK  4.6.0
Insight Segmentation and Registration Toolkit
Classes | Public Types | Public Member Functions | Static Public Member Functions | Protected Types | Protected Member Functions | Protected Attributes | Private Member Functions | Friends | List of all members
itk::LevelSetEquationContainer< TTermContainer > Class Template Reference

#include <itkLevelSetEquationContainer.h>

+ Inheritance diagram for itk::LevelSetEquationContainer< TTermContainer >:
+ Collaboration diagram for itk::LevelSetEquationContainer< TTermContainer >:

Detailed Description

template<typename TTermContainer>
class itk::LevelSetEquationContainer< TTermContainer >

Class for holding a set of level set equations (PDEs).

Template Parameters
TTermContainerContainer holding the terms in a level set equation

Evolving level-set functions $\left\{ \phi_j \right\}_{j=1}^{M}$ can be expressed as follows:

\begin{eqnarray*} \frac{\partial \phi_1(p)}{\partial \tau} &=& \sum\limits_{i=1}^{N_1} \alpha_{i1} \cdot \omega_{i1}(p) \\ \frac{\partial \phi_2(p)}{\partial \tau} &=& \sum\limits_{i=1}^{N_2} \alpha_{i2} \cdot \omega_{i2}(p) \\ & \vdots & \\ \frac{\partial \phi_M(p)}{\partial \tau} &=& \sum\limits_{i=1}^{N_M} \alpha_{iM} \cdot \omega_{iM}(p) \end{eqnarray*}

where $\omega_{iM}$ is a term which could depend on any of the level-set functions $\left\{ \phi_j \right\}_{j=1}^{M}$ , the input image, and $\alpha_{iM}$ is a weight to balance the contribution of each term in the PDE.

Each equation of this system of equation (PDE) is referred as an equation in the level-set framework. Each equation $ equation_{j} $ contributes to the evolution of the level-set function $ \phi_j $.

See Also
LevelSetEquationTerm

Definition at line 58 of file itkLevelSetEquationContainer.h.

Classes

class  ConstIterator
 
class  Iterator
 

Public Types

typedef SmartPointer< const SelfConstPointer
 
typedef
TermContainerType::InputImagePointer 
InputImagePointer
 
typedef
TermContainerType::InputImageType 
InputImageType
 
typedef
TermContainerType::LevelSetContainerPointer 
LevelSetContainerPointer
 
typedef
TermContainerType::LevelSetContainerType 
LevelSetContainerType
 
typedef
TermContainerType::LevelSetIdentifierType 
LevelSetIdentifierType
 
typedef
TermContainerType::LevelSetInputIndexType 
LevelSetInputIndexType
 
typedef
TermContainerType::LevelSetOutputRealType 
LevelSetOutputRealType
 
typedef SmartPointer< SelfPointer
 
typedef LevelSetEquationContainer Self
 
typedef Object Superclass
 
typedef TermContainerType::Pointer TermContainerPointer
 
typedef TTermContainer TermContainerType
 
- Public Types inherited from itk::Object
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef Object Self
 
typedef LightObject Superclass
 
- Public Types inherited from itk::LightObject
typedef SmartPointer< const SelfConstPointer
 
typedef SmartPointer< SelfPointer
 
typedef LightObject Self
 

Public Member Functions

void AddEquation (const LevelSetIdentifierType &iId, TermContainerType *iEquation)
 
Iterator Begin ()
 
ConstIterator Begin () const
 
LevelSetOutputRealType ComputeCFLContribution () const
 
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
Iterator End ()
 
ConstIterator End () const
 
TermContainerTypeGetEquation (const LevelSetIdentifierType &iId) const
 
virtual const
LevelSetContainerType
GetLevelSetContainer () const
 
virtual LevelSetContainerTypeGetModifiableLevelSetContainer ()
 
virtual const char * GetNameOfClass () const
 
void InitializeParameters ()
 
virtual void SetLevelSetContainer (LevelSetContainerType *_arg)
 
void UpdateInternalEquationTerms ()
 
void UpdatePixel (const LevelSetInputIndexType &iP, const LevelSetOutputRealType &oldValue, const LevelSetOutputRealType &newValue)
 
virtual void SetInput (InputImageType *_arg)
 
virtual InputImageTypeGetModifiableInput ()
 
virtual const InputImageTypeGetInput () 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
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary (void)
 
const MetaDataDictionaryGetMetaDataDictionary (void) 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
 
virtual void Register () const ITK_OVERRIDE
 
void RemoveAllObservers ()
 
void RemoveObserver (unsigned long tag)
 
void SetDebug (bool debugFlag) const
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
virtual void SetReferenceCount (int) ITK_OVERRIDE
 
virtual void UnRegister () const ITK_OVERRIDE
 
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 Types

typedef
MapContainerType::const_iterator 
MapContainerConstIterator
 
typedef MapContainerType::iterator MapContainerIterator
 
typedef std::map
< LevelSetIdentifierType,
TermContainerPointer
MapContainerType
 
- Protected Types inherited from itk::LightObject
typedef int InternalReferenceCountType
 

Protected Member Functions

 LevelSetEquationContainer ()
 
virtual ~LevelSetEquationContainer ()
 
- 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 ITK_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

MapContainerType m_Container
 
InputImagePointer m_Input
 
LevelSetContainerPointer m_LevelSetContainer
 
- Protected Attributes inherited from itk::LightObject
InternalReferenceCountType m_ReferenceCount
 
SimpleFastMutexLock m_ReferenceCountLock
 

Private Member Functions

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

Friends

class Iterator
 

Member Typedef Documentation

template<typename TTermContainer >
typedef SmartPointer< const Self > itk::LevelSetEquationContainer< TTermContainer >::ConstPointer

Definition at line 63 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef TermContainerType::InputImagePointer itk::LevelSetEquationContainer< TTermContainer >::InputImagePointer

Definition at line 77 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef TermContainerType::InputImageType itk::LevelSetEquationContainer< TTermContainer >::InputImageType

Definition at line 76 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef TermContainerType::LevelSetContainerPointer itk::LevelSetEquationContainer< TTermContainer >::LevelSetContainerPointer

Definition at line 84 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef TermContainerType::LevelSetContainerType itk::LevelSetEquationContainer< TTermContainer >::LevelSetContainerType

Definition at line 83 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef TermContainerType::LevelSetIdentifierType itk::LevelSetEquationContainer< TTermContainer >::LevelSetIdentifierType

Definition at line 82 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef TermContainerType::LevelSetInputIndexType itk::LevelSetEquationContainer< TTermContainer >::LevelSetInputIndexType

Definition at line 80 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef TermContainerType::LevelSetOutputRealType itk::LevelSetEquationContainer< TTermContainer >::LevelSetOutputRealType

Definition at line 79 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef MapContainerType::const_iterator itk::LevelSetEquationContainer< TTermContainer >::MapContainerConstIterator
protected

Definition at line 118 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef MapContainerType::iterator itk::LevelSetEquationContainer< TTermContainer >::MapContainerIterator
protected

Definition at line 117 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef std::map< LevelSetIdentifierType, TermContainerPointer > itk::LevelSetEquationContainer< TTermContainer >::MapContainerType
protected

Definition at line 113 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef SmartPointer< Self > itk::LevelSetEquationContainer< TTermContainer >::Pointer

Definition at line 62 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef LevelSetEquationContainer itk::LevelSetEquationContainer< TTermContainer >::Self

Definition at line 61 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef Object itk::LevelSetEquationContainer< TTermContainer >::Superclass

Definition at line 64 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef TermContainerType::Pointer itk::LevelSetEquationContainer< TTermContainer >::TermContainerPointer

Definition at line 74 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
typedef TTermContainer itk::LevelSetEquationContainer< TTermContainer >::TermContainerType

Definition at line 71 of file itkLevelSetEquationContainer.h.

Constructor & Destructor Documentation

template<typename TTermContainer >
itk::LevelSetEquationContainer< TTermContainer >::LevelSetEquationContainer ( )
protected
template<typename TTermContainer >
virtual itk::LevelSetEquationContainer< TTermContainer >::~LevelSetEquationContainer ( )
protectedvirtual
template<typename TTermContainer >
itk::LevelSetEquationContainer< TTermContainer >::LevelSetEquationContainer ( const Self )
private

Member Function Documentation

template<typename TTermContainer >
void itk::LevelSetEquationContainer< TTermContainer >::AddEquation ( const LevelSetIdentifierType iId,
TermContainerType iEquation 
)

Add a equation to the system of equations in the EquationContainer map

template<typename TTermContainer >
Iterator itk::LevelSetEquationContainer< TTermContainer >::Begin ( )
template<typename TTermContainer >
ConstIterator itk::LevelSetEquationContainer< TTermContainer >::Begin ( ) const
template<typename TTermContainer >
LevelSetOutputRealType itk::LevelSetEquationContainer< TTermContainer >::ComputeCFLContribution ( ) const

Returns the Courant-Friedrichs-Lewy (CFL) contribution for all the equations

template<typename TTermContainer >
virtual::itk::LightObject::Pointer itk::LevelSetEquationContainer< TTermContainer >::CreateAnother ( void  ) 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 TTermContainer >
Iterator itk::LevelSetEquationContainer< TTermContainer >::End ( )
template<typename TTermContainer >
ConstIterator itk::LevelSetEquationContainer< TTermContainer >::End ( ) const
template<typename TTermContainer >
TermContainerType* itk::LevelSetEquationContainer< TTermContainer >::GetEquation ( const LevelSetIdentifierType iId) const

Return a pointer to the equation of given id

template<typename TTermContainer >
virtual const InputImageType* itk::LevelSetEquationContainer< TTermContainer >::GetInput ( ) const
virtual

Set/Get the input speed or feature image

template<typename TTermContainer >
virtual const LevelSetContainerType* itk::LevelSetEquationContainer< TTermContainer >::GetLevelSetContainer ( ) const
virtual
template<typename TTermContainer >
virtual InputImageType* itk::LevelSetEquationContainer< TTermContainer >::GetModifiableInput ( )
virtual

Set/Get the input speed or feature image

template<typename TTermContainer >
virtual LevelSetContainerType* itk::LevelSetEquationContainer< TTermContainer >::GetModifiableLevelSetContainer ( )
virtual
template<typename TTermContainer >
virtual const char* itk::LevelSetEquationContainer< TTermContainer >::GetNameOfClass ( ) const
virtual

Run-time type information

Reimplemented from itk::Object.

template<typename TTermContainer >
void itk::LevelSetEquationContainer< TTermContainer >::InitializeParameters ( )

Initialize parameters in the terms of all the equations

template<typename TTermContainer >
static Pointer itk::LevelSetEquationContainer< TTermContainer >::New ( )
static

Method for creation through object factory

template<typename TTermContainer >
void itk::LevelSetEquationContainer< TTermContainer >::operator= ( const Self )
private
template<typename TTermContainer >
virtual void itk::LevelSetEquationContainer< TTermContainer >::SetInput ( InputImageType _arg)
virtual

Set/Get the input speed or feature image

template<typename TTermContainer >
virtual void itk::LevelSetEquationContainer< TTermContainer >::SetLevelSetContainer ( LevelSetContainerType _arg)
virtual
template<typename TTermContainer >
void itk::LevelSetEquationContainer< TTermContainer >::UpdateInternalEquationTerms ( )

Update the equation container recursively by calling update on individual equations

template<typename TTermContainer >
void itk::LevelSetEquationContainer< TTermContainer >::UpdatePixel ( const LevelSetInputIndexType iP,
const LevelSetOutputRealType oldValue,
const LevelSetOutputRealType newValue 
)

Supply the update at a given pixel index to update the terms

Friends And Related Function Documentation

template<typename TTermContainer >
friend class Iterator
friend

Definition at line 121 of file itkLevelSetEquationContainer.h.

Member Data Documentation

template<typename TTermContainer >
MapContainerType itk::LevelSetEquationContainer< TTermContainer >::m_Container
protected

Definition at line 261 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
InputImagePointer itk::LevelSetEquationContainer< TTermContainer >::m_Input
protected

Definition at line 262 of file itkLevelSetEquationContainer.h.

template<typename TTermContainer >
LevelSetContainerPointer itk::LevelSetEquationContainer< TTermContainer >::m_LevelSetContainer
protected

Definition at line 260 of file itkLevelSetEquationContainer.h.


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