#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
typedef AdvectionImageType::Pointer	AdvectionImagePointer

typedef Image< VectorType, itkGetStaticConstMacro(ImageDimension) >	AdvectionImageType

typedef SmartPointer< const Self >	ConstPointer

typedef ZeroFluxNeumannBoundaryCondition < InputImageType >	DefaultBoundaryConditionType

typedef Superclass::HeavisideConstPointer	HeavisideConstPointer

typedef Superclass::HeavisideType	HeavisideType

typedef Superclass::InputImagePointer	InputImagePointer

typedef Superclass::InputImageType	InputImageType

typedef Superclass::InputPixelRealType	InputPixelRealType

typedef Superclass::InputPixelType	InputPixelType

typedef Superclass::LevelSetContainerPointer	LevelSetContainerPointer

typedef Superclass::LevelSetContainerType	LevelSetContainerType

typedef Superclass::LevelSetDataType	LevelSetDataType

typedef Superclass::LevelSetGradientType	LevelSetGradientType

typedef Superclass::LevelSetHessianType	LevelSetHessianType

typedef Superclass::LevelSetIdentifierType	LevelSetIdentifierType

typedef Superclass::LevelSetInputIndexType	LevelSetInputIndexType

typedef Superclass::LevelSetOutputPixelType	LevelSetOutputPixelType

typedef Superclass::LevelSetOutputRealType	LevelSetOutputRealType

typedef Superclass::LevelSetPointer	LevelSetPointer

typedef Superclass::LevelSetType	LevelSetType

typedef Vector < LevelSetOutputRealType, itkGetStaticConstMacro(ImageDimension) >	NeighborhoodScalesType

typedef ConstNeighborhoodIterator < InputImageType, DefaultBoundaryConditionType >	NeighborhoodType

typedef SmartPointer< Self >	Pointer

typedef ConstNeighborhoodIterator < InputImageType >::RadiusType	RadiusType

typedef LevelSetEquationAdvectionTerm	Self

typedef LevelSetEquationTermBase < TInput, TLevelSetContainer >	Superclass

typedef LevelSetGradientType	VectorType

Public Types inherited from itk::LevelSetEquationTermBase< TInput, TLevelSetContainer >
typedef LevelSetContainerType::CacheImageType	CacheImageType

typedef SmartPointer< const Self >	ConstPointer

typedef LevelSetContainerType::DomainMapImageFilterType	DomainMapImageFilterType

typedef HeavisideType::ConstPointer	HeavisideConstPointer

typedef HeavisideStepFunctionBase < LevelSetOutputRealType, LevelSetOutputRealType >	HeavisideType

typedef InputImageType::Pointer	InputImagePointer

typedef TInput	InputImageType

typedef NumericTraits < InputPixelType >::RealType	InputPixelRealType

typedef InputImageType::PixelType	InputPixelType

typedef LevelSetContainerType::Pointer	LevelSetContainerPointer

typedef TLevelSetContainer	LevelSetContainerType

typedef LevelSetContainerType::LevelSetDataType	LevelSetDataType

typedef LevelSetContainerType::GradientType	LevelSetGradientType

typedef LevelSetContainerType::HessianType	LevelSetHessianType

typedef LevelSetContainerType::LevelSetIdentifierType	LevelSetIdentifierType

typedef LevelSetContainerType::InputIndexType	LevelSetInputIndexType

typedef LevelSetContainerType::OutputType	LevelSetOutputPixelType

typedef LevelSetContainerType::OutputRealType	LevelSetOutputRealType

typedef LevelSetContainerType::LevelSetPointer	LevelSetPointer

typedef LevelSetContainerType::LevelSetType	LevelSetType

typedef SmartPointer< Self >	Pointer

typedef itksys::hash_set < std::string >	RequiredDataType

typedef LevelSetEquationTermBase	Self

typedef Object	Superclass

Public Types inherited from itk::Object
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef Object	Self

typedef LightObject	Superclass

Public Types inherited from itk::LightObject
typedef SmartPointer< const Self >	ConstPointer

typedef SmartPointer< Self >	Pointer

typedef LightObject	Self

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

virtual void	Initialize (const LevelSetInputIndexType &) override

virtual void	InitializeParameters () override

void	SetAdvectionImage (AdvectionImageType *iImage)

virtual void	SetDerivativeSigma (LevelSetOutputRealType _arg)

virtual void	Update () override

virtual 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

virtual void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int) override

virtual void	UnRegister () const noexceptoverride

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 const unsigned int	ImageDimension = InputImageType::ImageDimension

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

	LevelSetEquationAdvectionTerm ()

virtual	~LevelSetEquationAdvectionTerm () override


virtual LevelSetOutputRealType	Value (const LevelSetInputIndexType &iP) override

virtual 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

virtual	~LevelSetEquationTermBase () override

Protected Member Functions inherited from itk::Object
	Object ()

bool	PrintObservers (std::ostream &os, Indent indent) const

virtual void	PrintSelf (std::ostream &os, Indent indent) const override

virtual void	SetTimeStamp (const TimeStamp &time)

virtual	~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
AtomicInt< int >	m_ReferenceCount

Private Member Functions
void	GenerateAdvectionImage ()

Private Attributes
bool	m_AutoGenerateAdvectionImage

LevelSetOutputRealType	m_DerivativeSigma