ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage > Class Template Referenceabstract

#include <itkFiniteDifferenceImageFilter.h>

+ Inheritance diagram for itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >:
+ Collaboration diagram for itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FiniteDifferenceFunctionType = FiniteDifferenceFunction< TOutputImage >
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using InputPixelValueType = typename NumericTraits< InputPixelType >::ValueType
 
using NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using OutputPixelValueType = typename NumericTraits< OutputPixelType >::ValueType
 
using PixelType = OutputPixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename FiniteDifferenceFunctionType::RadiusType
 
using Self = FiniteDifferenceImageFilter
 
using Superclass = InPlaceImageFilter< TInputImage, TOutputImage >
 
using TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType
 
- Public Types inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using 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< TInputImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using 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 FiniteDifferenceFunctionType ::PointerGetDifferenceFunction () const
 
virtual const IdentifierTypeGetElapsedIterations () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetDifferenceFunction (FiniteDifferenceFunctionType *_arg)
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TInputImage, 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< TInputImage, 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 TInputImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
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 void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool 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 = OutputImageType::ImageDimension
 
- Static Public Attributes inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
bool m_IsInitialized
 
IdentifierType m_NumberOfIterations
 
IdentifierType m_ElapsedIterations
 
bool m_ManualReinitialization
 
double m_RMSChange
 
double m_MaximumRMSError
 
bool m_UseImageSpacing
 
FiniteDifferenceFunctionType::Pointer m_DifferenceFunction
 
virtual void SetNumberOfIterations (IdentifierType _arg)
 
virtual const IdentifierTypeGetNumberOfIterations () 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 SetManualReinitialization (bool _arg)
 
virtual const bool & GetManualReinitialization () const
 
virtual void ManualReinitializationOn ()
 
virtual void ManualReinitializationOff ()
 
virtual void SetIsInitialized (bool _arg)
 
virtual bool GetIsInitialized ()
 
void SetStateToUninitialized ()
 
void SetStateToInitialized ()
 
 FiniteDifferenceImageFilter ()
 
 ~FiniteDifferenceImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
virtual void AllocateUpdateBuffer ()=0
 
virtual void ApplyUpdate (const 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 ()
 
virtual TimeStepType ResolveTimeStep (const std::vector< TimeStepType > &timeStepList, const std::vector< bool > &valid) const
 
virtual void SetElapsedIterations (IdentifierType _arg)
 
virtual void PostProcessOutput ()
 
void InitializeFunctionCoefficients ()
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, 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< TInputImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TInputImage, TOutputImage >
 InPlaceImageFilter ()=default
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
void ReleaseInputs () override
 
virtual bool GetRunningInPlace () const
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
 ImageToImageFilter ()
 
 ~ImageToImageFilter () override=default
 
void VerifyInputInformation () ITKv5_CONST override
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
void PushBackInput (const DataObject *input) override
 
void PushFrontInput (const DataObject *input) override
 
- 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 ()
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void ThreaderUpdateProgressOff ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
 ~Object () override
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &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)
 
- Static Protected Member Functions inherited from itk::ProcessObject
static constexpr float progressFixedToFloat (uint32_t fixed)
 
static uint32_t progressFloatToFixed (float f)
 
- Protected Attributes inherited from itk::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 TOutputImage>
class itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >

The Finite Difference Solver Hierarchy
This is an overview of the Finite Difference Solver (FDS) framework. 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
time_step = calculate_change(i)
update(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 FiniteDifferenceImageFilter. Solver objects are filters that take image inputs and produce image outputs. Solver objects require a FiniteDifferenceFunction object to perform the calculation at each image pixel during iteration. These specialized function objects are subclasses of FiniteDifferenceFunction. FiniteDifferenceFunction 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 DenseFiniteDifferenceImageFilter.

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.
FiniteDifferenceImageFilter
This class defines the generic solver API at the top level of the FDS framework. FiniteDifferenceImageFilter is an abstract class that implements the generic, high-level algorithm (described above).
Inputs and Outputs
This filter is an ImageToImage 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:
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.
See also
DenseFiniteDifferenceImageFilter

Definition at line 132 of file itkFiniteDifferenceImageFilter.h.

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ConstPointer = SmartPointer<const Self>

Definition at line 141 of file itkFiniteDifferenceImageFilter.h.

◆ FiniteDifferenceFunctionType

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::FiniteDifferenceFunctionType = FiniteDifferenceFunction<TOutputImage>

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 165 of file itkFiniteDifferenceImageFilter.h.

◆ InputImageType

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::InputImageType = TInputImage

Input and output image types.

Definition at line 147 of file itkFiniteDifferenceImageFilter.h.

◆ InputPixelType

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::InputPixelType = typename TInputImage::PixelType

Definition at line 155 of file itkFiniteDifferenceImageFilter.h.

◆ InputPixelValueType

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::InputPixelValueType = typename NumericTraits<InputPixelType>::ValueType

Definition at line 160 of file itkFiniteDifferenceImageFilter.h.

◆ NeighborhoodScalesType

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::NeighborhoodScalesType = typename FiniteDifferenceFunctionType::NeighborhoodScalesType

Definition at line 169 of file itkFiniteDifferenceImageFilter.h.

◆ OutputImageType

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::OutputImageType = TOutputImage

Definition at line 148 of file itkFiniteDifferenceImageFilter.h.

◆ OutputPixelType

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::OutputPixelType = typename TOutputImage::PixelType

The pixel type of the output image will be used in computations.

Definition at line 154 of file itkFiniteDifferenceImageFilter.h.

◆ OutputPixelValueType

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::OutputPixelValueType = typename NumericTraits<OutputPixelType>::ValueType

Extract value type in case the pixel is of vector type

Definition at line 159 of file itkFiniteDifferenceImageFilter.h.

◆ PixelType

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::PixelType = OutputPixelType

Definition at line 156 of file itkFiniteDifferenceImageFilter.h.

◆ Pointer

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::Pointer = SmartPointer<Self>

Definition at line 140 of file itkFiniteDifferenceImageFilter.h.

◆ RadiusType

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::RadiusType = typename FiniteDifferenceFunctionType::RadiusType

Definition at line 168 of file itkFiniteDifferenceImageFilter.h.

◆ Self

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::Self = FiniteDifferenceImageFilter

Standard class type aliases.

Definition at line 138 of file itkFiniteDifferenceImageFilter.h.

◆ Superclass

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::Superclass = InPlaceImageFilter<TInputImage, TOutputImage>

Definition at line 139 of file itkFiniteDifferenceImageFilter.h.

◆ TimeStepType

template<typename TInputImage, typename TOutputImage>
using itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType

Definition at line 166 of file itkFiniteDifferenceImageFilter.h.

Constructor & Destructor Documentation

◆ FiniteDifferenceImageFilter()

template<typename TInputImage, typename TOutputImage>
itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::FiniteDifferenceImageFilter ( )
protected

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

◆ ~FiniteDifferenceImageFilter()

template<typename TInputImage, typename TOutputImage>
itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::~FiniteDifferenceImageFilter ( )
overrideprotecteddefault

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

Member Function Documentation

◆ AllocateUpdateBuffer()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::AllocateUpdateBuffer ( )
protectedpure virtual

◆ ApplyUpdate()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ApplyUpdate ( const TimeStepType dt)
protectedpure virtual

◆ CalculateChange()

template<typename TInputImage, typename TOutputImage>
virtual TimeStepType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::CalculateChange ( )
protectedpure virtual

◆ CopyInputToOutput()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::CopyInputToOutput ( )
protectedpure virtual

◆ GenerateData()

template<typename TInputImage, typename TOutputImage>
void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GenerateData ( )
overrideprotectedvirtual

◆ GenerateInputRequestedRegion()

template<typename TInputImage, typename TOutputImage>
void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion ( )
overrideprotectedvirtual

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

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

◆ GetDifferenceFunction()

template<typename TInputImage, typename TOutputImage>
virtual const FiniteDifferenceFunctionType ::Pointer& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetDifferenceFunction ( ) const
virtual

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

Returns
A FiniteDifferenceObject pointer.

◆ GetElapsedIterations()

template<typename TInputImage, typename TOutputImage>
virtual const IdentifierType& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetElapsedIterations ( ) const
virtual

Get the number of elapsed iterations of the filter.

◆ GetIsInitialized()

template<typename TInputImage, typename TOutputImage>
virtual bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetIsInitialized ( )
virtual

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

◆ GetManualReinitialization()

template<typename TInputImage, typename TOutputImage>
virtual const bool& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetManualReinitialization ( ) const
virtual

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

◆ GetMaximumRMSError()

template<typename TInputImage, typename TOutputImage>
virtual const double& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetMaximumRMSError ( ) const
virtual

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

◆ GetNameOfClass()

template<typename TInputImage, typename TOutputImage>
virtual const char* itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
virtual

Run-time type information (and related methods)

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

Reimplemented in itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage ::ImageDimension > >, itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::CannySegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::GeodesicActiveContourShapePriorLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::AntiAliasBinaryImageFilter< TInputImage, TOutputImage >, itk::NarrowBandCurvesLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::GeodesicActiveContourLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::ShapeDetectionLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::CurvesLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::LaplacianSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::CurvatureRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField, TImageForceFunction >, itk::VectorThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::NarrowBandThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::ThresholdSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::AnisotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::DiffeomorphicDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::IsotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >, itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::DenseFiniteDifferenceImageFilter< TInputImage, TOutputImage >, itk::VectorCurvatureAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::DenseFiniteDifferenceImageFilter< TDisplacementField, TDisplacementField >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::UnsharpMaskLevelSetImageFilter< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage ::ImageDimension > >, itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::FiniteDifferenceSparseImageFilter< TInputImageType, TSparseOutputImageType >, itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >, itk::VectorGradientAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::CurvatureAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, and itk::GradientAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >.

◆ GetNumberOfIterations()

template<typename TInputImage, typename TOutputImage>
virtual const IdentifierType& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetNumberOfIterations ( ) const
virtual

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

◆ GetRMSChange()

template<typename TInputImage, typename TOutputImage>
virtual const double& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetRMSChange ( ) const
virtual

◆ GetUseImageSpacing()

template<typename TInputImage, typename TOutputImage>
virtual const bool& itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::GetUseImageSpacing ( ) const
virtual

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

◆ Halt()

template<typename TInputImage, typename TOutputImage>
virtual bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::Halt ( )
protectedvirtual

◆ Initialize()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::Initialize ( )
inlineprotectedvirtual

◆ InitializeFunctionCoefficients()

template<typename TInputImage, typename TOutputImage>
void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::InitializeFunctionCoefficients ( )
private

Initialize the values of the Function coefficients. This function will also take care of checking whether the image spacing should be taken into account or not.

◆ InitializeIteration()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::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::SegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage ::ImageDimension > >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage ::ImageDimension > >, itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::PDEDeformableRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::LevelSetMotionRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::ShapePriorSegmentationLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType >, itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::DiffeomorphicDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::FastSymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::SymmetricForcesDemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::DemonsRegistrationFilter< TFixedImage, TMovingImage, TDisplacementField >, itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::VectorCurvatureAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, and itk::CurvatureAnisotropicDiffusionImageFilter< TInputImage, TOutputImage >.

Definition at line 325 of file itkFiniteDifferenceImageFilter.h.

◆ ManualReinitializationOff()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ManualReinitializationOff ( )
virtual

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

◆ ManualReinitializationOn()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ManualReinitializationOn ( )
virtual

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

◆ PostProcessOutput()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::PostProcessOutput ( )
inlineprotectedvirtual

◆ PrintSelf()

template<typename TInputImage, typename TOutputImage>
void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

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

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

Reimplemented in itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, TOutputImage >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::NarrowBandLevelSetImageFilter< TInputImage, TFeatureImage, TOutputPixelType, Image< TOutputPixelType, TInputImage ::ImageDimension > >, itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >, itk::SparseFieldLevelSetImageFilter< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, TOutputImage >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage::ImageDimension > >, itk::NarrowBandImageFilterBase< TInputImage, Image< TOutputPixelType, TInputImage ::ImageDimension > >, itk::AntiAliasBinaryImageFilter< TInputImage, TOutputImage >, itk::CurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::AnisotropicDiffusionImageFilter< TInputImage, TOutputImage >, itk::MinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::BinaryMinMaxCurvatureFlowImageFilter< TInputImage, TOutputImage >, itk::AnisotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, itk::FiniteDifferenceSparseImageFilter< TInputImage, TSparseOutputImage >, itk::IsotropicFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >, and itk::UnsharpMaskLevelSetImageFilter< TInputImage, TOutputImage >.

◆ ResolveTimeStep()

template<typename TInputImage, typename TOutputImage>
virtual TimeStepType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ResolveTimeStep ( const std::vector< TimeStepType > &  timeStepList,
const std::vector< bool > &  valid 
) const
protectedvirtual

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 TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetDifferenceFunction ( FiniteDifferenceFunctionType _arg)
virtual

◆ SetElapsedIterations()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetElapsedIterations ( IdentifierType  _arg)
protectedvirtual

Set the number of elapsed iterations of the filter.

◆ SetIsInitialized()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetIsInitialized ( bool  _arg)
virtual

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

◆ SetManualReinitialization()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetManualReinitialization ( bool  _arg)
virtual

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

◆ SetMaximumRMSError()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetMaximumRMSError ( double  _arg)
virtual

◆ SetNumberOfIterations()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetNumberOfIterations ( IdentifierType  _arg)
virtual

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

◆ SetRMSChange()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetRMSChange ( double  _arg)
virtual

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

◆ SetStateToInitialized()

template<typename TInputImage, typename TOutputImage>
void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetStateToInitialized ( )
inline

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

Definition at line 224 of file itkFiniteDifferenceImageFilter.h.

◆ SetStateToUninitialized()

template<typename TInputImage, typename TOutputImage>
void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::SetStateToUninitialized ( )
inline

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

Definition at line 219 of file itkFiniteDifferenceImageFilter.h.

◆ SetUseImageSpacing()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::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 TOutputImage>
virtual bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::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 304 of file itkFiniteDifferenceImageFilter.h.

◆ UseImageSpacingOff()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::UseImageSpacingOff ( )
virtual

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

◆ UseImageSpacingOn()

template<typename TInputImage, typename TOutputImage>
virtual void itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::UseImageSpacingOn ( )
virtual

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

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TOutputImage>
constexpr unsigned int itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::ImageDimension = OutputImageType::ImageDimension
staticconstexpr

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

Definition at line 151 of file itkFiniteDifferenceImageFilter.h.

◆ m_DifferenceFunction

template<typename TInputImage, typename TOutputImage>
FiniteDifferenceFunctionType::Pointer itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_DifferenceFunction
private

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

Definition at line 380 of file itkFiniteDifferenceImageFilter.h.

◆ m_ElapsedIterations

template<typename TInputImage, typename TOutputImage>
IdentifierType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_ElapsedIterations
protected

A counter for keeping track of the number of elapsed iterations during filtering.

Definition at line 359 of file itkFiniteDifferenceImageFilter.h.

◆ m_IsInitialized

template<typename TInputImage, typename TOutputImage>
bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_IsInitialized
protected

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

Definition at line 240 of file itkFiniteDifferenceImageFilter.h.

◆ m_ManualReinitialization

template<typename TInputImage, typename TOutputImage>
bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_ManualReinitialization
protected

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

Definition at line 363 of file itkFiniteDifferenceImageFilter.h.

◆ m_MaximumRMSError

template<typename TInputImage, typename TOutputImage>
double itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_MaximumRMSError
protected

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

Definition at line 366 of file itkFiniteDifferenceImageFilter.h.

◆ m_NumberOfIterations

template<typename TInputImage, typename TOutputImage>
IdentifierType itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_NumberOfIterations
protected

The maximum number of iterations this filter will run

Definition at line 355 of file itkFiniteDifferenceImageFilter.h.

◆ m_RMSChange

template<typename TInputImage, typename TOutputImage>
double itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_RMSChange
protected

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

Definition at line 365 of file itkFiniteDifferenceImageFilter.h.

◆ m_UseImageSpacing

template<typename TInputImage, typename TOutputImage>
bool itk::FiniteDifferenceImageFilter< TInputImage, TOutputImage >::m_UseImageSpacing
private

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

Definition at line 377 of file itkFiniteDifferenceImageFilter.h.


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