#include <itkLevelSetEquationAdvectionTerm.h>

Detailed Description

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

Derived class to represents an advection term in the level-set evolution PDE.

\[ AdvectionImage\left( p \right) \bullet \nabla \phi\left( p \right) \]

\( AdvectionImage \left( p \right) \) is the advection image provided by the user.
\( \cdot \bullet \cdot \) denotes the usual dot product
\( \nabla \phi \) denotes the gradient of the level set function \( \phi \).

The advection image can be directly provided by the user; or by default, it is computed as the gradient of the input image. In this last case, it can be smoothed by the means of DerivativeSigma.

Template Parameters

TInput	Input Image Type
TLevelSetContainer	Level set function container type

Definition at line 52 of file itkLevelSetEquationAdvectionTerm.h.

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

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

Public Types
using	AdvectionImagePointer = typename AdvectionImageType::Pointer

using	AdvectionImageType = Image< VectorType, Self::ImageDimension >

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	RadiusType = typename ConstNeighborhoodIterator< InputImageType >::RadiusType

using	Self = LevelSetEquationAdvectionTerm

using	Superclass = LevelSetEquationTermBase< TInput, TLevelSetContainer >

using	VectorType = LevelSetGradientType

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

virtual AdvectionImageType *	GetModifiableAdvectionImage ()

const char *	GetNameOfClass () const override

void	Initialize (const LevelSetInputIndexType &) override

void	InitializeParameters () override

void	SetAdvectionImage (AdvectionImageType *iImage)

virtual void	SetDerivativeSigma (LevelSetOutputRealType _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, 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	SetCoefficient (LevelSetOutputRealType _arg)

virtual void	SetCurrentLevelSetId (LevelSetIdentifierType _arg)

virtual void	SetLevelSetContainer (LevelSetContainerType *iContainer)

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

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

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

Protected Member Functions
VectorType	AdvectionSpeed (const LevelSetInputIndexType &iP) const

	LevelSetEquationAdvectionTerm ()

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

	~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
AdvectionImagePointer	m_AdvectionImage {}

LevelSetOutputRealType	m_NeighborhoodScales [ImageDimension] {}

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

Private Member Functions
void	GenerateAdvectionImage ()

Private Attributes
bool	m_AutoGenerateAdvectionImage {}

LevelSetOutputRealType	m_DerivativeSigma {}

Member Typedef Documentation

◆ AdvectionImagePointer

template<typename TInput , typename TLevelSetContainer >

using itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::AdvectionImagePointer = typename AdvectionImageType::Pointer

Definition at line 94 of file itkLevelSetEquationAdvectionTerm.h.

◆ AdvectionImageType

template<typename TInput , typename TLevelSetContainer >

using itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::AdvectionImageType = Image<VectorType, Self::ImageDimension>

Definition at line 93 of file itkLevelSetEquationAdvectionTerm.h.

◆ ConstPointer

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 60 of file itkLevelSetEquationAdvectionTerm.h.

◆ DefaultBoundaryConditionType

template<typename TInput , typename TLevelSetContainer >

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

Neighborhood radius type

Definition at line 105 of file itkLevelSetEquationAdvectionTerm.h.

◆ NeighborhoodScalesType

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 109 of file itkLevelSetEquationAdvectionTerm.h.

◆ NeighborhoodType

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 107 of file itkLevelSetEquationAdvectionTerm.h.

◆ Pointer

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 59 of file itkLevelSetEquationAdvectionTerm.h.

◆ RadiusType

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 106 of file itkLevelSetEquationAdvectionTerm.h.

◆ Self

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 58 of file itkLevelSetEquationAdvectionTerm.h.

◆ Superclass

template<typename TInput , typename TLevelSetContainer >

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

Definition at line 61 of file itkLevelSetEquationAdvectionTerm.h.

◆ VectorType

template<typename TInput , typename TLevelSetContainer >

using itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::VectorType = LevelSetGradientType

Definition at line 91 of file itkLevelSetEquationAdvectionTerm.h.

Constructor & Destructor Documentation

◆ LevelSetEquationAdvectionTerm()

template<typename TInput , typename TLevelSetContainer >

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

protected

◆ ~LevelSetEquationAdvectionTerm()

template<typename TInput , typename TLevelSetContainer >

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

overrideprotecteddefault

Member Function Documentation

◆ AdvectionSpeed()

template<typename TInput , typename TLevelSetContainer >

VectorType itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::AdvectionSpeed ( const LevelSetInputIndexType & iP ) const

protected

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

◆ GenerateAdvectionImage()

template<typename TInput , typename TLevelSetContainer >

void itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::GenerateAdvectionImage ( )

private

◆ GetDerivativeSigma()

template<typename TInput , typename TLevelSetContainer >

virtual LevelSetOutputRealType itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::GetDerivativeSigma ( )

virtual

◆ GetModifiableAdvectionImage()

template<typename TInput , typename TLevelSetContainer >

virtual AdvectionImageType* itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::GetModifiableAdvectionImage ( )

virtual

◆ GetNameOfClass()

template<typename TInput , typename TLevelSetContainer >

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

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::Object.

◆ Initialize()

template<typename TInput , typename TLevelSetContainer >

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

overridevirtual

Todo:: to be documented.

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ InitializeParameters()

template<typename TInput , typename TLevelSetContainer >

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

overridevirtual

Initialize the parameters in the terms prior to an iteration

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ New()

template<typename TInput , typename TLevelSetContainer >

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

static

Method for creation through object factory

◆ SetAdvectionImage()

template<typename TInput , typename TLevelSetContainer >

void itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::SetAdvectionImage ( AdvectionImageType * iImage )

◆ SetDerivativeSigma()

template<typename TInput , typename TLevelSetContainer >

virtual void itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::SetDerivativeSigma ( LevelSetOutputRealType _arg )

virtual

◆ Update()

template<typename TInput , typename TLevelSetContainer >

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

overridevirtual

Todo:: to be documented.

Implements itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >.

◆ UpdatePixel()

template<typename TInput , typename TLevelSetContainer >

void itk::LevelSetEquationAdvectionTerm< 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 >.

◆ Value() [1/2]

template<typename TInput , typename TLevelSetContainer >

LevelSetOutputRealType itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::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 >

LevelSetOutputRealType itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::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 >

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

staticconstexpr

Definition at line 89 of file itkLevelSetEquationAdvectionTerm.h.

◆ m_AdvectionImage

template<typename TInput , typename TLevelSetContainer >

AdvectionImagePointer itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::m_AdvectionImage {}

protected

Definition at line 134 of file itkLevelSetEquationAdvectionTerm.h.

◆ m_AutoGenerateAdvectionImage

template<typename TInput , typename TLevelSetContainer >

bool itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::m_AutoGenerateAdvectionImage {}

private

Definition at line 154 of file itkLevelSetEquationAdvectionTerm.h.

◆ m_DerivativeSigma

template<typename TInput , typename TLevelSetContainer >

LevelSetOutputRealType itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::m_DerivativeSigma {}

private

Definition at line 152 of file itkLevelSetEquationAdvectionTerm.h.

◆ m_NeighborhoodScales

template<typename TInput , typename TLevelSetContainer >

LevelSetOutputRealType itk::LevelSetEquationAdvectionTerm< TInput, TLevelSetContainer >::m_NeighborhoodScales[ImageDimension] {}

protected

Definition at line 149 of file itkLevelSetEquationAdvectionTerm.h.

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

itkLevelSetEquationAdvectionTerm.h

Detailed Description

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

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Member Typedef Documentation

◆ AdvectionImagePointer

◆ AdvectionImageType

◆ ConstPointer

◆ DefaultBoundaryConditionType

◆ NeighborhoodScalesType

◆ NeighborhoodType

◆ Pointer

◆ RadiusType

◆ Self

◆ Superclass

◆ VectorType

Constructor & Destructor Documentation

◆ LevelSetEquationAdvectionTerm()

◆ ~LevelSetEquationAdvectionTerm()

Member Function Documentation

◆ AdvectionSpeed()

◆ GenerateAdvectionImage()

◆ GetDerivativeSigma()

◆ GetModifiableAdvectionImage()

◆ GetNameOfClass()

◆ Initialize()

◆ InitializeParameters()

◆ New()

◆ SetAdvectionImage()

◆ SetDerivativeSigma()

◆ Update()

◆ UpdatePixel()

◆ Value() [1/2]

◆ Value() [2/2]

Member Data Documentation

◆ ImageDimension

◆ m_AdvectionImage

◆ m_AutoGenerateAdvectionImage

◆ m_DerivativeSigma

◆ m_NeighborhoodScales

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