#include <itkSparseFieldFourthOrderLevelSetImageFilter.h>

Inheritance diagram for itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >:

Collaboration diagram for itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >:

Detailed Description

template<class TInputImage, class TOutputImage>
class itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >

This class implements the fourth order level set PDE framework.

: This class adds a ProcessNormals method to SparseFieldLevelSetImageFilter class. The ProcessNormals method uses the ImplicitManifoldNormalDiffusionFilter class to generate a SparseImage of filtered normal vectors. We make a copy of the current state of the output image (also referred to as level set image) for this class and pass it to ImplicitManifoldNormalDiffusionFilter. That class computes the normal vectors to the level set image and filters them. The output is in the form of a sparse image templated with the NormalBandNode type. We then compute curvatures from that output and store them in the SparseImage as well. This SparseImage is passed onto the LevelSetFunctionWithRefitTerm filter class to be used as a target in the propagation term.

INPUT and OUTPUT: Same as SparseFieldLevelSetImageFilter

PARAMETERS: MaxRefitIteration sets the maximum number of allowable iterations between calls to ProcessNormals. The decision of when to call the ProcessNormals method is made in InitializeIteration according to a few criteria one of which is this maximum number of iterations.

: MaxNormalIteration sets the maximum number of diffusion iterations on the normals to be performed by the ImplicitManifoldNormalDiffusionFilter class. Please read the documentation for that class.

: CurvatureBandWidth determines the width of the band to be processed in ImplicitManifoldNormalDiffusionFilter.

: RMSChangeNormalProcessTrigger provides another mechanism in InitializeIteration for calling the ProcessNormals method. Whenever the RMS change reported by SparseFieldLevelSetImageFilter falls below this parameter ProcessNormals is called regardless of whether MaxRefitIteration has been reached. This parameter could be used to speed up the algorithm; however, it can also effect the results. Use with caution. Default is 0 which does nothing.

IMPORTANT: Defaults for above parameters are set in the constructor. Users should not change these unless they have a good understanding of the algorithm.

OTHER PARAMETERS: NormalProcessType tells ImplicitManifoldNormalVectorFilter whether to use isotropic or anisotropic diffusion. A value of 0 means isotropic whereas a value of 1 means anisotropic diffusion. If this parameter is set to 1, NormalProcessConductance determines the level of detail preservation. Please read the documentation for ImplicitManifoldNormalVectorFilter and AnisotropicFourthOrderLevelSetImageFilter.

: NormalProcessUnsharpFlag turns unsharp masking on/off. If this parameter is turned on, then NormalProcessUnsharpWeight should be set. Please read the documentation for ImplicitManifoldNormalVectorFilter.

IMPORTANT: Users of this class must define the Halt function.

Definition at line 157 of file itkSparseFieldFourthOrderLevelSetImageFilter.h.

Public Types
typedef SmartPointer< const Self >	ConstPointer

typedef Superclass::IndexType	IndexType

typedef Superclass::LayerType	LayerType

typedef LevelSetFunctionWithRefitTerm < OutputImageType, SparseImageType >	LevelSetFunctionType

typedef Superclass::NeighborhoodScalesType	NeighborhoodScalesType

typedef NormalBandNode < OutputImageType >	NodeType

typedef ImplicitManifoldNormalVectorFilter < OutputImageType, SparseImageType >	NormalVectorFilterType

typedef NormalVectorDiffusionFunction < SparseImageType >	NormalVectorFunctionType

typedef NodeType::NodeDataType	NormalVectorType

typedef Superclass::OutputImageType	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef Superclass::RadiusType	RadiusType

typedef SparseFieldFourthOrderLevelSetImageFilter	Self

typedef NeighborhoodIterator < SparseImageType >	SparseImageIteratorType

typedef SparseImage< NodeType, itkGetStaticConstMacro(ImageDimension) >	SparseImageType

typedef SparseFieldLevelSetImageFilter < TInputImage, TOutputImage >	Superclass

typedef Superclass::ValueType	ValueType

Public Types inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef OutputImageType::IndexType	IndexType

typedef TInputImage	InputImageType

typedef std::vector < LayerPointerType >	LayerListType

typedef ObjectStore < LayerNodeType >	LayerNodeStorageType

typedef SparseFieldLevelSetNode < IndexType >	LayerNodeType

typedef LayerType::Pointer	LayerPointerType

typedef SparseFieldLayer < LayerNodeType >	LayerType

typedef Superclass::NeighborhoodScalesType	NeighborhoodScalesType

typedef TOutputImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef Superclass::RadiusType	RadiusType

typedef SparseFieldLevelSetImageFilter	Self

typedef Image< StatusType, itkGetStaticConstMacro(ImageDimension) >	StatusImageType

typedef signed char	StatusType

typedef FiniteDifferenceImageFilter < TInputImage, TOutputImage >	Superclass

typedef Superclass::TimeStepType	TimeStepType

typedef std::vector< ValueType >	UpdateBufferType

typedef OutputImageType::ValueType	ValueType

Public Types inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef FiniteDifferenceFunction < TOutputImage >	FiniteDifferenceFunctionType

typedef TInputImage	InputImageType

typedef TInputImage::PixelType	InputPixelType

typedef NumericTraits < InputPixelType >::ValueType	InputPixelValueType

typedef FiniteDifferenceFunctionType::NeighborhoodScalesType	NeighborhoodScalesType

typedef TOutputImage	OutputImageType

typedef TOutputImage::PixelType	OutputPixelType

typedef NumericTraits < OutputPixelType >::ValueType	OutputPixelValueType

typedef OutputPixelType	PixelType

typedef SmartPointer< Self >	Pointer

typedef FiniteDifferenceFunctionType::RadiusType	RadiusType

typedef FiniteDifferenceImageFilter	Self

typedef InPlaceImageFilter < TInputImage, TOutputImage >	Superclass

typedef FiniteDifferenceFunctionType::TimeStepType	TimeStepType

Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImagePointer	OutputImagePointer

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef Superclass::OutputImageType	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef InPlaceImageFilter	Self

typedef ImageToImageFilter < TInputImage, TOutputImage >	Superclass

Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef SmartPointer< const Self >	ConstPointer

typedef InputImageType::ConstPointer	InputImageConstPointer

typedef InputImageType::PixelType	InputImagePixelType

typedef InputImageType::Pointer	InputImagePointer

typedef InputImageType::RegionType	InputImageRegionType

typedef TInputImage	InputImageType

typedef Superclass::OutputImagePixelType	OutputImagePixelType

typedef Superclass::OutputImageRegionType	OutputImageRegionType

typedef SmartPointer< Self >	Pointer

typedef ImageToImageFilter	Self

typedef ImageSource< TOutputImage >	Superclass

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

typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType

typedef OutputImageType::PixelType	OutputImagePixelType

typedef OutputImageType::Pointer	OutputImagePointer

typedef OutputImageType::RegionType	OutputImageRegionType

typedef TOutputImage	OutputImageType

typedef SmartPointer< Self >	Pointer

typedef ImageSource	Self

typedef ProcessObject	Superclass

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

typedef DataObject::DataObjectIdentifierType	DataObjectIdentifierType

typedef DataObject::Pointer	DataObjectPointer

typedef std::vector < DataObjectPointer >	DataObjectPointerArray

typedef DataObjectPointerArray::size_type	DataObjectPointerArraySizeType

typedef std::vector < DataObjectIdentifierType >	NameArray

typedef SmartPointer< Self >	Pointer

typedef ProcessObject	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 const ValueType &	GetCurvatureBandWidth ()

virtual const unsigned int &	GetMaxNormalIteration ()

virtual const unsigned int &	GetMaxRefitIteration ()

unsigned int	GetMinimumNumberOfLayers () const

virtual const char *	GetNameOfClass () const

virtual const ValueType &	GetNormalProcessConductance ()

virtual const int &	GetNormalProcessType ()

virtual const bool &	GetNormalProcessUnsharpFlag ()

virtual const ValueType &	GetNormalProcessUnsharpWeight ()

virtual const ValueType &	GetRMSChangeNormalProcessTrigger ()

virtual void	SetCurvatureBandWidth (ValueType _arg)

void	SetLevelSetFunction (LevelSetFunctionType *lsf)

virtual void	SetMaxNormalIteration (unsigned int _arg)

virtual void	SetMaxRefitIteration (unsigned int _arg)

virtual void	SetNormalProcessConductance (ValueType _arg)

virtual void	SetNormalProcessType (int _arg)

virtual void	SetNormalProcessUnsharpFlag (bool _arg)

virtual void	SetNormalProcessUnsharpWeight (ValueType _arg)

virtual void	SetNumberOfLayers (const unsigned int n)

virtual void	SetRMSChangeNormalProcessTrigger (ValueType _arg)

Public Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const

	typedef (Concept::EqualityComparable< typename TOutputImage::PixelType >) OutputEqualityComparableCheck

	typedef (Concept::Convertible< double, typename TOutputImage::PixelType >) DoubleConvertibleToOutputCheck

	typedef (Concept::OStreamWritable< typename TOutputImage::PixelType >) OutputOStreamWritableCheck

virtual unsigned int	GetNumberOfLayers () const

virtual void	SetIsoSurfaceValue (ValueType _arg)

virtual ValueType	GetIsoSurfaceValue () const

virtual void	SetInterpolateSurfaceLocation (bool _arg)

virtual bool	GetInterpolateSurfaceLocation () const

void	InterpolateSurfaceLocationOn ()

void	InterpolateSurfaceLocationOff ()

Public Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const

virtual const IdentifierType &	GetElapsedIterations ()

virtual bool	GetIsInitialized ()

virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)

virtual void	SetIsInitialized (bool _arg)

void	SetStateToInitialized ()

void	SetStateToUninitialized ()

virtual void	SetNumberOfIterations (IdentifierType _arg)

virtual const IdentifierType &	GetNumberOfIterations ()

virtual void	SetUseImageSpacing (bool _arg)

virtual void	UseImageSpacingOn ()

virtual void	UseImageSpacingOff ()

virtual const bool &	GetUseImageSpacing ()

virtual void	SetMaximumRMSError (double _arg)

virtual const double &	GetMaximumRMSError ()

virtual void	SetRMSChange (double _arg)

virtual const double &	GetRMSChange ()

virtual void	SetManualReinitialization (bool _arg)

virtual const bool &	GetManualReinitialization ()

virtual void	ManualReinitializationOn ()

virtual void	ManualReinitializationOff ()

Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
virtual bool	CanRunInPlace () const

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual double	GetCoordinateTolerance ()

const InputImageType *	GetInput (void) const

const InputImageType *	GetInput (unsigned int idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

virtual void	PushBackInput (const InputImageType *image)

virtual void	PushFrontInput (const InputImageType *image)

virtual void	SetCoordinateTolerance (double _arg)

virtual void	SetInput (const InputImageType *image)

virtual void	SetInput (unsigned int, const TInputImage *image)

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance ()

Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageType *	GetOutput (unsigned int idx)

virtual void	GraftNthOutput (unsigned int idx, DataObject *output)

virtual void	GraftOutput (DataObject *output)

virtual void	GraftOutput (const DataObjectIdentifierType &key, DataObject *output)

OutputImageType *	GetOutput (void)

const OutputImageType *	GetOutput (void) const

virtual ProcessObject::DataObjectPointer	MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx)

Public Member Functions inherited from itk::ProcessObject
virtual void	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData ()

NameArray	GetInputNames () const

MultiThreader *	GetMultiThreader () const

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

virtual const float &	GetProgress ()

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

virtual void	SetProgress (float _arg)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float amount)

DataObjectPointerArray	GetInputs ()

DataObjectPointerArray	GetOutputs ()

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

virtual void	SetReleaseDataFlag (bool flag)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag ()

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	ReleaseDataBeforeUpdateFlagOff ()

virtual void	SetNumberOfThreads (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfThreads ()

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

const MetaDataDictionary &	GetMetaDataDictionary (void) 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

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

void	SetDebug (bool debugFlag) const

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

virtual void	SetReferenceCount (int)

virtual void	UnRegister () 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 Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension

Static Public Attributes inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >
static const unsigned int	ImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
static const unsigned int	ImageDimension = OutputImageType::ImageDimension

Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension

static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static const unsigned int	OutputImageDimension = TOutputImage::ImageDimension

unsigned int	m_RefitIteration

unsigned int	m_MaxRefitIteration

unsigned int	m_MaxNormalIteration

ValueType	m_RMSChangeNormalProcessTrigger

bool	m_ConvergenceFlag

LevelSetFunctionType *	m_LevelSetFunction

ValueType	m_CurvatureBandWidth

int	m_NormalProcessType

ValueType	m_NormalProcessConductance

bool	m_NormalProcessUnsharpFlag

ValueType	m_NormalProcessUnsharpWeight

static const SizeValueType	m_NumVertex

static const ValueType	m_DimConst

virtual void	InitializeIteration ()

	typedef (Concept::HasNumericTraits< ValueType >) OutputHasNumericTraitsCheck

	SparseFieldFourthOrderLevelSetImageFilter ()

	~SparseFieldFourthOrderLevelSetImageFilter ()

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

ValueType	ComputeCurvatureFromSparseImageNeighborhood (SparseImageIteratorType &neighborhood) const

void	ComputeCurvatureTarget (const OutputImageType distanceImage, SparseImageType sparseImage) const

void	ProcessNormals ()

bool	ActiveLayerCheckBand () const

	SparseFieldFourthOrderLevelSetImageFilter (const Self &)

void	operator= (const Self &)

Additional Inherited Members
Static Public Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >
static Pointer	New ()

Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(OutputImageDimension), itkGetStaticConstMacro(InputImageDimension) >	InputToOutputRegionCopierType

typedef ImageToImageFilterDetail::ImageRegionCopier < itkGetStaticConstMacro(InputImageDimension), itkGetStaticConstMacro(OutputImageDimension) >	OutputToInputRegionCopierType

Protected Member Functions inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >
void	AllocateUpdateBuffer ()

void	ApplyUpdate (const TimeStepType &dt)

TimeStepType	CalculateChange ()

virtual ValueType	CalculateUpdateValue (const IndexType &, const TimeStepType &dt, const ValueType &value, const ValueType &change)

void	ConstructActiveLayer ()

void	ConstructLayer (StatusType from, StatusType to)

void	CopyInputToOutput ()

virtual ValueType	GetValueOne () const

virtual ValueType	GetValueZero () const

void	Initialize ()

void	InitializeActiveLayerValues ()

virtual void	InitializeBackgroundPixels ()

virtual void	PostProcessOutput ()

void	ProcessOutsideList (LayerType *OutsideList, StatusType ChangeToStatus)

void	ProcessStatusList (LayerType InputList, LayerType OutputList, StatusType ChangeToStatus, StatusType SearchForStatus)

void	PropagateAllLayerValues ()

void	PropagateLayerValues (StatusType from, StatusType to, StatusType promote, int InOrOut)

	SparseFieldLevelSetImageFilter ()

void	UpdateActiveLayerValues (TimeStepType dt, LayerType StatusUpList, LayerType StatusDownList)

	~SparseFieldLevelSetImageFilter ()

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static ITK_THREAD_RETURN_TYPE	ThreaderCallback (void *arg)

Protected Attributes inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >
double	m_ConstantGradientValue

const InputImageType *	m_InputImage

bool	m_InterpolateSurfaceLocation

ValueType	m_IsoSurfaceValue

LayerNodeStorageType::Pointer	m_LayerNodeStore

LayerListType	m_Layers

SparseFieldCityBlockNeighborList < NeighborhoodIterator < OutputImageType > >	m_NeighborList

unsigned int	m_NumberOfLayers

OutputImageType *	m_OutputImage

OutputImageType::Pointer	m_ShiftedImage

StatusImageType::Pointer	m_StatusImage

UpdateBufferType	m_UpdateBuffer

Static Protected Attributes inherited from itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >
static StatusType	m_StatusActiveChangingDown

static StatusType	m_StatusActiveChangingUp

static StatusType	m_StatusBoundaryPixel

static StatusType	m_StatusChanging

static StatusType	m_StatusNull

static ValueType	m_ValueOne

static ValueType	m_ValueZero