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

Public Types
using	AllocatorType = TAllocator
using	ConstIterator = typename AllocatorType::const_iterator
using	Iterator = typename AllocatorType::iterator
using	OffsetType = typename Superclass::OffsetType
using	OffsetValueType = typename OffsetType::OffsetValueType
using	PixelType = TPixel
using	RadiusType = typename Superclass::RadiusType
using	Self = BinaryCrossStructuringElement
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
	BinaryCrossStructuringElement ()
	~BinaryCrossStructuringElement () override=default
	BinaryCrossStructuringElement (const Self &other)
Self &	operator= (const Self &other)
void	CreateStructuringElement ()
Public Member Functions inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
	itkTypeMacroNoParent (Neighborhood)
	Neighborhood ()
virtual	~Neighborhood ()=default
	Neighborhood (const Self &other)
	Neighborhood (Self &&)=default
Self &	operator= (const Self &other)
Self &	operator= (Self &&)=default
bool	operator== (const Self &other) const
bool	operator!= (const Self &other) const
const SizeType	GetRadius () const
SizeValueType	GetRadius (DimensionValueType n) const
SizeValueType	GetSize (DimensionValueType n) const
SizeType	GetSize () const
OffsetValueType	GetStride (DimensionValueType axis) const
Iterator	End ()
Iterator	Begin ()
ConstIterator	End () const
ConstIterator	Begin () const
NeighborIndexType	Size () const
TPixel &	operator[] (NeighborIndexType i)
const TPixel &	operator[] (NeighborIndexType i) const
TPixel &	GetElement (NeighborIndexType i)
TPixel	GetCenterValue () const
void	SetRadius (const SizeType &)
void	SetRadius (const SizeValueType *rad)
void	SetRadius (const SizeValueType)
void	Print (std::ostream &os) const
AllocatorType &	GetBufferReference ()
const AllocatorType &	GetBufferReference () const
TPixel &	operator[] (const OffsetType &o)
const TPixel &	operator[] (const OffsetType &o) const
OffsetType	GetOffset (NeighborIndexType i) const
virtual NeighborIndexType	GetNeighborhoodIndex (const OffsetType &) const
NeighborIndexType	GetCenterNeighborhoodIndex () const
std::slice	GetSlice (unsigned int) 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 >
void	SetSize ()
virtual void	Allocate (NeighborIndexType i)
virtual void	PrintSelf (std::ostream &, Indent) const
virtual void	ComputeNeighborhoodStrideTable ()
virtual void	ComputeNeighborhoodOffsetTable ()

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 52 of file itkBinaryCrossStructuringElement.h.

Member Typedef Documentation

AllocatorType

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

using itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::AllocatorType = TAllocator

External support for allocator type.

Definition at line 60 of file itkBinaryCrossStructuringElement.h.

ConstIterator

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

using itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::ConstIterator = typename AllocatorType::const_iterator

Definition at line 72 of file itkBinaryCrossStructuringElement.h.

Iterator

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

using itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::Iterator = typename AllocatorType::iterator

Iterator type alias 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 71 of file itkBinaryCrossStructuringElement.h.

OffsetType

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

using itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::OffsetType = typename Superclass::OffsetType

Offset and value type alias support

Definition at line 79 of file itkBinaryCrossStructuringElement.h.

OffsetValueType

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

using itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::OffsetValueType = typename OffsetType::OffsetValueType

Definition at line 80 of file itkBinaryCrossStructuringElement.h.

PixelType

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

using itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::PixelType = TPixel

External support for pixel type.

Definition at line 66 of file itkBinaryCrossStructuringElement.h.

RadiusType

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

using itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::RadiusType = typename Superclass::RadiusType

Radius type alias support

Definition at line 83 of file itkBinaryCrossStructuringElement.h.

Self

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

using itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::Self = BinaryCrossStructuringElement

Standard class type aliases.

Definition at line 56 of file itkBinaryCrossStructuringElement.h.

SizeType

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

using itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::SizeType = typename Superclass::SizeType

Size and value type alias support

Definition at line 75 of file itkBinaryCrossStructuringElement.h.

SizeValueType

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

using itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::SizeValueType = typename Superclass::SizeValueType

Definition at line 76 of file itkBinaryCrossStructuringElement.h.

SliceIteratorType

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

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

External slice iterator type type alias support

Definition at line 86 of file itkBinaryCrossStructuringElement.h.

Superclass

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

using itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::Superclass = Neighborhood<TPixel, VDimension, TAllocator>

Definition at line 57 of file itkBinaryCrossStructuringElement.h.

Constructor & Destructor Documentation

BinaryCrossStructuringElement() [1/2]

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

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

inline

Default constructor.

Definition at line 89 of file itkBinaryCrossStructuringElement.h.

References itk::Size< VDimension >::Fill().

~BinaryCrossStructuringElement()

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

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

overridedefault

Default destructor.

BinaryCrossStructuringElement() [2/2]

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 103 of file itkBinaryCrossStructuringElement.h.

Member Function Documentation

CreateStructuringElement()

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

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

(

)

Build the structuring element

operator=()

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.

Member Data Documentation

NeighborhoodDimension

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

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

staticconstexpr

External support for dimensionality.

Definition at line 63 of file itkBinaryCrossStructuringElement.h.

---

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

• itkBinaryCrossStructuringElement.h