#include <itkLevelSetEquationAdvectionTerm.h>

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

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

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.

Public Types
using	AdvectionImagePointer = typename AdvectionImageType::Pointer

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

using	ConstPointer = SmartPointer< const Self >

using	DefaultBoundaryConditionType = ZeroFluxNeumannBoundaryCondition< InputImageType >

using	HeavisideConstPointer = typename Superclass::HeavisideConstPointer

using	HeavisideType = typename Superclass::HeavisideType

using	InputImagePointer = typename Superclass::InputImagePointer

using	InputImageType = typename Superclass::InputImageType

using	InputPixelRealType = typename Superclass::InputPixelRealType

using	InputPixelType = typename Superclass::InputPixelType

using	LevelSetContainerPointer = typename Superclass::LevelSetContainerPointer

using	LevelSetContainerType = typename Superclass::LevelSetContainerType

using	LevelSetDataType = typename Superclass::LevelSetDataType

using	LevelSetGradientType = typename Superclass::LevelSetGradientType

using	LevelSetHessianType = typename Superclass::LevelSetHessianType

using	LevelSetIdentifierType = typename Superclass::LevelSetIdentifierType

using	LevelSetInputIndexType = typename Superclass::LevelSetInputIndexType

using	LevelSetOutputPixelType = typename Superclass::LevelSetOutputPixelType

using	LevelSetOutputRealType = typename Superclass::LevelSetOutputRealType

using	LevelSetPointer = typename Superclass::LevelSetPointer

using	LevelSetType = typename Superclass::LevelSetType

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

virtual const AdvectionImageType *	GetAdvectionImage () const

virtual LevelSetOutputRealType	GetDerivativeSigma ()

virtual AdvectionImageType *	GetModifiableAdvectionImage ()

virtual const char *	GetNameOfClass () const

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 const LevelSetType *	GetCurrentLevelSetPointer () const

virtual const LevelSetContainerType *	GetLevelSetContainer () const

virtual LevelSetType *	GetModifiableCurrentLevelSetPointer ()

virtual LevelSetContainerType *	GetModifiableLevelSetContainer ()

const RequiredDataType &	GetRequiredData () const

virtual void	Initialize (const LevelSetInputIndexType &iP)=0

virtual void	SetCoefficient (LevelSetOutputRealType _arg)

virtual void	SetCurrentLevelSetId (LevelSetIdentifierType _arg)

virtual void	SetLevelSetContainer (LevelSetContainerType *ptr)

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

virtual void	SetInput (InputImageType *_arg)

virtual InputImageType *	GetModifiableInput ()

virtual const InputImageType *	GetInput () 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 *)

unsigned long	AddObserver (const EventObject &event, Command *) const

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)

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexceptoverride

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
virtual void	Delete ()

virtual int	GetReferenceCount () const

	itkCloneMacro (Self)

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

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

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 &time)

	~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