ITK  5.3.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
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 = Offset< VDimension >
 
using OffsetValueType = typename OffsetType::OffsetValueType
 
using PixelType = TPixel
 
using RadiusType = itk::Size< VDimension >
 
using Self = BinaryCrossStructuringElement
 
using SizeType = itk::Size< VDimension >
 
using SizeValueType = typename SizeType::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 (const Self &other)
 
void CreateStructuringElement ()
 
 ~BinaryCrossStructuringElement () override=default
 
 BinaryCrossStructuringElement ()
 
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
 
SizeType GetSize () const
 
SizeValueType GetSize (DimensionValueType n) const
 
std::slice GetSlice (unsigned int) const
 
OffsetValueType GetStride (DimensionValueType axis) const
 
 ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)
 
 itkTypeMacroNoParent (Neighborhood)
 
 Neighborhood ()=default
 
 Neighborhood (const Self &)=default
 
 Neighborhood (Self &&)=default
 
Selfoperator= (const Self &)=default
 
Selfoperator= (Self &&)=default
 
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 ()=default
 
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)
 
AllocatorTypeGetBufferReference ()
 
const AllocatorTypeGetBufferReference () const
 
TPixel & operator[] (const OffsetType &o)
 
const TPixel & operator[] (const OffsetType &o) 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 >
virtual void Allocate (NeighborIndexType i)
 
virtual void ComputeNeighborhoodOffsetTable ()
 
virtual void ComputeNeighborhoodStrideTable ()
 
virtual void PrintSelf (std::ostream &, Indent) const
 
void SetSize ()
 

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::Neighborhood< TPixel, VDimension, TAllocator >::OffsetType = Offset<VDimension>

Offset type used to reference neighbor locations

Definition at line 86 of file itkNeighborhood.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::Neighborhood< TPixel, VDimension, TAllocator >::RadiusType = itk::Size<VDimension>

Radius type alias support

Definition at line 83 of file itkNeighborhood.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::Neighborhood< TPixel, VDimension, TAllocator >::SizeType = itk::Size<VDimension>

Size and value type alias support

Definition at line 79 of file itkNeighborhood.h.

◆ SizeValueType

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

Definition at line 80 of file itkNeighborhood.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: