itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator > Class Template Reference

#include <itkBinaryCrossStructuringElement.h>

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

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

Detailed Description

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

A Neighborhood that represents a cross structuring element with binary elements.

This class defines a Neighborhood whose elements are either on or off depending on whether they are the face connected neighbors of the neighborhood center when the radii are all 1. The neighorhood is a cross for any size radius. By default, the Neighborhood is defined to be of radii 1 (i.e. 3x3x...). This can be changed explicitly using the SetRadius() method.

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

Definition at line 53 of file itkBinaryCrossStructuringElement.h.

Public Types
typedef TAllocator	AllocatorType
typedef AllocatorType::const_iterator	ConstIterator
typedef AllocatorType::iterator	Iterator
typedef Superclass::OffsetType	OffsetType
typedef OffsetType::OffsetValueType	OffsetValueType
typedef TPixel	PixelType
typedef Superclass::RadiusType	RadiusType
typedef BinaryCrossStructuringElement	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
	BinaryCrossStructuringElement (const Self &other)
void	CreateStructuringElement ()
virtual	~BinaryCrossStructuringElement ()
	BinaryCrossStructuringElement ()
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)
bool	operator!= (const Self &other) const
Self &	operator= (const Self &other)
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 ()
	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 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<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef TAllocator itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::AllocatorType

External support for allocator type.

Definition at line 62 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef AllocatorType::const_iterator itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::ConstIterator

Definition at line 74 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef AllocatorType::iterator itk::BinaryCrossStructuringElement< 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 73 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef Superclass::OffsetType itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::OffsetType

Offset and value typedef support.

Definition at line 81 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef OffsetType::OffsetValueType itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::OffsetValueType

Definition at line 82 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef TPixel itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::PixelType

External support for pixel type.

Definition at line 68 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef Superclass::RadiusType itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::RadiusType

Radius typedef support.

Definition at line 85 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef BinaryCrossStructuringElement itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::Self

Standard class typedefs.

Definition at line 58 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef Superclass::SizeType itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::SizeType

Size and value typedef support.

Definition at line 77 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef Superclass::SizeValueType itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::SizeValueType

Definition at line 78 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef SliceIterator< TPixel, Self > itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::SliceIteratorType

External slice iterator type typedef support.

Definition at line 88 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

typedef Neighborhood< TPixel, VDimension, TAllocator > itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::Superclass

Definition at line 59 of file itkBinaryCrossStructuringElement.h.

Constructor & Destructor Documentation

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::BinaryCrossStructuringElement ( )

inline

Default constructor.

Definition at line 91 of file itkBinaryCrossStructuringElement.h.

References itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius().

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

virtual itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::~BinaryCrossStructuringElement ( )

inlinevirtual

Default destructor.

Definition at line 101 of file itkBinaryCrossStructuringElement.h.

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::BinaryCrossStructuringElement ( const Self &  other )

inline

Copy constructor.

Definition at line 104 of file itkBinaryCrossStructuringElement.h.

Member Function Documentation

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

void itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::CreateStructuringElement

(

)

Build the structuring element

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

Self& itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::operator= ( const Self &  other )

inline

Assignment operator.

Definition at line 109 of file itkBinaryCrossStructuringElement.h.

References itk::Neighborhood< TPixel, VDimension, TAllocator >::operator=().

Member Data Documentation

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>

const unsigned int itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::NeighborhoodDimension = VDimension

static

External support for dimensionality.

Definition at line 65 of file itkBinaryCrossStructuringElement.h.

---

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

• itkBinaryCrossStructuringElement.h