ITK  4.3.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator > Class Template Reference

#include <itkBinaryBallStructuringElement.h>

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

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
Wiki Examples:

Definition at line 59 of file itkBinaryBallStructuringElement.h.

Public Types

typedef TAllocator AllocatorType
 
typedef
AllocatorType::const_iterator 
ConstIterator
 
typedef AllocatorType::iterator Iterator
 
typedef TPixel PixelType
 
typedef Superclass::RadiusType RadiusType
 
typedef
BinaryBallStructuringElement 
Self
 
typedef Superclass::SizeType SizeType
 
typedef Superclass::SizeValueType SizeValueType
 
typedef SliceIterator< TPixel,
Self
SliceIteratorType
 
typedef Neighborhood< TPixel,
VDimension, TAllocator > 
Superclass
 
- Public Types inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
typedef TAllocator AllocatorType
 
typedef
AllocatorType::const_iterator 
ConstIterator
 
typedef unsigned int DimensionValueType
 
typedef AllocatorType::iterator Iterator
 
typedef SizeValueType NeighborIndexType
 
typedef Offset< VDimension > OffsetType
 
typedef TPixel PixelType
 
typedef Neighborhood Self
 
typedef SizeType::SizeValueType SizeValueType
 
typedef SliceIterator< TPixel,
Self
SliceIteratorType
 

Public Member Functions

 BinaryBallStructuringElement ()
 
 BinaryBallStructuringElement (const Self &other)
 
void CreateStructuringElement ()
 
virtual ~BinaryBallStructuringElement ()
 
Selfoperator= (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
 
 Neighborhood (const Self &other)
 
bool operator!= (const Self &other) const
 
Selfoperator= (const Self &other)
 
bool operator== (const Self &other) const
 
void Print (std::ostream &os) const
 
void SetRadius (const SizeType &)
 
void SetRadius (const SizeValueType *rad)
 
void SetRadius (const SizeValueType)
 
NeighborIndexType Size () const
 
virtual ~Neighborhood ()
 
 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)
 
AllocatorTypeGetBufferReference ()
 
const AllocatorTypeGetBufferReference () const
 
TPixel & operator[] (const OffsetType &o)
 
const TPixel & operator[] (const OffsetType &o) const
 

Static Public Attributes

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

Additional Inherited Members

- Public Attributes inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
typedef::itk::Size< VDimension > RadiusType
 
typedef::itk::Size< VDimension > SizeType
 
- 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 ()
 

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.

Definition at line 68 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

Definition at line 80 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., AllocatorType::iterator and AllocatorType::const_iterator, because the allocator may be a vnl object or other type, which uses this form.

Definition at line 79 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.

Definition at line 74 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.

Definition at line 87 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.

Definition at line 64 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.

Definition at line 83 of file itkBinaryBallStructuringElement.h.

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

Definition at line 84 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.

Definition at line 90 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 65 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 93 of file itkBinaryBallStructuringElement.h.

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

Default destructor.

Definition at line 96 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 99 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 >>
Self& itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::operator= ( const Self other)
inline

Assignment operator.

Definition at line 104 of file itkBinaryBallStructuringElement.h.

Member Data Documentation

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

External support for dimensionality.

Definition at line 71 of file itkBinaryBallStructuringElement.h.


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