#include <itkLevelSetEquationOverlapPenaltyTerm.h>

Detailed Description

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

Class to represent the overlap penalty among many level-sets.

\[ \sum_{i \neq j } \left(H_{\epsilon}\left(\phi_j \left( p \right) \right)\right) \]

\( i \) is the current level-set id,
\( j \) is any level-set id,
\( p \) is the given location,
\( H_{\epsilon} \) is regularized Heaviside function.

Template Parameters

TInput	Input Image Type
TLevelSetContainer	Level set function container type

Definition at line 47 of file itkLevelSetEquationOverlapPenaltyTerm.h.

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

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

Public Types
using	CompensatedSummationType = CompensatedSummation< LevelSetOutputRealType >

using	ConstPointer = SmartPointer< const Self >

using	IdListConstIterator = typename LevelSetContainerType::IdListConstIterator

using	IdListIterator = typename LevelSetContainerType::IdListIterator

using	IdListType = typename LevelSetContainerType::IdListType

using	Pointer = SmartPointer< Self >

using	Self = LevelSetEquationOverlapPenaltyTerm

using	Superclass = LevelSetEquationTermBase< TInput, TLevelSetContainer >

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

using	ConstPointer = SmartPointer< const Self >

using	DomainMapImageFilterType = typename LevelSetContainerType::DomainMapImageFilterType

using	HeavisideConstPointer = typename HeavisideType::ConstPointer

using	HeavisideType = HeavisideStepFunctionBase< LevelSetOutputRealType, LevelSetOutputRealType >

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageType = TInput

using	InputPixelRealType = typename NumericTraits< InputPixelType >::RealType

using	InputPixelType = typename InputImageType::PixelType

using	LevelSetContainerPointer = typename LevelSetContainerType::Pointer

using	LevelSetContainerType = TLevelSetContainer

using	LevelSetDataType = typename LevelSetContainerType::LevelSetDataType

using	LevelSetGradientType = typename LevelSetContainerType::GradientType

using	LevelSetHessianType = typename LevelSetContainerType::HessianType

using	LevelSetIdentifierType = typename LevelSetContainerType::LevelSetIdentifierType

using	LevelSetInputIndexType = typename LevelSetContainerType::InputIndexType

using	LevelSetOutputPixelType = typename LevelSetContainerType::OutputType

using	LevelSetOutputRealType = typename LevelSetContainerType::OutputRealType

using	LevelSetPointer = typename LevelSetContainerType::LevelSetPointer

using	LevelSetType = typename LevelSetContainerType::LevelSetType

using	Pointer = SmartPointer< Self >

using	RequiredDataType = std::unordered_set< std::string >

using	Self = LevelSetEquationTermBase

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 void	ComputeSumTerm (const LevelSetInputIndexType &index, LevelSetOutputRealType &sum)

const char *	GetNameOfClass () const override

void	Initialize (const LevelSetInputIndexType &index) override

void	InitializeParameters () override

void	Update () override

void	UpdatePixel (const LevelSetInputIndexType &index, 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, const LevelSetDataType &iData)

virtual LevelSetOutputRealType	GetCFLContribution () const

virtual LevelSetOutputRealType	GetCoefficient ()

virtual LevelSetIdentifierType	GetCurrentLevelSetId ()

virtual LevelSetType *	GetModifiableCurrentLevelSetPointer ()

virtual LevelSetContainerType *	GetModifiableLevelSetContainer ()

const char *	GetNameOfClass () const override

const RequiredDataType &	GetRequiredData () const

virtual void	Initialize (const LevelSetInputIndexType &iP)=0

virtual void	InitializeParameters ()=0

virtual void	SetCoefficient (LevelSetOutputRealType _arg)

virtual void	SetCurrentLevelSetId (LevelSetIdentifierType _arg)

virtual void	SetLevelSetContainer (LevelSetContainerType *iContainer)

virtual void	Update ()=0

virtual void	UpdatePixel (const LevelSetInputIndexType &iP, const LevelSetOutputRealType &oldValue, const LevelSetOutputRealType &newValue)=0

virtual void	SetInput (InputImageType *_arg)

virtual InputImageType *	GetModifiableInput ()

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 *)

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

const char *	GetNameOfClass () const override

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 Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

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
	LevelSetEquationOverlapPenaltyTerm ()

LevelSetOutputRealType	Value (const LevelSetInputIndexType &index) override

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

	~LevelSetEquationOverlapPenaltyTerm () override=default

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

void	SetUp ()

virtual LevelSetOutputRealType	Value (const LevelSetInputIndexType &iP)=0

virtual LevelSetOutputRealType	Value (const LevelSetInputIndexType &iP, const LevelSetDataType &iData)=0

	~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	PrintSelf (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::LevelSetEquationTermBase< TInput, TLevelSetContainer >
LevelSetOutputRealType	m_CFLContribution

LevelSetOutputRealType	m_Coefficient

LevelSetIdentifierType	m_CurrentLevelSetId

LevelSetPointer	m_CurrentLevelSetPointer

HeavisideConstPointer	m_Heaviside

InputImagePointer	m_Input

LevelSetContainerPointer	m_LevelSetContainer

RequiredDataType	m_RequiredData

std::string	m_TermName

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

Member Typedef Documentation

◆ CompensatedSummationType

template<typename TInput , typename TLevelSetContainer >

using itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::CompensatedSummationType = CompensatedSummation<LevelSetOutputRealType>

Definition at line 93 of file itkLevelSetEquationOverlapPenaltyTerm.h.

◆ ConstPointer

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 56 of file itkLevelSetEquationOverlapPenaltyTerm.h.

◆ IdListConstIterator

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 91 of file itkLevelSetEquationOverlapPenaltyTerm.h.

◆ IdListIterator

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 90 of file itkLevelSetEquationOverlapPenaltyTerm.h.

◆ IdListType

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 89 of file itkLevelSetEquationOverlapPenaltyTerm.h.

◆ Pointer

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 55 of file itkLevelSetEquationOverlapPenaltyTerm.h.

◆ Self

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 54 of file itkLevelSetEquationOverlapPenaltyTerm.h.

◆ Superclass

template<typename TInput , typename TLevelSetContainer >

using itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Superclass = LevelSetEquationTermBase<TInput, TLevelSetContainer>

Definition at line 57 of file itkLevelSetEquationOverlapPenaltyTerm.h.

Constructor & Destructor Documentation

◆ LevelSetEquationOverlapPenaltyTerm()

template<typename TInput , typename TLevelSetContainer >

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

protected

◆ ~LevelSetEquationOverlapPenaltyTerm()

template<typename TInput , typename TLevelSetContainer >

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

overrideprotecteddefault

Member Function Documentation

◆ ComputeSumTerm()

template<typename TInput , typename TLevelSetContainer >

virtual void itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::ComputeSumTerm	(	const LevelSetInputIndexType &	index,
		LevelSetOutputRealType &	sum
	)

virtual

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

◆ GetNameOfClass()

template<typename TInput , typename TLevelSetContainer >

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ Initialize()

template<typename TInput , typename TLevelSetContainer >

void itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Initialize ( const LevelSetInputIndexType & index )

overridevirtual

Initialize term parameters in the dense case by computing for each pixel location

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ InitializeParameters()

template<typename TInput , typename TLevelSetContainer >

void itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::InitializeParameters ( )

overridevirtual

Initialize parameters in the terms prior to an iteration

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ New()

template<typename TInput , typename TLevelSetContainer >

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

static

Method for creation through object factory

◆ Update()

template<typename TInput , typename TLevelSetContainer >

void itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Update ( )

overridevirtual

Update the term parameter values at end of iteration

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ UpdatePixel()

template<typename TInput , typename TLevelSetContainer >

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

overridevirtual

Supply updates at pixels to keep the term parameters always updated

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ Value() [1/2]

template<typename TInput , typename TLevelSetContainer >

LevelSetOutputRealType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Value ( const LevelSetInputIndexType & index )

overrideprotectedvirtual

Returns the term contribution for a given location index

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ Value() [2/2]

template<typename TInput , typename TLevelSetContainer >

LevelSetOutputRealType itk::LevelSetEquationOverlapPenaltyTerm< TInput, TLevelSetContainer >::Value	(	const LevelSetInputIndexType &	index,
		const LevelSetDataType &	data
	)

overrideprotectedvirtual

Returns the term contribution for a given location index

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

Member Data Documentation

◆ m_CacheImage

template<typename TInput , typename TLevelSetContainer >

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

private

Definition at line 135 of file itkLevelSetEquationOverlapPenaltyTerm.h.

◆ m_DomainMapImageFilter

template<typename TInput , typename TLevelSetContainer >

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

private

Definition at line 134 of file itkLevelSetEquationOverlapPenaltyTerm.h.

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

itkLevelSetEquationOverlapPenaltyTerm.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ CompensatedSummationType

◆ ConstPointer

◆ IdListConstIterator

◆ IdListIterator

◆ IdListType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ LevelSetEquationOverlapPenaltyTerm()

◆ ~LevelSetEquationOverlapPenaltyTerm()

Member Function Documentation

◆ ComputeSumTerm()

◆ GetNameOfClass()

◆ Initialize()

◆ InitializeParameters()

◆ New()

◆ Update()

◆ UpdatePixel()

◆ Value() [1/2]

◆ Value() [2/2]

Member Data Documentation

◆ m_CacheImage

◆ m_DomainMapImageFilter