#include <itkMultiphaseSparseFiniteDifferenceImageFilter.h>

Detailed Description

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 \(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 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 \(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.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.

For algorithmic details see [141] and \sethian1996.

This code was adapted from [22].

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"
https://doi.org/10.54294/wvwmf8

That is based on the papers:

"Level Set Segmentation: Active Contours without edge"
https://doi.org/10.54294/8jk6oy

and

"Level set segmentation using coupled active surfaces"
https://doi.org/10.54294/23ugmy

Definition at line 167 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

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

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

Classes
struct	SparseDataStruct

Public Types
using	BFCType = NeighborhoodAlgorithm::ImageBoundaryFacesCalculator<StatusImageType>

using	ConstPointer = SmartPointer<const Self>

using	FeatureImagePointer

using	FeatureImageType

using	FeaturePointType

using	FeatureRegionType

using	FeatureSizeType

using	FeatureSpacingType

using	FiniteDifferenceFunctionFloatOffsetType = typename FiniteDifferenceFunctionType::FloatOffsetType

using	FiniteDifferenceFunctionPointer

using	FiniteDifferenceFunctionType

using	IdCellType

using	InputImagePointer

using	InputImageType

using	InputIndexType

using	InputIndexValueType

using	InputOffsetValueType

using	InputPixelType

using	InputPointType

using	InputRegionType

using	InputSizeType

using	InputSizeValueType

using	InputSpacingType

using	LayerConstIterator = typename LayerType::ConstIterator

using	LayerIterator = typename LayerType::Iterator

using	LayerListConstIterator = typename LayerListType::const_iterator

using	LayerListIterator = typename LayerListType::iterator

using	LayerListType = std::vector<LayerPointerType>

using	LayerNodeStoragePointer = typename LayerNodeStorageType::Pointer

using	LayerNodeStorageType = ObjectStore<LayerNodeType>

using	LayerNodeType = SparseFieldLevelSetNode<OutputIndexType>

using	LayerPointerType = typename LayerType::Pointer

using	LayerType = SparseFieldLayer<LayerNodeType>

using	NeighborListType = SparseFieldCityBlockNeighborList<NeighborhoodIterator<OutputImageType>>

using	OffsetType = typename NeighborListType::OffsetType

using	OutputImagePointer

using	OutputImageType

using	OutputIndexType

using	OutputIndexValueType

using	OutputPixelType

using	OutputRegionType

using	OutputSizeType

using	Pointer = SmartPointer<Self>

using	Self = MultiphaseSparseFiniteDifferenceImageFilter

using	StatusImagePointer = typename StatusImageType::Pointer

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

using	StatusType = signed char

using	Superclass

using	TimeStepType

using	UpdateBufferConstIterator = typename UpdateBufferType::const_iterator

using	UpdateBufferType = std::vector<ValueType>

using	ValueType = typename InputImageType::ValueType

using	ZeroCrossingFilterPointer = typename ZeroCrossingFilterType::Pointer

using	ZeroCrossingFilterType = ZeroCrossingImageFilter<InputImageType, InputImageType>

Public Types inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, unsigned int >
using	CentroidVectorType

using	ConstPointer

using	FeatureImagePointer

using	FeatureImageType

using	FeaturePixelType

using	FeaturePointType

using	FeatureRegionType

using	FeatureSizeType

using	FeatureSpacingType

using	FiniteDifferenceFunctionPointer

using	FiniteDifferenceFunctionType

using	IdCellType

using	InputCoordinateType

using	InputImagePointer

using	InputImageType

using	InputIndexType

using	InputIndexValueType

using	InputOffsetValueType

using	InputPixelType

using	InputPointType

using	InputRegionType

using	InputSizeType

using	InputSizeValueType

using	InputSpacingType

using	KdTreeGeneratorPointer

using	KdTreeGeneratorType

using	KdTreePointer

using	KdTreeType

using	OutputImagePointer

using	OutputImageType

using	OutputIndexType

using	OutputIndexValueType

using	OutputPixelType

using	OutputRegionType

using	OutputSizeType

using	OutputSizeValueType

using	Pointer

using	RadiusType

using	SampleType

using	Self

using	Superclass

using	TimeStepType

using	TimeStepVectorType

using	VectorIdCellType

Public Types inherited from itk::InPlaceImageFilter< TFeatureImage, TOutputImage >
using	ConstPointer

using	InputImageConstPointer

using	InputImagePixelType

using	InputImagePointer

using	InputImageRegionType

using	InputImageType

typedef typename OutputImageType::PixelType	OutputImagePixelType

using	OutputImagePixelType

typedef typename OutputImageType::RegionType	OutputImageRegionType

using	OutputImageRegionType

using	Pointer

using	Self

using	Superclass

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	OutputImagePixelType

using	OutputImageRegionType

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

const char *	GetNameOfClass () const override

void	SetFunctionCount (const IdCellType &n)


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

virtual void	InterpolateSurfaceLocationOn ()

virtual void	InterpolateSurfaceLocationOff ()

Public Member Functions inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, unsigned int >
virtual const unsigned int &	GetElapsedIterations () const

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

virtual void	SetUseImageSpacing (bool _arg)

virtual void	UseImageSpacingOn ()

virtual void	UseImageSpacingOff ()

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	SetInitializedState (bool _arg)

virtual const bool &	GetInitializedState () const

virtual void	InitializedStateOn ()

virtual void	InitializedStateOff ()

virtual void	SetManualReinitialization (bool _arg)

virtual const bool &	GetManualReinitialization () const

virtual void	ManualReinitializationOn ()

virtual void	ManualReinitializationOff ()

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

virtual bool	CanRunInPlace () const

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

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

const InputImageType *	GetInput (unsigned int idx) const

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *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 >
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	AbortGenerateDataOff ()

virtual void	AbortGenerateDataOn ()

virtual void	EnlargeOutputRequestedRegion (DataObject *output)

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

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

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

virtual int	GetReferenceCount () const

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

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 = Superclass::ImageDimension

Static Public Attributes inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, unsigned int >
static constexpr unsigned int	ImageDimension

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

static constexpr unsigned int	InputImageDimension

static constexpr unsigned int	OutputImageDimension

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 (TimeStepType dt) override

TimeStepType	CalculateChange () override

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

void	ConstructActiveLayer ()

void	ConstructLayer (SparseDataStruct *sparsePtr, StatusType from, StatusType to)

void	CopyInputToOutput () override

virtual ValueType	GetValueOne () const

virtual ValueType	GetValueZero () const

void	Initialize () override

void	InitializeActiveLayerValues ()

void	InitializeBackgroundConstants ()

virtual void	InitializeBackgroundPixels ()

void	InitializeIteration () override

	MultiphaseSparseFiniteDifferenceImageFilter ()

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	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 functionIndex, unsigned int idx, NeighborhoodIterator< InputImageType > &iterator, ValueType &newValue, bool &status)

	~MultiphaseSparseFiniteDifferenceImageFilter () override

Protected Member Functions inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, unsigned int >
void	GenerateData () override

void	GenerateInputRequestedRegion () override

virtual bool	Halt ()

	MultiphaseFiniteDifferenceImageFilter ()

TimeStepType	ResolveTimeStep (const TimeStepVectorType &timeStepList, const std::vector< uint8_t > &valid)

virtual bool	ThreadedHalt (void *threadInfo)

	~MultiphaseFiniteDifferenceImageFilter () override=default

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

virtual bool	GetRunningInPlace () const

	InPlaceImageFilter ()=default

	InPlaceImageFilter ()=default

void	ReleaseInputs () override

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

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)

	ImageToImageFilter ()

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

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

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

virtual void	DynamicMultiThreadingOff ()

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

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

virtual void	SetThreaderUpdateProgress (bool arg)

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

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

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	PrintTrailer (std::ostream &os, Indent indent) const

virtual	~LightObject ()

Protected Attributes
ValueType	m_BackgroundValue {}

bool	m_InterpolateSurfaceLocation {}

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, unsigned int >
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

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 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 { 0 }

double	m_RMSSum { 0. }

Additional Inherited Members
Protected Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using	InputToOutputRegionCopierType

using	OutputToInputRegionCopierType

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

◆ BFCType

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

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

Definition at line 252 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ ConstPointer

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

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

Definition at line 179 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ FeatureImagePointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeatureImagePointer

Definition at line 194 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeatureImageType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeatureImageType

Definition at line 193 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeaturePointType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeaturePointType

Definition at line 198 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeatureRegionType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeatureRegionType

Definition at line 195 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeatureSizeType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeatureSizeType

Definition at line 196 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeatureSpacingType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FeatureSpacingType

Definition at line 197 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FiniteDifferenceFunctionFloatOffsetType

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FiniteDifferenceFunctionFloatOffsetType = typename FiniteDifferenceFunctionType::FloatOffsetType

Definition at line 225 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ FiniteDifferenceFunctionPointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FiniteDifferenceFunctionPointer

Definition at line 217 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FiniteDifferenceFunctionType

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

using itk::MultiphaseFiniteDifferenceImageFilter< 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.

Definition at line 216 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ IdCellType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::IdCellType

Definition at line 210 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputImagePointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputImagePointer

Definition at line 177 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputImageType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputImageType

Input and output image types.

Definition at line 176 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputIndexType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputIndexType

Definition at line 184 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputIndexValueType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputIndexValueType

Definition at line 185 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputOffsetValueType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputOffsetValueType

Definition at line 191 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputPixelType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputPixelType

Definition at line 189 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputPointType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputPointType

Definition at line 178 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputRegionType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputRegionType

Definition at line 188 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputSizeType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputSizeType

Definition at line 186 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputSizeValueType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputSizeValueType

Definition at line 187 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputSpacingType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::InputSpacingType

Definition at line 190 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ LayerConstIterator

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerConstIterator = typename LayerType::ConstIterator

Definition at line 234 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ LayerIterator

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerIterator = typename LayerType::Iterator

Definition at line 233 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ LayerListConstIterator

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerListConstIterator = typename LayerListType::const_iterator

Definition at line 239 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ LayerListIterator

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerListIterator = typename LayerListType::iterator

Definition at line 238 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ LayerListType

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

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

A type for a list of LayerPointerTypes

Definition at line 237 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ LayerNodeStoragePointer

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerNodeStoragePointer = typename LayerNodeStorageType::Pointer

Definition at line 257 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ LayerNodeStorageType

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

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

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

Definition at line 256 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ LayerNodeType

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

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

Node type used in sparse field layer lists.

Definition at line 228 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ LayerPointerType

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::LayerPointerType = typename LayerType::Pointer

Definition at line 232 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ LayerType

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

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

A list type used in the algorithm.

Definition at line 231 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ NeighborListType

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

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

Definition at line 263 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ OffsetType

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OffsetType = typename NeighborListType::OffsetType

Definition at line 264 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ OutputImagePointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputImagePointer

Definition at line 202 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputImageType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputImageType

Definition at line 201 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputIndexType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputIndexType

Definition at line 207 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputIndexValueType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputIndexValueType

Definition at line 208 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputPixelType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputPixelType

Definition at line 203 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputRegionType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputRegionType

Definition at line 204 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputSizeType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputSizeType

Definition at line 205 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ Pointer

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

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

Definition at line 178 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ Self

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

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

Standard class type aliases

Definition at line 175 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ StatusImagePointer

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::StatusImagePointer = typename StatusImageType::Pointer

Definition at line 247 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ StatusImageType

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::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 246 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ StatusType

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

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

Type used for storing status information

Definition at line 242 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ Superclass

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

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

Initial value:

MultiphaseFiniteDifferenceImageFilter<TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell>

itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, unsigned int >::MultiphaseFiniteDifferenceImageFilter

MultiphaseFiniteDifferenceImageFilter()

Definition itkMultiphaseFiniteDifferenceImageFilter.h:389

Definition at line 176 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ TimeStepType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::TimeStepType

Definition at line 218 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ UpdateBufferConstIterator

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::UpdateBufferConstIterator = typename UpdateBufferType::const_iterator

Definition at line 261 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ UpdateBufferType

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

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

Container type used to store updates to the active layer.

Definition at line 260 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ ValueType

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ValueType = typename InputImageType::ValueType

Definition at line 220 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ ZeroCrossingFilterPointer

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

using itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ZeroCrossingFilterPointer = typename ZeroCrossingFilterType::Pointer

Definition at line 250 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ ZeroCrossingFilterType

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

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

Definition at line 249 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

Constructor & Destructor Documentation

◆ MultiphaseSparseFiniteDifferenceImageFilter()

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

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

protected

◆ ~MultiphaseSparseFiniteDifferenceImageFilter()

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

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

inlineoverrideprotected

Definition at line 306 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

Member Function Documentation

◆ AllocateUpdateBuffer()

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

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

inlineoverrideprotectedvirtual

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

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

Definition at line 392 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ ApplyUpdate()

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

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

overrideprotectedvirtual

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

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

◆ CalculateChange()

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

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

overrideprotectedvirtual

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, unsigned int >.

◆ CalculateUpdateValue()

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

virtual ValueType itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::CalculateUpdateValue	(	const OutputIndexType &	idx,
		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 358 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ ConstructActiveLayer()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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.

◆ ConstructLayer()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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.

◆ CopyInputToOutput()

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

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::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::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, unsigned int >.

◆ CreateAnother()

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

virtual::itk::LightObject::Pointer itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::CreateAnother ( ) 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::LightObject.

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

◆ GetInterpolateSurfaceLocation()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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.

◆ GetIsoSurfaceValue()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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.

◆ GetNameOfClass()

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

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

overridevirtual

See also: LightObject::GetNameOfClass()

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

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

◆ GetNumberOfLayers()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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

◆ GetValueOne()

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

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

protectedvirtual

◆ GetValueZero()

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

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

protectedvirtual

◆ Initialize()

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

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

overrideprotectedvirtual

Constructs the sparse field layers and initializes their values.

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

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

◆ InitializeActiveLayerValues()

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

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

protected

Initializes the values of the active layer set.

◆ InitializeBackgroundConstants()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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.

◆ InitializeBackgroundPixels()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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.

◆ InitializeIteration()

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

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

overrideprotectedvirtual

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, unsigned int >.

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

◆ InterpolateSurfaceLocationOff()

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

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

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.

◆ InterpolateSurfaceLocationOn()

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

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

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.

◆ New()

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

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

static

Method for creation through the object factory.

◆ PostProcessOutput()

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

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::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::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, unsigned int >.

◆ PrintSelf()

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

void itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::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::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, unsigned int >.

◆ ProcessOutsideList()

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

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

protected

◆ ProcessStatusList()

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

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

protected

◆ PropagateAllLayerValues()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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.

◆ PropagateFunctionLayerValues()

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

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

protected

◆ PropagateLayerValues()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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).

◆ SetFunctionCount()

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

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

inline

Definition at line 288 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ SetInterpolateSurfaceLocation()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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.

◆ SetIsoSurfaceValue()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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.

◆ SetNumberOfLayers()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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

Referenced by itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >::ScalarChanAndVeseSparseLevelSetImageFilter().

◆ UpdateActiveLayerValues()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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.

◆ UpdatePixel()

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

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

inlineprotectedvirtual

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

Definition at line 468 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

Member Data Documentation

◆ ImageDimension

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

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

staticconstexpr

Definition at line 187 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_BackgroundValue

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 519 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_BoundsCheckingActive

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 535 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_ConstantGradientValue

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 480 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_CurrentFunctionIndex

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

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

private

Definition at line 528 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_InterpolateSurfaceLocation

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 525 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_IsoSurfaceValue

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 516 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_NeighborList

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 348 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_NumberOfLayers

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 513 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_PixelDistance

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 351 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_RMSCounter

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

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

private

Definition at line 531 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_RMSSum

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

double itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_RMSSum { 0. }

private

Definition at line 530 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_SparseData

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

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

protected

Definition at line 508 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_StatusActiveChangingDown

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 498 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_StatusActiveChangingUp

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 494 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_StatusBoundaryPixel

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 502 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_StatusChanging

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 490 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_StatusNull

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 506 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_ValueOne

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 483 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ m_ValueZero

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename 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 486 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

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

itkMultiphaseSparseFiniteDifferenceImageFilter.h

Detailed Description

Classes

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

◆ BFCType

◆ ConstPointer

◆ FeatureImagePointer

◆ FeatureImageType

◆ FeaturePointType

◆ FeatureRegionType

◆ FeatureSizeType

◆ FeatureSpacingType

◆ FiniteDifferenceFunctionFloatOffsetType

◆ FiniteDifferenceFunctionPointer

◆ FiniteDifferenceFunctionType

◆ IdCellType

◆ InputImagePointer

◆ InputImageType

◆ InputIndexType

◆ InputIndexValueType

◆ InputOffsetValueType

◆ InputPixelType

◆ InputPointType

◆ InputRegionType

◆ InputSizeType

◆ InputSizeValueType

◆ InputSpacingType

◆ LayerConstIterator

◆ LayerIterator

◆ LayerListConstIterator

◆ LayerListIterator

◆ LayerListType

◆ LayerNodeStoragePointer

◆ LayerNodeStorageType

◆ LayerNodeType

◆ LayerPointerType

◆ LayerType

◆ NeighborListType

◆ OffsetType

◆ OutputImagePointer

◆ OutputImageType

◆ OutputIndexType

◆ OutputIndexValueType

◆ OutputPixelType

◆ OutputRegionType

◆ OutputSizeType

◆ Pointer

◆ Self

◆ StatusImagePointer

◆ StatusImageType

◆ StatusType

◆ Superclass

◆ TimeStepType

◆ UpdateBufferConstIterator

◆ UpdateBufferType

◆ ValueType

◆ ZeroCrossingFilterPointer

◆ ZeroCrossingFilterType

Constructor & Destructor Documentation

◆ MultiphaseSparseFiniteDifferenceImageFilter()

◆ ~MultiphaseSparseFiniteDifferenceImageFilter()

Member Function Documentation

◆ AllocateUpdateBuffer()

◆ ApplyUpdate()

◆ CalculateChange()

◆ CalculateUpdateValue()

◆ ConstructActiveLayer()

◆ ConstructLayer()

◆ CopyInputToOutput()

◆ CreateAnother()

◆ GetInterpolateSurfaceLocation()

◆ GetIsoSurfaceValue()