itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator > Class Template Reference
[Operators, Image Iterators]

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

#include <itkBinaryBallStructuringElement.h>

Inheritance diagram for itk::BinaryBallStructuringElement:

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

[legend]List of all members.

Public Types
typedef BinaryBallStructuringElement	Self
typedef Neighborhood< TPixel, VDimension, TAllocator >	Superclass
typedef TAllocator	AllocatorType
typedef TPixel	PixelType
typedef AllocatorType::iterator	Iterator
typedef AllocatorType::const_iterator	ConstIterator
typedef Superclass::SizeType	SizeType
typedef Superclass::SizeValueType	SizeValueType
typedef Superclass::RadiusType	RadiusType
typedef SliceIterator< TPixel, Self >	SliceIteratorType
Public Methods
	itkStaticConstMacro (NeighborhoodDimension, unsigned int, VDimension)
	BinaryBallStructuringElement ()
virtual	~BinaryBallStructuringElement ()
	BinaryBallStructuringElement (const Self &other)
void	CreateStructuringElement ()
Self &	operator= (const Self &other)

---

Detailed Description

template<class TPixel, unsigned int VDimension = 2, class 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 0 or 1 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.

See also:

Neighborhood , MorphologyImageFilter , BinaryDilateImageFilter , BinaryErodeImageFilter

Definition at line 52 of file itkBinaryBallStructuringElement.h.

---

Member Typedef Documentation

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

External support for allocator type. Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >. Definition at line 61 of file itkBinaryBallStructuringElement.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> typedef AllocatorType::const_iterator itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::ConstIterator

Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >. Definition at line 73 of file itkBinaryBallStructuringElement.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> typedef AllocatorType::iterator itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::Iterator

Iterator typedef support. Note the naming is intentional, i.e., iterator and const_iterator, because the allocator may be a vnl object or other type, which uses this form. Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >. Definition at line 72 of file itkBinaryBallStructuringElement.h.

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

External support for pixel type. Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >. Definition at line 67 of file itkBinaryBallStructuringElement.h.

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

Radius typedef support. Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >. Definition at line 80 of file itkBinaryBallStructuringElement.h.

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

Standard class typedefs. Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >. Definition at line 57 of file itkBinaryBallStructuringElement.h.

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

Size and value typedef support. Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >. Definition at line 76 of file itkBinaryBallStructuringElement.h.

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

Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >. Definition at line 77 of file itkBinaryBallStructuringElement.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> typedef SliceIterator<TPixel, Self> itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::SliceIteratorType

External slice iterator type typedef support. Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >. Definition at line 83 of file itkBinaryBallStructuringElement.h.

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

Definition at line 58 of file itkBinaryBallStructuringElement.h.

---

Constructor & Destructor Documentation

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::BinaryBallStructuringElement (    )  [inline]

Default constructor. Definition at line 86 of file itkBinaryBallStructuringElement.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> virtual itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::~BinaryBallStructuringElement (    )  [inline, virtual]

Default destructor. Definition at line 89 of file itkBinaryBallStructuringElement.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::BinaryBallStructuringElement (  const Self &    other )  [inline]

Copy constructor. Definition at line 92 of file itkBinaryBallStructuringElement.h.

---

Member Function Documentation

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> void itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::CreateStructuringElement (    )

Build the structuring element

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::itkStaticConstMacro (  NeighborhoodDimension   , unsigned    int, VDimension    )

External support for dimensionality. Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>> Self& itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::operator= (  const Self &    other )  [inline]

Assignment operator. Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >. Definition at line 98 of file itkBinaryBallStructuringElement.h.

---

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

• itkBinaryBallStructuringElement.h

---