#include <itkLevelSetEquationBinaryMaskTerm.h>

Detailed Description

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

Class to represent the mask boundary as a negative energy.

\[ M\left( p \right) \cdot \]

\( M \) is a mask with 0 representing a boundary,

Template Parameters

TInput	Input Image Type
TLevelSetContainer	Level set function container type

Definition at line 44 of file itkLevelSetEquationBinaryMaskTerm.h.

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

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

Public Types
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 = LevelSetEquationBinaryMaskTerm

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
virtual::itk::LightObject::Pointer	CreateAnother () const

const char *	GetNameOfClass () const override

void	Initialize (const LevelSetInputIndexType &iP) override

void	InitializeParameters () override

virtual void	SetMask (InputImageType *_arg)

void	Update () override

void	UpdatePixel (const LevelSetInputIndexType &iP, 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 char *	GetNameOfClass () const override

const char *	GetNameOfClass () const override

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

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) 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::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
	LevelSetEquationBinaryMaskTerm ()

LevelSetOutputRealType	Value (const LevelSetInputIndexType &index) override

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

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

Protected Attributes
InputImagePointer	m_Mask {}

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

◆ CacheImageType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::CacheImageType

Definition at line 82 of file itkLevelSetEquationTermBase.h.

◆ ConstPointer

template<typename TInput, typename TLevelSetContainer>

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

Definition at line 51 of file itkLevelSetEquationBinaryMaskTerm.h.

◆ DomainMapImageFilterType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::DomainMapImageFilterType

Definition at line 81 of file itkLevelSetEquationTermBase.h.

◆ HeavisideConstPointer

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::HeavisideConstPointer

Definition at line 86 of file itkLevelSetEquationTermBase.h.

◆ HeavisideType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::HeavisideType

Definition at line 84 of file itkLevelSetEquationTermBase.h.

◆ InputImagePointer

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::InputImagePointer

Definition at line 64 of file itkLevelSetEquationTermBase.h.

◆ InputImageType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::InputImageType

Definition at line 63 of file itkLevelSetEquationTermBase.h.

◆ InputPixelRealType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::InputPixelRealType

Definition at line 66 of file itkLevelSetEquationTermBase.h.

◆ InputPixelType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::InputPixelType

Definition at line 65 of file itkLevelSetEquationTermBase.h.

◆ LevelSetContainerPointer

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetContainerPointer

Definition at line 71 of file itkLevelSetEquationTermBase.h.

◆ LevelSetContainerType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetContainerType

Level-set function container type

Definition at line 69 of file itkLevelSetEquationTermBase.h.

◆ LevelSetDataType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetDataType

Definition at line 79 of file itkLevelSetEquationTermBase.h.

◆ LevelSetGradientType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetGradientType

Definition at line 77 of file itkLevelSetEquationTermBase.h.

◆ LevelSetHessianType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetHessianType

Definition at line 78 of file itkLevelSetEquationTermBase.h.

◆ LevelSetIdentifierType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetIdentifierType

Definition at line 70 of file itkLevelSetEquationTermBase.h.

◆ LevelSetInputIndexType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetInputIndexType

Definition at line 76 of file itkLevelSetEquationTermBase.h.

◆ LevelSetOutputPixelType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetOutputPixelType

Definition at line 74 of file itkLevelSetEquationTermBase.h.

◆ LevelSetOutputRealType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetOutputRealType

Definition at line 75 of file itkLevelSetEquationTermBase.h.

◆ LevelSetPointer

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetPointer

Definition at line 73 of file itkLevelSetEquationTermBase.h.

◆ LevelSetType

template<typename TInput, typename TLevelSetContainer>

using itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >::LevelSetType

Definition at line 72 of file itkLevelSetEquationTermBase.h.

◆ Pointer

template<typename TInput, typename TLevelSetContainer>

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

Definition at line 50 of file itkLevelSetEquationBinaryMaskTerm.h.

◆ Self

template<typename TInput, typename TLevelSetContainer>

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

Definition at line 49 of file itkLevelSetEquationBinaryMaskTerm.h.

◆ Superclass

template<typename TInput, typename TLevelSetContainer>

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

Definition at line 52 of file itkLevelSetEquationBinaryMaskTerm.h.

Constructor & Destructor Documentation

◆ LevelSetEquationBinaryMaskTerm()

template<typename TInput, typename TLevelSetContainer>

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

protected

Referenced by GetNameOfClass().

◆ ~LevelSetEquationBinaryMaskTerm()

template<typename TInput, typename TLevelSetContainer>

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

overrideprotecteddefault

Member Function Documentation

◆ CreateAnother()

template<typename TInput, typename TLevelSetContainer>

virtual::itk::LightObject::Pointer itk::LevelSetEquationBinaryMaskTerm< 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>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::LightObject.

References LevelSetEquationBinaryMaskTerm().

◆ Initialize()

template<typename TInput, typename TLevelSetContainer>

void itk::LevelSetEquationBinaryMaskTerm< TInput, TLevelSetContainer >::Initialize ( const LevelSetInputIndexType & iP )

inlineoverridevirtual

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

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

Definition at line 97 of file itkLevelSetEquationBinaryMaskTerm.h.

◆ InitializeParameters()

template<typename TInput, typename TLevelSetContainer>

void itk::LevelSetEquationBinaryMaskTerm< 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::LevelSetEquationBinaryMaskTerm< TInput, TLevelSetContainer >::New ( )

static

Method for creation through object factory

◆ SetMask()

template<typename TInput, typename TLevelSetContainer>

virtual void itk::LevelSetEquationBinaryMaskTerm< TInput, TLevelSetContainer >::SetMask ( InputImageType * _arg )

virtual

◆ Update()

template<typename TInput, typename TLevelSetContainer>

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

inlineoverridevirtual

Update the term parameter values at end of iteration

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

Definition at line 88 of file itkLevelSetEquationBinaryMaskTerm.h.

◆ UpdatePixel()

template<typename TInput, typename TLevelSetContainer>

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

inlineoverridevirtual

Supply updates at pixels to keep the term parameters always updated

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

Definition at line 102 of file itkLevelSetEquationBinaryMaskTerm.h.

◆ Value() [1/2]

template<typename TInput, typename TLevelSetContainer>

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

overrideprotectedvirtual

Returns the term contribution for a given location iP, i.e. \( \omega_i( p ) \).

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ Value() [2/2]

template<typename TInput, typename TLevelSetContainer>

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

overrideprotectedvirtual

Returns the term contribution for a given location iP, i.e. \( \omega_i( p ) \).

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

Member Data Documentation

◆ m_Mask

template<typename TInput, typename TLevelSetContainer>

InputImagePointer itk::LevelSetEquationBinaryMaskTerm< TInput, TLevelSetContainer >::m_Mask {}

protected

Definition at line 123 of file itkLevelSetEquationBinaryMaskTerm.h.

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

itkLevelSetEquationBinaryMaskTerm.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ CacheImageType

◆ ConstPointer

◆ DomainMapImageFilterType

◆ HeavisideConstPointer

◆ HeavisideType

◆ InputImagePointer

◆ InputImageType

◆ InputPixelRealType

◆ InputPixelType

◆ LevelSetContainerPointer

◆ LevelSetContainerType

◆ LevelSetDataType

◆ LevelSetGradientType

◆ LevelSetHessianType

◆ LevelSetIdentifierType

◆ LevelSetInputIndexType

◆ LevelSetOutputPixelType

◆ LevelSetOutputRealType

◆ LevelSetPointer

◆ LevelSetType

◆ Pointer

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ LevelSetEquationBinaryMaskTerm()

◆ ~LevelSetEquationBinaryMaskTerm()

Member Function Documentation

◆ CreateAnother()

◆ GetNameOfClass()

◆ Initialize()

◆ InitializeParameters()

◆ New()

◆ SetMask()

◆ Update()

◆ UpdatePixel()

◆ Value() [1/2]

◆ Value() [2/2]

Member Data Documentation

◆ m_Mask