#include <itkSparseFieldLevelSetImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >

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 \(k\)-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 \(k\)-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 \(k\)-level set. These indices are called the "active set". The values at these active set indices define the position of the \(k\)-level curve. The active set indices are shifted to follow the distance transform embedding of the \(k\)-level curve as their values move in and out of a fixed numerical range about \(k\). 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:

For each active layer index \(x_j\): Compute the change at \(u_{x_j}\), the grid point in the embedding, based on local geometry and external forces and using a stable numerical scheme.
For each active layer index \(x_j\), 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.
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 FiniteDifferenceImageFilter 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 \(k\) 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.

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 require a minimum of 2 layers. 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 FiniteDifferenceImageFilter 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.

Definition at line 244 of file itkSparseFieldLevelSetImageFilter.h.

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

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

Public Types
using	ConstPointer = SmartPointer< const Self >

using	IndexType = typename OutputImageType::IndexType

using	InputImageType = TInputImage

using	LayerListType = std::vector< LayerPointerType >

using	LayerNodeStorageType = ObjectStore< LayerNodeType >

using	LayerNodeType = SparseFieldLevelSetNode< IndexType >

using	LayerPointerType = typename LayerType::Pointer

using	LayerType = SparseFieldLayer< LayerNodeType >

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = SparseFieldLevelSetImageFilter

using	StatusImageType = Image< StatusType, Self::ImageDimension >

using	StatusType = signed char

using	Superclass = FiniteDifferenceImageFilter< TInputImage, TOutputImage >

using	UpdateBufferType = std::vector< ValueType >

using	ValueType = typename OutputImageType::ValueType

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

using	FiniteDifferenceFunctionType = FiniteDifferenceFunction< TOutputImage >

using	InputImageType = TInputImage

using	InputPixelType = typename TInputImage::PixelType

using	InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType

using	NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType

using	OutputImageType = TOutputImage

using	OutputPixelType = typename TOutputImage::PixelType

using	OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType

using	PixelType = OutputPixelType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename FiniteDifferenceFunctionType::RadiusType

using	Self = FiniteDifferenceImageFilter

using	Superclass = InPlaceImageFilter< TInputImage, TOutputImage >

using	TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

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

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TInputImage, TOutputImage >

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

using	InputImageConstPointer = typename InputImageType::ConstPointer

using	InputImagePixelType = typename InputImageType::PixelType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageRegionType = typename InputImageType::RegionType

using	InputImageType = TInputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageToImageFilter

using	Superclass = ImageSource< TOutputImage >

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

using	DataObjectIdentifierType = Superclass::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType

using	OutputImagePixelType = typename OutputImageType::PixelType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageRegionType = typename OutputImageType::RegionType

using	OutputImageType = TOutputImage

using	Pointer = SmartPointer< Self >

using	Self = ImageSource

using	Superclass = ProcessObject

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

using	DataObjectIdentifierType = DataObject::DataObjectIdentifierType

using	DataObjectPointer = DataObject::Pointer

using	DataObjectPointerArray = std::vector< DataObjectPointer >

using	DataObjectPointerArraySizeType = DataObjectPointerArray::size_type

using	MultiThreaderType = MultiThreaderBase

using	NameArray = std::vector< DataObjectIdentifierType >

using	Pointer = SmartPointer< Self >

using	Self = ProcessObject

using	Superclass = Object

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

using	Pointer = SmartPointer< Self >

using	Self = Object

using	Superclass = LightObject

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

using	Pointer = SmartPointer< Self >

using	Self = LightObject

Public Member Functions
const char *	GetNameOfClass () const override


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::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
virtual const FiniteDifferenceFunctionType::Pointer &	GetDifferenceFunction () const

virtual const IdentifierType &	GetElapsedIterations () const

virtual bool	GetIsInitialized ()

const char *	GetNameOfClass () const override

virtual void	SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)

virtual void	SetIsInitialized (bool _arg)

void	SetStateToInitialized ()

void	SetStateToUninitialized ()

virtual void	SetNumberOfIterations (IdentifierType _arg)

virtual const IdentifierType &	GetNumberOfIterations () const

virtual void	SetUseImageSpacing (bool _arg)

virtual void	UseImageSpacingOn ()

virtual const bool &	GetUseImageSpacing () const

virtual void	SetMaximumRMSError (double _arg)

virtual const double &	GetMaximumRMSError () const

virtual void	SetRMSChange (double _arg)

virtual const double &	GetRMSChange () const

virtual void	SetManualReinitialization (bool _arg)

virtual const bool &	GetManualReinitialization () const

virtual void	ManualReinitializationOn ()

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

const char *	GetNameOfClass () const override

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

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

virtual void	SetCoordinateTolerance (double _arg)

virtual double	GetCoordinateTolerance () const

virtual void	SetDirectionTolerance (double _arg)

virtual double	GetDirectionTolerance () const

Public Member Functions inherited from itk::ImageSource< TOutputImage >
const char *	GetNameOfClass () const override

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

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

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

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

ProcessObject::DataObjectPointer	MakeOutput (const ProcessObject::DataObjectIdentifierType &) override

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

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

Public Member Functions inherited from itk::Object
unsigned long	AddObserver (const EventObject &event, Command *cmd) const

unsigned long	AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

Public Member Functions inherited from itk::LightObject
Pointer	Clone () const

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

void	Print (std::ostream &os, Indent indent=0) const

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Member Functions
static Pointer	New ()

Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static double	GetGlobalDefaultCoordinateTolerance ()

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static void	SetGlobalDefaultDirectionTolerance (double)

Static Public Member Functions inherited from itk::Object
static bool	GetGlobalWarningDisplay ()

static void	GlobalWarningDisplayOff ()

static void	GlobalWarningDisplayOn ()

static Pointer	New ()

static void	SetGlobalWarningDisplay (bool val)

Static Public Member Functions inherited from itk::LightObject
static void	BreakOnError ()

static Pointer	New ()

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

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

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

static constexpr unsigned int	OutputImageDimension

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

static constexpr unsigned int	OutputImageDimension = TOutputImage::ImageDimension

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

Protected Member Functions
void	AllocateUpdateBuffer () override

void	ApplyUpdate (const TimeStepType &dt) override

TimeStepType	CalculateChange () override

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

void	ConstructActiveLayer ()

void	ConstructLayer (StatusType from, StatusType to)

void	CopyInputToOutput () override

virtual ValueType	GetValueOne () const

virtual ValueType	GetValueZero () const

void	Initialize () override

void	InitializeActiveLayerValues ()

virtual void	InitializeBackgroundPixels ()

void	PostProcessOutput () override

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

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 UpList, LayerType DownList)

	~SparseFieldLevelSetImageFilter () override=default

Protected Member Functions inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
virtual void	AllocateUpdateBuffer ()=0

virtual void	ApplyUpdate (const TimeStepType &dt)=0

virtual TimeStepType	CalculateChange ()=0

virtual void	CopyInputToOutput ()=0

	FiniteDifferenceImageFilter ()

void	GenerateData () override

void	GenerateInputRequestedRegion () override

virtual bool	Halt ()

virtual void	Initialize ()

virtual void	InitializeIteration ()

virtual void	PostProcessOutput ()

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

virtual TimeStepType	ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const BooleanStdVectorType &valid) const

virtual void	SetElapsedIterations (IdentifierType _arg)

virtual bool	ThreadedHalt (void *)

	~FiniteDifferenceImageFilter () override=default

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

	InPlaceImageFilter ()=default

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

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void	CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)

virtual void	CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

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

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void	AfterThreadedGenerateData ()

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

virtual unsigned int	SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)

	~ImageSource () override=default

virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

Protected Member Functions inherited from itk::ProcessObject
virtual void	AddInput (DataObject *input)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

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 idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer	InternalClone () const

	LightObject ()

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

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

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

virtual	~LightObject ()

Protected Attributes
double	m_ConstantGradientValue { 1.0 }

const InputImageType *	m_InputImage {}

bool	m_InterpolateSurfaceLocation { true }

ValueType	m_IsoSurfaceValue {}

LayerNodeStorageType::Pointer	m_LayerNodeStore {}

LayerListType	m_Layers {}

SparseFieldCityBlockNeighborList< NeighborhoodIterator< OutputImageType > >	m_NeighborList {}

unsigned int	m_NumberOfLayers { 2 }

OutputImageType *	m_OutputImage {}

OutputImageType::Pointer	m_ShiftedImage {}

StatusImageType::Pointer	m_StatusImage {}

UpdateBufferType	m_UpdateBuffer {}

Protected Attributes inherited from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >
IdentifierType	m_ElapsedIterations {}

bool	m_IsInitialized {}

bool	m_ManualReinitialization {}

double	m_MaximumRMSError {}

IdentifierType	m_NumberOfIterations {}

double	m_RMSChange {}

Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool	m_DynamicMultiThreading { true }

Protected Attributes inherited from itk::ProcessObject
TimeStamp	m_OutputInformationMTime {}

bool	m_Updating {}

Protected Attributes inherited from itk::LightObject
std::atomic< int >	m_ReferenceCount {}

Static Protected Attributes
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

Private Attributes
bool	m_BoundsCheckingActive { false }

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >

using	OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >

Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

Static Protected Member Functions inherited from itk::ProcessObject
template<typename TSourceObject >
static void	MakeRequiredOutputs (TSourceObject &sourceObject, const DataObjectPointerArraySizeType numberOfRequiredOutputs)

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 253 of file itkSparseFieldLevelSetImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::IndexType = typename OutputImageType::IndexType

Definition at line 269 of file itkSparseFieldLevelSetImageFilter.h.

◆ InputImageType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Information derived from the image types.

Definition at line 267 of file itkSparseFieldLevelSetImageFilter.h.

◆ LayerListType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerListType = std::vector<LayerPointerType>

A type for a list of LayerPointerTypes

Definition at line 284 of file itkSparseFieldLevelSetImageFilter.h.

◆ LayerNodeStorageType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerNodeStorageType = ObjectStore<LayerNodeType>

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

Definition at line 295 of file itkSparseFieldLevelSetImageFilter.h.

◆ LayerNodeType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerNodeType = SparseFieldLevelSetNode<IndexType>

Node type used in sparse field layer lists.

Definition at line 277 of file itkSparseFieldLevelSetImageFilter.h.

◆ LayerPointerType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerPointerType = typename LayerType::Pointer

Definition at line 281 of file itkSparseFieldLevelSetImageFilter.h.

◆ LayerType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::LayerType = SparseFieldLayer<LayerNodeType>

A list type used in the algorithm.

Definition at line 280 of file itkSparseFieldLevelSetImageFilter.h.

◆ OutputImageType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 268 of file itkSparseFieldLevelSetImageFilter.h.

◆ Pointer

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 252 of file itkSparseFieldLevelSetImageFilter.h.

◆ Self

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Self = SparseFieldLevelSetImageFilter

Standard class type aliases

Definition at line 250 of file itkSparseFieldLevelSetImageFilter.h.

◆ StatusImageType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::StatusImageType = Image<StatusType, Self::ImageDimension>

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

Definition at line 291 of file itkSparseFieldLevelSetImageFilter.h.

◆ StatusType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::StatusType = signed char

Type used for storing status information

Definition at line 287 of file itkSparseFieldLevelSetImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Superclass = FiniteDifferenceImageFilter<TInputImage, TOutputImage>

Definition at line 251 of file itkSparseFieldLevelSetImageFilter.h.

◆ UpdateBufferType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::UpdateBufferType = std::vector<ValueType>

Container type used to store updates to the active layer.

Definition at line 298 of file itkSparseFieldLevelSetImageFilter.h.

◆ ValueType

template<typename TInputImage , typename TOutputImage >

using itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ValueType = typename OutputImageType::ValueType

The data type used in numerical computations. Derived from the output image type.

Definition at line 274 of file itkSparseFieldLevelSetImageFilter.h.

Constructor & Destructor Documentation

◆ SparseFieldLevelSetImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::SparseFieldLevelSetImageFilter ( )

protected

◆ ~SparseFieldLevelSetImageFilter()

template<typename TInputImage , typename TOutputImage >

itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::~SparseFieldLevelSetImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ AllocateUpdateBuffer()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::AllocateUpdateBuffer ( )

overrideprotectedvirtual

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

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

◆ ApplyUpdate()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ApplyUpdate ( const TimeStepType & dt )

overrideprotectedvirtual

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

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

◆ CalculateChange()

template<typename TInputImage , typename TOutputImage >

TimeStepType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CalculateChange ( )

overrideprotectedvirtual

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

Implements itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

◆ CalculateUpdateValue()

template<typename TInputImage , typename TOutputImage >

virtual ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CalculateUpdateValue	(	const IndexType &	,
		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.

Reimplemented in itk::AntiAliasBinaryImageFilter< TInputImage, TOutputImage >.

Definition at line 358 of file itkSparseFieldLevelSetImageFilter.h.

◆ ConstructActiveLayer()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::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.

◆ ConstructLayer()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ConstructLayer	(	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.

◆ CopyInputToOutput()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::CopyInputToOutput ( )

overrideprotectedvirtual

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::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

◆ GetInterpolateSurfaceLocation()

template<typename TInputImage , typename TOutputImage >

virtual bool itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetInterpolateSurfaceLocation ( ) const

virtual

Get the RMS change calculated in the PREVIOUS iteration. This value is the square root of the average square of the change value of all pixels updated during the previous iteration. 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.

◆ GetIsoSurfaceValue()

template<typename TInputImage , typename TOutputImage >

virtual ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetIsoSurfaceValue ( ) const

virtual

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

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >

const char * itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::AntiAliasBinaryImageFilter< TInputImage, TOutputImage >, and itk::UnsharpMaskLevelSetImageFilter< TInputImage, TOutputImage >.

◆ GetNumberOfLayers()

template<typename TInputImage , typename TOutputImage >

virtual unsigned int itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::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

◆ GetValueOne()

template<typename TInputImage , typename TOutputImage >

virtual ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetValueOne ( ) const

protectedvirtual

◆ GetValueZero()

template<typename TInputImage , typename TOutputImage >

virtual ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::GetValueZero ( ) const

protectedvirtual

◆ Initialize()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::Initialize ( )

overrideprotectedvirtual

Constructs the sparse field layers and initializes their values.

Reimplemented from itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

◆ InitializeActiveLayerValues()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InitializeActiveLayerValues ( )

protected

Initializes the values of the active layer set.

◆ InitializeBackgroundPixels()

template<typename TInputImage , typename TOutputImage >

virtual void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::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.

◆ InterpolateSurfaceLocationOff()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InterpolateSurfaceLocationOff ( )

inline

See Get/SetInterpolateSurfaceLocation

Definition at line 333 of file itkSparseFieldLevelSetImageFilter.h.

◆ InterpolateSurfaceLocationOn()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InterpolateSurfaceLocationOn ( )

inline

See Get/SetInterpolateSurfaceLocation

Definition at line 328 of file itkSparseFieldLevelSetImageFilter.h.

◆ New()

template<typename TInputImage , typename TOutputImage >

static Pointer itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::New ( )

static

Method for creation through the object factory.

◆ PostProcessOutput()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::PostProcessOutput ( )

overrideprotectedvirtual

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::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::PrintSelf	(	std::ostream &	os,
		Indent	indent
	)		const

overrideprotectedvirtual

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::FiniteDifferenceImageFilter< TInputImage, TOutputImage >.

Reimplemented in itk::AntiAliasBinaryImageFilter< TInputImage, TOutputImage >, and itk::UnsharpMaskLevelSetImageFilter< TInputImage, TOutputImage >.

◆ ProcessOutsideList()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ProcessOutsideList	(	LayerType *	OutsideList,
		StatusType	ChangeToStatus
	)

protected

◆ ProcessStatusList()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ProcessStatusList	(	LayerType *	InputList,
		LayerType *	OutputList,
		StatusType	ChangeToStatus,
		StatusType	SearchForStatus
	)

protected

◆ PropagateAllLayerValues()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::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.

◆ PropagateLayerValues()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::PropagateLayerValues	(	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).

◆ SetInterpolateSurfaceLocation()

template<typename TInputImage , typename TOutputImage >

virtual void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::SetInterpolateSurfaceLocation ( bool _arg )

virtual

Get the RMS change calculated in the PREVIOUS iteration. This value is the square root of the average square of the change value of all pixels updated during the previous iteration. 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.

◆ SetIsoSurfaceValue()

template<typename TInputImage , typename TOutputImage >

virtual void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::SetIsoSurfaceValue ( ValueType _arg )

virtual

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

◆ SetNumberOfLayers()

template<typename TInputImage , typename TOutputImage >

virtual void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::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

Reimplemented in itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >.

◆ UpdateActiveLayerValues()

template<typename TInputImage , typename TOutputImage >

void itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::UpdateActiveLayerValues	(	TimeStepType	dt,
		LayerType *	UpList,
		LayerType *	DownList
	)

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.

Member Data Documentation

◆ ImageDimension

template<typename TInputImage , typename TOutputImage >

constexpr unsigned int itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 270 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_BoundsCheckingActive

template<typename TInputImage , typename TOutputImage >

bool itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_BoundsCheckingActive { false }

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 538 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_ConstantGradientValue

template<typename TInputImage , typename TOutputImage >

double itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ConstantGradientValue { 1.0 }

protected

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 463 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_InputImage

template<typename TInputImage , typename TOutputImage >

const InputImageType* itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_InputImage {}

protected

Definition at line 532 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_InterpolateSurfaceLocation

template<typename TInputImage , typename TOutputImage >

bool itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_InterpolateSurfaceLocation { true }

protected

The RMS change calculated from each update. Can be used by a subclass to determine halting criteria. Valid only for the previous iteration, not during the current iteration. Calculated in ApplyUpdate. 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 530 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_IsoSurfaceValue

template<typename TInputImage , typename TOutputImage >

ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_IsoSurfaceValue {}

protected

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

Definition at line 515 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_LayerNodeStore

template<typename TInputImage , typename TOutputImage >

LayerNodeStorageType::Pointer itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_LayerNodeStore {}

protected

Storage for layer node objects.

Definition at line 512 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_Layers

template<typename TInputImage , typename TOutputImage >

LayerListType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_Layers {}

protected

An array which contains all of the layers needed in the sparse field. Layers are organized as follows: m_Layer[0] = active layer, m_Layer[i:odd] = inside layer (i+1)/2, m_Layer[i:even] = outside layer i/2

Definition at line 500 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_NeighborList

template<typename TInputImage , typename TOutputImage >

SparseFieldCityBlockNeighborList<NeighborhoodIterator<OutputImageType> > itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_NeighborList {}

protected

Connectivity information for examining neighbor pixels.

Definition at line 459 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_NumberOfLayers

template<typename TInputImage , typename TOutputImage >

unsigned int itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_NumberOfLayers { 2 }

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 506 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_OutputImage

template<typename TInputImage , typename TOutputImage >

OutputImageType* itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_OutputImage {}

protected

Definition at line 533 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_ShiftedImage

template<typename TInputImage , typename TOutputImage >

OutputImageType::Pointer itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ShiftedImage {}

protected

This image is a copy of the input with m_IsoSurfaceValue subtracted from each pixel. This way we only need to consider the zero level set in our calculations. Makes the implementation easier and more efficient.

Definition at line 494 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_StatusActiveChangingDown

template<typename TInputImage , typename TOutputImage >

StatusType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusActiveChangingDown

staticprotected

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

Definition at line 481 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_StatusActiveChangingUp

template<typename TInputImage , typename TOutputImage >

StatusType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusActiveChangingUp

staticprotected

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

Definition at line 477 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_StatusBoundaryPixel

template<typename TInputImage , typename TOutputImage >

StatusType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusBoundaryPixel

staticprotected

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

Definition at line 485 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_StatusChanging

template<typename TInputImage , typename TOutputImage >

StatusType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusChanging

staticprotected

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

Definition at line 473 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_StatusImage

template<typename TInputImage , typename TOutputImage >

StatusImageType::Pointer itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusImage {}

protected

An image of status values used internally by the algorithm.

Definition at line 509 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_StatusNull

template<typename TInputImage , typename TOutputImage >

StatusType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_StatusNull

staticprotected

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

Definition at line 489 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_UpdateBuffer

template<typename TInputImage , typename TOutputImage >

UpdateBufferType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_UpdateBuffer {}

protected

The update buffer used to store change values computed in CalculateChange.

Definition at line 519 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_ValueOne

template<typename TInputImage , typename TOutputImage >

ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ValueOne

staticprotected

Multiplicative identity of the ValueType.

Definition at line 466 of file itkSparseFieldLevelSetImageFilter.h.

◆ m_ValueZero

template<typename TInputImage , typename TOutputImage >

ValueType itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::m_ValueZero

staticprotected

Additive identity of the ValueType.

Definition at line 469 of file itkSparseFieldLevelSetImageFilter.h.

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

itkSparseFieldLevelSetImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ ConstPointer

◆ IndexType

◆ InputImageType

◆ LayerListType

◆ LayerNodeStorageType

◆ LayerNodeType

◆ LayerPointerType

◆ LayerType

◆ OutputImageType

◆ Pointer

◆ Self

◆ StatusImageType

◆ StatusType

◆ Superclass

◆ UpdateBufferType

◆ ValueType

Constructor & Destructor Documentation

◆ SparseFieldLevelSetImageFilter()

◆ ~SparseFieldLevelSetImageFilter()

Member Function Documentation

◆ AllocateUpdateBuffer()

◆ ApplyUpdate()

◆ CalculateChange()

◆ CalculateUpdateValue()

◆ ConstructActiveLayer()

◆ ConstructLayer()

◆ CopyInputToOutput()

◆ GetInterpolateSurfaceLocation()

◆ GetIsoSurfaceValue()

◆ GetNameOfClass()

◆ GetNumberOfLayers()

◆ GetValueOne()

◆ GetValueZero()

◆ Initialize()

◆ InitializeActiveLayerValues()

◆ InitializeBackgroundPixels()

◆ InterpolateSurfaceLocationOff()

◆ InterpolateSurfaceLocationOn()

◆ New()

◆ PostProcessOutput()

◆ PrintSelf()

◆ ProcessOutsideList()

◆ ProcessStatusList()

◆ PropagateAllLayerValues()

◆ PropagateLayerValues()

◆ SetInterpolateSurfaceLocation()

◆ SetIsoSurfaceValue()

◆ SetNumberOfLayers()

◆ UpdateActiveLayerValues()

Member Data Documentation

◆ ImageDimension

◆ m_BoundsCheckingActive

◆ m_ConstantGradientValue

◆ m_InputImage

◆ m_InterpolateSurfaceLocation

◆ m_IsoSurfaceValue

◆ m_LayerNodeStore

◆ m_Layers

◆ m_NeighborList

◆ m_NumberOfLayers

◆ m_OutputImage

◆ m_ShiftedImage

◆ m_StatusActiveChangingDown

◆ m_StatusActiveChangingUp

◆ m_StatusBoundaryPixel

◆ m_StatusChanging

◆ m_StatusImage

◆ m_StatusNull

◆ m_UpdateBuffer