ITK  5.1.0
Insight 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 >:

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)
 
 ~BinaryBallStructuringElement () override=default
 
Selfoperator= (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
 
Selfoperator= (const Self &other)
 
Selfoperator= (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
 
AllocatorTypeGetBufferReference ()
 
const AllocatorTypeGetBufferReference () 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::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
ITK Sphinx Examples:
\li All ITK Sphinx Examples
Examples
Examples/Filtering/GrayscaleFunctionDilateImageFilter.cxx, Examples/Filtering/MathematicalMorphologyBinaryFilters.cxx, Examples/Filtering/MathematicalMorphologyGrayscaleFilters.cxx, Examples/Filtering/MorphologicalImageEnhancement.cxx, SphinxExamples/src/Filtering/BinaryMathematicalMorphology/ClosingBinaryImage/Code.cxx, SphinxExamples/src/Filtering/BinaryMathematicalMorphology/OpeningBinaryImage/Code.cxx, and SphinxExamples/src/Filtering/MathematicalMorphology/CreateABinaryBallStructuringElement/Code.cxx.

Definition at line 62 of file itkBinaryBallStructuringElement.h.

Member Typedef Documentation

◆ AllocatorType

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

External support for allocator type.

Definition at line 70 of file itkBinaryBallStructuringElement.h.

◆ ConstIterator

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

Definition at line 82 of file itkBinaryBallStructuringElement.h.

◆ Iterator

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
using itk::BinaryBallStructuringElement< 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 81 of file itkBinaryBallStructuringElement.h.

◆ PixelType

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

External support for pixel type.

Definition at line 76 of file itkBinaryBallStructuringElement.h.

◆ RadiusType

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

Radius type alias support

Definition at line 89 of file itkBinaryBallStructuringElement.h.

◆ Self

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

Standard class type aliases.

Definition at line 66 of file itkBinaryBallStructuringElement.h.

◆ SizeType

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

Size and value type alias support

Definition at line 85 of file itkBinaryBallStructuringElement.h.

◆ SizeValueType

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

Definition at line 86 of file itkBinaryBallStructuringElement.h.

◆ SliceIteratorType

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

External slice iterator type type alias support

Definition at line 92 of file itkBinaryBallStructuringElement.h.

◆ Superclass

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

Definition at line 67 of file itkBinaryBallStructuringElement.h.

Constructor & Destructor Documentation

◆ BinaryBallStructuringElement() [1/2]

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

Default constructor.

◆ ~BinaryBallStructuringElement()

template<typename TPixel , unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >::~BinaryBallStructuringElement ( )
overridedefault

Default destructor.

◆ BinaryBallStructuringElement() [2/2]

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

Copy constructor.

Definition at line 101 of file itkBinaryBallStructuringElement.h.

Member Function Documentation

◆ CreateStructuringElement()

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

Build the structuring element

◆ operator=()

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

Assignment operator.

Definition at line 107 of file itkBinaryBallStructuringElement.h.

Member Data Documentation

◆ NeighborhoodDimension

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

External support for dimensionality.

Definition at line 73 of file itkBinaryBallStructuringElement.h.


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