#include <itkMultiphaseFiniteDifferenceImageFilter.h>

Detailed Description

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFiniteDifferenceFunction = FiniteDifferenceFunction<TOutputImage>, typename TIdCell = unsigned int>
class itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >

The Finite Difference Solver Hierarchy

This is an alternate version of the ITK finite difference solver (FDS) framework, supporting the solution of multiple functions, simultaneously. The FDS framework is a set of classes for creating filters to solve partial differential equations on images using an iterative, finite difference update scheme.

: The high-level algorithm implemented by the framework can be described by the following pseudocode.

WHILE NOT convergence:
   FOR ALL pixels i
    FOR ALL functions f
    min_time_step = min(min_time_step, calculate_change(f, i))
    FOR ALL functions f
        update(f, i, time_step)

: The following equation describes update \(n+1\) at pixel \(i\) on discrete image \( u \) :

: \(u_{\mathbf{i}}^{n+1}=u^n_{\mathbf{i}}+\Delta u^n_{\mathbf{i}}\Delta t\)

Component objects: The FDS hierarchy is comprised of two component object types, variations of which are designed to be plugged together to create filters for different applications. At the process level are the "solver" objects, which are subclasses of MultiphaseFiniteDifferenceImageFilter. Solver objects are filters that take image inputs and produce image outputs. Solver objects require a "finite difference function" object to perform the calculation at each image pixel during iteration. These specialized function objects are subclasses of FiniteDifferenceFunction. FiniteDifferenceFunctions take a neighborhood of pixels as input (in the form of an itk::NeighborhoodIterator) and produce a scalar valued result.

: Filters for different applications are created by defining a function object to handle the numerical calculations and choosing (or creating) a solver object that reflects the requirements and constraints of the application. For example, anisotropic diffusion filters are created by plugging anisotropic diffusion functions into the DenseFiniteDifferenceImageFilter2. The separation between function object and solver object allows us to create, for example, sparse-field, dense-field, and narrow-band implementations of a level-set surface evolution filter can all be constructed by plugging the same function object into three different, specialized solvers.

Creating new filters in this hierarchy: The procedure for creating a filter within the FDS hierarchy is to identify all the virtual methods that need to be defined for your particular application. In the simplest case, a filter needs only to instantiate a specific function object and define some halting criteria. For more complicated applications, you may need to define a specialized type of iteration scheme or updating procedure in a higher-level solver object.

: Some simple examples are the specific subclasses of AnisotropicDiffusionImageFilter. The leaves of the anisotropic diffusion filter tree only define the function object they use for their particular flavor of diffusion. See CurvatureAnisotropicDiffusionImageFilter and GradientAnisotropicDiffusionImageFilter for details.

FiniteDifferenceImageFilter2: This class defines the generic solver API at the top level of the FDS framework. FiniteDifferenceImageFilter2 is an abstract class that implements the generic, high-level algorithm (described above).

Inputs and Outputs: This filter is an Image to Image filter. Depending on the specific subclass implementation, finite difference image filters may process a variety of image types. The input to the filter is the initial value of \( u \) and the output of the filter is the solution to the p.d.e.

How to use this class: GenerateData() relies on several virtual methods that must be defined by a subclass. Specifically: AllocateUpdateBuffer ApplyUpdate CalculateChange and Halt. To create a finite difference solver, implement a subclass to define these methods.

: Note that there is no fixed container type for the buffer used to hold the update \( \Delta \). The container might be another image, or simply a list of values. AllocateUpdateBuffer is responsible for creating the \( \Delta \) container. CalculateChange populates this buffer and ApplyUpdate adds the buffer values to the output image (solution). The boolean Halt() (or ThreadedHalt) method returns a true value to stop iteration.

Based on 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"
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

See also: DenseFiniteDifferenceImageFilter2

Definition at line 162 of file itkMultiphaseFiniteDifferenceImageFilter.h.

Inheritance diagram for itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >:

Collaboration diagram for itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >:

Public Types
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 = TFiniteDifferenceFunction

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	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	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 const unsigned int &	GetElapsedIterations () const

InputImagePointer	GetLevelSet (const IdCellType &i)

const char *	GetNameOfClass () const override

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

virtual const bool &	GetManualReinitialization () const

virtual void	ManualReinitializationOn ()

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

const char *	GetNameOfClass () const override

virtual void	SetInPlace (bool _arg)

virtual bool	GetInPlace () const

virtual void	InPlaceOn ()

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

const InputImageType *	GetInput (unsigned int idx) const

const char *	GetNameOfClass () const override

void	PopBackInput () override

void	PopFrontInput () override

virtual void	PushBackInput (const InputImageType *input)

virtual void	PushFrontInput (const InputImageType *input)

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

virtual void	SetInput (const InputImageType *input)

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

OutputImageType *	GetOutput (unsigned int idx)

OutputImageType *	GetOutput ()

const OutputImageType *	GetOutput () const

virtual void	GraftOutput (DataObject *graft)

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

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

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

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

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

virtual void	EnlargeOutputRequestedRegion (DataObject *)

virtual const bool &	GetAbortGenerateData () const

DataObjectPointerArray	GetIndexedInputs ()

DataObjectPointerArray	GetIndexedOutputs ()

NameArray	GetInputNames () const

DataObjectPointerArray	GetInputs ()

MultiThreaderType *	GetMultiThreader () const

const char *	GetNameOfClass () const override

DataObjectPointerArraySizeType	GetNumberOfIndexedInputs () const

DataObjectPointerArraySizeType	GetNumberOfIndexedOutputs () const

DataObjectPointerArraySizeType	GetNumberOfInputs () const

DataObjectPointerArraySizeType	GetNumberOfOutputs () const

virtual DataObjectPointerArraySizeType	GetNumberOfValidRequiredInputs () const

NameArray	GetOutputNames () const

DataObjectPointerArray	GetOutputs ()

virtual float	GetProgress () const

NameArray	GetRequiredInputNames () const

bool	HasInput (const DataObjectIdentifierType &key) const

bool	HasOutput (const DataObjectIdentifierType &key) const

void	IncrementProgress (float increment)

virtual DataObjectPointer	MakeOutput (const DataObjectIdentifierType &)

virtual DataObjectPointer	MakeOutput (DataObjectPointerArraySizeType idx)

virtual void	PrepareOutputs ()

virtual void	PropagateRequestedRegion (DataObject *output)

virtual void	ResetPipeline ()

virtual void	SetAbortGenerateData (bool _arg)

void	SetMultiThreader (MultiThreaderType *threader)

virtual void	Update ()

virtual void	UpdateLargestPossibleRegion ()

virtual void	UpdateOutputData (DataObject *output)

virtual void	UpdateOutputInformation ()

void	UpdateProgress (float progress)

virtual void	SetReleaseDataFlag (bool val)

virtual bool	GetReleaseDataFlag () const

void	ReleaseDataFlagOn ()

void	ReleaseDataFlagOff ()

virtual void	SetReleaseDataBeforeUpdateFlag (bool _arg)

virtual const bool &	GetReleaseDataBeforeUpdateFlag () const

virtual void	ReleaseDataBeforeUpdateFlagOn ()

virtual void	SetNumberOfWorkUnits (ThreadIdType _arg)

virtual const ThreadIdType &	GetNumberOfWorkUnits () const

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

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

LightObject::Pointer	CreateAnother () const override

virtual void	DebugOff () const

virtual void	DebugOn () const

Command *	GetCommand (unsigned long tag)

bool	GetDebug () const

MetaDataDictionary &	GetMetaDataDictionary ()

const MetaDataDictionary &	GetMetaDataDictionary () const

virtual ModifiedTimeType	GetMTime () const

const char *	GetNameOfClass () const override

virtual const TimeStamp &	GetTimeStamp () const

bool	HasObserver (const EventObject &event) const

void	InvokeEvent (const EventObject &)

void	InvokeEvent (const EventObject &) const

virtual void	Modified () const

void	Register () const override

void	RemoveAllObservers ()

void	RemoveObserver (unsigned long tag) const

void	SetDebug (bool debugFlag) const

void	SetReferenceCount (int) override

void	UnRegister () const noexcept override

void	SetMetaDataDictionary (const MetaDataDictionary &rhs)

void	SetMetaDataDictionary (MetaDataDictionary &&rrhs)

virtual void	SetObjectName (std::string _arg)

virtual const std::string &	GetObjectName () const

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

virtual Pointer	CreateAnother () const

virtual void	Delete ()

virtual const char *	GetNameOfClass () const

virtual int	GetReferenceCount () const

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

virtual void	Register () const

virtual void	SetReferenceCount (int)

virtual void	UnRegister () const noexcept

Static Public Attributes
static constexpr unsigned int	ImageDimension = TOutputImage::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

Protected Member Functions
virtual void	AllocateUpdateBuffer ()=0

virtual void	ApplyUpdate (TimeStepType dt)=0

virtual TimeStepType	CalculateChange ()=0

virtual void	CopyInputToOutput ()=0

void	GenerateData () override

void	GenerateInputRequestedRegion () override

virtual bool	Halt ()

virtual void	Initialize ()

	MultiphaseFiniteDifferenceImageFilter ()

virtual void	PostProcessOutput ()

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

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

virtual bool	ThreadedHalt (void *)

	~MultiphaseFiniteDifferenceImageFilter () override=default


virtual void	InitializeIteration ()

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

	InPlaceImageFilter ()=default

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

void	ReleaseInputs () override

	~InPlaceImageFilter () override=default

void	AllocateOutputs () override

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

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

void	GenerateInputRequestedRegion () override

	ImageToImageFilter ()

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

void	VerifyInputInformation () const override

	~ImageToImageFilter () override=default

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

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

virtual void	AllocateOutputs ()

virtual void	BeforeThreadedGenerateData ()

void	ClassicMultiThread (ThreadFunctionType callbackFunction)

void	GenerateData () override

virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () const

	ImageSource ()

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

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

	~ImageSource () override=default

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

virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)

virtual bool	GetDynamicMultiThreading () const

virtual void	SetDynamicMultiThreading (bool _arg)

virtual void	DynamicMultiThreadingOn ()

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

void	AddOptionalInputName (const DataObjectIdentifierType &)

void	AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	AddOutput (DataObject *output)

bool	AddRequiredInputName (const DataObjectIdentifierType &)

bool	AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)

virtual void	CacheInputReleaseDataFlags ()

virtual void	GenerateData ()

virtual void	GenerateInputRequestedRegion ()

virtual void	GenerateOutputInformation ()

virtual void	GenerateOutputRequestedRegion (DataObject *output)

DataObject *	GetInput (const DataObjectIdentifierType &key)

const DataObject *	GetInput (const DataObjectIdentifierType &key) const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () const

virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () const

bool	IsIndexedInputName (const DataObjectIdentifierType &) const

bool	IsIndexedOutputName (const DataObjectIdentifierType &) const

bool	IsRequiredInputName (const DataObjectIdentifierType &) const

DataObjectPointerArraySizeType	MakeIndexFromInputName (const DataObjectIdentifierType &name) const

DataObjectPointerArraySizeType	MakeIndexFromOutputName (const DataObjectIdentifierType &name) const

DataObjectIdentifierType	MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const

DataObjectIdentifierType	MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const

virtual void	PopBackInput ()

virtual void	PopFrontInput ()

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

	ProcessObject ()

virtual void	PropagateResetPipeline ()

virtual void	PushBackInput (const DataObject *input)

virtual void	PushFrontInput (const DataObject *input)

virtual void	ReleaseInputs ()

virtual void	RemoveInput (const DataObjectIdentifierType &key)

virtual void	RemoveInput (DataObjectPointerArraySizeType)

virtual void	RemoveOutput (const DataObjectIdentifierType &key)

virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)

bool	RemoveRequiredInputName (const DataObjectIdentifierType &)

virtual void	RestoreInputReleaseDataFlags ()

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

virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)

virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)

void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)

void	SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)

virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)

virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)

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

virtual void	SetPrimaryInput (DataObject *object)

virtual void	SetPrimaryOutput (DataObject *object)

void	SetRequiredInputNames (const NameArray &)

virtual void	VerifyInputInformation () const

virtual void	VerifyPreconditions () const

	~ProcessObject () override

DataObject *	GetInput (DataObjectPointerArraySizeType idx)

const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const

DataObject *	GetPrimaryInput ()

const DataObject *	GetPrimaryInput () const

virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryInputName () const

DataObject *	GetOutput (const DataObjectIdentifierType &key)

const DataObject *	GetOutput (const DataObjectIdentifierType &key) const

virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)

virtual const char *	GetPrimaryOutputName () const

DataObject *	GetOutput (DataObjectPointerArraySizeType i)

const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const

DataObject *	GetPrimaryOutput ()

const DataObject *	GetPrimaryOutput () const

virtual bool	GetThreaderUpdateProgress () const

virtual void	ThreaderUpdateProgressOn ()

virtual void	SetThreaderUpdateProgress (bool arg)

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

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

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

virtual void	SetTimeStamp (const TimeStamp &timeStamp)

	~Object () override

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

	LightObject ()

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

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

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

virtual	~LightObject ()

Protected Attributes
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 {}

Private Attributes
bool	m_InitializedState {}

bool	m_ManualReinitialization {}

Additional Inherited Members
Static Public Member Functions inherited from itk::ImageToImageFilter< TFeatureImage, 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 ()

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

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

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

static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION	ThreaderCallback (void *arg)

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

static constexpr float	progressFixedToFloat (uint32_t fixed)

static uint32_t	progressFloatToFixed (float f)

Member Typedef Documentation

◆ CentroidVectorType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::CentroidVectorType = Vector<float, Self::ImageDimension>

Definition at line 222 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ ConstPointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::ConstPointer = SmartPointer<const Self>

Definition at line 171 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeatureImagePointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::FeatureImagePointer = typename FeatureImageType::Pointer

Definition at line 194 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeatureImageType

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

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

Definition at line 193 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeaturePixelType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::FeaturePixelType = typename FeatureImageType::PixelType

Definition at line 199 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeaturePointType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::FeaturePointType = typename FeatureImageType::PointType

Definition at line 198 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeatureRegionType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::FeatureRegionType = typename FeatureImageType::RegionType

Definition at line 195 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeatureSizeType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::FeatureSizeType = typename FeatureImageType::SizeType

Definition at line 196 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FeatureSpacingType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::FeatureSpacingType = typename FeatureImageType::SpacingType

Definition at line 197 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FiniteDifferenceFunctionPointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::FiniteDifferenceFunctionPointer = typename FiniteDifferenceFunctionType::Pointer

Definition at line 217 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ FiniteDifferenceFunctionType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::FiniteDifferenceFunctionType = TFiniteDifferenceFunction

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 TFiniteDifferenceFunction = FiniteDifferenceFunction<TOutputImage>, typename TIdCell = unsigned int>

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

Definition at line 210 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputCoordRepType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InputCoordRepType = typename InputPointType::CoordRepType

Definition at line 183 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputImagePointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InputImagePointer = typename InputImageType::Pointer

Definition at line 181 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputImageType

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

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

Input and output image types.

Definition at line 180 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputIndexType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InputIndexType = typename InputImageType::IndexType

Definition at line 184 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputIndexValueType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InputIndexValueType = typename InputIndexType::IndexValueType

Definition at line 185 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputOffsetValueType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InputOffsetValueType = typename InputImageType::OffsetValueType

Definition at line 191 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputPixelType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InputPixelType = typename InputImageType::PixelType

Definition at line 189 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputPointType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InputPointType = typename InputImageType::PointType

Definition at line 182 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputRegionType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InputRegionType = typename InputImageType::RegionType

Definition at line 188 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputSizeType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InputSizeType = typename InputImageType::SizeType

Definition at line 186 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputSizeValueType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InputSizeValueType = typename InputSizeType::SizeValueType

Definition at line 187 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InputSpacingType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InputSpacingType = typename InputImageType::SpacingType

Definition at line 190 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ KdTreeGeneratorPointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::KdTreeGeneratorPointer = typename KdTreeGeneratorType::Pointer

Definition at line 225 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ KdTreeGeneratorType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::KdTreeGeneratorType = Statistics::KdTreeGenerator<SampleType>

Definition at line 224 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ KdTreePointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::KdTreePointer = typename KdTreeType::Pointer

Definition at line 227 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ KdTreeType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::KdTreeType = typename KdTreeGeneratorType::KdTreeType

Definition at line 226 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputImagePointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 202 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputImageType

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

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

Definition at line 201 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputIndexType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::OutputIndexType = typename OutputImageType::IndexType

Definition at line 207 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputIndexValueType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::OutputIndexValueType = typename OutputImageType::IndexValueType

Definition at line 208 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputPixelType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::OutputPixelType = typename OutputImageType::PixelType

Definition at line 203 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputRegionType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::OutputRegionType = typename OutputImageType::RegionType

Definition at line 204 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputSizeType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::OutputSizeType = typename OutputImageType::SizeType

Definition at line 205 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ OutputSizeValueType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::OutputSizeValueType = typename OutputImageType::SizeValueType

Definition at line 206 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ Pointer

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::Pointer = SmartPointer<Self>

Definition at line 170 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ RadiusType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::RadiusType = typename FiniteDifferenceFunctionType::RadiusType

Definition at line 220 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ SampleType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SampleType = Statistics::ListSample<CentroidVectorType>

Definition at line 223 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ Self

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::Self = MultiphaseFiniteDifferenceImageFilter

Standard class type aliases.

Definition at line 168 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ Superclass

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::Superclass = InPlaceImageFilter<TFeatureImage, TOutputImage>

Definition at line 169 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ TimeStepType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

Definition at line 218 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ TimeStepVectorType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::TimeStepVectorType = typename std::vector<TimeStepType>

Definition at line 219 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ VectorIdCellType

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

using itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::VectorIdCellType = std::vector<IdCellType>

Definition at line 211 of file itkMultiphaseFiniteDifferenceImageFilter.h.

Constructor & Destructor Documentation

◆ MultiphaseFiniteDifferenceImageFilter()

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

itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::MultiphaseFiniteDifferenceImageFilter ( )

inlineprotected

Definition at line 389 of file itkMultiphaseFiniteDifferenceImageFilter.h.

References itk::Math::eps, and itk::NumericTraits< T >::max().

◆ ~MultiphaseFiniteDifferenceImageFilter()

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

itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::~MultiphaseFiniteDifferenceImageFilter ( )

overrideprotecteddefault

Member Function Documentation

◆ AllocateUpdateBuffer()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::AllocateUpdateBuffer ( )

protectedpure virtual

This method allocates a temporary update container in the subclass.

Implemented in itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage > >, itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, and itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage >, unsigned int >.

◆ ApplyUpdate()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::ApplyUpdate ( TimeStepType dt )

protectedpure virtual

This method is defined by a subclass to apply changes to the output from an update buffer and a time step value "dt".

Parameters

dt	Time step value.

Implemented in itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage > >, itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, and itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage >, unsigned int >.

◆ CalculateChange()

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

virtual TimeStepType itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::CalculateChange ( )

protectedpure virtual

This method is defined by a subclass to populate an update buffer with changes for the pixels in the output. It returns a time step value to be used for the update.

Returns: A time step to use in updating the output with the changes calculated from this method.

Implemented in itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage > >, itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, and itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage >, unsigned int >.

◆ CopyInputToOutput()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::CopyInputToOutput ( )

protectedpure virtual

This method can be defined in subclasses as needed to copy the input to the output. See DenseFiniteDifferenceImageFilter2 for an implementation.

Implemented in itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage > >, itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, and itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage >, unsigned int >.

◆ GenerateData()

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

void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GenerateData ( )

overrideprotectedvirtual

This is the default, high-level algorithm for calculating finite difference solutions. It calls virtual methods in its subclasses to implement the major steps of the algorithm.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GenerateInputRequestedRegion()

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

void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GenerateInputRequestedRegion ( )

overrideprotectedvirtual

FiniteDifferenceImageFilter2 needs a larger input requested region than the output requested region. As such, we need to provide an implementation for GenerateInputRequestedRegion() in order to inform the pipeline execution model.

: The filter will ask for a padded region to perform its neighborhood calculations. If no such region is available, the boundaries will be handled as described in the FiniteDifferenceFunction defined by the subclass.

See also: ProcessObject::GenerateInputRequestedRegion()

Reimplemented from itk::ProcessObject.

◆ GetDifferenceFunction()

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

virtual const FiniteDifferenceFunctionPointer itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GetDifferenceFunction ( const IdCellType & functionIndex ) const

inlinevirtual

This method returns a pointer to a FiniteDifferenceFunction object that will be used by the filter to calculate updates at image pixels.

Parameters

functionIndex Index of difference function to return.

Returns: A FiniteDifferenceObject pointer.

Definition at line 234 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ GetElapsedIterations()

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

virtual const unsigned int & itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GetElapsedIterations ( ) const

virtual

Get the number of elapsed iterations of the filter.

◆ GetInitializedState()

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

virtual const bool & itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GetInitializedState ( ) const

virtual

Set/Get the state of the filter.

◆ GetLevelSet()

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

InputImagePointer itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GetLevelSet ( const IdCellType & i )

inline

Definition at line 329 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ GetManualReinitialization()

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

virtual const bool & itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GetManualReinitialization ( ) const

virtual

Require the filter to be manually reinitialized (by calling SetInitializedStateOff()

◆ GetMaximumRMSError()

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

virtual const double & itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GetMaximumRMSError ( ) const

virtual

Set/Get the maximum error allowed in the solution. This may not be defined for all solvers and its meaning may change with the application.

◆ GetNameOfClass()

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

const char * itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GetNameOfClass ( ) const

overridevirtual

See also: LightObject::GetNameOfClass()

Reimplemented from itk::ImageSource< TOutputImage >.

Reimplemented in itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage >, unsigned int >.

◆ GetNumberOfIterations()

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

virtual const unsigned int & itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GetNumberOfIterations ( ) const

virtual

Set/Get the number of iterations that the filter will run.

◆ GetRMSChange()

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

virtual const double & itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GetRMSChange ( ) const

virtual

Set/Get the root mean squared change of the previous iteration. May not be used by all solvers.

◆ GetUseImageSpacing()

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

virtual const bool & itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GetUseImageSpacing ( ) const

virtual

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOn.

◆ Halt()

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

virtual bool itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::Halt ( )

protectedvirtual

This method returns true when the current iterative solution of the equation has met the criteria to stop solving. Defined by a subclass.

◆ Initialize()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::Initialize ( )

inlineprotectedvirtual

This method is optionally defined by a subclass and is called before the loop of iterations of calculate_change & update. It does the global initialization, i.e. in the SparseFieldLevelSetImageFilter, initialize the list of layers.

Reimplemented in itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage >, unsigned int >, itk::ScalarChanAndVeseDenseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData >, and itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 495 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ InitializedStateOn()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InitializedStateOn ( )

virtual

Set/Get the state of the filter.

◆ InitializeIteration()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InitializeIteration ( )

inlineprotectedvirtual

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 in itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage >, unsigned int >, itk::ScalarChanAndVeseDenseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData >, and itk::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >.

Definition at line 505 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ ManualReinitializationOn()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::ManualReinitializationOn ( )

virtual

Require the filter to be manually reinitialized (by calling SetInitializedStateOff()

◆ PostProcessOutput()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::PostProcessOutput ( )

inlineprotectedvirtual

This method is called after the solution has been generated to allow subclasses to apply some further processing to the output.

Reimplemented in itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage > >, itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, and itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage >, unsigned int >.

Definition at line 533 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ PrintSelf()

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

void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, 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::ImageSource< TOutputImage >.

Reimplemented in itk::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, ScalarChanAndVeseLevelSetFunction< TInputImage, TFeatureImage >, unsigned int >.

◆ ResolveTimeStep()

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

TimeStepType itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::ResolveTimeStep	(	const TimeStepVectorType &	timeStepList,
		const std::vector< uint8_t > &	valid
	)

inlineprotected

Virtual method for resolving a single time step from a set of time steps returned from processing threads.

Returns: Time step (dt) for the iteration update based on a list of time steps generated from the threaded calculated change method (one for each region processed).

Parameters

timeStepList	The set of time changes compiled from all the threaded calls to ThreadedGenerateData.
valid	The set of flags indicating which of "timeStepList" elements are valid. Although they are uint8_t, they should be treated like booleans.

The default is to return the minimum value in the list.

◆ SetDifferenceFunction()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetDifferenceFunction	(	const IdCellType &	functionIndex,
		FiniteDifferenceFunctionPointer	function
	)

inlinevirtual

This method sets the pointer to a FiniteDifferenceFunction object that will be used by the filter to calculate updates at image pixels.

Parameters

functionIndex	Index of difference function to set.
function	Pointer to difference function to set.

Definition at line 252 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ SetElapsedIterations()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetElapsedIterations ( unsigned int _arg )

virtual

Set the number of elapsed iterations of the filter.

◆ SetFunctionCount()

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

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

inline

Definition at line 354 of file itkMultiphaseFiniteDifferenceImageFilter.h.

References New().

◆ SetInitializedState()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetInitializedState ( bool _arg )

virtual

Set/Get the state of the filter.

◆ SetKdTree()

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

void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetKdTree ( KdTreeType * kdtree )

inline

Definition at line 348 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ SetLevelSet()

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

void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetLevelSet	(	const IdCellType &	i,
		const InputImageType *	levelSet
	)

inline

Definition at line 305 of file itkMultiphaseFiniteDifferenceImageFilter.h.

References itk::ImageConstIterator< TImage >::Get(), itk::ImageRegionConstIterator< TImage >::GoToBegin(), itk::ImageConstIterator< TImage >::IsAtEnd(), New(), and itk::ImageRegionIterator< TImage >::Set().

◆ SetLookup()

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

void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetLookup ( VectorIdCellType lookup )

inline

Definition at line 342 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ SetManualReinitialization()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetManualReinitialization ( bool _arg )

virtual

Require the filter to be manually reinitialized (by calling SetInitializedStateOff()

◆ SetMaximumRMSError()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetMaximumRMSError ( double _arg )

virtual

Set/Get the maximum error allowed in the solution. This may not be defined for all solvers and its meaning may change with the application.

◆ SetNumberOfIterations()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetNumberOfIterations ( unsigned int _arg )

virtual

Set/Get the number of iterations that the filter will run.

◆ SetRMSChange()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetRMSChange ( double _arg )

virtual

Set/Get the root mean squared change of the previous iteration. May not be used by all solvers.

◆ SetUseImageSpacing()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::SetUseImageSpacing ( bool _arg )

virtual

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOn.

◆ ThreadedHalt()

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

virtual bool itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::ThreadedHalt ( void * )

inlineprotectedvirtual

This method is similar to Halt(), and its default implementation in this class is simply to call Halt(). However, this method takes as a parameter a void pointer to the MultiThreaderBase::WorkUnitInfo structure. If you override this method instead of overriding Halt, you will be able to get the current thread ID and handle the Halt method accordingly. This is useful if you are doing a lot of processing in Halt that you don't want parallelized. Notice that ThreadedHalt is only called by the multithreaded filters, so you still should implement Halt, just in case a non-threaded filter is used.

Definition at line 484 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ UseImageSpacingOn()

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

virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::UseImageSpacingOn ( )

virtual

Use the image spacing information in calculations. Use this option if you want derivatives in physical space. Default is UseImageSpacingOn.

Member Data Documentation

◆ ImageDimension

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

constexpr unsigned int itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::ImageDimension = TOutputImage::ImageDimension

staticconstexpr

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

Definition at line 177 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_DifferenceFunctions

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

std::vector<FiniteDifferenceFunctionPointer> itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_DifferenceFunctions {}

protected

The function that will be used in calculating updates for each pixel.

Definition at line 416 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_ElapsedIterations

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

unsigned int itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_ElapsedIterations {}

protected

Definition at line 410 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_FunctionCount

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

IdCellType itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_FunctionCount {}

protected

Definition at line 405 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_InitializedState

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

bool itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_InitializedState {}

private

State that the filter is in, i.e. UNINITIALIZED or INITIALIZED

Definition at line 542 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_KdTree

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

KdTreePointer itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_KdTree {}

protected

Definition at line 408 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_LevelSet

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

std::vector<InputImagePointer> itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_LevelSet {}

protected

Definition at line 406 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_Lookup

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

VectorIdCellType itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_Lookup {}

protected

Definition at line 407 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_ManualReinitialization

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

bool itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_ManualReinitialization {}

private

Indicates whether the filter automatically resets to UNINITIALIZED state after completing, or whether filter must be manually reset

Definition at line 539 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_MaximumRMSError

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

double itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_MaximumRMSError {}

protected

Definition at line 411 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_NumberOfIterations

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

unsigned int itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_NumberOfIterations {}

protected

Definition at line 413 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_RMSChange

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

double itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_RMSChange {}

protected

Definition at line 412 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ m_UseImageSpacing

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

bool itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::m_UseImageSpacing {}

protected

Control whether derivatives use spacing of the input image in its calculation.

Definition at line 420 of file itkMultiphaseFiniteDifferenceImageFilter.h.

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

itkMultiphaseFiniteDifferenceImageFilter.h

Detailed Description

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Private Attributes

Additional Inherited Members

Member Typedef Documentation

◆ CentroidVectorType

◆ ConstPointer

◆ FeatureImagePointer

◆ FeatureImageType

◆ FeaturePixelType

◆ FeaturePointType

◆ FeatureRegionType

◆ FeatureSizeType

◆ FeatureSpacingType

◆ FiniteDifferenceFunctionPointer

◆ FiniteDifferenceFunctionType

◆ IdCellType

◆ InputCoordRepType

◆ InputImagePointer

◆ InputImageType

◆ InputIndexType

◆ InputIndexValueType

◆ InputOffsetValueType

◆ InputPixelType

◆ InputPointType

◆ InputRegionType

◆ InputSizeType

◆ InputSizeValueType

◆ InputSpacingType

◆ KdTreeGeneratorPointer

◆ KdTreeGeneratorType

◆ KdTreePointer

◆ KdTreeType

◆ OutputImagePointer

◆ OutputImageType

◆ OutputIndexType

◆ OutputIndexValueType

◆ OutputPixelType

◆ OutputRegionType

◆ OutputSizeType

◆ OutputSizeValueType

◆ Pointer

◆ RadiusType

◆ SampleType

◆ Self

◆ Superclass

◆ TimeStepType

◆ TimeStepVectorType

◆ VectorIdCellType

Constructor & Destructor Documentation

◆ MultiphaseFiniteDifferenceImageFilter()

◆ ~MultiphaseFiniteDifferenceImageFilter()

Member Function Documentation

◆ AllocateUpdateBuffer()

◆ ApplyUpdate()

◆ CalculateChange()

◆ CopyInputToOutput()

◆ GenerateData()

◆ GenerateInputRequestedRegion()

◆ GetDifferenceFunction()

◆ GetElapsedIterations()

◆ GetInitializedState()

◆ GetLevelSet()

◆ GetManualReinitialization()

◆ GetMaximumRMSError()

◆ GetNameOfClass()

◆ GetNumberOfIterations()

◆ GetRMSChange()

◆ GetUseImageSpacing()

◆ Halt()

◆ Initialize()

◆ InitializedStateOn()

◆ InitializeIteration()

◆ ManualReinitializationOn()

◆ PostProcessOutput()

◆ PrintSelf()