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

#include <itkBinaryMorphologyImageFilter.h>

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

Public Types

using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename InputImageType::IndexType
 
using IndexValueType = typename InputImageType::IndexValueType
 
using InputImageRegionType = typename InputImageType::RegionType
 
using InputImageType = TInputImage
 
using InputPixelType = typename InputImageType::PixelType
 
using InputRealType = typename NumericTraits< InputPixelType >::RealType
 
using InputSizeType = typename InputImageType::SizeType
 
using InputSizeValueType = typename InputImageType::SizeValueType
 
using KernelIteratorType = typename KernelType::ConstIterator
 
using KernelType = TKernel
 
using OffsetType = typename InputImageType::OffsetType
 
using OutputImageRegionType = typename OutputImageType::RegionType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename OutputImageType::PixelType
 
using Pointer = SmartPointer< Self >
 
using Self = BinaryMorphologyImageFilter
 
using Superclass = KernelImageFilter< InputImageType, OutputImageType, TKernel >
 
- Public Types inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
using ConstPointer = SmartPointer< const Self >
 
using FlatKernelType = FlatStructuringElement<(Self::ImageDimension)>
 
using IndexType = typename TInputImage::IndexType
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using KernelType = TKernel
 
using OffsetType = typename TInputImage::OffsetType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename TInputImage::SizeType
 
using RegionType = typename TInputImage::RegionType
 
using Self = KernelImageFilter
 
using SizeType = typename TInputImage::SizeType
 
using Superclass = BoxImageFilter< TInputImage, TOutputImage >
 
- Public Types inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
using ConstPointer = SmartPointer< const Self >
 
using IndexType = typename TInputImage::IndexType
 
using InputImageType = TInputImage
 
using InputPixelType = typename TInputImage::PixelType
 
using OffsetType = typename TInputImage::OffsetType
 
using OutputImageType = TOutputImage
 
using OutputPixelType = typename TOutputImage::PixelType
 
using Pointer = SmartPointer< Self >
 
using RadiusType = typename TInputImage::SizeType
 
using RadiusValueType = typename TInputImage::SizeValueType
 
using RegionType = typename TInputImage::RegionType
 
using Self = BoxImageFilter
 
using SizeType = typename TInputImage::SizeType
 
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 ::itk::LightObject::Pointer CreateAnother () const
 
virtual OutputPixelType GetBackgroundValue () const
 
virtual InputPixelType GetForegroundValue () const
 
virtual const char * GetNameOfClass () const
 
virtual void SetBackgroundValue (OutputPixelType _arg)
 
virtual void SetForegroundValue (InputPixelType _arg)
 
- Public Member Functions inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
virtual const KernelTypeGetKernel () const
 
void SetRadius (const RadiusType &radius) override
 
void SetRadius (const SizeValueType &radius) override
 
- Public Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
virtual const RadiusTypeGetRadius () const
 
virtual void SetRadius (const RadiusValueType &radius)
 
- 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
 
unsigned long AddObserver (const EventObject &event, std::function< void(const EventObject &)> function) const
 
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 Member Functions

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

Static Public Attributes

static constexpr unsigned int InputImageDimension = TInputImage::ImageDimension
 
static constexpr unsigned int KernelDimension = TKernel::NeighborhoodDimension
 
static constexpr unsigned int OutputImageDimension = TOutputImage::ImageDimension
 
- Static Public Attributes inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
static constexpr unsigned int ImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
static constexpr unsigned int ImageDimension = TInputImage::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
 
using NeighborIndexContainer = std::vector< OffsetType >
 
using NeighborIndexContainerContainer = std::vector< NeighborIndexContainer >
 
using ComponentVectorType = std::vector< OffsetType >
 
using ComponentVectorConstIterator = typename ComponentVectorType::const_iterator
 
bool m_BoundaryToForeground
 
InputPixelType m_ForegroundValue
 
OutputPixelType m_BackgroundValue
 
NeighborIndexContainerContainer m_KernelDifferenceSets
 
std::vector< OffsetTypem_KernelCCVector
 
virtual void SetBoundaryToForeground (bool _arg)
 
virtual const bool & GetBoundaryToForeground () const
 
virtual void BoundaryToForegroundOn ()
 
virtual void BoundaryToForegroundOff ()
 
void SetKernel (const KernelType &kernel) override
 
 BinaryMorphologyImageFilter ()
 
 ~BinaryMorphologyImageFilter () override=default
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void AnalyzeKernel ()
 
NeighborIndexContainerGetDifferenceSet (unsigned int code)
 
ComponentVectorConstIterator KernelCCVectorBegin ()
 
ComponentVectorConstIterator KernelCCVectorEnd ()
 

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 >
 
- Protected Member Functions inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
 KernelImageFilter ()
 
 ~KernelImageFilter () override=default
 
- Protected Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
 BoxImageFilter ()
 
void GenerateInputRequestedRegion () override
 
 ~BoxImageFilter () override=default
 
- 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 GenerateData () override
 
void ClassicMultiThread (ThreadFunctionType callbackFunction)
 
virtual void ThreadedGenerateData (const OutputImageRegionType &outputRegionForThread, ThreadIdType threadId)
 
virtual void DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
 
virtual void AllocateOutputs ()
 
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 ReleaseInputs ()
 
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::KernelImageFilter< TInputImage, TOutputImage, TKernel >
KernelType m_Kernel
 
- 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, typename TKernel>
class itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >

Base class for fast binary dilation and erosion.

BinaryMorphologyImageFilter is a base class for fast binary morphological operations. The implementation of this class and its subclasses are based on the papers:

L.Vincent "Morphological transformations of binary images with arbitrary structuring elements", and

N.Nikopoulos et al. "An efficient algorithm for 3d binary morphological transformations with 3d structuring elements for arbitrary size and shape". IEEE Transactions on Image Processing. Vol. 9. No. 3. 2000. pp. 283-286.

Gray scale images can be processed as binary images by selecting a "ForegroundValued" (which subclasses may alias as "DilateValue" or "ErodeValue"). Pixel not matching the foreground value are considered "background". This is useful in processing segmented images where all pixels in segment #1 have value 1 and pixels in segment #2 have value 2, etc. A particular "segment number" can be processed. ForegroundValue defaults to the maximum possible value of the PixelType.

The structuring element is assumed to be composed of binary values (zero or one). Only elements of the structuring element having values > 0 are candidates for affecting the center pixel. A reasonable choice of structuring element is itk::BinaryBallStructuringElement.

Description of the algorithm:

Let's consider the set of the ON elements of the input image as X.

Let's consider the structuring element as B = {B0, B1, ..., Bn}, where Bi denotes a connected component of B.

Let's consider bi, i in [0,n], an arbitrary point of Bi.

We use hence the next property in order to compute minkoswki addition ( which will be written (+) ):

X (+) B = ( Xb0 UNION Xb1 UNION ... Xbn ) UNION ( BORDER(X) (+) B ),

where Xbi is the set X translated with respect to vector bi :

Xbi ={ x + bi, x belongs to X }

where BORDER(X) is the extracted border of X ( 8 connectivity in 2D, 26 in 3D )

Our implementation for dilation is defined as:

X (+) SYM(B) = DILATION(X)_B

Where DILATION(X)_B is the dilation of set with structuring element B. Where SYM(B) is the symmetric of the structuring element relatively to its center.

This code was contributed by Jerome Schmid from the University of Strasbourg who provided a fast dilation implementation. Gaetan Lehmann from INRA de Jouy-en-Josas then provided a fast erosion implementation based on Jerome's implementation. The common portions of these two implementations were then placed in this superclass.

See also
ImageToImageFilter BinaryErodeImageFilter BinaryDilateImageFilter

Definition at line 103 of file itkBinaryMorphologyImageFilter.h.

Member Typedef Documentation

◆ ComponentVectorConstIterator

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ComponentVectorConstIterator = typename ComponentVectorType::const_iterator
protected

Iterator for ComponentVectorType

Definition at line 207 of file itkBinaryMorphologyImageFilter.h.

◆ ComponentVectorType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::ComponentVectorType = std::vector<OffsetType>
protected

Type definition of the container for indices

Definition at line 204 of file itkBinaryMorphologyImageFilter.h.

◆ ConstPointer

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

Definition at line 124 of file itkBinaryMorphologyImageFilter.h.

◆ IndexType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::IndexType = typename InputImageType::IndexType

Definition at line 143 of file itkBinaryMorphologyImageFilter.h.

◆ IndexValueType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::IndexValueType = typename InputImageType::IndexValueType

Definition at line 144 of file itkBinaryMorphologyImageFilter.h.

◆ InputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::InputImageRegionType = typename InputImageType::RegionType

Definition at line 146 of file itkBinaryMorphologyImageFilter.h.

◆ InputImageType

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

Convenient type alias for simplifying declarations.

Definition at line 117 of file itkBinaryMorphologyImageFilter.h.

◆ InputPixelType

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

Image type alias support

Definition at line 139 of file itkBinaryMorphologyImageFilter.h.

◆ InputRealType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::InputRealType = typename NumericTraits<InputPixelType>::RealType

Definition at line 141 of file itkBinaryMorphologyImageFilter.h.

◆ InputSizeType

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

Definition at line 148 of file itkBinaryMorphologyImageFilter.h.

◆ InputSizeValueType

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

Definition at line 149 of file itkBinaryMorphologyImageFilter.h.

◆ KernelIteratorType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelIteratorType = typename KernelType::ConstIterator

Kernel (structuring element) iterator.

Definition at line 136 of file itkBinaryMorphologyImageFilter.h.

◆ KernelType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelType = TKernel

Kernel type alias.

Definition at line 133 of file itkBinaryMorphologyImageFilter.h.

◆ NeighborIndexContainer

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::NeighborIndexContainer = std::vector<OffsetType>
protected

Type definition of container of neighbourhood index

Definition at line 198 of file itkBinaryMorphologyImageFilter.h.

◆ NeighborIndexContainerContainer

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::NeighborIndexContainerContainer = std::vector<NeighborIndexContainer>
protected

Type definition of container of container of neighbourhood index

Definition at line 201 of file itkBinaryMorphologyImageFilter.h.

◆ OffsetType

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::OffsetType = typename InputImageType::OffsetType

Definition at line 142 of file itkBinaryMorphologyImageFilter.h.

◆ OutputImageRegionType

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

Definition at line 147 of file itkBinaryMorphologyImageFilter.h.

◆ OutputImageType

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

Definition at line 118 of file itkBinaryMorphologyImageFilter.h.

◆ OutputPixelType

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

Definition at line 140 of file itkBinaryMorphologyImageFilter.h.

◆ Pointer

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

Definition at line 123 of file itkBinaryMorphologyImageFilter.h.

◆ Self

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

Standard class type aliases.

Definition at line 121 of file itkBinaryMorphologyImageFilter.h.

◆ Superclass

template<typename TInputImage , typename TOutputImage , typename TKernel >
using itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::Superclass = KernelImageFilter<InputImageType, OutputImageType, TKernel>

Definition at line 122 of file itkBinaryMorphologyImageFilter.h.

Constructor & Destructor Documentation

◆ BinaryMorphologyImageFilter()

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

Type definition of container of neighbourhood index

◆ ~BinaryMorphologyImageFilter()

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

Type definition of container of neighbourhood index

Member Function Documentation

◆ AnalyzeKernel()

template<typename TInputImage , typename TOutputImage , typename TKernel >
void itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::AnalyzeKernel ( )
protected

Analyze kernel and prepare data for GenerateData() function

◆ BoundaryToForegroundOff()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual void itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::BoundaryToForegroundOff ( )
virtual

Type definition of container of neighbourhood index

◆ BoundaryToForegroundOn()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual void itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::BoundaryToForegroundOn ( )
virtual

Type definition of container of neighbourhood index

◆ CreateAnother()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual::itk::LightObject::Pointer itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::CreateAnother ( ) const
virtual

Create an object from an instance, potentially deferring to a factory. This method allows you to create an instance of an object that is exactly the same type as the referring object. This is useful in cases where an object has been cast back to a base class.

Reimplemented from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

Reimplemented in itk::FastIncrementalBinaryDilateImageFilter< TInputImage, TOutputImage, TKernel >.

◆ GetBackgroundValue()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual OutputPixelType itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetBackgroundValue ( ) const
virtual

Get the value used as "background". Any pixel value which is not DilateValue is considered background. BackgroundValue is used to fill the removed pixels.

◆ GetBoundaryToForeground()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual const bool& itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetBoundaryToForeground ( ) const
virtual

Type definition of container of neighbourhood index

◆ GetDifferenceSet()

template<typename TInputImage , typename TOutputImage , typename TKernel >
NeighborIndexContainer& itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetDifferenceSet ( unsigned int  code)
inlineprotected

Get the difference set for a particular offset

Definition at line 212 of file itkBinaryMorphologyImageFilter.h.

◆ GetForegroundValue()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual InputPixelType itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::GetForegroundValue ( ) const
virtual

Get the value in the image considered as "foreground". Defaults to maximum value of PixelType.

◆ GetNameOfClass()

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

◆ KernelCCVectorBegin()

template<typename TInputImage , typename TOutputImage , typename TKernel >
ComponentVectorConstIterator itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelCCVectorBegin ( )
inlineprotected

Get an iterator to the start of the connected component vector

Definition at line 220 of file itkBinaryMorphologyImageFilter.h.

◆ KernelCCVectorEnd()

template<typename TInputImage , typename TOutputImage , typename TKernel >
ComponentVectorConstIterator itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelCCVectorEnd ( )
inlineprotected

Get an iterator to the end of the connected component vector

Definition at line 228 of file itkBinaryMorphologyImageFilter.h.

◆ New()

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

Method for creation through the object factory.

◆ PrintSelf()

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

Type definition of container of neighbourhood index

Reimplemented from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

◆ SetBackgroundValue()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual void itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetBackgroundValue ( OutputPixelType  _arg)
virtual

Set the value used as "background". Any pixel value which is not DilateValue is considered background. BackgroundValue is used to fill the removed pixels.

◆ SetBoundaryToForeground()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual void itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetBoundaryToForeground ( bool  _arg)
virtual

Get/Set the borders as foreground (true) or background (false).

◆ SetForegroundValue()

template<typename TInputImage , typename TOutputImage , typename TKernel >
virtual void itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetForegroundValue ( InputPixelType  _arg)
virtual

Input and output images must be the same dimension. Set the value in the image to consider as "foreground". Defaults to maximum value of PixelType. Subclasses may alias this to DilateValue or ErodeValue.

◆ SetKernel()

template<typename TInputImage , typename TOutputImage , typename TKernel >
void itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::SetKernel ( const KernelType kernel)
overridevirtual

Set kernel (structuring element).

Reimplemented from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >.

Member Data Documentation

◆ InputImageDimension

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

Extract dimension from input and output image.

Definition at line 110 of file itkBinaryMorphologyImageFilter.h.

◆ KernelDimension

template<typename TInputImage , typename TOutputImage , typename TKernel >
constexpr unsigned int itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::KernelDimension = TKernel::NeighborhoodDimension
staticconstexpr

Extract the dimension of the kernel

Definition at line 114 of file itkBinaryMorphologyImageFilter.h.

◆ m_BackgroundValue

template<typename TInputImage , typename TOutputImage , typename TKernel >
OutputPixelType itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_BackgroundValue
private

Pixel value for background

Definition at line 240 of file itkBinaryMorphologyImageFilter.h.

◆ m_BoundaryToForeground

template<typename TInputImage , typename TOutputImage , typename TKernel >
bool itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_BoundaryToForeground
protected

Type definition of container of neighbourhood index

Definition at line 233 of file itkBinaryMorphologyImageFilter.h.

◆ m_ForegroundValue

template<typename TInputImage , typename TOutputImage , typename TKernel >
InputPixelType itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_ForegroundValue
private

Pixel value to dilate

Definition at line 237 of file itkBinaryMorphologyImageFilter.h.

◆ m_KernelCCVector

template<typename TInputImage , typename TOutputImage , typename TKernel >
std::vector<OffsetType> itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_KernelCCVector
private

For each Connected Component ( CC ) of structuring element we store the position of one element, arbitrary chosen, which belongs to the CC

Definition at line 248 of file itkBinaryMorphologyImageFilter.h.

◆ m_KernelDifferenceSets

template<typename TInputImage , typename TOutputImage , typename TKernel >
NeighborIndexContainerContainer itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::m_KernelDifferenceSets
private

Difference sets definition

Definition at line 243 of file itkBinaryMorphologyImageFilter.h.

◆ OutputImageDimension

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

Definition at line 111 of file itkBinaryMorphologyImageFilter.h.


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