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

#include <itkSignedMaurerDistanceMapImageFilter.h>

Detailed Description

template<typename TInputImage, typename TOutputImage>
class itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >

This filter calculates the Euclidean distance transform of a binary image in linear time for arbitrary dimensions.

Inputs and Outputs
This is an image-to-image filter. The dimensionality is arbitrary. The only dimensionality constraint is that the input and output images be of the same dimensions and size. To maintain integer arithmetic within the filter, the default output is the signed squared distance. This implies that the input image should be of type "unsigned int" or "int" whereas the output image is of type "int". Obviously, if the user wishes to utilize the image spacing or to have a filter with the Euclidean distance (as opposed to the squared distance), output image types of float or double should be used.

The inside is considered as having negative distances. Outside is treated as having positive distances. To change the convention, use the InsideIsPositive(bool) function.

Parameters
Set/GetBackgroundValue specifies the background of the value of the input binary image. Normally this is zero and, as such, zero is the default value. Other than that, the usage is completely analogous to the itk::DanielssonDistanceImageFilter class except it does not return the Voronoi map.

Reference: C. R. Maurer, Jr., R. Qi, and V. Raghavan, "A Linear Time Algorithm for Computing Exact Euclidean Distance Transforms of Binary Images in Arbitrary Dimensions", IEEE - Transactions on Pattern Analysis and Machine Intelligence, 25(2): 265-270, 2003.

ITK Sphinx Examples:
Examples
SphinxExamples/src/Filtering/DistanceMap/MaurerDistanceMapOfBinary/Code.cxx.

Definition at line 67 of file itkSignedMaurerDistanceMapImageFilter.h.

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using InputImageConstPointer = typename InputImageType::ConstPointer
 
using InputImageType = TInputImage
 
using InputIndexType = typename InputImageType::IndexType
 
using InputIndexValueType = typename InputImageType::IndexValueType
 
using InputPixelType = typename InputImageType::PixelType
 
using InputRegionType = typename InputImageType::RegionType
 
using InputSizeType = typename InputImageType::SizeType
 
using InputSizeValueType = typename InputImageType::SizeValueType
 
using InputSpacingType = typename InputImageType::SpacingType
 
using OutputImagePointer = typename OutputImageType::Pointer
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
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 OutputSpacingType = typename OutputImageType::SpacingType
 
using Pointer = SmartPointer< Self >
 
using Self = SignedMaurerDistanceMapImageFilter
 
using Superclass = ImageToImageFilter< InputImageType, OutputImageType >
 
- 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 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 bool & GetInsideIsPositive () const
 
const char * GetNameOfClass () const override
 
virtual const bool & GetSquaredDistance () const
 
virtual const bool & GetUseImageSpacing () const
 
virtual void InsideIsPositiveOn ()
 
virtual void SetInsideIsPositive (bool _arg)
 
virtual void SetSquaredDistance (bool _arg)
 
virtual void SetUseImageSpacing (bool _arg)
 
virtual void SquaredDistanceOn ()
 
virtual void UseImageSpacingOn ()
 
virtual void SetBackgroundValue (InputPixelType _arg)
 
virtual const InputPixelTypeGetBackgroundValue () 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 *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 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 (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) const
 
void SetDebug (bool debugFlag) const
 
void SetReferenceCount (int) override
 
void UnRegister () const noexcept override
 
void SetMetaDataDictionary (const MetaDataDictionary &rhs)
 
void SetMetaDataDictionary (MetaDataDictionary &&rrhs)
 
virtual void SetObjectName (std::string _arg)
 
virtual const std::string & GetObjectName () const
 
- Public Member Functions inherited from itk::LightObject
Pointer Clone () const
 
virtual void Delete ()
 
virtual int GetReferenceCount () const
 
void Print (std::ostream &os, Indent indent=0) const
 

Static Public Member Functions

static Pointer New ()
 
- Static Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, 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 ()
 

Static Public Attributes

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

Protected Member Functions

void DynamicThreadedGenerateData (const OutputImageRegionType &) override
 
void GenerateData () override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
 SignedMaurerDistanceMapImageFilter ()
 
unsigned int SplitRequestedRegion (unsigned int i, unsigned int num, OutputImageRegionType &splitRegion) override
 
void ThreadedGenerateData (const OutputImageRegionType &, ThreadIdType) override
 
 ~SignedMaurerDistanceMapImageFilter () override=default
 
- Protected Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
virtual void CallCopyInputRegionToOutputRegion (OutputImageRegionType &destRegion, const InputImageRegionType &srcRegion)
 
virtual void CallCopyOutputRegionToInputRegion (InputImageRegionType &destRegion, const OutputImageRegionType &srcRegion)
 
void GenerateInputRequestedRegion () override
 
 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 AllocateOutputs ()
 
virtual void BeforeThreadedGenerateData ()
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual const ImageRegionSplitterBaseGetImageRegionSplitter () const
 
 ImageSource ()
 
 ~ImageSource () override=default
 
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 ReleaseInputs ()
 
virtual void RemoveInput (const DataObjectIdentifierType &key)
 
virtual void RemoveInput (DataObjectPointerArraySizeType)
 
virtual void RemoveOutput (const DataObjectIdentifierType &key)
 
virtual void RemoveOutput (DataObjectPointerArraySizeType idx)
 
bool RemoveRequiredInputName (const DataObjectIdentifierType &)
 
virtual void RestoreInputReleaseDataFlags ()
 
virtual void SetInput (const DataObjectIdentifierType &key, DataObject *input)
 
virtual void SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
 
virtual void SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
 
void SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
 
void SetNumberOfIndexedOutputs (DataObjectPointerArraySizeType num)
 
virtual void SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
 
virtual void SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
 
virtual void SetOutput (const DataObjectIdentifierType &name, DataObject *output)
 
virtual void SetPrimaryInput (DataObject *object)
 
virtual void SetPrimaryOutput (DataObject *object)
 
void SetRequiredInputNames (const NameArray &)
 
virtual void 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 ()
 

Private Member Functions

bool Remove (OutputPixelType, OutputPixelType, OutputPixelType, OutputPixelType, OutputPixelType, OutputPixelType)
 
void Voronoi (unsigned int, OutputIndexType idx, OutputImageType *output)
 

Private Attributes

InputPixelType m_BackgroundValue {}
 
unsigned int m_CurrentDimension { 0 }
 
const InputImageTypem_InputCache {}
 
bool m_InsideIsPositive { false }
 
InputSpacingType m_Spacing {}
 
bool m_SquaredDistance { false }
 
bool m_UseImageSpacing { true }
 

Additional Inherited Members

- Protected Types inherited from itk::ImageToImageFilter< TInputImage, 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)
 
- 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 {}
 

Member Typedef Documentation

◆ ConstPointer

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

Definition at line 89 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ InputImageConstPointer

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::InputImageConstPointer = typename InputImageType::ConstPointer

Definition at line 79 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ InputImageType

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

Convenient type alias for simplifying declarations.

Definition at line 78 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ InputIndexType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::InputIndexType = typename InputImageType::IndexType

Definition at line 109 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ InputIndexValueType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::InputIndexValueType = typename InputImageType::IndexValueType

Definition at line 110 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ InputPixelType

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

Image type alias support

Definition at line 101 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ InputRegionType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::InputRegionType = typename InputImageType::RegionType

Definition at line 97 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ InputSizeType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::InputSizeType = typename InputImageType::SizeType

Definition at line 104 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ InputSizeValueType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::InputSizeValueType = typename InputImageType::SizeValueType

Definition at line 105 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ InputSpacingType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::InputSpacingType = typename InputImageType::SpacingType

Definition at line 114 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ OutputImagePointer

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::OutputImagePointer = typename OutputImageType::Pointer

Definition at line 82 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ OutputImageRegionType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::OutputImageRegionType = typename OutputImageType::RegionType

Definition at line 116 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ OutputImageType

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

Definition at line 81 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ OutputIndexType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::OutputIndexType = typename OutputImageType::IndexType

Definition at line 111 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ OutputIndexValueType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::OutputIndexValueType = typename OutputImageType::IndexValueType

Definition at line 112 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ OutputPixelType

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

Definition at line 102 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ OutputRegionType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::OutputRegionType = typename OutputImageType::RegionType

Definition at line 98 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ OutputSizeType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::OutputSizeType = typename OutputImageType::SizeType

Definition at line 106 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ OutputSizeValueType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::OutputSizeValueType = typename OutputImageType::SizeValueType

Definition at line 107 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ OutputSpacingType

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::OutputSpacingType = typename OutputImageType::SpacingType

Definition at line 115 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ Pointer

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

Definition at line 88 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ Self

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

Standard class type aliases.

Definition at line 85 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage >
using itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::Superclass = ImageToImageFilter<InputImageType, OutputImageType>

Definition at line 86 of file itkSignedMaurerDistanceMapImageFilter.h.

Constructor & Destructor Documentation

◆ SignedMaurerDistanceMapImageFilter()

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

◆ ~SignedMaurerDistanceMapImageFilter()

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

Member Function Documentation

◆ DynamicThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::DynamicThreadedGenerateData ( const OutputImageRegionType outputRegionForThread)
inlineoverrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See also
GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

Definition at line 182 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ GenerateData()

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

A version of GenerateData() specific for image processing filters. This implementation will split the processing across multiple threads. The buffer is allocated by this method. Then the BeforeThreadedGenerateData() method is called (if provided). Then, a series of threads are spawned each calling DynamicThreadedGenerateData(). After all the threads have completed processing, the AfterThreadedGenerateData() method is called (if provided). If an image processing filter cannot be threaded, the filter should provide an implementation of GenerateData(). That implementation is responsible for allocating the output buffer. If a filter can be threaded, it should NOT provide a GenerateData() method but should provide a DynamicThreadedGenerateData() instead.

See also
ThreadedGenerateData()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ GetBackgroundValue()

template<typename TInputImage , typename TOutputImage >
virtual const InputPixelType& itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::GetBackgroundValue ( ) const
virtual

Set the background value which defines the object. Usually this value is = 0.

◆ GetInsideIsPositive()

template<typename TInputImage , typename TOutputImage >
virtual const bool& itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::GetInsideIsPositive ( ) const
virtual

Get if the inside represents positive values in the signed distance map.

See also
GetInsideIsPositive()

◆ GetNameOfClass()

template<typename TInputImage , typename TOutputImage >
const char* itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::GetNameOfClass ( ) const
overridevirtual

◆ GetSquaredDistance()

template<typename TInputImage , typename TOutputImage >
virtual const bool& itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::GetSquaredDistance ( ) const
virtual

Get the distance squared.

◆ GetUseImageSpacing()

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

Get whether spacing is used.

◆ InsideIsPositiveOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::InsideIsPositiveOn ( )
virtual

Set if the inside represents positive values in the signed distance map. By convention ON pixels are treated as inside pixels. Default is true.

◆ New()

template<typename TInputImage , typename TOutputImage >
static Pointer itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::New ( )
static

Method for creation through the object factory.

◆ PrintSelf()

template<typename TInputImage , typename TOutputImage >
void itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::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::ImageToImageFilter< TInputImage, TOutputImage >.

◆ Remove()

template<typename TInputImage , typename TOutputImage >
bool itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::Remove ( OutputPixelType  ,
OutputPixelType  ,
OutputPixelType  ,
OutputPixelType  ,
OutputPixelType  ,
OutputPixelType   
)
private

◆ SetBackgroundValue()

template<typename TInputImage , typename TOutputImage >
virtual void itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::SetBackgroundValue ( InputPixelType  _arg)
virtual

Set the background value which defines the object. Usually this value is = 0.

◆ SetInsideIsPositive()

template<typename TInputImage , typename TOutputImage >
virtual void itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::SetInsideIsPositive ( bool  _arg)
virtual

Set if the inside represents positive values in the signed distance map. By convention ON pixels are treated as inside pixels.

◆ SetSquaredDistance()

template<typename TInputImage , typename TOutputImage >
virtual void itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::SetSquaredDistance ( bool  _arg)
virtual

Set if the distance should be squared.

◆ SetUseImageSpacing()

template<typename TInputImage , typename TOutputImage >
virtual void itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::SetUseImageSpacing ( bool  _arg)
virtual

Set if image spacing should be used in computing distances.

◆ SplitRequestedRegion()

template<typename TInputImage , typename TOutputImage >
unsigned int itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::SplitRequestedRegion ( unsigned int  i,
unsigned int  pieces,
OutputImageRegionType splitRegion 
)
overrideprotectedvirtual

Split the output's RequestedRegion into "pieces" pieces, returning region "i" as "splitRegion". This method is called concurrently "pieces" times. The regions must not overlap. The method returns the number of pieces that the routine is capable of splitting the output RequestedRegion, i.e. return value is less than or equal to "pieces".

To override the algorithm used split the image this method should no longer be overridden. Instead, the algorithm should be implemented in a ImageRegionSplitterBase class, and the GetImageRegionSplitter should overridden to return the splitter object with the desired algorithm.

See also
GetImageRegionSplitter

Reimplemented from itk::ImageSource< TOutputImage >.

◆ SquaredDistanceOn()

template<typename TInputImage , typename TOutputImage >
virtual void itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::SquaredDistanceOn ( )
virtual

Set On/Off if the distance is squared.

◆ ThreadedGenerateData()

template<typename TInputImage , typename TOutputImage >
void itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData ( const OutputImageRegionType region,
ThreadIdType  threadId 
)
overrideprotectedvirtual

If an imaging filter can be implemented as a multithreaded algorithm, the filter will provide an implementation of ThreadedGenerateData() or DynamicThreadedGenerateData(). This superclass will automatically split the output image into a number of pieces, spawn multiple threads, and call (Dynamic)ThreadedGenerateData() in each thread. Prior to spawning threads, the BeforeThreadedGenerateData() method is called. After all the threads have completed, the AfterThreadedGenerateData() method is called. If an image processing filter cannot support threading, that filter should provide an implementation of the GenerateData() method instead of providing an implementation of (Dynamic)ThreadedGenerateData(). If a filter provides a GenerateData() method as its implementation, then the filter is responsible for allocating the output data. If a filter provides a (Dynamic)ThreadedGenerateData() method as its implementation, then the output memory will allocated automatically by this superclass. The (Dynamic)ThreadedGenerateData() method should only produce the output specified by "outputThreadRegion" parameter. (Dynamic)ThreadedGenerateData() cannot write to any other portion of the output image (as this is responsibility of a different thread).

DynamicThreadedGenerateData() is the newer variant without threadId, and is the preferred signature, which is called by default. This variant can split the requested region into different number of pieces depending on current multi-processing load, which allows better load balancing. The non-dynamic (also known as classic) ThreadedGenerateData() signature has threadId, and number of pieces to be split into is known in advance. It is activated by calling this->DynamicMultiThreadingOff(); in derived class constructor. It should be used when the multi-threaded algorithm needs to pre-allocate some data structure with size dependent on the number of pieces (also known as chunks, work units, and sometimes also incorrectly as threads). Only PlatformMultiThreader guarantees that each piece will be processed in its own specific thread. Pool and TBB multi-threaders maintain a pool of threads (normally equal to number of processing cores) which they use to process the pieces. This normally results in a single thread being reused to process multiple work units.

See also
GenerateData(), SplitRequestedRegion()

Reimplemented from itk::ImageSource< TOutputImage >.

◆ UseImageSpacingOn()

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

Set On/Off whether spacing is used.

◆ Voronoi()

template<typename TInputImage , typename TOutputImage >
void itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::Voronoi ( unsigned int  ,
OutputIndexType  idx,
OutputImageType output 
)
private

Member Data Documentation

◆ ImageDimension

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

Definition at line 75 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ InputImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::InputImageDimension = TInputImage::ImageDimension
staticconstexpr

Extract dimension from input and output image.

Definition at line 73 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ m_BackgroundValue

template<typename TInputImage , typename TOutputImage >
InputPixelType itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::m_BackgroundValue {}
private

Definition at line 192 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ m_CurrentDimension

template<typename TInputImage , typename TOutputImage >
unsigned int itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::m_CurrentDimension { 0 }
private

Definition at line 195 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ m_InputCache

template<typename TInputImage , typename TOutputImage >
const InputImageType* itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::m_InputCache {}
private

Definition at line 201 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ m_InsideIsPositive

template<typename TInputImage , typename TOutputImage >
bool itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::m_InsideIsPositive { false }
private

Definition at line 197 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ m_Spacing

template<typename TInputImage , typename TOutputImage >
InputSpacingType itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::m_Spacing {}
private

Definition at line 193 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ m_SquaredDistance

template<typename TInputImage , typename TOutputImage >
bool itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::m_SquaredDistance { false }
private

Definition at line 199 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ m_UseImageSpacing

template<typename TInputImage , typename TOutputImage >
bool itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::m_UseImageSpacing { true }
private

Definition at line 198 of file itkSignedMaurerDistanceMapImageFilter.h.

◆ OutputImageDimension

template<typename TInputImage , typename TOutputImage >
constexpr unsigned int itk::SignedMaurerDistanceMapImageFilter< TInputImage, TOutputImage >::OutputImageDimension = TOutputImage::ImageDimension
staticconstexpr

Definition at line 74 of file itkSignedMaurerDistanceMapImageFilter.h.


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