#include <itkLevelSetEquationChanAndVeseExternalTerm.h>

Detailed Description

template<typename TInput, typename TLevelSetContainer>
class itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >

Class to represent the external energy Chan And Vese term.

\[ \delta_{\epsilon}\left( \phi_{k}\left( p \right) \right) \cdot \prod_{i = 1, i \neq k}^{N} \left( 1 - H_{\epsilon} \left( \phi_i\left( p \right) \right) \right) \cdot \left\| I(p) - \mu_{out} \right\|^2 \]

\( \delta_{\epsilon} \) is a regularized dirac function,
\( k \) is the current level-set id,
\( I\left( p \right) \) is the pixel value at the given location \( p \),
\( H_{\epsilon} \) is a regularized Heaviside function,
\( \mu_{out} \) is the external mean intensity

Template Parameters

TInput	Input Image Type
TLevelSetContainer	Level set function container type

Definition at line 50 of file itkLevelSetEquationChanAndVeseExternalTerm.h.

Inheritance diagram for itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >:

Collaboration diagram for itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >:

Public Types
using	ConstPointer = SmartPointer<const Self>

using	DomainIteratorType = typename DomainMapImageFilterType::DomainMapType::const_iterator

using	IdListConstIterator = typename LevelSetContainerType::IdListConstIterator

using	IdListIterator = typename LevelSetContainerType::IdListIterator

using	IdListType = typename LevelSetContainerType::IdListType

using	Pointer = SmartPointer<Self>

using	Self = LevelSetEquationChanAndVeseExternalTerm

using	Superclass = LevelSetEquationChanAndVeseInternalTerm<TInput, TLevelSetContainer>

Public Types inherited from itk::LevelSetEquationChanAndVeseInternalTerm< TInput, TLevelSetContainer >
using	CacheImageType

using	ConstPointer = SmartPointer<const Self>

using	DomainMapImageFilterType

using	HeavisideConstPointer

using	HeavisideType

using	InputImagePointer

using	InputImageType

using	InputPixelRealType

using	InputPixelType

using	LevelSetContainerPointer

using	LevelSetContainerType

using	LevelSetDataType

using	LevelSetGradientType

using	LevelSetHessianType

using	LevelSetIdentifierType

using	LevelSetInputIndexType

using	LevelSetOutputPixelType

using	LevelSetOutputRealType

using	LevelSetPointer

using	LevelSetType

using	Pointer = SmartPointer<Self>

using	Self = LevelSetEquationChanAndVeseInternalTerm

using	Superclass = LevelSetEquationTermBase<TInput, TLevelSetContainer>

Public Types inherited from itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >
using	CacheImageType

using	CacheImageType

using	ConstPointer

using	ConstPointer

using	DomainMapImageFilterType

using	DomainMapImageFilterType

using	HeavisideConstPointer

using	HeavisideConstPointer

using	HeavisideType

using	HeavisideType

using	InputImagePointer

using	InputImagePointer

using	InputImageType

using	InputImageType

using	InputPixelRealType

using	InputPixelRealType

using	InputPixelType

using	InputPixelType

using	LevelSetContainerPointer

using	LevelSetContainerPointer

using	LevelSetContainerType

using	LevelSetContainerType

using	LevelSetDataType

using	LevelSetDataType

using	LevelSetGradientType

using	LevelSetGradientType

using	LevelSetHessianType

using	LevelSetHessianType

using	LevelSetIdentifierType

using	LevelSetIdentifierType

using	LevelSetInputIndexType

using	LevelSetInputIndexType

using	LevelSetOutputPixelType

using	LevelSetOutputPixelType

using	LevelSetOutputRealType

using	LevelSetOutputRealType

using	LevelSetPointer

using	LevelSetPointer

using	LevelSetType

using	LevelSetType

using	Pointer

using	Pointer

using	RequiredDataType

using	RequiredDataType

using	Self

using	Self

using	Superclass

using	Superclass

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	ComputeProduct (const LevelSetInputIndexType &iP, LevelSetOutputRealType &prod) override

void	ComputeProductTerm (const LevelSetInputIndexType &iP, LevelSetOutputRealType &prod) override

virtual::itk::LightObject::Pointer	CreateAnother () const

virtual const char *	GetNameOfClass () const

void	UpdatePixel (const LevelSetInputIndexType &iP, const LevelSetOutputRealType &oldValue, const LevelSetOutputRealType &newValue) override

Public Member Functions inherited from itk::LevelSetEquationChanAndVeseInternalTerm< TInput, TLevelSetContainer >
virtual::itk::LightObject::Pointer	CreateAnother () const

virtual InputPixelRealType	GetMean ()

void	Initialize (const LevelSetInputIndexType &inputIndex) override

void	InitializeParameters () override

virtual void	SetMean (InputPixelRealType _arg)

void	Update () override

void	UpdatePixel (const LevelSetInputIndexType &inputIndex, const LevelSetOutputRealType &oldValue, const LevelSetOutputRealType &newValue) override

Public Member Functions inherited from itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >
virtual LevelSetOutputRealType	Evaluate (const LevelSetInputIndexType &iP)

virtual LevelSetOutputRealType	Evaluate (const LevelSetInputIndexType &iP)

virtual LevelSetOutputRealType	Evaluate (const LevelSetInputIndexType &iP, const LevelSetDataType &iData)

virtual LevelSetOutputRealType	Evaluate (const LevelSetInputIndexType &iP, const LevelSetDataType &iData)

virtual LevelSetOutputRealType	GetCFLContribution () const

virtual LevelSetOutputRealType	GetCFLContribution () const

virtual LevelSetOutputRealType	GetCoefficient ()

virtual LevelSetOutputRealType	GetCoefficient ()

virtual LevelSetIdentifierType	GetCurrentLevelSetId ()

virtual LevelSetIdentifierType	GetCurrentLevelSetId ()

virtual const LevelSetType *	GetCurrentLevelSetPointer () const

virtual const LevelSetType *	GetCurrentLevelSetPointer () const

virtual const LevelSetContainerType *	GetLevelSetContainer () const

virtual const LevelSetContainerType *	GetLevelSetContainer () const

virtual LevelSetType *	GetModifiableCurrentLevelSetPointer ()

virtual LevelSetType *	GetModifiableCurrentLevelSetPointer ()

virtual LevelSetContainerType *	GetModifiableLevelSetContainer ()

virtual LevelSetContainerType *	GetModifiableLevelSetContainer ()

const RequiredDataType &	GetRequiredData () const

const RequiredDataType &	GetRequiredData () const

virtual void	SetCoefficient (LevelSetOutputRealType _arg)

virtual void	SetCoefficient (LevelSetOutputRealType _arg)

virtual void	SetCurrentLevelSetId (LevelSetIdentifierType _arg)

virtual void	SetCurrentLevelSetId (LevelSetIdentifierType _arg)

virtual void	SetLevelSetContainer (LevelSetContainerType *iContainer)

virtual void	SetLevelSetContainer (LevelSetContainerType *iContainer)

virtual void	SetInput (InputImageType *_arg)

virtual InputImageType *	GetModifiableInput ()

virtual const InputImageType *	GetInput () const

virtual void	SetInput (InputImageType *_arg)

virtual InputImageType *	GetModifiableInput ()

virtual const InputImageType *	GetInput () const

virtual void	SetTermName (const char *_arg)

virtual const char *	GetTermName () const

virtual void	SetTermName (const char *_arg)

virtual const char *	GetTermName () const

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

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) 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::LevelSetEquationChanAndVeseInternalTerm< TInput, TLevelSetContainer >
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
	LevelSetEquationChanAndVeseExternalTerm ()

	~LevelSetEquationChanAndVeseExternalTerm () override=default

Protected Member Functions inherited from itk::LevelSetEquationChanAndVeseInternalTerm< TInput, TLevelSetContainer >
void	Accumulate (const InputPixelType &inputPixel, const LevelSetOutputRealType &heavisideValue)

	LevelSetEquationChanAndVeseInternalTerm ()

LevelSetOutputRealType	Value (const LevelSetInputIndexType &inputIndex) override

LevelSetOutputRealType	Value (const LevelSetInputIndexType &inputIndex, const LevelSetDataType &data) override

	~LevelSetEquationChanAndVeseInternalTerm () override=default

Protected Member Functions inherited from itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >
	LevelSetEquationTermBase ()

	LevelSetEquationTermBase ()

void	SetUp ()

void	SetUp ()

	~LevelSetEquationTermBase () override=default

	~LevelSetEquationTermBase () 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 ()

Private Attributes
CacheImageType *	m_CacheImage {}

DomainMapImageFilterType *	m_DomainMapImageFilter {}

Additional Inherited Members
Protected Attributes inherited from itk::LevelSetEquationChanAndVeseInternalTerm< TInput, TLevelSetContainer >
InputPixelRealType	m_Mean {}

LevelSetOutputRealType	m_TotalH {}

InputPixelRealType	m_TotalValue {}

Protected Attributes inherited from itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >
LevelSetOutputRealType	m_CFLContribution

LevelSetOutputRealType	m_CFLContribution

LevelSetOutputRealType	m_Coefficient

LevelSetOutputRealType	m_Coefficient

LevelSetIdentifierType	m_CurrentLevelSetId

LevelSetIdentifierType	m_CurrentLevelSetId

LevelSetPointer	m_CurrentLevelSetPointer

LevelSetPointer	m_CurrentLevelSetPointer

HeavisideConstPointer	m_Heaviside

HeavisideConstPointer	m_Heaviside

InputImagePointer	m_Input

InputImagePointer	m_Input

LevelSetContainerPointer	m_LevelSetContainer

LevelSetContainerPointer	m_LevelSetContainer

RequiredDataType	m_RequiredData

RequiredDataType	m_RequiredData

std::string	m_TermName

std::string	m_TermName

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

Member Typedef Documentation

◆ ConstPointer

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::ConstPointer = SmartPointer<const Self>

Definition at line 58 of file itkLevelSetEquationChanAndVeseExternalTerm.h.

◆ DomainIteratorType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::DomainIteratorType = typename DomainMapImageFilterType::DomainMapType::const_iterator

Definition at line 86 of file itkLevelSetEquationChanAndVeseExternalTerm.h.

◆ IdListConstIterator

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::IdListConstIterator = typename LevelSetContainerType::IdListConstIterator

Definition at line 90 of file itkLevelSetEquationChanAndVeseExternalTerm.h.

◆ IdListIterator

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::IdListIterator = typename LevelSetContainerType::IdListIterator

Definition at line 89 of file itkLevelSetEquationChanAndVeseExternalTerm.h.

◆ IdListType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::IdListType = typename LevelSetContainerType::IdListType

Definition at line 88 of file itkLevelSetEquationChanAndVeseExternalTerm.h.

◆ Pointer

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::Pointer = SmartPointer<Self>

Definition at line 57 of file itkLevelSetEquationChanAndVeseExternalTerm.h.

◆ Self

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::Self = LevelSetEquationChanAndVeseExternalTerm

Definition at line 56 of file itkLevelSetEquationChanAndVeseExternalTerm.h.

◆ Superclass

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::Superclass = LevelSetEquationChanAndVeseInternalTerm<TInput, TLevelSetContainer>

Definition at line 59 of file itkLevelSetEquationChanAndVeseExternalTerm.h.

Constructor & Destructor Documentation

◆ LevelSetEquationChanAndVeseExternalTerm()

template<typename TInput, typename TLevelSetContainer>

itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::LevelSetEquationChanAndVeseExternalTerm ( )

protected

Referenced by GetNameOfClass().

◆ ~LevelSetEquationChanAndVeseExternalTerm()

template<typename TInput, typename TLevelSetContainer>

itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::~LevelSetEquationChanAndVeseExternalTerm ( )

overrideprotecteddefault

Member Function Documentation

◆ ComputeProduct()

template<typename TInput, typename TLevelSetContainer>

void itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::ComputeProduct	(	const LevelSetInputIndexType &	iP,
		LevelSetOutputRealType &	prod )

overridevirtual

Compute the product of Heaviside functions in the multi-levelset cases

Reimplemented from itk::LevelSetEquationChanAndVeseInternalTerm< TInput, TLevelSetContainer >.

◆ ComputeProductTerm()

template<typename TInput, typename TLevelSetContainer>

void itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::ComputeProductTerm	(	const LevelSetInputIndexType &	iP,
		LevelSetOutputRealType &	prod )

overridevirtual

Compute the product of Heaviside functions in the multi-levelset cases except the current levelset

Reimplemented from itk::LevelSetEquationChanAndVeseInternalTerm< TInput, TLevelSetContainer >.

◆ CreateAnother()

template<typename TInput, typename TLevelSetContainer>

virtual::itk::LightObject::Pointer itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::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.

◆ GetNameOfClass()

template<typename TInput, typename TLevelSetContainer>

virtual const char * itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::GetNameOfClass ( ) const

virtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LevelSetEquationChanAndVeseInternalTerm< TInput, TLevelSetContainer >.

References LevelSetEquationChanAndVeseExternalTerm().

◆ New()

template<typename TInput, typename TLevelSetContainer>

static Pointer itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::New ( )

static

Method for creation through object factory

◆ UpdatePixel()

template<typename TInput, typename TLevelSetContainer>

void itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::UpdatePixel	(	const LevelSetInputIndexType &	iP,
		const LevelSetOutputRealType &	oldValue,
		const LevelSetOutputRealType &	newValue )

overridevirtual

Supply updates at pixels to keep the term parameters always updated

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

Member Data Documentation

◆ m_CacheImage

template<typename TInput, typename TLevelSetContainer>

CacheImageType* itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::m_CacheImage {}

private

Definition at line 116 of file itkLevelSetEquationChanAndVeseExternalTerm.h.

◆ m_DomainMapImageFilter

template<typename TInput, typename TLevelSetContainer>

DomainMapImageFilterType* itk::LevelSetEquationChanAndVeseExternalTerm< TInput, TLevelSetContainer >::m_DomainMapImageFilter {}

private

Definition at line 115 of file itkLevelSetEquationChanAndVeseExternalTerm.h.

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

itkLevelSetEquationChanAndVeseExternalTerm.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ DomainIteratorType

◆ IdListConstIterator

◆ IdListIterator

◆ IdListType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ LevelSetEquationChanAndVeseExternalTerm()

◆ ~LevelSetEquationChanAndVeseExternalTerm()

Member Function Documentation

◆ ComputeProduct()

◆ ComputeProductTerm()

◆ CreateAnother()

◆ GetNameOfClass()

◆ New()

◆ UpdatePixel()

Member Data Documentation

◆ m_CacheImage

◆ m_DomainMapImageFilter