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

#include <itkNeighborhood.h>

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

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

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:

WikiExamples/Functions/NeighborhoodOperatorImageFunction.cxx, and WikiExamples/Statistics/TextureFeatures.cxx.

Definition at line 55 of file itkNeighborhood.h.

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
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)
	Neighborhood (Self &&)=default
bool	operator!= (const Self &other) const
Self &	operator= (const Self &other)
Self &	operator= (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
	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 constexpr unsigned int	NeighborhoodDimension = VDimension

Protected Member Functions
virtual void	Allocate (NeighborIndexType i)
virtual void	ComputeNeighborhoodOffsetTable ()
virtual void	ComputeNeighborhoodStrideTable ()
virtual void	PrintSelf (std::ostream &, Indent) const
void	SetSize ()

Private Attributes
AllocatorType	m_DataBuffer
std::vector< OffsetType >	m_OffsetTable
SizeType	m_Radius
SizeType	m_Size
OffsetValueType	m_StrideTable [VDimension]

Member Typedef Documentation

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 62 of file itkNeighborhood.h.

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 77 of file itkNeighborhood.h.

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 93 of file itkNeighborhood.h.

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 76 of file itkNeighborhood.h.

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 97 of file itkNeighborhood.h.

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 87 of file itkNeighborhood.h.

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 71 of file itkNeighborhood.h.

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 84 of file itkNeighborhood.h.

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 59 of file itkNeighborhood.h.

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 80 of file itkNeighborhood.h.

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

using itk::Neighborhood< TPixel, VDimension, TAllocator >::SizeValueType = typename SizeType::SizeValueType

Definition at line 81 of file itkNeighborhood.h.

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 90 of file itkNeighborhood.h.

Constructor & Destructor Documentation

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

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

inline

Default constructor.

Definition at line 100 of file itkNeighborhood.h.

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

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

virtualdefault

Default destructor.

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

itk::Neighborhood< TPixel, VDimension, TAllocator >::Neighborhood

(

const Self &

other

)

Copy constructor.

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

itk::Neighborhood< TPixel, VDimension, TAllocator >::Neighborhood ( Self &&  )

default

Move-constructor.

Member Function Documentation

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 260 of file itkNeighborhood.h.

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

Iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( )

inline

STL-style iterator support.

Definition at line 170 of file itkNeighborhood.h.

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

ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( ) const

inline

STL-style iterator support.

Definition at line 174 of file itkNeighborhood.h.

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.

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

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 168 of file itkNeighborhood.h.

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

ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::End ( ) const

inline

STL-style iterator support.

Definition at line 172 of file itkNeighborhood.h.

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 221 of file itkNeighborhood.h.

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

const AllocatorType& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetBufferReference ( ) const

inline

Returns a reference to the data buffer structure.

Definition at line 223 of file itkNeighborhood.h.

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

NeighborIndexType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetCenterNeighborhoodIndex ( ) const

inline

Definition at line 241 of file itkNeighborhood.h.

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 192 of file itkNeighborhood.h.

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

TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetElement ( NeighborIndexType  i )

inline

Pass-through data access methods to the buffer.

Definition at line 187 of file itkNeighborhood.h.

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

virtual NeighborIndexType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetNeighborhoodIndex ( const OffsetType &  ) const

virtual

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 236 of file itkNeighborhood.h.

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 144 of file itkNeighborhood.h.

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 149 of file itkNeighborhood.h.

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 154 of file itkNeighborhood.h.

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 158 of file itkNeighborhood.h.

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

std::slice itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSlice

(

unsigned

int

)

const

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 164 of file itkNeighborhood.h.

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

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).

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.

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

Self& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator=

(

const Self &

other

)

Assignment operator.

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

Self& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator= ( Self &&  )

default

Move-assignment.

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 128 of file itkNeighborhood.h.

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 183 of file itkNeighborhood.h.

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

const TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( NeighborIndexType  i ) const

inline

Pass-through data access methods to the buffer.

Definition at line 185 of file itkNeighborhood.h.

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 228 of file itkNeighborhood.h.

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

const TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( const OffsetType &  o ) const

inline

Get pixel value by offset

Definition at line 230 of file itkNeighborhood.h.

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 217 of file itkNeighborhood.h.

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::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::FlatStructuringElement< VDimension >, itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >, itk::GaussianOperator< TPixel, VDimension, TAllocator >, itk::GaussianOperator< ScalarType, NDimensions >, itk::GaussianOperator< ScalarType, Superclass::Dimension >, itk::SobelOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< FixedGradientPixelType, itk::GradientDifferenceImageToImageMetric::FixedImageDimension >, itk::SobelOperator< MovedGradientPixelType, itk::GradientDifferenceImageToImageMetric::MovedImageDimension >, 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::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 >, itk::HigherOrderAccurateDerivativeOperator< TPixel, VDimension, TAllocator >, itk::LaplacianOperator< TPixel, VDimension, TAllocator >, itk::ConstNeighborhoodIteratorWithOnlyIndex< TImage >, itk::DerivativeOperator< TPixel, VDimension, TAllocator >, itk::DerivativeOperator< OutputImagePixelType, itk::CannyEdgeDetectionImageFilter::ImageDimension >, itk::DerivativeOperator< PixelType, itk::GPUGradientNDAnisotropicDiffusionFunction::ImageDimension >, itk::DerivativeOperator< ScalarValueType, itk::VectorCurvatureNDAnisotropicDiffusionFunction::ImageDimension >, itk::DerivativeOperator< PixelType, itk::CurvatureNDAnisotropicDiffusionFunction::ImageDimension >, itk::DerivativeOperator< ScalarValueType, itk::VectorGradientNDAnisotropicDiffusionFunction::ImageDimension >, itk::DerivativeOperator< PixelType, itk::GradientNDAnisotropicDiffusionFunction::ImageDimension >, itk::DerivativeOperator< OutputImagePixelType, itkGetStaticConstMacro(ImageDimension)>, and itk::ImageKernelOperator< TPixel, VDimension, TAllocator >.

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/MathematicalMorphology/CreateABinaryBallStructuringElement/Code.cxx, WikiExamples/Iterators/ShapedNeighborhoodIterator.cxx, WikiExamples/Morphology/BinaryBallStructuringElement.cxx, WikiExamples/Morphology/BinaryDilateImageFilter.cxx, WikiExamples/Morphology/BinaryErodeImageFilter.cxx, WikiExamples/Morphology/BinaryMorphologicalClosingImageFilter.cxx, WikiExamples/Morphology/BinaryMorphologicalOpeningImageFilter.cxx, WikiExamples/Morphology/GrayscaleDilateImageFilter.cxx, and WikiExamples/Morphology/GrayscaleErodeImageFilter.cxx.

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

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 201 of file itkNeighborhood.h.

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).

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 250 of file itkNeighborhood.h.

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 179 of file itkNeighborhood.h.

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

Member Data Documentation

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 283 of file itkNeighborhood.h.

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

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

std::vector< OffsetType > itk::Neighborhood< TPixel, VDimension, TAllocator >::m_OffsetTable

private

Definition at line 290 of file itkNeighborhood.h.

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 276 of file itkNeighborhood.h.

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

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 280 of file itkNeighborhood.h.

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

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 287 of file itkNeighborhood.h.

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

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

static

External support for dimensionality.

Definition at line 65 of file itkNeighborhood.h.

---

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

• itkNeighborhood.h