#include <itkLevelSetEquationContainer.h>

Detailed Description

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

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

Template Parameters

TTermContainer Container 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

Examples: SphinxExamples/src/Bridge/VtkGlue/VisualizeEvolvingDense2DLevelSetAsElevationMap/Code.cxx, and SphinxExamples/src/Bridge/VtkGlue/VisualizeEvolvingDense2DLevelSetZeroSet/Code.cxx.

Definition at line 58 of file itkLevelSetEquationContainer.h.

Inheritance diagram for itk::LevelSetEquationContainer< TTermContainer >:

Collaboration diagram for itk::LevelSetEquationContainer< TTermContainer >:

Classes
class	ConstIterator

class	Iterator

Public Types
using	ConstPointer = SmartPointer< const Self >

using	InputImagePointer = typename TermContainerType::InputImagePointer

using	InputImageType = typename TermContainerType::InputImageType

using	LevelSetContainerPointer = typename TermContainerType::LevelSetContainerPointer

using	LevelSetContainerType = typename TermContainerType::LevelSetContainerType

using	LevelSetIdentifierType = typename TermContainerType::LevelSetIdentifierType

using	LevelSetInputIndexType = typename TermContainerType::LevelSetInputIndexType

using	LevelSetOutputRealType = typename TermContainerType::LevelSetOutputRealType

using	Pointer = SmartPointer< Self >

using	Self = LevelSetEquationContainer

using	Superclass = Object

using	TermContainerPointer = typename TermContainerType::Pointer

using	TermContainerType = TTermContainer

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
void	AddEquation (const LevelSetIdentifierType &iId, TermContainerType *iEquation)

Iterator	Begin ()

ConstIterator	Begin () const

LevelSetOutputRealType	ComputeCFLContribution () const

Iterator	End ()

ConstIterator	End () const

TermContainerType *	GetEquation (const LevelSetIdentifierType &iId) const

virtual LevelSetContainerType *	GetModifiableLevelSetContainer ()

const char *	GetNameOfClass () const override

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 InputImageType *	GetModifiableInput ()

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *)

unsigned long	AddObserver (const EventObject &event, Command *) 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

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

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

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 Types
using	MapContainerConstIterator = typename MapContainerType::const_iterator

using	MapContainerIterator = typename MapContainerType::iterator

using	MapContainerType = std::map< LevelSetIdentifierType, TermContainerPointer >

Protected Member Functions
	LevelSetEquationContainer ()=default

	~LevelSetEquationContainer () override=default

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

InputImagePointer	m_Input {}

LevelSetContainerPointer	m_LevelSetContainer {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Friends
class	Iterator