itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel > Class Template Reference

#include <itkBinaryErodeImageFilter.h>

Inheritance diagram for itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >:

Collaboration diagram for itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >:

Public Types
using	ConstPointer = SmartPointer< const Self >
using	IndexType = typename InputImageType::IndexType
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	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 = BinaryErodeImageFilter
using	Superclass = BinaryMorphologyImageFilter< InputImageType, OutputImageType, KernelType >
Public Types inherited from itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >
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
InputPixelType	GetErodeValue () const
virtual const char *	GetNameOfClass () const
void	SetErodeValue (const InputPixelType &value)
Public Member Functions inherited from itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >
virtual ::itk::LightObject::Pointer	CreateAnother () const
virtual OutputPixelType	GetBackgroundValue () const
virtual InputPixelType	GetForegroundValue () const
virtual void	SetBackgroundValue (OutputPixelType _arg)
virtual void	SetForegroundValue (InputPixelType _arg)
virtual void	SetBoundaryToForeground (bool _arg)
virtual const bool &	GetBoundaryToForeground () const
virtual void	BoundaryToForegroundOn ()
virtual void	BoundaryToForegroundOff ()
void	SetKernel (const KernelType &kernel) override
Public Member Functions inherited from itk::KernelImageFilter< TInputImage, TOutputImage, TKernel >
virtual const KernelType &	GetKernel () const
void	SetRadius (const RadiusType &radius) override
void	SetRadius (const SizeValueType &radius) override
Public Member Functions inherited from itk::BoxImageFilter< TInputImage, TOutputImage >
virtual const RadiusType &	GetRadius () const
virtual void	SetRadius (const RadiusValueType &radius)
Public Member Functions inherited from itk::ImageToImageFilter< TInputImage, TOutputImage >
const InputImageType *	GetInput () const
const InputImageType *	GetInput (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 >
OutputImageType *	GetOutput ()
const OutputImageType *	GetOutput () const
OutputImageType *	GetOutput (unsigned int idx)
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	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 val)
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 ThreadIdType &	GetNumberOfWorkUnits () const
MultiThreaderType *	GetMultiThreader () 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
Command *	GetCommand (unsigned long tag)
bool	GetDebug () const
MetaDataDictionary &	GetMetaDataDictionary ()
const MetaDataDictionary &	GetMetaDataDictionary () const
virtual ModifiedTimeType	GetMTime () const
virtual const TimeStamp &	GetTimeStamp () 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 Member Functions
static Pointer	New ()
Static Public Member Functions inherited from itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >
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 val)
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::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >
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

Protected Types
using	NeighborIndexContainer = typename Superclass::NeighborIndexContainer
Protected Types inherited from itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >
using	NeighborIndexContainer = std::vector< OffsetType >
using	NeighborIndexContainerContainer = std::vector< NeighborIndexContainer >
using	ComponentVectorType = std::vector< OffsetType >
using	ComponentVectorConstIterator = typename ComponentVectorType::const_iterator
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
	BinaryErodeImageFilter ()
void	GenerateData () override
void	PrintSelf (std::ostream &os, Indent indent) const override
	~BinaryErodeImageFilter () override=default
Protected Member Functions inherited from itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >
	BinaryMorphologyImageFilter ()
	~BinaryMorphologyImageFilter () override=default
void	PrintSelf (std::ostream &os, Indent indent) const override
void	AnalyzeKernel ()
NeighborIndexContainer &	GetDifferenceSet (unsigned int code)
ComponentVectorConstIterator	KernelCCVectorBegin ()
ComponentVectorConstIterator	KernelCCVectorEnd ()
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	ClassicMultiThread (ThreadFunctionType callbackFunction)
virtual void	ThreadedGenerateData (const OutputImageRegionType &region, ThreadIdType threadId)
virtual void	DynamicThreadedGenerateData (const OutputImageRegionType &outputRegionForThread)
virtual void	AllocateOutputs ()
virtual void	BeforeThreadedGenerateData ()
virtual void	AfterThreadedGenerateData ()
virtual const ImageRegionSplitterBase *	GetImageRegionSplitter () 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
DataObject *	GetInput (const DataObjectIdentifierType &key)
const DataObject *	GetInput (const DataObjectIdentifierType &key) const
DataObject *	GetInput (DataObjectPointerArraySizeType idx)
const DataObject *	GetInput (DataObjectPointerArraySizeType idx) const
virtual void	SetInput (const DataObjectIdentifierType &key, DataObject *input)
virtual void	SetNthInput (DataObjectPointerArraySizeType idx, DataObject *input)
virtual void	AddInput (DataObject *input)
virtual void	RemoveInput (const DataObjectIdentifierType &key)
virtual void	RemoveInput (DataObjectPointerArraySizeType)
DataObject *	GetPrimaryInput ()
const DataObject *	GetPrimaryInput () const
virtual void	SetPrimaryInputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryInputName () const
virtual void	SetPrimaryInput (DataObject *object)
void	SetNumberOfIndexedInputs (DataObjectPointerArraySizeType num)
virtual void	SetNumberOfRequiredInputs (DataObjectPointerArraySizeType)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredInputs () 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)
DataObject *	GetOutput (const DataObjectIdentifierType &key)
const DataObject *	GetOutput (const DataObjectIdentifierType &key) const
virtual void	SetPrimaryOutputName (const DataObjectIdentifierType &key)
virtual const char *	GetPrimaryOutputName () const
DataObject *	GetOutput (DataObjectPointerArraySizeType i)
const DataObject *	GetOutput (DataObjectPointerArraySizeType i) const
virtual void	SetOutput (const DataObjectIdentifierType &name, DataObject *output)
virtual void	RemoveOutput (const DataObjectIdentifierType &key)
DataObject *	GetPrimaryOutput ()
const DataObject *	GetPrimaryOutput () const
virtual void	SetPrimaryOutput (DataObject *object)
virtual void	SetNthOutput (DataObjectPointerArraySizeType idx, DataObject *output)
virtual void	AddOutput (DataObject *output)
virtual void	RemoveOutput (DataObjectPointerArraySizeType idx)
virtual void	SetNumberOfRequiredOutputs (DataObjectPointerArraySizeType _arg)
virtual const DataObjectPointerArraySizeType &	GetNumberOfRequiredOutputs () 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 &timeStamp)
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 ()

Additional Inherited Members
Static Protected Member Functions inherited from itk::ImageSource< TOutputImage >
static const ImageRegionSplitterBase *	GetGlobalDefaultSplitter ()
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::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >
bool	m_BoundaryToForeground
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::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >

Fast binary erosion of a single intensity value in the image.

BinaryErodeImageFilter is a binary erosion morphologic operation on the foreground of an image. Only the value designated by the intensity value "SetForegroundValue()" (alias as SetErodeValue()) is considered as foreground, and other intensity values are considered background.

Grayscale images can be processed as binary images by selecting a "ForegroundValue" (alias "ErodeValue"). Pixel values matching the erode value are considered the "foreground" and all other pixels are "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 eroded pixels will receive the BackgroundValue (defaults to NumericTraits::NonpositiveMin() ).

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.

This implementation is 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.

See also

ImageToImageFilter BinaryDilateImageFilter BinaryMorphologyImageFilter

ITK Sphinx Examples:

• All ITK Sphinx Examples

• Erode A Binary Image

Examples

Examples/Filtering/MathematicalMorphologyBinaryFilters.cxx, SphinxExamples/src/Filtering/BinaryMathematicalMorphology/ErodeABinaryImage/Code.cxx, and SphinxExamples/src/Filtering/MathematicalMorphology/ErodeBinaryImageUsingFlatStruct/Code.cxx.

Definition at line 72 of file itkBinaryErodeImageFilter.h.

Member Typedef Documentation

ConstPointer

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::ConstPointer = SmartPointer<const Self>

Definition at line 95 of file itkBinaryErodeImageFilter.h.

IndexType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 111 of file itkBinaryErodeImageFilter.h.

InputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 113 of file itkBinaryErodeImageFilter.h.

InputImageType

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::InputImageType = TInputImage

Convenient type alias for simplifying declarations.

Definition at line 86 of file itkBinaryErodeImageFilter.h.

InputPixelType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Image type alias support

Definition at line 107 of file itkBinaryErodeImageFilter.h.

InputRealType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 109 of file itkBinaryErodeImageFilter.h.

InputSizeType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 115 of file itkBinaryErodeImageFilter.h.

KernelIteratorType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Kernel (structuring element) iterator.

Definition at line 104 of file itkBinaryErodeImageFilter.h.

KernelType

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::KernelType = TKernel

Definition at line 88 of file itkBinaryErodeImageFilter.h.

NeighborIndexContainer

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::NeighborIndexContainer = typename Superclass::NeighborIndexContainer

protected

Definition at line 145 of file itkBinaryErodeImageFilter.h.

OffsetType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 110 of file itkBinaryErodeImageFilter.h.

OutputImageRegionType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 114 of file itkBinaryErodeImageFilter.h.

OutputImageType

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageType = TOutputImage

Definition at line 87 of file itkBinaryErodeImageFilter.h.

OutputPixelType

template<typename TInputImage , typename TOutputImage , typename TKernel >

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

Definition at line 108 of file itkBinaryErodeImageFilter.h.

Pointer

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::Pointer = SmartPointer<Self>

Definition at line 94 of file itkBinaryErodeImageFilter.h.

Self

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::Self = BinaryErodeImageFilter

Standard class type aliases.

Definition at line 91 of file itkBinaryErodeImageFilter.h.

Superclass

template<typename TInputImage , typename TOutputImage , typename TKernel >

using itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::Superclass = BinaryMorphologyImageFilter<InputImageType, OutputImageType, KernelType>

Definition at line 92 of file itkBinaryErodeImageFilter.h.

Constructor & Destructor Documentation

BinaryErodeImageFilter()

template<typename TInputImage , typename TOutputImage , typename TKernel >

itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::BinaryErodeImageFilter ( )

protected

~BinaryErodeImageFilter()

template<typename TInputImage , typename TOutputImage , typename TKernel >

itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::~BinaryErodeImageFilter ( )

overrideprotecteddefault

Member Function Documentation

CreateAnother()

template<typename TInputImage , typename TOutputImage , typename TKernel >

virtual::itk::LightObject::Pointer itk::BinaryErodeImageFilter< 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 >.

GenerateData()

template<typename TInputImage , typename TOutputImage , typename TKernel >

void itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::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 >.

GetErodeValue()

template<typename TInputImage , typename TOutputImage , typename TKernel >

InputPixelType itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::GetErodeValue ( ) const

inline

Get the value in the image considered as "foreground". Defaults to maximum value of PixelType. This is an alias to the GetForegroundValue in the superclass.

Definition at line 130 of file itkBinaryErodeImageFilter.h.

GetNameOfClass()

template<typename TInputImage , typename TOutputImage , typename TKernel >

virtual const char* itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::GetNameOfClass ( ) const

virtual

Run-time type information (and related methods).

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

New()

template<typename TInputImage , typename TOutputImage , typename TKernel >

static Pointer itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::New ( )

static

Method for creation through the object factory.

PrintSelf()

template<typename TInputImage , typename TOutputImage , typename TKernel >

void itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::PrintSelf ( std::ostream &  os, Indent  indent  ) const

overrideprotectedvirtual

Typedef for the region copier function object that converts an input region to an output region.

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

SetErodeValue()

template<typename TInputImage , typename TOutputImage , typename TKernel >

void itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::SetErodeValue ( const InputPixelType &  value )

inline

Set the value in the image to consider as "foreground". Defaults to maximum value of PixelType. This is an alias to the SetForegroundValue in the superclass.

Definition at line 121 of file itkBinaryErodeImageFilter.h.

Member Data Documentation

InputImageDimension

template<typename TInputImage , typename TOutputImage , typename TKernel >

constexpr unsigned int itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::InputImageDimension = TInputImage::ImageDimension

staticconstexpr

Extract dimension from input and output image.

Definition at line 79 of file itkBinaryErodeImageFilter.h.

KernelDimension

template<typename TInputImage , typename TOutputImage , typename TKernel >

constexpr unsigned int itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::KernelDimension = TKernel::NeighborhoodDimension

staticconstexpr

Extract the dimension of the kernel

Definition at line 83 of file itkBinaryErodeImageFilter.h.

OutputImageDimension

template<typename TInputImage , typename TOutputImage , typename TKernel >

constexpr unsigned int itk::BinaryErodeImageFilter< TInputImage, TOutputImage, TKernel >::OutputImageDimension = TOutputImage::ImageDimension

staticconstexpr

Definition at line 80 of file itkBinaryErodeImageFilter.h.

---

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

• itkBinaryErodeImageFilter.h