itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell > Class Template Reference

#include <itkMultiphaseSparseFiniteDifferenceImageFilter.h>

Inheritance diagram for itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >:

Collaboration diagram for itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >:

List of all members.

Classes
struct	SparseDataStruct

Public Types
typedef NeighborhoodAlgorithm::ImageBoundaryFacesCalculator < StatusImageType >	BFCType
typedef SmartPointer< const Self >	ConstPointer
typedef Superclass::FeatureImagePointer	FeatureImagePointer
typedef Superclass::FeatureImageType	FeatureImageType
typedef Superclass::FeaturePointType	FeaturePointType
typedef Superclass::FeatureRegionType	FeatureRegionType
typedef Superclass::FeatureSizeType	FeatureSizeType
typedef Superclass::FeatureSpacingType	FeatureSpacingType
typedef FiniteDifferenceFunctionType::FloatOffsetType	FiniteDifferenceFunctionFloatOffsetType
typedef Superclass::FiniteDifferenceFunctionPointer	FiniteDifferenceFunctionPointer
typedef Superclass::FiniteDifferenceFunctionType	FiniteDifferenceFunctionType
typedef Superclass::IdCellType	IdCellType
typedef Superclass::InputImagePointer	InputImagePointer
typedef Superclass::InputImageType	InputImageType
typedef Superclass::InputIndexType	InputIndexType
typedef Superclass::InputIndexValueType	InputIndexValueType
typedef Superclass::InputOffsetValueType	InputOffsetValueType
typedef Superclass::InputPixelType	InputPixelType
typedef Superclass::InputPointType	InputPointType
typedef Superclass::InputRegionType	InputRegionType
typedef Superclass::InputSizeType	InputSizeType
typedef Superclass::InputSizeValueType	InputSizeValueType
typedef Superclass::InputSpacingType	InputSpacingType
typedef LayerType::ConstIterator	LayerConstIterator
typedef LayerType::Iterator	LayerIterator
typedef LayerListType::const_iterator	LayerListConstIterator
typedef LayerListType::iterator	LayerListIterator
typedef std::vector < LayerPointerType >	LayerListType
typedef LayerNodeStorageType::Pointer	LayerNodeStoragePointer
typedef ObjectStore < LayerNodeType >	LayerNodeStorageType
typedef SparseFieldLevelSetNode < OutputIndexType >	LayerNodeType
typedef LayerType::Pointer	LayerPointerType
typedef SparseFieldLayer < LayerNodeType >	LayerType
typedef SparseFieldCityBlockNeighborList < NeighborhoodIterator < OutputImageType > >	NeighborListType
typedef NeighborListType::OffsetType	OffsetType
typedef Superclass::OutputImagePointer	OutputImagePointer
typedef Superclass::OutputImageType	OutputImageType
typedef Superclass::OutputIndexType	OutputIndexType
typedef Superclass::OutputIndexValueType	OutputIndexValueType
typedef Superclass::OutputPixelType	OutputPixelType
typedef Superclass::OutputRegionType	OutputRegionType
typedef Superclass::OutputSizeType	OutputSizeType
typedef SmartPointer< Self >	Pointer
typedef MultiphaseSparseFiniteDifferenceImageFilter	Self
typedef StatusImageType::Pointer	StatusImagePointer
typedef Image< StatusType, itkGetStaticConstMacro(ImageDimension) >	StatusImageType
typedef signed char	StatusType
typedef MultiphaseFiniteDifferenceImageFilter < TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >	Superclass
typedef Superclass::TimeStepType	TimeStepType
typedef UpdateBufferType::const_iterator	UpdateBufferConstIterator
typedef std::vector< ValueType >	UpdateBufferType
typedef InputImageType::ValueType	ValueType
typedef ZeroCrossingFilterType::Pointer	ZeroCrossingFilterPointer
typedef ZeroCrossingImageFilter < InputImageType, InputImageType >	ZeroCrossingFilterType
Public Types inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
typedef Vector< float, itkGetStaticConstMacro(ImageDimension) >	CentroidVectorType
typedef FeatureImageType::PixelType	FeaturePixelType
typedef InputPointType::CoordRepType	InputCoordRepType
typedef KdTreeGeneratorType::Pointer	KdTreeGeneratorPointer
typedef Statistics::KdTreeGenerator < SampleType >	KdTreeGeneratorType
typedef KdTreeType::Pointer	KdTreePointer
typedef KdTreeGeneratorType::KdTreeType	KdTreeType
typedef OutputImageType::SizeValueType	OutputSizeValueType
typedef FiniteDifferenceFunctionType::RadiusType	RadiusType
typedef Statistics::ListSample < CentroidVectorType >	SampleType
typedef std::vector< TimeStepType >	TimeStepVectorType
typedef std::vector< IdCellType >	VectorIdCellType
Public Types inherited from itk::InPlaceImageFilter< TFeatureImage, TOutputImage >
typedef InputImageType::ConstPointer	InputImageConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::RegionType	InputImageRegionType
typedef Superclass::OutputImagePixelType	OutputImagePixelType
typedef Superclass::OutputImageRegionType	OutputImageRegionType
Public Types inherited from itk::ImageToImageFilter< TFeatureImage, TOutputImage >
Public Types inherited from itk::ImageSource< TOutputImage >
typedef Superclass::DataObjectIdentifierType	DataObjectIdentifierType
typedef DataObject::Pointer	DataObjectPointer
typedef Superclass::DataObjectPointerArraySizeType	DataObjectPointerArraySizeType
Public Types inherited from itk::ProcessObject
typedef std::vector < DataObjectPointer >	DataObjectPointerArray
typedef std::vector < DataObjectIdentifierType >	NameArray
Public Types inherited from itk::Object
Public Types inherited from itk::LightObject

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
void	SetFunctionCount (const IdCellType &n)
	typedef (Concept::EqualityComparable< typename TOutputImage::PixelType >) OutputEqualityComparableCheck
	typedef (Concept::Convertible< double, typename TOutputImage::PixelType >) DoubleConvertibleToOutputCheck
	typedef (Concept::OStreamWritable< typename TOutputImage::PixelType >) OutputOStreamWritableCheck
virtual void	SetNumberOfLayers (unsigned int _arg)
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::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
virtual const unsigned int &	GetElapsedIterations ()
InputImagePointer	GetLevelSet (const IdCellType &i)
virtual void	SetElapsedIterations (unsigned int _arg)
void	SetFunctionCount (const IdCellType &n)
void	SetKdTree (KdTreeType *kdtree)
void	SetLevelSet (const IdCellType &i, const InputImageType *levelSet)
void	SetLookup (VectorIdCellType lookup)
virtual const FiniteDifferenceFunctionPointer	GetDifferenceFunction (const IdCellType &functionIndex) const
virtual void	SetDifferenceFunction (const IdCellType &functionIndex, FiniteDifferenceFunctionPointer function)
virtual void	SetNumberOfIterations (unsigned int _arg)
virtual const unsigned int &	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	SetInitializedState (bool _arg)
virtual const bool &	GetInitializedState ()
virtual void	InitializedStateOn ()
virtual void	InitializedStateOff ()
virtual void	SetManualReinitialization (bool _arg)
virtual const bool &	GetManualReinitialization ()
virtual void	ManualReinitializationOn ()
virtual void	ManualReinitializationOff ()
Public Member Functions inherited from itk::InPlaceImageFilter< TFeatureImage, 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< TFeatureImage, TOutputImage >
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	SetInput (const InputImageType *image)
virtual void	SetInput (unsigned int, const TFeatureImage *image)
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 unsigned long	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 Member Functions
static Pointer	New ()

Static Public Attributes
static const unsigned int	ImageDimension = Superclass::ImageDimension
Static Public Attributes inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
Static Public Attributes inherited from itk::InPlaceImageFilter< TFeatureImage, TOutputImage >
static const unsigned int	InputImageDimension
static const unsigned int	OutputImageDimension
Static Public Attributes inherited from itk::ImageToImageFilter< TFeatureImage, TOutputImage >
Static Public Attributes inherited from itk::ImageSource< TOutputImage >

Protected Member Functions
void	AllocateUpdateBuffer ()
void	ApplyUpdate (TimeStepType dt)
TimeStepType	CalculateChange ()
virtual ValueType	CalculateUpdateValue (const OutputIndexType &, const TimeStepType &dt, const ValueType &value, const ValueType &change)
void	ConstructActiveLayer ()
void	ConstructLayer (SparseDataStruct *sparsePtr, StatusType from, StatusType to)
void	CopyInputToOutput ()
virtual ValueType	GetValueOne () const
virtual ValueType	GetValueZero () const
void	Initialize ()
void	InitializeActiveLayerValues ()
void	InitializeBackgroundConstants ()
virtual void	InitializeBackgroundPixels ()
void	InitializeIteration ()
virtual void	PostProcessOutput ()
virtual void	PrintSelf (std::ostream &os, Indent indent) const
void	ProcessOutsideList (LayerType *OutsideList, StatusType ChangeToStatus)
void	ProcessStatusList (LayerType *InputList, LayerType *OutputList, StatusType ChangeToStatus, StatusType SearchForStatus)
void	PropagateAllLayerValues ()
void	PropagateFunctionLayerValues (unsigned int functionIndex)
void	PropagateLayerValues (SparseDataStruct *sparsePtr, StatusType from, StatusType to, StatusType promote, int InOrOut)
void	UpdateActiveLayerValues (TimeStepType dt, LayerType *StatusUpList, LayerType *StatusDownList)
virtual void	UpdatePixel (unsigned int, unsigned int, NeighborhoodIterator< InputImageType > &, ValueType &, bool &)
	MultiphaseSparseFiniteDifferenceImageFilter ()
	~MultiphaseSparseFiniteDifferenceImageFilter ()
Protected Member Functions inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
virtual void	ApplyUpdate (TimeStepType dt)=0
virtual void	GenerateData ()
virtual void	GenerateInputRequestedRegion ()
virtual bool	Halt ()
	MultiphaseFiniteDifferenceImageFilter ()
TimeStepType	ResolveTimeStep (const TimeStepVectorType &timeStepList, const std::vector< bool > &valid)
virtual bool	ThreadedHalt (void *)
	~MultiphaseFiniteDifferenceImageFilter ()
Protected Member Functions inherited from itk::InPlaceImageFilter< TFeatureImage, TOutputImage >
virtual void	AllocateOutputs ()
virtual bool	GetRunningInPlace () const
	InPlaceImageFilter ()
virtual void	ReleaseInputs ()
	~InPlaceImageFilter ()
Protected Member Functions inherited from itk::ImageToImageFilter< TFeatureImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
	ImageToImageFilter ()
virtual void	VerifyInputInformation ()
	~ImageToImageFilter ()
void	PushBackInput (const DataObject *input)
void	PushFrontInput (const DataObject *input)
Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()
virtual void	BeforeThreadedGenerateData ()
	ImageSource ()
virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion)
virtual void	ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
virtual	~ImageSource ()
Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)
virtual void	AddOutput (DataObject *output)
bool	AddRequiredInputName (const DataObjectIdentifierType &)
virtual void	CacheInputReleaseDataFlags ()
virtual void	GenerateOutputInformation ()
virtual void	GenerateOutputRequestedRegion (DataObject *output)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs ()
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs ()
bool	IsIndexedName (const DataObjectIdentifierType &) const
bool	IsRequiredInputName (const DataObjectIdentifierType &) const
	itkLegacyMacro (virtual void RemoveInput(DataObject *input))
	itkLegacyMacro (virtual void RemoveOutput(DataObject *output))
	itkLegacyMacro (void SetNumberOfInputs(DataObjectPointerArraySizeType num))
	itkLegacyMacro (void SetNumberOfOutputs(DataObjectPointerArraySizeType num))
DataObjectPointerArraySizeType	MakeIndexFromName (const DataObjectIdentifierType &) const
DataObjectIdentifierType	MakeNameFromIndex (DataObjectPointerArraySizeType) const
	ProcessObject ()
virtual void	PropagateResetPipeline ()
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
bool	RemoveRequiredInputName (const DataObjectIdentifierType &)
virtual void	RestoreInputReleaseDataFlags ()
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
virtual void	SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual void	SetOutput (const DataObjectIdentifierType &key, DataObject *output)
virtual void	SetPrimaryInput (DataObject *input)
virtual void	SetPrimaryOutput (DataObject *output)
void	SetRequiredInputNames (const NameArray &)
virtual void	VerifyPreconditions ()
	~ProcessObject ()
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
DataObject *	GetOutput (DataObjectPointerArraySizeType idx)
const DataObject *	GetOutput (DataObjectPointerArraySizeType idx) const
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
Protected Member Functions inherited from itk::Object
	Object ()
bool	PrintObservers (std::ostream &os, Indent indent) const
virtual void	SetTimeStamp (const TimeStamp &time)
virtual	~Object ()
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
ValueType	m_BackgroundValue
ValueType	m_IsoSurfaceValue
NeighborListType	m_NeighborList
unsigned int	m_NumberOfLayers
std::vector< ValueType >	m_PixelDistance
std::vector< SparseDataStruct * >	m_SparseData
Protected Attributes inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
std::vector < FiniteDifferenceFunctionPointer >	m_DifferenceFunctions
unsigned int	m_ElapsedIterations
IdCellType	m_FunctionCount
KdTreePointer	m_KdTree
std::vector< InputImagePointer >	m_LevelSet
VectorIdCellType	m_Lookup
double	m_MaximumRMSError
unsigned int	m_NumberOfIterations
double	m_RMSChange
bool	m_UseImageSpacing

Static Protected Attributes
static double	m_ConstantGradientValue
static const StatusType	m_StatusActiveChangingDown
static const StatusType	m_StatusActiveChangingUp
static const StatusType	m_StatusBoundaryPixel
static const StatusType	m_StatusChanging
static const StatusType	m_StatusNull
static const ValueType	m_ValueOne
static const ValueType	m_ValueZero

Private Attributes
bool	m_BoundsCheckingActive
unsigned int	m_CurrentFunctionIndex
unsigned int	m_RMSCounter
double	m_RMSSum
bool	m_InterpolateSurfaceLocation
	MultiphaseSparseFiniteDifferenceImageFilter (const Self &)
void	operator= (const Self &)

Additional Inherited Members

---

Detailed Description

template<class TInputImage, class TFeatureImage, class TOutputImage, class TFunction, typename TIdCell = unsigned int>
class itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >

This class implements a finite difference partial differential equation solver for evolving surfaces embedded in volumes as level-sets.

The "sparse field" approach to the level-set model is a logical extension of the classical narrow band technique, which seeks to minimize computational effort by restricting calculations to those pixels in a region of interest around the moving surface (the -level curve). The sparse field method uses a narrow band that is exactly the width needed to calculate changes on the level curve for the next time step. Because the band of grid points under consideration is so sparse, this approach has several advantages: the algorithm does exactly the number of calculations needed to determine the next position of the -level curve, and the distance transform around the level curve can be recomputed at each iteration.

The sparse field algorithm works by constructing a linked list of indices that are adjacent to the -level set. These indices are called the "active set". The values at these active set indices define the position of the -level curve. The active set indices are shifted to follow the distance transform embedding of the -level curve as their values move in and out of a fixed numerical range about . In this way, the active set is maintained as only those pixels adjacent to the evolving surface. Calculations are then done only at indices contained in the active set.

The city-block neighborhoods of the active set indices are maintained as separate lists called ``layers''. At each iteration, the values at the layers are reinitialized as the distance transform from the active set. The number of layers can be adjusted according to the footprint needed for the calculations on the level curve.

Briefly, the sparse field solver algorithm is as follows:

1. For each active layer index : Compute the change at , the grid point in the embedding, based on local geometry and external forces and using a stable numerical scheme.
2. For each active layer index , add the change to the grid point value and redefine the active set indices and those of its layers based on any value changes which have moved outside of the numerical range allowed for the active set.
3. Starting with the first layers adjacent to the active set and moving outwards, reconstruct the distance transform by setting values in the layers according to their neighbors. At the very outer layers, add or remove indices which have come into or moved out of the sparse field.

HOW TO USE THIS CLASS

Typically, this class should be subclassed with additional functionality for specific applications. It is possible, however to use this solver as a filter directly by instantiating it and supplying it with an appropriate LevelSetFunction object via the SetDifferenceFunction method. See the subclasses and their associated documentation for more information on using this class. Also see the FiniteDifferenceImageFilter2 documentation for a general overview of this class of solvers.

INPUTS

This filter takes an itk::Image as input. The appropriate type of input image is entirely determined by the application. As a rule, however, the input type is immediately converted to the output type before processing. This is because the input is not assumed to be a real value type and must be converted to signed, real values for the calculations. The input values will also be shifted by the isosurface value so that the algorithm only needs to consider the zero level set.

OUTPUTS

The output of the filter is the distance transform embedding of the isosurface as the zero level set. Values INSIDE the surface will be NEGATIVE and values OUTSIDE the surface will be POSITIVE. The distance transform only holds for those indices in layers around the active layer. Elsewhere, the values are a fixed positive or negative that is one greater than the layer of greatest magnitude. In other words, if there are three layers, then inside values reach a minimum of -4.0 and outside values a maximum of 4.0.IndexType *this->SetNumberOfLayers(5);

PARAMETERS

The NumberOfLayers parameter controls the number of layers inside and outside of the active set (see description above). The sparse field will contain 2*NumberOfLayers+1 lists of indices: the active set and city block neighbors inside and outside the active set. It is important to specify enough layers to cover the footprint of your calculations. Curvature calculations in three dimensions, for example, require 3 layers. In two dimensions, a minimum of 2 layers is probably required. Higher order derivatives and other geometrical measures may require more layers. If too few layers are specified, then the calculations will pull values from the background, which may consist of arbitrary or random values.

The IsoSurfaceValue indicates which value in the input represents the interface of interest. By default, this value is zero. When the solver initializes, it will subtract the IsoSurfaceValue from all values, in the input, shifting the isosurface of interest to zero in the output.

IMPORTANT!

Read the documentation for FiniteDifferenceImageFilter2 before attempting to use this filter. The solver requires that you specify a FiniteDifferenceFunction to use for calculations. This is set using the method SetDifferenceFunction in the parent class.

REFERENCES

Whitaker, Ross. A Level-Set Approach to 3D Reconstruction from Range Data. International Journal of Computer Vision. V. 29 No. 3, 203-231. 1998.

Sethian, J.A. Level Set Methods. Cambridge University Press. 1996.

This code was adapted from the paper

   "An active contour model without edges"
    T. Chan and L. Vese.
    In Scale-Space Theories in Computer Vision, pages 141-151, 1999.

Author:

Mosaliganti K., Smith B., Gelas A., Gouaillard A., Megason S.

This code was taken from the Insight Journal paper:

"Cell Tracking using Coupled Active Surfaces for Nuclei and Membranes"
http://www.insight-journal.org/browse/publication/642
http://hdl.handle.net/10380/3055

That is based on the papers:

"Level Set Segmentation: Active Contours without edge"
http://www.insight-journal.org/browse/publication/322
http://hdl.handle.net/1926/1532

and

"Level set segmentation using coupled active surfaces"
http://www.insight-journal.org/browse/publication/323
http://hdl.handle.net/1926/1533

Definition at line 178 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

---

Member Typedef Documentation

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef NeighborhoodAlgorithm::ImageBoundaryFacesCalculator< StatusImageType > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::BFCType

Definition at line 268 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef SmartPointer< const Self > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ConstPointer

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 189 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::FeatureImagePointer itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeatureImagePointer

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 217 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::FeatureImageType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeatureImageType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 215 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::FeaturePointType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeaturePointType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 220 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::FeatureRegionType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeatureRegionType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 218 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::FeatureSizeType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeatureSizeType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 216 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::FeatureSpacingType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeatureSpacingType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 219 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef FiniteDifferenceFunctionType::FloatOffsetType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FiniteDifferenceFunctionFloatOffsetType

Definition at line 238 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::FiniteDifferenceFunctionPointer itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FiniteDifferenceFunctionPointer

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 236 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::FiniteDifferenceFunctionType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FiniteDifferenceFunctionType

The value type of the time step. This is distinct from PixelType because PixelType may often be a vector value, while the TimeStep is a scalar value.

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 234 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::IdCellType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::IdCellType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 231 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::InputImagePointer itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputImagePointer

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 204 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::InputImageType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputImageType

Information derived from the image types.

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 203 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::InputIndexType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputIndexType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 208 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::InputIndexValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputIndexValueType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 209 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::InputOffsetValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputOffsetValueType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 213 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::InputPixelType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputPixelType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 210 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::InputPointType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputPointType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 211 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::InputRegionType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputRegionType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 205 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::InputSizeType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputSizeType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 206 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::InputSizeValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputSizeValueType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 207 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::InputSpacingType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputSpacingType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 212 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef LayerType::ConstIterator itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerConstIterator

Definition at line 247 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef LayerType::Iterator itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerIterator

Definition at line 246 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef LayerListType::const_iterator itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerListConstIterator

Definition at line 252 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef LayerListType::iterator itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerListIterator

Definition at line 251 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef std::vector< LayerPointerType > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerListType

A type for a list of LayerPointerTypes

Definition at line 250 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef LayerNodeStorageType::Pointer itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerNodeStoragePointer

Definition at line 273 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef ObjectStore< LayerNodeType > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerNodeStorageType

Memory pre-allocator used to manage layer nodes in a multi-threaded environment.

Definition at line 272 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef SparseFieldLevelSetNode< OutputIndexType > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerNodeType

Node type used in sparse field layer lists.

Definition at line 241 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef LayerType::Pointer itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerPointerType

Definition at line 245 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef SparseFieldLayer< LayerNodeType > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerType

A list type used in the algorithm.

Definition at line 244 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef SparseFieldCityBlockNeighborList< NeighborhoodIterator< OutputImageType > > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::NeighborListType

Definition at line 279 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef NeighborListType::OffsetType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OffsetType

Definition at line 280 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::OutputImagePointer itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputImagePointer

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 223 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::OutputImageType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputImageType

Superclass typedefs.

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 222 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::OutputIndexType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputIndexType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 226 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::OutputIndexValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputIndexValueType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 227 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::OutputPixelType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputPixelType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 228 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::OutputRegionType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputRegionType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 224 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::OutputSizeType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputSizeType

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 225 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef SmartPointer< Self > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::Pointer

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 188 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef MultiphaseSparseFiniteDifferenceImageFilter itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::Self

Standard class typedefs

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 185 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef StatusImageType::Pointer itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::StatusImagePointer

Definition at line 261 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Image< StatusType, itkGetStaticConstMacro(ImageDimension) > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::StatusImageType

The type of the image used to index status information. Necessary for the internals of the algorithm.

Definition at line 260 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef signed char itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::StatusType

Type used for storing status information

Definition at line 255 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::Superclass

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 187 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef Superclass::TimeStepType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::TimeStepType

Typedefs from the superclass

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 200 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef UpdateBufferType::const_iterator itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::UpdateBufferConstIterator

Definition at line 277 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef std::vector< ValueType > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::UpdateBufferType

Container type used to store updates to the active layer.

Definition at line 276 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef InputImageType::ValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ValueType

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 230 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef ZeroCrossingFilterType::Pointer itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ZeroCrossingFilterPointer

Definition at line 266 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

typedef ZeroCrossingImageFilter< InputImageType, InputImageType > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ZeroCrossingFilterType

Definition at line 264 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

---

Constructor & Destructor Documentation

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::MultiphaseSparseFiniteDifferenceImageFilter ( )

protected

End concept checking

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::~MultiphaseSparseFiniteDifferenceImageFilter ( )

inlineprotected

End concept checking

Definition at line 334 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::MultiphaseSparseFiniteDifferenceImageFilter ( const Self &  )

private

This flag tells the solver whether or not to interpolate for the actual surface location when calculating change at each active layer node. By default this is turned on. Subclasses which do not sample propagation (speed), advection, or curvature terms should turn this flag off.

---

Member Function Documentation

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::AllocateUpdateBuffer ( )

inlineprotectedvirtual

Reserves memory in the update buffer. Called before each iteration.

Implements itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Definition at line 417 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ApplyUpdate ( TimeStepType  dt )

protected

Applies the update buffer values to the active layer and reconstructs the sparse field layers for the next iteration.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

TimeStepType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::CalculateChange ( )

protectedvirtual

Traverses the active layer list and calculates the change at these indices to be applied in the current iteration.

Implements itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual ValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::CalculateUpdateValue ( const OutputIndexType &  , const TimeStepType &  dt, const ValueType &  value, const ValueType &  change  )

inlineprotectedvirtual

This function allows a subclass to override the way in which updates to output values are applied during each iteration. The default simply follows the standard finite difference scheme of scaling the change by the timestep and adding to the value of the previous iteration.

Definition at line 387 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ConstructActiveLayer ( )

protected

Constructs the active layer and initialize the first layers inside and outside of the active layer. The active layer defines the position of the zero level set by its values, which are constrained within a range around zero.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ConstructLayer ( SparseDataStruct *  sparsePtr, StatusType  from, StatusType  to  )

protected

Initializes a layer of the sparse field using a previously initialized layer. Builds the list of nodes in m_Layer[to] using m_Layer[from]. Marks values in the m_StatusImage.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::CopyInputToOutput ( )

protectedvirtual

Copies the input to the output image. Processing occurs on the output image, so the data type of the output image determines the precision of the calculations (i.e. double or float). This method overrides the parent class method to do some additional processing.

Implements itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual::itk::LightObject::Pointer itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::CreateAnother ( void  ) const

virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::Object.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual bool itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::GetInterpolateSurfaceLocation ( ) const

virtual

Get/Set the value of the InterpolateSurfaceLocation flag. This flag tells the solver whether or not to interpolate for the surface location when calculating change at a voxel location. Turned on by default. Some applications may not use this value and can safely turn the flag off.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual ValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::GetIsoSurfaceValue ( ) const

virtual

Set/Get the value of the isosurface to use in the input image.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual const char* itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual unsigned int itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::GetNumberOfLayers ( ) const

virtual

Set/Get the number of layers to use in the sparse field. Argument is the number of layers on ONE side of the active layer, so the total layers in the sparse field is 2 * NumberOfLayers +1

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual ValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::GetValueOne ( ) const

protectedvirtual

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual ValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::GetValueZero ( ) const

protectedvirtual

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::Initialize ( )

protectedvirtual

Constructs the sparse field layers and initializes their values.

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InitializeActiveLayerValues ( )

protected

Initializes the values of the active layer set.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InitializeBackgroundConstants ( )

protected

Initializes the pixel constants that will be set outside the sparse layer.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InitializeBackgroundPixels ( )

protectedvirtual

This method pre-processes pixels inside and outside the sparse field layers. The default is to set them to positive and negative values, respectively. This is not necessary as part of the calculations, but produces a more intuitive output for the user.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InitializeIteration ( )

protectedvirtual

This method is optionally defined by a subclass and is called immediately prior to each iterative CalculateChange-ApplyUpdate cycle. It can be used to set global variables needed for the next iteration (ie. average gradient magnitude of the image in anisotropic diffusion functions), or otherwise prepare for the next iteration.

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InterpolateSurfaceLocationOff ( )

inline

See Get/SetInterpolateSurfaceLocation

Definition at line 305 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InterpolateSurfaceLocationOn ( )

inline

See Get/SetInterpolateSurfaceLocation

Definition at line 303 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

static Pointer itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::New ( )

static

Method for creation through the object factory.

Reimplemented from itk::Object.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::operator= ( const Self &  )

private

This flag tells the solver whether or not to interpolate for the actual surface location when calculating change at each active layer node. By default this is turned on. Subclasses which do not sample propagation (speed), advection, or curvature terms should turn this flag off.

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::PostProcessOutput ( )

protectedvirtual

This method packages the output(s) into a consistent format. The default implementation produces a volume with the final solution values in the sparse field, and inside and outside values elsewhere as appropriate.

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

protectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ProcessOutsideList ( LayerType *  OutsideList, StatusType  ChangeToStatus  )

protected

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ProcessStatusList ( LayerType *  InputList, LayerType *  OutputList, StatusType  ChangeToStatus, StatusType  SearchForStatus  )

protected

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::PropagateAllLayerValues ( )

protected

Adjusts the values associated with all the index layers of the sparse field by propagating out one layer at a time from the active set. This method also takes care of deleting nodes from the layers which have been marked in the status image as having been moved to other layers.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::PropagateFunctionLayerValues ( unsigned int  functionIndex )

protected

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::PropagateLayerValues ( SparseDataStruct *  sparsePtr, StatusType  from, StatusType  to, StatusType  promote, int  InOrOut  )

protected

Adjusts the values in a single layer "to" using values in a neighboring layer "from". The list of indices in "to" are traversed and assigned new values appropriately. Any indices in "to" without neighbors in "from" are moved into the "promote" layer (or deleted if "promote" is greater than the number of layers). "InOrOut" == 1 indicates this propagation is inwards (more negative). "InOrOut" == 2 indicates this propagation is outwards (more positive).

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::SetFunctionCount ( const IdCellType &  n )

inline

Definition at line 309 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::SetInterpolateSurfaceLocation ( bool  _arg )

virtual

Get/Set the value of the InterpolateSurfaceLocation flag. This flag tells the solver whether or not to interpolate for the surface location when calculating change at a voxel location. Turned on by default. Some applications may not use this value and can safely turn the flag off.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::SetIsoSurfaceValue ( ValueType  _arg )

virtual

Set/Get the value of the isosurface to use in the input image.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::SetNumberOfLayers ( unsigned int  _arg )

virtual

Set/Get the number of layers to use in the sparse field. Argument is the number of layers on ONE side of the active layer, so the total layers in the sparse field is 2 * NumberOfLayers +1

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::typedef

(

Concept::EqualityComparable< typename TOutputImage::PixelType >

)

Begin concept checking This class requires OutputEqualityComparableCheck in the form of ( Concept::EqualityComparable< typename TOutputImage::PixelType > )

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::typedef

(

Concept::Convertible< double, typename TOutputImage::PixelType >

)

This class requires DoubleConvertibleToOutputCheck in the form of ( Concept::Convertible< double, typename TOutputImage::PixelType > )

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::typedef

(

Concept::OStreamWritable< typename TOutputImage::PixelType >

)

This class requires OutputOStreamWritableCheck in the form of ( Concept::OStreamWritable< typename TOutputImage::PixelType > )

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::UpdateActiveLayerValues ( TimeStepType  dt, LayerType *  StatusUpList, LayerType *  StatusDownList  )

protected

Updates the active layer values using m_UpdateBuffer. Also creates an "up" and "down" list for promotion/demotion of indices leaving the active set.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

virtual void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::UpdatePixel ( unsigned int  , unsigned int  , NeighborhoodIterator< InputImageType > &  , ValueType &  , bool &    )

inlineprotectedvirtual

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 479 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

---

Member Data Documentation

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

const unsigned int itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ImageDimension = Superclass::ImageDimension

static

Dimensionality of input and output data is assumed to be the same.

Reimplemented from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >.

Reimplemented in itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 197 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

ValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_BackgroundValue

protected

The value of the pixel outside the sparse layers

Definition at line 528 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

bool itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_BoundsCheckingActive

private

This flag is true when methods need to check boundary conditions and false when methods do not need to check for boundary conditions.

Definition at line 547 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

double itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_ConstantGradientValue

staticprotected

The constant gradient to maintain between isosurfaces in the sparse-field of the level-set image. This value defaults to 1.0

Definition at line 485 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

unsigned int itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_CurrentFunctionIndex

private

Definition at line 540 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

bool itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_InterpolateSurfaceLocation

protected

This flag tells the solver whether or not to interpolate for the actual surface location when calculating change at each active layer node. By default this is turned on. Subclasses which do not sample propagation (speed), advection, or curvature terms should turn this flag off.

Definition at line 534 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

ValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_IsoSurfaceValue

protected

The value in the input which represents the isosurface of interest.

Definition at line 525 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

NeighborListType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_NeighborList

protected

Connectivity information for examining neighbor pixels.

Definition at line 378 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

unsigned int itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_NumberOfLayers

protected

The number of layers to use in the sparse field. Sparse field will consist of m_NumberOfLayers layers on both sides of a single active layer. This active layer is the interface of interest, i.e. the zero level set.

Definition at line 522 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

std::vector< ValueType > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_PixelDistance

protected

Stores the distance between pixels in the neighborhood iterator.

Definition at line 381 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

unsigned int itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_RMSCounter

private

Definition at line 543 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

double itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_RMSSum

private

Definition at line 542 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

std::vector< SparseDataStruct * > itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_SparseData

protected

Definition at line 517 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

const StatusType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_StatusActiveChangingDown

staticprotected

Special status value which indicates a pending change to a more negative sparse field.

Definition at line 507 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

const StatusType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_StatusActiveChangingUp

staticprotected

Special status value which indicates a pending change to a more positive sparse field.

Definition at line 503 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

const StatusType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_StatusBoundaryPixel

staticprotected

Special status value which indicates a pixel is on the boundary of the image

Definition at line 511 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

const StatusType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_StatusChanging

staticprotected

Special status value which indicates pending change to another sparse field layer.

Definition at line 499 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

const StatusType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_StatusNull

staticprotected

Special status value used as a default for indices which have no meaningful status.

Definition at line 515 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

const ValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_ValueOne

staticprotected

Multiplicative identity of the ValueType.

Definition at line 492 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

template<class TInputImage , class TFeatureImage , class TOutputImage , class TFunction , typename TIdCell = unsigned int>

const ValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_ValueZero

staticprotected

Additive identity of the ValueType.

Definition at line 495 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

---

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

• itkMultiphaseSparseFiniteDifferenceImageFilter.h