#include <itkLevelSetEquationPropagationTerm.h>

Detailed Description

template<typename TInput, typename TLevelSetContainer, typename TPropagationImage = TInput>
class itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >

Derived class to represents a propagation term in the level-set evolution PDE.

\[ PropagationImage( p ) \cdot \left\| \nabla \phi\left( p \right) \right\| \]

PropagationImage is the propagation image set by the user.
\( \| \cdot \| \) denotes the usual \(L_2\)-norm
\( \nabla \phi \) denotes the gradient of the level-set function \( \phi \).

Template Parameters

TInput	Input Image Type
TLevelSetContainer	Level set function container type

Definition at line 49 of file itkLevelSetEquationPropagationTerm.h.

Inheritance diagram for itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >:

Collaboration diagram for itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >:

Public Types
using	ConstPointer = SmartPointer< const Self >

using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< InputImageType >

using	NeighborhoodScalesType = Vector< LevelSetOutputRealType, Self::ImageDimension >

using	NeighborhoodType = ConstNeighborhoodIterator< InputImageType, DefaultBoundaryConditionType >

using	Pointer = SmartPointer< Self >

using	PropagationImagePointer = typename PropagationImageType::Pointer

using	PropagationImageType = TPropagationImage

using	RadiusType = typename ConstNeighborhoodIterator< InputImageType >::RadiusType

using	Self = LevelSetEquationPropagationTerm

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
const char *	GetNameOfClass () const override

void	Initialize (const LevelSetInputIndexType &) override

void	InitializeParameters () override

void	Update () override

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


virtual void	SetPropagationImage (PropagationImageType *_arg)

virtual PropagationImageType *	GetModifiablePropagationImage ()

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

Static Public Attributes
static constexpr unsigned int	ImageDimension = InputImageType::ImageDimension

Protected Member Functions
	LevelSetEquationPropagationTerm ()

LevelSetOutputRealType	PropagationSpeed (const LevelSetInputIndexType &iP) const

	~LevelSetEquationPropagationTerm () override=default


LevelSetOutputRealType	Value (const LevelSetInputIndexType &iP) override

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

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

Protected Attributes
PropagationImagePointer	m_PropagationImage {}

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

◆ ConstPointer

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

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

Definition at line 56 of file itkLevelSetEquationPropagationTerm.h.

◆ DefaultBoundaryConditionType

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

using itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition<InputImageType>

Neighborhood radius type

Definition at line 91 of file itkLevelSetEquationPropagationTerm.h.

◆ NeighborhoodScalesType

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

using itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::NeighborhoodScalesType = Vector<LevelSetOutputRealType, Self::ImageDimension>

Definition at line 95 of file itkLevelSetEquationPropagationTerm.h.

◆ NeighborhoodType

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

using itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::NeighborhoodType = ConstNeighborhoodIterator<InputImageType, DefaultBoundaryConditionType>

Definition at line 93 of file itkLevelSetEquationPropagationTerm.h.

◆ Pointer

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

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

Definition at line 55 of file itkLevelSetEquationPropagationTerm.h.

◆ PropagationImagePointer

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

using itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::PropagationImagePointer = typename PropagationImageType::Pointer

Definition at line 88 of file itkLevelSetEquationPropagationTerm.h.

◆ PropagationImageType

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

using itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::PropagationImageType = TPropagationImage

Definition at line 87 of file itkLevelSetEquationPropagationTerm.h.

◆ RadiusType

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

using itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::RadiusType = typename ConstNeighborhoodIterator<InputImageType>::RadiusType

Definition at line 92 of file itkLevelSetEquationPropagationTerm.h.

◆ Self

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

using itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::Self = LevelSetEquationPropagationTerm

Definition at line 54 of file itkLevelSetEquationPropagationTerm.h.

◆ Superclass

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

using itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::Superclass = LevelSetEquationTermBase<TInput, TLevelSetContainer>

Definition at line 57 of file itkLevelSetEquationPropagationTerm.h.

Constructor & Destructor Documentation

◆ LevelSetEquationPropagationTerm()

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::LevelSetEquationPropagationTerm ( )

protected

◆ ~LevelSetEquationPropagationTerm()

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::~LevelSetEquationPropagationTerm ( )

overrideprotecteddefault

Member Function Documentation

◆ GetModifiablePropagationImage()

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

virtual PropagationImageType * itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::GetModifiablePropagationImage ( )

virtual

Set/Get the propagation image. By default, if no PropagationImage has been set, it casts the input image and uses it in the term contribution calculation.

◆ GetNameOfClass()

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ Initialize()

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

void itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::Initialize ( const LevelSetInputIndexType & )

overridevirtual

Todo:: to be documented.

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ InitializeParameters()

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

void itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::InitializeParameters ( )

overridevirtual

Initialize the parameters in the terms prior to an iteration

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ New()

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

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

static

Method for creation through object factory

◆ PropagationSpeed()

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

LevelSetOutputRealType itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::PropagationSpeed ( const LevelSetInputIndexType & iP ) const

protected

Return the spatial speed dependence a given pixel location Usually, it is constant across the image domain

◆ SetPropagationImage()

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

virtual void itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::SetPropagationImage ( PropagationImageType * _arg )

virtual

Set/Get the propagation image. By default, if no PropagationImage has been set, it casts the input image and uses it in the term contribution calculation.

◆ Update()

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

void itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::Update ( )

overridevirtual

Todo:: to be documented.

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ UpdatePixel()

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

void itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::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 >.

◆ Value() [1/2]

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

LevelSetOutputRealType itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::Value ( const LevelSetInputIndexType & iP )

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 , typename TPropagationImage = TInput>

LevelSetOutputRealType itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::Value	(	const LevelSetInputIndexType &	iP,
		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

◆ ImageDimension

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

constexpr unsigned int itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::ImageDimension = InputImageType::ImageDimension

staticconstexpr

Definition at line 85 of file itkLevelSetEquationPropagationTerm.h.

◆ m_PropagationImage

template<typename TInput , typename TLevelSetContainer , typename TPropagationImage = TInput>

PropagationImagePointer itk::LevelSetEquationPropagationTerm< TInput, TLevelSetContainer, TPropagationImage >::m_PropagationImage {}

protected

Definition at line 127 of file itkLevelSetEquationPropagationTerm.h.

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

itkLevelSetEquationPropagationTerm.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Member Typedef Documentation

◆ ConstPointer

◆ DefaultBoundaryConditionType

◆ NeighborhoodScalesType

◆ NeighborhoodType

◆ Pointer

◆ PropagationImagePointer

◆ PropagationImageType

◆ RadiusType

◆ Self

◆ Superclass

Constructor & Destructor Documentation

◆ LevelSetEquationPropagationTerm()

◆ ~LevelSetEquationPropagationTerm()

Member Function Documentation

◆ GetModifiablePropagationImage()

◆ GetNameOfClass()

◆ Initialize()

◆ InitializeParameters()

◆ New()

◆ PropagationSpeed()

◆ SetPropagationImage()

◆ Update()

◆ UpdatePixel()

◆ Value() [1/2]

◆ Value() [2/2]

Member Data Documentation

◆ ImageDimension

◆ m_PropagationImage