#include <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 = typename Superclass::FeatureImagePointer

using	FeatureImageType = typename Superclass::FeatureImageType

using	FeaturePointType = typename Superclass::FeaturePointType

using	FeatureRegionType = typename Superclass::FeatureRegionType

using	FeatureSizeType = typename Superclass::FeatureSizeType

using	FeatureSpacingType = typename Superclass::FeatureSpacingType

using	FiniteDifferenceFunctionFloatOffsetType = typename FiniteDifferenceFunctionType::FloatOffsetType

using	FiniteDifferenceFunctionPointer = typename Superclass::FiniteDifferenceFunctionPointer

using	FiniteDifferenceFunctionType = typename Superclass::FiniteDifferenceFunctionType

using	IdCellType = typename Superclass::IdCellType

using	InputImagePointer = typename Superclass::InputImagePointer

using	InputImageType = typename Superclass::InputImageType

using	InputIndexType = typename Superclass::InputIndexType

using	InputIndexValueType = typename Superclass::InputIndexValueType

using	InputOffsetValueType = typename Superclass::InputOffsetValueType

using	InputPixelType = typename Superclass::InputPixelType

using	InputPointType = typename Superclass::InputPointType

using	InputRegionType = typename Superclass::InputRegionType

using	InputSizeType = typename Superclass::InputSizeType

using	InputSizeValueType = typename Superclass::InputSizeValueType

using	InputSpacingType = typename Superclass::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 = typename Superclass::OutputImagePointer

using	OutputImageType = typename Superclass::OutputImageType

using	OutputIndexType = typename Superclass::OutputIndexType

using	OutputIndexValueType = typename Superclass::OutputIndexValueType

using	OutputPixelType = typename Superclass::OutputPixelType

using	OutputRegionType = typename Superclass::OutputRegionType

using	OutputSizeType = typename Superclass::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 = MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >

using	TimeStepType = typename Superclass::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, TIdCell >
using	CentroidVectorType = Vector< float, Self::ImageDimension >

using	ConstPointer = SmartPointer< const Self >

using	FeatureImagePointer = typename FeatureImageType::Pointer

using	FeatureImageType = TFeatureImage

using	FeaturePixelType = typename FeatureImageType::PixelType

using	FeaturePointType = typename FeatureImageType::PointType

using	FeatureRegionType = typename FeatureImageType::RegionType

using	FeatureSizeType = typename FeatureImageType::SizeType

using	FeatureSpacingType = typename FeatureImageType::SpacingType

using	FiniteDifferenceFunctionPointer = typename FiniteDifferenceFunctionType::Pointer

using	FiniteDifferenceFunctionType = TFunction

using	IdCellType = TIdCell

using	InputCoordRepType = typename InputPointType::CoordRepType

using	InputImagePointer = typename InputImageType::Pointer

using	InputImageType = TInputImage

using	InputIndexType = typename InputImageType::IndexType

using	InputIndexValueType = typename InputIndexType::IndexValueType

using	InputOffsetValueType = typename InputImageType::OffsetValueType

using	InputPixelType = typename InputImageType::PixelType

using	InputPointType = typename InputImageType::PointType

using	InputRegionType = typename InputImageType::RegionType

using	InputSizeType = typename InputImageType::SizeType

using	InputSizeValueType = typename InputSizeType::SizeValueType

using	InputSpacingType = typename InputImageType::SpacingType

using	KdTreeGeneratorPointer = typename KdTreeGeneratorType::Pointer

using	KdTreeGeneratorType = Statistics::KdTreeGenerator< SampleType >

using	KdTreePointer = typename KdTreeType::Pointer

using	KdTreeType = typename KdTreeGeneratorType::KdTreeType

using	OutputImagePointer = typename OutputImageType::Pointer

using	OutputImageType = TOutputImage

using	OutputIndexType = typename OutputImageType::IndexType

using	OutputIndexValueType = typename OutputImageType::IndexValueType

using	OutputPixelType = typename OutputImageType::PixelType

using	OutputRegionType = typename OutputImageType::RegionType

using	OutputSizeType = typename OutputImageType::SizeType

using	OutputSizeValueType = typename OutputImageType::SizeValueType

using	Pointer = SmartPointer< Self >

using	RadiusType = typename FiniteDifferenceFunctionType::RadiusType

using	SampleType = Statistics::ListSample< CentroidVectorType >

using	Self = MultiphaseFiniteDifferenceImageFilter

using	Superclass = InPlaceImageFilter< TFeatureImage, TOutputImage >

using	TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

using	TimeStepVectorType = typename std::vector< TimeStepType >

using	VectorIdCellType = std::vector< IdCellType >

Public Types inherited from itk::InPlaceImageFilter< TFeatureImage, 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 = TFeatureImage

using	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImagePointer = typename Superclass::OutputImagePointer

using	OutputImageRegionType = typename Superclass::OutputImageRegionType

using	OutputImageType = typename Superclass::OutputImageType

using	Pointer = SmartPointer< Self >

using	Self = InPlaceImageFilter

using	Superclass = ImageToImageFilter< TFeatureImage, TOutputImage >

Public Types inherited from itk::ImageToImageFilter< TFeatureImage, 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 = TFeatureImage

using	OutputImagePixelType = typename Superclass::OutputImagePixelType

using	OutputImageRegionType = typename Superclass::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

virtual const char *	GetNameOfClass () const

Public Member Functions inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
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 ()

virtual void	SetElapsedIterations (unsigned int _arg)

virtual const unsigned int &	GetElapsedIterations () const

void	SetLevelSet (const IdCellType &i, const InputImageType *levelSet)

InputImagePointer	GetLevelSet (const IdCellType &i)

void	SetLookup (VectorIdCellType lookup)

void	SetKdTree (KdTreeType *kdtree)

void	SetFunctionCount (const IdCellType &n)

Public Member Functions inherited from itk::InPlaceImageFilter< TFeatureImage, TOutputImage >
virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

virtual void	InPlaceOff ()

virtual bool	CanRunInPlace () const

Public Member Functions inherited from itk::ImageToImageFilter< TFeatureImage, 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 DataObjectIdentifierType &key, DataObject *input)

virtual void	SetInput (const InputImageType *input)

virtual void	SetInput (unsigned int, const TFeatureImage *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 ()

const OutputImageType *	GetOutput () const

OutputImageType *	GetOutput (unsigned int idx)

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

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

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	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

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

MultiThreaderType *	GetMultiThreader () const

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	PrepareOutputs ()

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

unsigned long	AddObserver (const EventObject &event, Command *) const

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

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag)

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< TFeatureImage, TOutputImage >
static void	SetGlobalDefaultDirectionTolerance (double)

static double	GetGlobalDefaultDirectionTolerance ()

static void	SetGlobalDefaultCoordinateTolerance (double)

static double	GetGlobalDefaultCoordinateTolerance ()

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, TIdCell >
static constexpr unsigned int	ImageDimension

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

static constexpr unsigned int	OutputImageDimension

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

static constexpr unsigned int	OutputImageDimension

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

NeighborListType	m_NeighborList

std::vector< ValueType >	m_PixelDistance

std::vector< SparseDataStruct * >	m_SparseData

unsigned int	m_NumberOfLayers

ValueType	m_IsoSurfaceValue

ValueType	m_BackgroundValue

bool	m_InterpolateSurfaceLocation

static double	m_ConstantGradientValue

static const ValueType	m_ValueOne

static const ValueType	m_ValueZero

static const StatusType	m_StatusChanging

static const StatusType	m_StatusActiveChangingUp

static const StatusType	m_StatusActiveChangingDown

static const StatusType	m_StatusBoundaryPixel

static const StatusType	m_StatusNull

unsigned int	m_CurrentFunctionIndex

double	m_RMSSum { 0. }

unsigned int	m_RMSCounter { 0 }

bool	m_BoundsCheckingActive

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

void	SetFunctionCount (const IdCellType &n)

	MultiphaseSparseFiniteDifferenceImageFilter ()

	~MultiphaseSparseFiniteDifferenceImageFilter () override

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

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

void	PostProcessOutput () override

virtual void	InitializeBackgroundPixels ()

void	Initialize () override

void	CopyInputToOutput () override

void	AllocateUpdateBuffer () override

void	ApplyUpdate (TimeStepType dt) override

TimeStepType	CalculateChange () override

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

void	ConstructActiveLayer ()

void	InitializeActiveLayerValues ()

void	InitializeBackgroundConstants ()

void	PropagateLayerValues (SparseDataStruct *sparsePtr, StatusType from, StatusType to, StatusType promote, int InOrOut)

void	PropagateAllLayerValues ()

void	PropagateFunctionLayerValues (unsigned int functionIndex)

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

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

void	ProcessOutsideList (LayerType *OutsideList, StatusType ChangeToStatus)

void	InitializeIteration () override

virtual void	UpdatePixel (unsigned int, unsigned int, NeighborhoodIterator< InputImageType > &, ValueType &, bool &)

virtual ValueType	GetValueZero () const

virtual ValueType	GetValueOne () const

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

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

Protected Member Functions inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
	MultiphaseFiniteDifferenceImageFilter ()

	~MultiphaseFiniteDifferenceImageFilter () override=default

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

virtual void	ApplyUpdate (TimeStepType dt)=0

void	GenerateData () override

void	GenerateInputRequestedRegion () override

virtual bool	Halt ()

virtual bool	ThreadedHalt (void *)

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

Protected Member Functions inherited from itk::InPlaceImageFilter< TFeatureImage, TOutputImage >
	InPlaceImageFilter ()=default

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

void	ReleaseInputs () override

virtual bool	GetRunningInPlace () const

Protected Member Functions inherited from itk::ImageToImageFilter< TFeatureImage, TOutputImage >
void	PushBackInput (const DataObject *input) override

void	PushFrontInput (const DataObject *input) override

	ImageToImageFilter ()

	~ImageToImageFilter () override=default

void	VerifyInputInformation () ITKv5_CONST override

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

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

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

	~ImageSource () override=default

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

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

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual void	BeforeThreadedGenerateData ()

virtual void	AfterThreadedGenerateData ()

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

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

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

virtual void	DynamicMultiThreadingOff ()

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

	~ProcessObject () override

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

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

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	AddInput (DataObject *input)

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

virtual void	SetPrimaryInput (DataObject *object)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

void	SetRequiredInputNames (const NameArray &)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

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

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

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual void	SetPrimaryOutput (DataObject *object)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

virtual void	AddOutput (DataObject *output)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

virtual void	VerifyPreconditions () ITKv5_CONST

virtual void	GenerateOutputRequestedRegion (DataObject *output)

virtual void	GenerateOutputInformation ()

virtual void	PropagateResetPipeline ()

virtual void	CacheInputReleaseDataFlags ()

virtual void	RestoreInputReleaseDataFlags ()

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	ThreaderUpdateProgressOff ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

	~Object () override

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

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

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
static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Protected Attributes inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
IdCellType	m_FunctionCount

std::vector< InputImagePointer >	m_LevelSet

VectorIdCellType	m_Lookup

KdTreePointer	m_KdTree

unsigned int	m_ElapsedIterations

double	m_MaximumRMSError

double	m_RMSChange

unsigned int	m_NumberOfIterations

std::vector< FiniteDifferenceFunctionPointer >	m_DifferenceFunctions

bool	m_UseImageSpacing

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

Protected Attributes inherited from itk::ProcessObject
bool	m_Updating

TimeStamp	m_OutputInformationMTime

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

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 -level curve). The sparse field method uses a narrow band that is exactly the width needed to calculate changes on the level curve for the next time step. Because the band of grid points under consideration is so sparse, this approach has several advantages: the algorithm does exactly the number of calculations needed to determine the next position of the -level curve, and the distance transform around the level curve can be recomputed at each iteration.

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

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

: Briefly, the sparse field solver algorithm is as follows:

For each active layer index : 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 , 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 isosurface value so that the algorithm only needs to consider the zero level set.

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

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

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

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

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

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

This code was adapted from the paper

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

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

This code was taken from the Insight Journal paper:

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

That is based on the papers:

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

and

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

Definition at line 181 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

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 266 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 193 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ FeatureImagePointer

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

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

Definition at line 221 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ FeatureImageType

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

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

Definition at line 219 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ FeaturePointType

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

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

Definition at line 224 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ FeatureRegionType

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

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

Definition at line 222 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ FeatureSizeType

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

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

Definition at line 220 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ FeatureSpacingType

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

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

Definition at line 223 of file itkMultiphaseSparseFiniteDifferenceImageFilter.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 239 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ FiniteDifferenceFunctionPointer

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

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

Definition at line 238 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ FiniteDifferenceFunctionType

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

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

Definition at line 237 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ IdCellType

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

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

Definition at line 235 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ InputImagePointer

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

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

Definition at line 208 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ InputImageType

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

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

Information derived from the image types.

Definition at line 207 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ InputIndexType

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

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

Definition at line 212 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ InputIndexValueType

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

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

Definition at line 213 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ InputOffsetValueType

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

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

Definition at line 217 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ InputPixelType

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

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

Definition at line 214 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ InputPointType

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

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

Definition at line 215 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ InputRegionType

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

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

Definition at line 209 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ InputSizeType

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

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

Definition at line 210 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ InputSizeValueType

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

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

Definition at line 211 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ InputSpacingType

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

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

Definition at line 216 of file itkMultiphaseSparseFiniteDifferenceImageFilter.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 248 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 247 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 253 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 252 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 251 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 271 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 270 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 242 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 246 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 245 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 277 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 278 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ OutputImagePointer

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

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

Definition at line 227 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ OutputImageType

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

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

Definition at line 226 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ OutputIndexType

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

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

Definition at line 230 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ OutputIndexValueType

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

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

Definition at line 231 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ OutputPixelType

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

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

Definition at line 232 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ OutputRegionType

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

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

Definition at line 228 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ OutputSizeType

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

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

Definition at line 229 of file itkMultiphaseSparseFiniteDifferenceImageFilter.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 192 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 189 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 261 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 260 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 256 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 = MultiphaseFiniteDifferenceImageFilter<TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell>

Definition at line 191 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

◆ TimeStepType

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

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

Typedefs from the superclass

Definition at line 204 of file itkMultiphaseSparseFiniteDifferenceImageFilter.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 275 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 274 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 234 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 264 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 263 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

Connectivity information for examining neighbor pixels.

◆ ~MultiphaseSparseFiniteDifferenceImageFilter()

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

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

inlineoverrideprotected

Connectivity information for examining neighbor pixels.

Definition at line 324 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, TIdCell >.

Definition at line 410 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 )

overrideprotected

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

◆ 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, TIdCell >.

◆ 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 &	,
		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 376 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, TIdCell >.

◆ 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::Object.

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

Connectivity information for examining neighbor pixels.

◆ 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

Connectivity information for examining neighbor pixels.

◆ GetNameOfClass()

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

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

virtual

Run-time type information (and related methods).

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

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

◆ 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

Connectivity information for examining neighbor pixels.

◆ 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

Connectivity information for examining neighbor pixels.

◆ 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

Connectivity information for examining neighbor pixels.

◆ 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, TIdCell >.

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

Connectivity information for examining neighbor pixels.

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

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

Connectivity information for examining neighbor pixels.

◆ 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

Connectivity information for examining neighbor pixels.

◆ 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, TIdCell >.

◆ 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

Connectivity information for examining neighbor pixels.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ 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

Connectivity information for examining neighbor pixels.

◆ 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

Connectivity information for examining neighbor pixels.

◆ 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

Connectivity information for examining neighbor pixels.

◆ 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

Connectivity information for examining neighbor pixels.

Definition at line 302 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

◆ 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	,
		unsigned int	,
		NeighborhoodIterator< InputImageType > &	,
		ValueType &	,
		bool &
	)

inlineprotectedvirtual

Connectivity information for examining neighbor pixels.

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

Definition at line 486 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

Member Data Documentation

◆ ImageDimension

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

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

staticconstexpr

Definition at line 201 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 537 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 553 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 494 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

Connectivity information for examining neighbor pixels.

Definition at line 546 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 543 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 534 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 366 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 531 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 369 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

Connectivity information for examining neighbor pixels.

Definition at line 549 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

Connectivity information for examining neighbor pixels.

Definition at line 548 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

Connectivity information for examining neighbor pixels.

Definition at line 526 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 516 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 512 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 520 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 508 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 524 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 501 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 504 of file itkMultiphaseSparseFiniteDifferenceImageFilter.h.

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

itkMultiphaseSparseFiniteDifferenceImageFilter.h

Classes

Public Types

Public Member Functions

Static Public Member Functions

Static Public Attributes

Additional Inherited Members

Detailed Description

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

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

◆ GetNameOfClass()

◆ GetNumberOfLayers()

◆ GetValueOne()

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