ITK  5.1.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell > Class Template Referenceabstract

#include <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 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 const char * GetNameOfClass () const
 
- 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 InputImageTypeGetInput () const
 
const InputImageTypeGetInput (unsigned int idx) const
 
void PopBackInput () override
 
void PopFrontInput () override
 
virtual void PushBackInput (const InputImageType *image)
 
virtual void PushFrontInput (const InputImageType *image)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *image)
 
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 >
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
OutputImageTypeGetOutput (unsigned int idx)
 
virtual void GraftOutput (DataObject *output)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *output)
 
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 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 ()
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual const float & GetProgress () const
 
void UpdateProgress (float progress)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputInformation ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual void ResetPipeline ()
 
virtual void SetReleaseDataFlag (bool flag)
 
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 ThreadIdTypeGetNumberOfWorkUnits () const
 
MultiThreaderTypeGetMultiThreader () 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
 
LightObject::Pointer CreateAnother () const override
 
virtual void DebugOff () const
 
virtual void DebugOn () const
 
CommandGetCommand (unsigned long tag)
 
bool GetDebug () const
 
MetaDataDictionaryGetMetaDataDictionary ()
 
const MetaDataDictionaryGetMetaDataDictionary () const
 
virtual ModifiedTimeType GetMTime () const
 
virtual const TimeStampGetTimeStamp () 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
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
 itkCloneMacro (Self)
 
void Print (std::ostream &os, Indent indent=0) const
 

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
 
IdCellType m_FunctionCount
 
std::vector< InputImagePointerm_LevelSet
 
VectorIdCellType m_Lookup
 
KdTreePointer m_KdTree
 
unsigned int m_ElapsedIterations
 
double m_MaximumRMSError
 
double m_RMSChange
 
unsigned int m_NumberOfIterations
 
std::vector< FiniteDifferenceFunctionPointerm_DifferenceFunctions
 
bool m_UseImageSpacing
 
bool m_ManualReinitialization
 
bool m_InitializedState
 
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)
 
 MultiphaseFiniteDifferenceImageFilter ()
 
 ~MultiphaseFiniteDifferenceImageFilter () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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 bool ThreadedHalt (void *)
 
virtual void Initialize ()
 
virtual void InitializeIteration ()
 
TimeStepType ResolveTimeStep (const TimeStepVectorType &timeStepList, const std::vector< bool > &valid)
 
virtual void PostProcessOutput ()
 

Additional Inherited Members

- 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 flag)
 
- 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 >
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TFeatureImage, TOutputImage >
 InPlaceImageFilter ()=default
 
 ~InPlaceImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
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
 
void VerifyInputInformation () ITKv5_CONST override
 
void GenerateInputRequestedRegion () 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 &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void BeforeThreadedGenerateData ()
 
virtual void AfterThreadedGenerateData ()
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () 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
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType num, DataObject *input)
 
virtual void AddInput (DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
virtual void SetPrimaryInput (DataObject *input)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () 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)
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType idx) const
 
virtual void SetOutput (const DataObjectIdentifierType &key, DataObject *output)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual void SetPrimaryOutput (DataObject *output)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType num, DataObject *output)
 
virtual void AddOutput (DataObject *output)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () 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 ()
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &time)
 
- 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 ImageRegionSplitterBaseGetGlobalDefaultSplitter ()
 
static ITK_THREAD_RETURN_FUNCTION_CALL_CONVENTION ThreaderCallback (void *arg)
 
- 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 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"
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
See also
DenseFiniteDifferenceImageFilter2

Definition at line 165 of file itkMultiphaseFiniteDifferenceImageFilter.h.

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 225 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 174 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 197 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 196 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 202 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 201 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 198 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 199 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 200 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 220 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 219 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 213 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 186 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 184 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 183 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 187 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 188 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 194 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 192 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 185 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 191 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 189 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 190 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 193 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 228 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 227 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 230 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 229 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 205 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 204 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 210 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 211 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 206 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 207 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 208 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 209 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 173 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 223 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 226 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 171 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 172 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 221 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 222 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 214 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

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

Definition at line 393 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ ~MultiphaseFiniteDifferenceImageFilter()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFiniteDifferenceFunction = FiniteDifferenceFunction<TOutputImage>, typename TIdCell = unsigned int>
itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::~MultiphaseFiniteDifferenceImageFilter ( )
inlineoverrideprotected

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

Definition at line 407 of file itkMultiphaseFiniteDifferenceImageFilter.h.

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

◆ 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
dtTime step value.

◆ 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::MultiphaseSparseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >, and itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction >.

◆ 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

◆ 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
functionIndexIndex of difference function to return.
Returns
A FiniteDifferenceObject pointer.

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

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

◆ 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

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

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

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

◆ 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

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

◆ GetNameOfClass()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFiniteDifferenceFunction = FiniteDifferenceFunction<TOutputImage>, typename TIdCell = unsigned int>
virtual const char* itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::GetNameOfClass ( ) const
virtual

◆ 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

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

◆ 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

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

◆ 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

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

◆ 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

◆ InitializedStateOff()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFiniteDifferenceFunction = FiniteDifferenceFunction<TOutputImage>, typename TIdCell = unsigned int>
virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::InitializedStateOff ( )
virtual

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

◆ 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

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

◆ 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::ScalarChanAndVeseSparseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData, TIdCell >, and itk::ScalarChanAndVeseDenseLevelSetImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TSharedData >.

Definition at line 509 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ ManualReinitializationOff()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFiniteDifferenceFunction = FiniteDifferenceFunction<TOutputImage>, typename TIdCell = unsigned int>
virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::ManualReinitializationOff ( )
virtual

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

◆ 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

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

◆ 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

◆ 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

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

Reimplemented from itk::ImageSource< TOutputImage >.

◆ 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< bool > &  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
timeStepListThe set of time changes compiled from all the threaded calls to ThreadedGenerateData.
validThe set of flags indicating which of "list" elements are valid

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
functionIndexIndex of difference function to set.
functionPointer to difference function to set.

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

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

Definition at line 357 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ 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

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

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

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

Definition at line 308 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ 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

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

Definition at line 345 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 488 of file itkMultiphaseFiniteDifferenceImageFilter.h.

◆ UseImageSpacingOff()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFiniteDifferenceFunction = FiniteDifferenceFunction<TOutputImage>, typename TIdCell = unsigned int>
virtual void itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFiniteDifferenceFunction, TIdCell >::UseImageSpacingOff ( )
virtual

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

◆ 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

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

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

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

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

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

Definition at line 409 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 545 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

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

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

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

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

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

Definition at line 411 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 542 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

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

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

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

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

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

Definition at line 416 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 424 of file itkMultiphaseFiniteDifferenceImageFilter.h.


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