ITK  5.4.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Member Functions | Private Attributes | List of all members
itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell > Class Template Reference

#include <itkMultiphaseDenseFiniteDifferenceImageFilter.h>

Detailed Description

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

This filter implements a layer of the finite difference solver hierarchy that performs "dense" iteration, ie. iteration over all pixels in the input and output at each change calculation and update step. Dense iteration is in contrast to a "sparse" iteration over a subset of the pixels. See documentation for FiniteDifferenceImageFilter for an overview of the iterative finite difference algorithm:

\(u_{\mathbf{i}}^{n+1}=u^n_{\mathbf{i}}+\Delta u^n_{\mathbf{i}}\Delta t\)
The generic code for performing iterations and updates at each time step is inherited from the parent class. This class defines an update buffer for \( \Delta \) and the methods CalculateChange() and ApplyUpdate(). These methods are designed to automatically thread their execution. \( \Delta \) is defined as an image of identical size and type as the output image.
As we descend through each layer in the hierarchy, we know more and more about the specific application of our filter. At this level, we have committed to iteration over each pixel in an image. We take advantage of that knowledge to multithread the iteration and update methods.
Inputs and Outputs
This is an image to image filter. The specific types of the images are not fixed at this level in the hierarchy.
How to use this class
This filter is only one layer in a branch the finite difference solver hierarchy. It does not define the function used in the CalculateChange() and it does not define the stopping criteria (Halt method). To use this class, subclass it to a specific instance that supplies a function and Halt() method.

Based on the paper:

   "An active contour model without edges"
    T. Chan and L. Vese.
    In Scale-Space Theories in Computer Vision, pages 141-151, 1999.
Author
Mosaliganti K., Smith B., Gelas A., Gouaillard A., Megason S.

This code was taken from the Insight Journal paper:

"Cell Tracking using Coupled Active Surfaces for Nuclei and Membranes"
https://www.insight-journal.org/browse/publication/642

That is based on the papers:

"Level Set Segmentation: Active Contours without edge"
https://www.insight-journal.org/browse/publication/322

and

"Level set segmentation using coupled active surfaces"
https://www.insight-journal.org/browse/publication/323
See also
FiniteDifferenceImageFilter

Definition at line 102 of file itkMultiphaseDenseFiniteDifferenceImageFilter.h.

+ Inheritance diagram for itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >:
+ Collaboration diagram for itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >:

Public Types

using ConstPointer = SmartPointer< const Self >
 
using FaceCalculatorType = NeighborhoodAlgorithm::ImageBoundaryFacesCalculator< InputImageType >
 
using FaceListType = typename FaceCalculatorType::FaceListType
 
using MaurerPointer = typename MaurerType::Pointer
 
using MaurerType = SignedMaurerDistanceMapImageFilter< InputImageType, InputImageType >
 
using NeighborhoodIteratorType = typename FiniteDifferenceFunctionType::NeighborhoodType
 
using OutputPixelType = typename OutputImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = MultiphaseDenseFiniteDifferenceImageFilter
 
using SizeValueType = typename Superclass::OutputSizeValueType
 
using Superclass = MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
 
using ThresholdFilterPointer = typename ThresholdFilterType::Pointer
 
using ThresholdFilterType = BinaryThresholdImageFilter< InputImageType, InputImageType >
 
using ValueType = typename InputImageType::ValueType
 
- Public Types inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
using CentroidVectorType = Vector< float, Self::ImageDimension >
 
using ConstPointer = SmartPointer< const Self >
 
using FeatureImagePointer = typename FeatureImageType::Pointer
 
using FeatureImageType = TFeatureImage
 
using FeaturePixelType = typename FeatureImageType::PixelType
 
using FeaturePointType = typename FeatureImageType::PointType
 
using FeatureRegionType = typename FeatureImageType::RegionType
 
using FeatureSizeType = typename FeatureImageType::SizeType
 
using FeatureSpacingType = typename FeatureImageType::SpacingType
 
using FiniteDifferenceFunctionPointer = typename FiniteDifferenceFunctionType::Pointer
 
using FiniteDifferenceFunctionType = TFunction
 
using IdCellType = TIdCell
 
using InputCoordRepType = typename InputPointType::CoordRepType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageType = TInputImage
 
using InputIndexType = typename InputImageType::IndexType
 
using InputIndexValueType = typename InputIndexType::IndexValueType
 
using InputOffsetValueType = typename InputImageType::OffsetValueType
 
using InputPixelType = typename InputImageType::PixelType
 
using InputPointType = typename InputImageType::PointType
 
using InputRegionType = typename InputImageType::RegionType
 
using InputSizeType = typename InputImageType::SizeType
 
using InputSizeValueType = typename InputSizeType::SizeValueType
 
using InputSpacingType = typename InputImageType::SpacingType
 
using KdTreeGeneratorPointer = typename KdTreeGeneratorType::Pointer
 
using KdTreeGeneratorType = Statistics::KdTreeGenerator< SampleType >
 
using KdTreePointer = typename KdTreeType::Pointer
 
using KdTreeType = typename KdTreeGeneratorType::KdTreeType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageType = TOutputImage
 
using OutputIndexType = typename OutputImageType::IndexType
 
using OutputIndexValueType = typename OutputImageType::IndexValueType
 
using OutputPixelType = typename OutputImageType::PixelType
 
using OutputRegionType = typename OutputImageType::RegionType
 
using OutputSizeType = typename OutputImageType::SizeType
 
using OutputSizeValueType = typename OutputImageType::SizeValueType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename FiniteDifferenceFunctionType::RadiusType
 
using SampleType = Statistics::ListSample< CentroidVectorType >
 
using Self = MultiphaseFiniteDifferenceImageFilter
 
using Superclass = InPlaceImageFilter< TFeatureImage, TOutputImage >
 
using TimeStepType = typename FiniteDifferenceFunctionType::TimeStepType
 
using TimeStepVectorType = typename std::vector< TimeStepType >
 
using VectorIdCellType = std::vector< IdCellType >
 
- Public Types inherited from itk::InPlaceImageFilter< TFeatureImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TFeatureImage
 
using Pointer = SmartPointer< Self >
 
using Self = InPlaceImageFilter
 
using Superclass = ImageToImageFilter< TFeatureImage, TOutputImage >
 
- Public Types inherited from itk::ImageToImageFilter< TFeatureImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImagePixelType = typename InputImageType::PixelType
 
using InputImagePointer = typename InputImageType::Pointer
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TFeatureImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageToImageFilter
 
using Superclass = ImageSource< TOutputImage >
 
- Public Types inherited from itk::ImageSource< TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = Superclass::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArraySizeType = Superclass::DataObjectPointerArraySizeType
 
using OutputImagePixelType = typename OutputImageType::PixelType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using Pointer = SmartPointer< Self >
 
using Self = ImageSource
 
using Superclass = ProcessObject
 
- Public Types inherited from itk::ProcessObject
using ConstPointer = SmartPointer< const Self >
 
using DataObjectIdentifierType = DataObject::DataObjectIdentifierType
 
using DataObjectPointer = DataObject::Pointer
 
using DataObjectPointerArray = std::vector< DataObjectPointer >
 
using DataObjectPointerArraySizeType = DataObjectPointerArray::size_type
 
using MultiThreaderType = MultiThreaderBase
 
using NameArray = std::vector< DataObjectIdentifierType >
 
using Pointer = SmartPointer< Self >
 
using Self = ProcessObject
 
using Superclass = Object
 
- Public Types inherited from itk::Object
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = Object
 
using Superclass = LightObject
 
- Public Types inherited from itk::LightObject
using ConstPointer = SmartPointer< const Self >
 
using Pointer = SmartPointer< Self >
 
using Self = LightObject
 

Public Member Functions

const char * GetNameOfClass () const override
 
virtual unsigned int GetReinitializeCounter ()
 
void SetFunctionCount (const IdCellType &n)
 
virtual void SetReinitializeCounter (unsigned int _arg)
 
- Public Member Functions inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
virtual const unsigned int & GetElapsedIterations () const
 
InputImagePointer GetLevelSet (const IdCellType &i)
 
const char * GetNameOfClass () const override
 
virtual void SetElapsedIterations (unsigned int _arg)
 
void SetFunctionCount (const IdCellType &n)
 
void SetKdTree (KdTreeType *kdtree)
 
void SetLevelSet (const IdCellType &i, const InputImageType *levelSet)
 
void SetLookup (VectorIdCellType lookup)
 
virtual const FiniteDifferenceFunctionPointer GetDifferenceFunction (const IdCellType &functionIndex) const
 
virtual void SetDifferenceFunction (const IdCellType &functionIndex, FiniteDifferenceFunctionPointer function)
 
virtual void SetNumberOfIterations (unsigned int _arg)
 
virtual const unsigned int & GetNumberOfIterations () const
 
virtual void SetUseImageSpacing (bool _arg)
 
virtual void UseImageSpacingOn ()
 
virtual const bool & GetUseImageSpacing () const
 
virtual void SetMaximumRMSError (double _arg)
 
virtual const double & GetMaximumRMSError () const
 
virtual void SetRMSChange (double _arg)
 
virtual const double & GetRMSChange () const
 
virtual void SetInitializedState (bool _arg)
 
virtual const bool & GetInitializedState () const
 
virtual void InitializedStateOn ()
 
virtual void SetManualReinitialization (bool _arg)
 
virtual const bool & GetManualReinitialization () const
 
virtual void ManualReinitializationOn ()
 
- Public Member Functions inherited from itk::InPlaceImageFilter< TFeatureImage, TOutputImage >
virtual bool CanRunInPlace () const
 
virtual void SetInPlace (bool _arg)
 
virtual bool GetInPlace () const
 
virtual void InPlaceOn ()
 
- 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 *input)
 
virtual void PushFrontInput (const InputImageType *input)
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetInput (const InputImageType *input)
 
virtual void SetInput (unsigned int, const TFeatureImage *image)
 
virtual void SetCoordinateTolerance (double _arg)
 
virtual double GetCoordinateTolerance () const
 
virtual void SetDirectionTolerance (double _arg)
 
virtual double GetDirectionTolerance () const
 
- Public Member Functions inherited from itk::ImageSource< TOutputImage >
OutputImageTypeGetOutput (unsigned int idx)
 
OutputImageTypeGetOutput ()
 
const OutputImageTypeGetOutput () const
 
virtual void GraftOutput (DataObject *graft)
 
virtual void GraftOutput (const DataObjectIdentifierType &key, DataObject *graft)
 
virtual void GraftNthOutput (unsigned int idx, DataObject *graft)
 
ProcessObject::DataObjectPointer MakeOutput (ProcessObject::DataObjectPointerArraySizeType idx) override
 
ProcessObject::DataObjectPointer MakeOutput (const ProcessObject::DataObjectIdentifierType &) override
 
- Public Member Functions inherited from itk::ProcessObject
virtual void AbortGenerateDataOn ()
 
virtual void EnlargeOutputRequestedRegion (DataObject *)
 
virtual const bool & GetAbortGenerateData () const
 
DataObjectPointerArray GetIndexedInputs ()
 
DataObjectPointerArray GetIndexedOutputs ()
 
NameArray GetInputNames () const
 
DataObjectPointerArray GetInputs ()
 
MultiThreaderTypeGetMultiThreader () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedInputs () const
 
DataObjectPointerArraySizeType GetNumberOfIndexedOutputs () const
 
DataObjectPointerArraySizeType GetNumberOfInputs () const
 
DataObjectPointerArraySizeType GetNumberOfOutputs () const
 
virtual DataObjectPointerArraySizeType GetNumberOfValidRequiredInputs () const
 
NameArray GetOutputNames () const
 
DataObjectPointerArray GetOutputs ()
 
virtual float GetProgress () const
 
NameArray GetRequiredInputNames () const
 
bool HasInput (const DataObjectIdentifierType &key) const
 
bool HasOutput (const DataObjectIdentifierType &key) const
 
void IncrementProgress (float increment)
 
virtual void PrepareOutputs ()
 
virtual void PropagateRequestedRegion (DataObject *output)
 
virtual void ResetPipeline ()
 
virtual void SetAbortGenerateData (bool _arg)
 
void SetMultiThreader (MultiThreaderType *threader)
 
virtual void Update ()
 
virtual void UpdateLargestPossibleRegion ()
 
virtual void UpdateOutputData (DataObject *output)
 
virtual void UpdateOutputInformation ()
 
void UpdateProgress (float progress)
 
virtual void SetReleaseDataFlag (bool val)
 
virtual bool GetReleaseDataFlag () const
 
void ReleaseDataFlagOn ()
 
void ReleaseDataFlagOff ()
 
virtual void SetReleaseDataBeforeUpdateFlag (bool _arg)
 
virtual const bool & GetReleaseDataBeforeUpdateFlag () const
 
virtual void ReleaseDataBeforeUpdateFlagOn ()
 
virtual void SetNumberOfWorkUnits (ThreadIdType _arg)
 
virtual const ThreadIdTypeGetNumberOfWorkUnits () const
 
- Public Member Functions inherited from itk::Object
unsigned long AddObserver (const EventObject &event, Command *)
 
unsigned long AddObserver (const EventObject &event, Command *) const
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
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
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Attributes

static constexpr unsigned int ImageDimension = Superclass::ImageDimension
 
- Static Public Attributes inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
static constexpr unsigned int ImageDimension
 
- Static Public Attributes inherited from itk::InPlaceImageFilter< TFeatureImage, TOutputImage >
static constexpr unsigned int InputImageDimension
 
static constexpr unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageToImageFilter< TFeatureImage, TOutputImage >
static constexpr unsigned int InputImageDimension
 
static constexpr unsigned int OutputImageDimension
 
- Static Public Attributes inherited from itk::ImageSource< TOutputImage >
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 

Protected Member Functions

void ApplyUpdate (TimeStepType dt) override
 
void CopyInputToOutput () override
 
 MultiphaseDenseFiniteDifferenceImageFilter ()
 
void PostProcessOutput () override
 
void PrintSelf (std::ostream &, Indent indent) const override
 
 ~MultiphaseDenseFiniteDifferenceImageFilter () override=default
 
- Protected Member Functions inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
void GenerateData () override
 
void GenerateInputRequestedRegion () override
 
virtual bool Halt ()
 
virtual void Initialize ()
 
 MultiphaseFiniteDifferenceImageFilter ()
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
TimeStepType ResolveTimeStep (const TimeStepVectorType &timeStepList, const std::vector< uint8_t > &valid)
 
virtual bool ThreadedHalt (void *)
 
 ~MultiphaseFiniteDifferenceImageFilter () override=default
 
virtual void InitializeIteration ()
 
- Protected Member Functions inherited from itk::InPlaceImageFilter< TFeatureImage, TOutputImage >
virtual bool GetRunningInPlace () const
 
 InPlaceImageFilter ()=default
 
void ReleaseInputs () override
 
 ~InPlaceImageFilter () override=default
 
void AllocateOutputs () override
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TFeatureImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
 ImageToImageFilter ()
 
void VerifyInputInformation () ITKv5_CONST override
 
 ~ImageToImageFilter () override=default
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
- Protected Member Functions inherited from itk::ImageSource< TOutputImage >
virtual void AfterThreadedGenerateData ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
virtual unsigned int SplitRequestedRegion (unsigned int i, unsigned int pieces, OutputImageRegionType &splitRegion)
 
 ~ImageSource () override=default
 
virtual void ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual bool GetDynamicMultiThreading () const
 
virtual void SetDynamicMultiThreading (bool _arg)
 
virtual void DynamicMultiThreadingOn ()
 
- Protected Member Functions inherited from itk::ProcessObject
virtual void AddInput (DataObject *input)
 
void AddOptionalInputName (const DataObjectIdentifierType &)
 
void AddOptionalInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void AddOutput (DataObject *output)
 
bool AddRequiredInputName (const DataObjectIdentifierType &)
 
bool AddRequiredInputName (const DataObjectIdentifierType &, DataObjectPointerArraySizeType idx)
 
virtual void CacheInputReleaseDataFlags ()
 
virtual void GenerateOutputInformation ()
 
virtual void GenerateOutputRequestedRegion (DataObject *output)
 
DataObjectGetInput (const DataObjectIdentifierType &key)
 
const DataObjectGetInput (const DataObjectIdentifierType &key) const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredInputs () const
 
virtual const DataObjectPointerArraySizeTypeGetNumberOfRequiredOutputs () const
 
bool IsIndexedInputName (const DataObjectIdentifierType &) const
 
bool IsIndexedOutputName (const DataObjectIdentifierType &) const
 
bool IsRequiredInputName (const DataObjectIdentifierType &) const
 
DataObjectPointerArraySizeType MakeIndexFromInputName (const DataObjectIdentifierType &name) const
 
DataObjectPointerArraySizeType MakeIndexFromOutputName (const DataObjectIdentifierType &name) const
 
DataObjectIdentifierType MakeNameFromInputIndex (DataObjectPointerArraySizeType idx) const
 
DataObjectIdentifierType MakeNameFromOutputIndex (DataObjectPointerArraySizeType idx) const
 
 ProcessObject ()
 
virtual void PropagateResetPipeline ()
 
virtual void PushBackInput (const DataObject *input)
 
virtual void PushFrontInput (const DataObject *input)
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void VerifyPreconditions () ITKv5_CONST
 
 ~ProcessObject () override
 
DataObjectGetInput (DataObjectPointerArraySizeType idx)
 
const DataObjectGetInput (DataObjectPointerArraySizeType idx) const
 
DataObjectGetPrimaryInput ()
 
const DataObjectGetPrimaryInput () const
 
virtual void SetPrimaryInputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryInputName () const
 
DataObjectGetOutput (const DataObjectIdentifierType &key)
 
const DataObjectGetOutput (const DataObjectIdentifierType &key) const
 
virtual void SetPrimaryOutputName (const DataObjectIdentifierType &key)
 
virtual const char * GetPrimaryOutputName () const
 
DataObjectGetOutput (DataObjectPointerArraySizeType i)
 
const DataObjectGetOutput (DataObjectPointerArraySizeType i) const
 
DataObjectGetPrimaryOutput ()
 
const DataObjectGetPrimaryOutput () const
 
virtual bool GetThreaderUpdateProgress () const
 
virtual void ThreaderUpdateProgressOn ()
 
virtual void SetThreaderUpdateProgress (bool arg)
 
- Protected Member Functions inherited from itk::Object
 Object ()
 
bool PrintObservers (std::ostream &os, Indent indent) const
 
virtual void SetTimeStamp (const TimeStamp &timeStamp)
 
 ~Object () override
 
- Protected Member Functions inherited from itk::LightObject
virtual LightObject::Pointer InternalClone () const
 
 LightObject ()
 
virtual void PrintHeader (std::ostream &os, Indent indent) const
 
virtual void PrintTrailer (std::ostream &os, Indent indent) const
 
virtual ~LightObject ()
 

Protected Attributes

unsigned int m_ReinitializeCounter {}
 
- Protected Attributes inherited from itk::MultiphaseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >
std::vector< FiniteDifferenceFunctionPointerm_DifferenceFunctions
 
unsigned int m_ElapsedIterations
 
IdCellType m_FunctionCount
 
KdTreePointer m_KdTree
 
std::vector< InputImagePointerm_LevelSet
 
VectorIdCellType m_Lookup
 
double m_MaximumRMSError
 
unsigned int m_NumberOfIterations
 
double m_RMSChange
 
bool m_UseImageSpacing
 
- Protected Attributes inherited from itk::ImageSource< TOutputImage >
bool m_DynamicMultiThreading {}
 
- Protected Attributes inherited from itk::ProcessObject
TimeStamp m_OutputInformationMTime {}
 
bool m_Updating {}
 
- Protected Attributes inherited from itk::LightObject
std::atomic< int > m_ReferenceCount {}
 

Private Member Functions

void AllocateUpdateBuffer () override
 
TimeStepType CalculateChange () override
 

Private Attributes

std::vector< InputImagePointerm_UpdateBuffers {}
 

Additional Inherited Members

- Static Public Member Functions inherited from itk::ImageToImageFilter< TFeatureImage, TOutputImage >
static double GetGlobalDefaultCoordinateTolerance ()
 
static double GetGlobalDefaultDirectionTolerance ()
 
static void SetGlobalDefaultCoordinateTolerance (double)
 
static void SetGlobalDefaultDirectionTolerance (double)
 
- Static Public Member Functions inherited from itk::Object
static bool GetGlobalWarningDisplay ()
 
static void GlobalWarningDisplayOff ()
 
static void GlobalWarningDisplayOn ()
 
static Pointer New ()
 
static void SetGlobalWarningDisplay (bool val)
 
- Static Public Member Functions inherited from itk::LightObject
static void BreakOnError ()
 
static Pointer New ()
 
- Protected Types inherited from itk::ImageToImageFilter< TFeatureImage, TOutputImage >
using InputToOutputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::OutputImageDimension, Self::InputImageDimension >
 
using OutputToInputRegionCopierType = ImageToImageFilterDetail::ImageRegionCopier< Self::InputImageDimension, Self::OutputImageDimension >
 
- Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const 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)
 

Member Typedef Documentation

◆ ConstPointer

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ConstPointer = SmartPointer<const Self>

◆ FaceCalculatorType

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FaceCalculatorType = NeighborhoodAlgorithm::ImageBoundaryFacesCalculator<InputImageType>

◆ FaceListType

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::FaceListType = typename FaceCalculatorType::FaceListType

◆ MaurerPointer

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::MaurerPointer = typename MaurerType::Pointer

◆ MaurerType

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::MaurerType = SignedMaurerDistanceMapImageFilter<InputImageType, InputImageType>

◆ NeighborhoodIteratorType

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::NeighborhoodIteratorType = typename FiniteDifferenceFunctionType::NeighborhoodType

◆ OutputPixelType

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::OutputPixelType = typename OutputImageType::PixelType

◆ Pointer

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::Pointer = SmartPointer<Self>

◆ Self

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::Self = MultiphaseDenseFiniteDifferenceImageFilter

Standard class type aliases

Definition at line 109 of file itkMultiphaseDenseFiniteDifferenceImageFilter.h.

◆ SizeValueType

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::SizeValueType = typename Superclass::OutputSizeValueType

◆ Superclass

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::Superclass = MultiphaseFiniteDifferenceImageFilter<TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell>

◆ ThresholdFilterPointer

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ThresholdFilterPointer = typename ThresholdFilterType::Pointer

◆ ThresholdFilterType

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ThresholdFilterType = BinaryThresholdImageFilter<InputImageType, InputImageType>

◆ ValueType

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
using itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ValueType = typename InputImageType::ValueType

Constructor & Destructor Documentation

◆ MultiphaseDenseFiniteDifferenceImageFilter()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::MultiphaseDenseFiniteDifferenceImageFilter ( )
inlineprotected

◆ ~MultiphaseDenseFiniteDifferenceImageFilter()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::~MultiphaseDenseFiniteDifferenceImageFilter ( )
overrideprotecteddefault

Member Function Documentation

◆ AllocateUpdateBuffer()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
void itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::AllocateUpdateBuffer ( )
overrideprivatevirtual

◆ ApplyUpdate()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
void itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ApplyUpdate ( TimeStepType  dt)
overrideprotectedvirtual

This method applies changes from the m_UpdateBuffer to the output using the ThreadedApplyUpdate() method and a multithreading mechanism. "dt" is the time step to use for the update of each pixel.

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

◆ CalculateChange()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
TimeStepType itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::CalculateChange ( )
overrideprivatevirtual

This method populates an update buffer with changes for each pixel in the output using the ThreadedCalculateChange() method and a multithreading mechanism. Returns value is a time step to be used for the update.

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

◆ CopyInputToOutput()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
void itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::CopyInputToOutput ( )
overrideprotectedvirtual

A simple method to copy the data from the input to the output. ( Supports "read-only" image adaptors in the case where the input image type converts to a different output image type. )

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

◆ GetNameOfClass()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
const char* itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::GetNameOfClass ( ) const
overridevirtual

◆ GetReinitializeCounter()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
virtual unsigned int itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::GetReinitializeCounter ( )
virtual

◆ PostProcessOutput()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
void itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::PostProcessOutput ( )
overrideprotectedvirtual

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

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

◆ PrintSelf()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
void itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::PrintSelf ( std::ostream &  os,
Indent  indent 
) const
overrideprotectedvirtual

Methods invoked by Print() to print information about the object including superclasses. Typically not called by the user (use Print() instead) but used in the hierarchical print process to combine the output of several classes.

Reimplemented from itk::ImageSource< TOutputImage >.

◆ SetFunctionCount()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
void itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::SetFunctionCount ( const IdCellType n)

◆ SetReinitializeCounter()

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
virtual void itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::SetReinitializeCounter ( unsigned int  _arg)
virtual

Member Data Documentation

◆ ImageDimension

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
constexpr unsigned int itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::ImageDimension = Superclass::ImageDimension
staticconstexpr

Dimensionality of input and output data is assumed to be the same. It is inherited from the superclass.

Definition at line 120 of file itkMultiphaseDenseFiniteDifferenceImageFilter.h.

◆ m_ReinitializeCounter

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
unsigned int itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_ReinitializeCounter {}
protected

◆ m_UpdateBuffers

template<typename TInputImage, typename TFeatureImage, typename TOutputImage, typename TFunction, typename TIdCell = unsigned int>
std::vector<InputImagePointer> itk::MultiphaseDenseFiniteDifferenceImageFilter< TInputImage, TFeatureImage, TOutputImage, TFunction, TIdCell >::m_UpdateBuffers {}
private

The buffer that holds the updates for an iteration of the algorithm.

Definition at line 228 of file itkMultiphaseDenseFiniteDifferenceImageFilter.h.


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