#include <itkBinaryBallStructuringElement.h>

Inheritance diagram for itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >:

Collaboration diagram for itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >:

Detailed Description

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
class itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >

A Neighborhood that represents a ball structuring element (ellipsoid) with binary elements.

This class defines a Neighborhood whose elements are either off or on depending on whether they are outside or inside an ellipsoid whose radii match the radii of the Neighborhood. This class can be used as a structuring element for the Morphology image filters.

A BinaryBallStructuringElement has an N-dimensional radius. The radius is defined separately for each dimension as the number of pixels that the neighborhood extends outward from the center pixel. For example, a 2D BinaryBallStructuringElement object with a radius of 2x3 has sides of length 5x7.

BinaryBallStructuringElement objects always have an unambiguous center because their side lengths are always odd.

Internally, this class carries out all of its computations using the FlatStructuringElement. It is preferable to use that class instead of this one because FlatStructuringElement is more flexible.

See Also: Neighborhood; MorphologyImageFilter; BinaryDilateImageFilter; BinaryErodeImageFilter

Wiki Examples:

Examples:: Examples/Filtering/GrayscaleFunctionDilateImageFilter.cxx, Examples/Filtering/MathematicalMorphologyBinaryFilters.cxx, Examples/Filtering/MathematicalMorphologyGrayscaleFilters.cxx, Examples/Filtering/MorphologicalImageEnhancement.cxx, SphinxExamples/src/Filtering/MathematicalMorphology/CreateABinaryBallStructuringElement/Code.cxx, WikiExamples/Iterators/ShapedNeighborhoodIterator.cxx, WikiExamples/Morphology/BinaryBallStructuringElement.cxx, WikiExamples/Morphology/BinaryDilateImageFilter.cxx, WikiExamples/Morphology/BinaryErodeImageFilter.cxx, WikiExamples/Morphology/BinaryMorphologicalClosingImageFilter.cxx, WikiExamples/Morphology/BinaryMorphologicalOpeningImageFilter.cxx, WikiExamples/Morphology/GrayscaleDilateImageFilter.cxx, and WikiExamples/Morphology/GrayscaleErodeImageFilter.cxx.

Definition at line 63 of file itkBinaryBallStructuringElement.h.

Public Types
using	AllocatorType = TAllocator

using	ConstIterator = typename AllocatorType::const_iterator

using	Iterator = typename AllocatorType::iterator

using	PixelType = TPixel

using	RadiusType = typename Superclass::RadiusType

using	Self = BinaryBallStructuringElement

using	SizeType = typename Superclass::SizeType

using	SizeValueType = typename Superclass::SizeValueType

using	SliceIteratorType = SliceIterator< TPixel, Self >

using	Superclass = Neighborhood< TPixel, VDimension, TAllocator >

Public Types inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
using	AllocatorType = TAllocator

using	ConstIterator = typename AllocatorType::const_iterator

using	DimensionValueType = unsigned int

using	Iterator = typename AllocatorType::iterator

using	NeighborIndexType = SizeValueType

using	OffsetType = Offset< VDimension >

using	PixelType = TPixel

using	RadiusType = ::itk::Size< VDimension >

using	Self = Neighborhood

using	SizeType = ::itk::Size< VDimension >

using	SizeValueType = typename SizeType::SizeValueType

using	SliceIteratorType = SliceIterator< TPixel, Self >

Public Member Functions
	BinaryBallStructuringElement ()=default

	BinaryBallStructuringElement (const Self &other)

void	CreateStructuringElement ()

	~BinaryBallStructuringElement () override=default


Self &	operator= (const Self &other)

Public Member Functions inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
NeighborIndexType	GetCenterNeighborhoodIndex () const

TPixel	GetCenterValue () const

virtual NeighborIndexType	GetNeighborhoodIndex (const OffsetType &) const

OffsetType	GetOffset (NeighborIndexType i) const

const SizeType	GetRadius () const

SizeValueType	GetRadius (DimensionValueType n) const

SizeValueType	GetSize (DimensionValueType n) const

SizeType	GetSize () const

std::slice	GetSlice (unsigned int) const

OffsetValueType	GetStride (DimensionValueType axis) const

	itkTypeMacroNoParent (Neighborhood)

	Neighborhood (const Self &other)

	Neighborhood (Self &&)=default

bool	operator!= (const Self &other) const

Self &	operator= (const Self &other)

Self &	operator= (Self &&)=default

bool	operator== (const Self &other) const

void	Print (std::ostream &os) const

void	SetRadius (const SizeType &)

void	SetRadius (const SizeValueType)

NeighborIndexType	Size () const

virtual	~Neighborhood ()=default

	Neighborhood ()

Iterator	End ()

Iterator	Begin ()

ConstIterator	End () const

ConstIterator	Begin () const

TPixel &	operator[] (NeighborIndexType i)

const TPixel &	operator[] (NeighborIndexType i) const

TPixel &	GetElement (NeighborIndexType i)

void	SetRadius (const SizeValueType *rad)

AllocatorType &	GetBufferReference ()

const AllocatorType &	GetBufferReference () const

TPixel &	operator[] (const OffsetType &o)

const TPixel &	operator[] (const OffsetType &o) const

Static Public Attributes
static constexpr unsigned int	NeighborhoodDimension = VDimension

Static Public Attributes inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
static constexpr unsigned int	NeighborhoodDimension = VDimension

Additional Inherited Members
Protected Member Functions inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
virtual void	Allocate (NeighborIndexType i)

virtual void	ComputeNeighborhoodOffsetTable ()

virtual void	ComputeNeighborhoodStrideTable ()

virtual void	PrintSelf (std::ostream &, Indent) const

void	SetSize ()