ITK  5.2.0
Insight Toolkit
Public Types | Public Member Functions | Static Public Attributes | List of all members
itk::Neighborhood< TPixel, VDimension, TAllocator > Class Template Reference
Data Processing Objects » OperatorsData Access Objects » Iterators » | Image IteratorsGroup Core » | Module ITKCommon

#include <itkNeighborhood.h>

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

Public Types

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

 itkTypeMacroNoParent (Neighborhood)
 

Static Public Attributes

static constexpr unsigned int NeighborhoodDimension = VDimension
 
SizeType m_Radius
 
SizeType m_Size
 
AllocatorType m_DataBuffer
 
OffsetValueType m_StrideTable [VDimension]
 
std::vector< OffsetType > m_OffsetTable
 
 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
 
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::Neighborhood< TPixel, VDimension, TAllocator >

A light-weight container object for storing an N-dimensional neighborhood of values.

This class serves as the base class for several other Itk objects such as itk::NeighborhoodOperator and itk::NeighborhoodIterator. Its purpose is to store values and their relative spatial locations.

A Neighborhood 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 Neighborhood object with a radius of 2x3 has sides of length 5x7. Neighborhood objects always have an unambiguous center because their side lengths are always odd.

See also
Neighborhood
NeighborhoodIterator
Examples
SphinxExamples/src/Core/ImageFunction/MultiplyKernelWithAnImageAtLocation/Code.cxx.

Definition at line 54 of file itkNeighborhood.h.

Member Typedef Documentation

◆ AllocatorType

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

External support for allocator type.

Definition at line 61 of file itkNeighborhood.h.

◆ ConstIterator

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

Definition at line 76 of file itkNeighborhood.h.

◆ DimensionValueType

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

Type used to refer to space dimensions

Definition at line 92 of file itkNeighborhood.h.

◆ Iterator

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

◆ NeighborIndexType

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

Type used to refer to the elements of the pixel list that are part of the neighborhood.

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

◆ PixelType

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

External support for pixel type.

Definition at line 70 of file itkNeighborhood.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::Neighborhood< TPixel, VDimension, TAllocator >::Self = Neighborhood

Standard class type aliases.

Definition at line 58 of file itkNeighborhood.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::Neighborhood< TPixel, VDimension, TAllocator >::SliceIteratorType = SliceIterator<TPixel, Self>

External slice iterator type type alias support

Definition at line 89 of file itkNeighborhood.h.

Constructor & Destructor Documentation

◆ Neighborhood() [1/3]

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

Default constructor.

Definition at line 99 of file itkNeighborhood.h.

◆ ~Neighborhood()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
virtual itk::Neighborhood< TPixel, VDimension, TAllocator >::~Neighborhood ( )
virtualdefault

Default destructor.

◆ Neighborhood() [2/3]

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

Copy constructor.

◆ Neighborhood() [3/3]

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

Move-constructor.

Member Function Documentation

◆ Allocate()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
virtual void itk::Neighborhood< TPixel, VDimension, TAllocator >::Allocate ( NeighborIndexType  i)
inlineprotectedvirtual

Allocates the neighborhood's memory buffer.

Definition at line 308 of file itkNeighborhood.h.

◆ Begin() [1/2]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
Iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( )
inline

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

Definition at line 187 of file itkNeighborhood.h.

◆ Begin() [2/2]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( ) const
inline

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

Definition at line 197 of file itkNeighborhood.h.

◆ ComputeNeighborhoodOffsetTable()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
virtual void itk::Neighborhood< TPixel, VDimension, TAllocator >::ComputeNeighborhoodOffsetTable ( )
protectedvirtual

Fills entries into the offset lookup table. Called once on initialization.

◆ ComputeNeighborhoodStrideTable()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
virtual void itk::Neighborhood< TPixel, VDimension, TAllocator >::ComputeNeighborhoodStrideTable ( )
protectedvirtual

Computes the entries for the stride table

◆ End() [1/2]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
Iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::End ( )
inline

STL-style iterator support.

Definition at line 182 of file itkNeighborhood.h.

◆ End() [2/2]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::End ( ) const
inline

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

Definition at line 192 of file itkNeighborhood.h.

◆ GetBufferReference() [1/2]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
AllocatorType& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetBufferReference ( )
inline

Returns a reference to the data buffer structure.

Definition at line 258 of file itkNeighborhood.h.

Referenced by itk::operator<<().

◆ GetBufferReference() [2/2]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
const AllocatorType& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetBufferReference ( ) const
inline

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

Definition at line 263 of file itkNeighborhood.h.

◆ GetCenterNeighborhoodIndex()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
NeighborIndexType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetCenterNeighborhoodIndex ( ) const
inline

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

Definition at line 286 of file itkNeighborhood.h.

◆ GetCenterValue()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
TPixel itk::Neighborhood< TPixel, VDimension, TAllocator >::GetCenterValue ( ) const
inline

Returns the element at the center of the neighborhood.

Definition at line 222 of file itkNeighborhood.h.

◆ GetElement()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetElement ( NeighborIndexType  i)
inline

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

Definition at line 214 of file itkNeighborhood.h.

◆ GetNeighborhoodIndex()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
virtual NeighborIndexType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetNeighborhoodIndex ( const OffsetType &  ) const
virtual

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

◆ GetOffset()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
OffsetType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetOffset ( NeighborIndexType  i) const
inline

Returns the itk::Offset from the center of the Neighborhood to the requested neighbor index.

Definition at line 277 of file itkNeighborhood.h.

◆ GetRadius() [1/2]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
const SizeType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius ( ) const
inline

Returns the radius of the neighborhood.

Definition at line 143 of file itkNeighborhood.h.

Referenced by itk::operator<<().

◆ GetRadius() [2/2]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
SizeValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius ( DimensionValueType  n) const
inline

Returns the radius of the neighborhood along a specified dimension.

Definition at line 151 of file itkNeighborhood.h.

◆ GetSize() [1/2]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
SizeType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSize ( ) const
inline

Returns the size (total length of sides) of the neighborhood.

Definition at line 166 of file itkNeighborhood.h.

◆ GetSize() [2/2]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
SizeValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSize ( DimensionValueType  n) const
inline

Returns the size (total length) of the neighborhood along a specified dimension.

Definition at line 159 of file itkNeighborhood.h.

Referenced by itk::operator<<().

◆ GetSlice()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
std::slice itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSlice ( unsigned int  ) const

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

◆ GetStride()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
OffsetValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetStride ( DimensionValueType  axis) const
inline

Returns the stride length for the specified dimension. Stride length is the number of pixels between adjacent pixels along the given dimension.

Definition at line 175 of file itkNeighborhood.h.

Referenced by itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >::Initialize().

◆ itkTypeMacroNoParent()

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

Run-time type information (and related methods).

◆ operator!=()

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

Not Equal operator.

Definition at line 136 of file itkNeighborhood.h.

◆ operator=() [1/2]

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

Assignment operator.

◆ operator=() [2/2]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
Self& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator= ( Self &&  )
default

Move-assignment.

◆ operator==()

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

Comparison operator.

Definition at line 129 of file itkNeighborhood.h.

◆ operator[]() [1/4]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( const OffsetType &  o)
inline

Get pixel value by offset

Definition at line 270 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< char, TImage::ImageDimension >::operator[]().

◆ operator[]() [2/4]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
const TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( const OffsetType &  o) const
inline

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

Definition at line 271 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< char, TImage::ImageDimension >::operator[]().

◆ operator[]() [3/4]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( NeighborIndexType  i)
inline

Pass-through data access methods to the buffer.

Definition at line 211 of file itkNeighborhood.h.

◆ operator[]() [4/4]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
const TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( NeighborIndexType  i) const
inline

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

Definition at line 212 of file itkNeighborhood.h.

◆ Print()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::Print ( std::ostream &  os) const
inline

Standard itk object method.

Definition at line 251 of file itkNeighborhood.h.

◆ PrintSelf()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
virtual void itk::Neighborhood< TPixel, VDimension, TAllocator >::PrintSelf ( std::ostream &  ,
Indent   
) const
protectedvirtual

Standard itk object method.

Reimplemented in itk::FlatStructuringElement< VDimension >, itk::AnnulusOperator< TPixel, TDimension, TAllocator >, itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >, itk::GaussianOperator< TPixel, VDimension, TAllocator >, itk::GaussianOperator< ScalarType, NDimensions >, itk::GaussianOperator< ScalarType, Superclass::Dimension >, itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >, itk::NeighborhoodOperator< MovedGradientPixelType, VDimension, NeighborhoodAllocator< MovedGradientPixelType > >, itk::NeighborhoodOperator< ScalarValueType, VDimension, NeighborhoodAllocator< ScalarValueType > >, itk::NeighborhoodOperator< PixelType, VDimension, NeighborhoodAllocator< PixelType > >, itk::NeighborhoodOperator< FixedGradientPixelType, VDimension, NeighborhoodAllocator< FixedGradientPixelType > >, itk::NeighborhoodOperator< OutputImagePixelType, VDimension, NeighborhoodAllocator< OutputImagePixelType > >, itk::NeighborhoodOperator< ScalarType, VDimension, NeighborhoodAllocator< ScalarType > >, itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >, itk::SobelOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< FixedGradientPixelType, Self::FixedImageDimension >, itk::SobelOperator< MovedGradientPixelType, Self::MovedImageDimension >, itk::DerivativeOperator< TPixel, VDimension, TAllocator >, itk::LaplacianOperator< TPixel, VDimension, TAllocator >, itk::DerivativeOperator< ScalarValueType, Self::ImageDimension >, itk::DerivativeOperator< PixelType, Self::ImageDimension >, itk::DerivativeOperator< OutputImagePixelType, Self::ImageDimension >, itk::ImageKernelOperator< TPixel, VDimension, TAllocator >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::NeighborhoodIterator< TImage, TBoundaryCondition >, itk::NeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ConstNeighborhoodIterator< TInputImage >, itk::ConstNeighborhoodIterator< TInput >, itk::ConstNeighborhoodIterator< TImage >, itk::ConstNeighborhoodIterator< FixedImageType >, itk::ConstNeighborhoodIterator< TImageType >, itk::ConstNeighborhoodIterator< TDisplacementField >, itk::ConstNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ConstNeighborhoodIterator< TSparseImageType >, and itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >.

◆ SetRadius() [1/3]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius ( const SizeType &  )

Sets the radius for the neighborhood, calculates size from the radius, and allocates storage.

Examples
SphinxExamples/src/Filtering/BinaryMathematicalMorphology/ClosingBinaryImage/Code.cxx, SphinxExamples/src/Filtering/BinaryMathematicalMorphology/OpeningBinaryImage/Code.cxx, and SphinxExamples/src/Filtering/MathematicalMorphology/CreateABinaryBallStructuringElement/Code.cxx.

Referenced by itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >::Initialize().

◆ SetRadius() [2/3]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius ( const SizeValueType *  rad)
inline

Sets the radius for the neighborhood. Overloaded to support an unsigned long array.

Definition at line 235 of file itkNeighborhood.h.

◆ SetRadius() [3/3]

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius ( const  SizeValueType)

Overloads SetRadius to allow a single long integer argument that is used as the radius of all the dimensions of the Neighborhood (resulting in a "square" neighborhood).

◆ SetSize()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetSize ( )
inlineprotected

Sets the length along each dimension.

Definition at line 297 of file itkNeighborhood.h.

◆ Size()

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
NeighborIndexType itk::Neighborhood< TPixel, VDimension, TAllocator >::Size ( ) const
inline

More STL-style support.

Definition at line 205 of file itkNeighborhood.h.

Referenced by itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >::Initialize(), and itk::VectorNeighborhoodInnerProduct< ImageType >::operator()().

Member Data Documentation

◆ m_DataBuffer

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
AllocatorType itk::Neighborhood< TPixel, VDimension, TAllocator >::m_DataBuffer
private

The buffer in which data is stored.

Definition at line 336 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< char, TImage::ImageDimension >::operator!=(), and itk::Neighborhood< char, TImage::ImageDimension >::operator==().

◆ m_OffsetTable

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
std::vector<OffsetType> itk::Neighborhood< TPixel, VDimension, TAllocator >::m_OffsetTable
private

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

Definition at line 343 of file itkNeighborhood.h.

◆ m_Radius

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

Number of neighbors to include (symmetrically) along each axis. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

Definition at line 329 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< char, TImage::ImageDimension >::operator!=(), and itk::Neighborhood< char, TImage::ImageDimension >::operator==().

◆ m_Size

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

Actual length of each dimension, calculated from m_Radius. A neighborhood will always have odd-length axes (m_Radius[n]*2+1).

Definition at line 333 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< char, TImage::ImageDimension >::operator!=(), and itk::Neighborhood< char, TImage::ImageDimension >::operator==().

◆ m_StrideTable

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator<TPixel>>
OffsetValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::m_StrideTable[VDimension]
private

A lookup table for keeping track of stride lengths in a neighborhood i.e. the memory offsets between pixels along each dimensional axis

Definition at line 340 of file itkNeighborhood.h.

◆ NeighborhoodDimension

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

External support for dimensionality.

Definition at line 64 of file itkNeighborhood.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file.
Generated on Thu Apr 1 2021 02:30:07 for ITK by   doxygen 1.8.16