itk::Neighborhood< TPixel, VDimension, TAllocator > Class Template Reference
[Operators, Image Iterators]

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

#include <itkNeighborhood.h>

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

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

List of all members.

Public Types

typedef TAllocator AllocatorType

typedef
AllocatorType::const_iterator ConstIterator

typedef AllocatorType::iterator Iterator

typedef Offset< VDimension > OffsetType

typedef TPixel PixelType

typedef ::itk::Size< VDimension > RadiusType

typedef Neighborhood Self

typedef ::itk::Size< VDimension > SizeType

typedef SizeType::SizeValueType SizeValueType

typedef SliceIterator< TPixel,
Self > SliceIteratorType

Public Member Functions

unsigned int GetCenterNeighborhoodIndex () const

TPixel GetCenterValue () const

virtual unsigned int GetNeighborhoodIndex (const OffsetType &) const

OffsetType GetOffset (unsigned int i) const

unsigned long GetRadius (const unsigned long n) const

const SizeType GetRadius () const

SizeType GetSize () const

unsigned long GetSize (const unsigned long n) const

std::slice GetSlice (unsigned int) const

unsigned GetStride (const unsigned axis) const

itkStaticConstMacro (NeighborhoodDimension, unsigned int, VDimension)

Neighborhood (const Self &other)

bool operator!= (const Self &other) const

Self & operator= (const Self &other)

bool operator== (const Self &other) const

void Print (std::ostream &os) const

void SetRadius (const unsigned long)

void SetRadius (const SizeType &)

unsigned int Size () const

virtual ~Neighborhood ()

ConstIterator Begin () const

Iterator Begin ()

ConstIterator End () const

Iterator End ()

const AllocatorType & GetBufferReference () const

AllocatorType & GetBufferReference ()

TPixel & GetElement (unsigned int i)

const TPixel & operator[] (unsigned int i) const

TPixel & operator[] (unsigned int i)

Neighborhood ()

const TPixel & operator[] (const OffsetType &o) const

TPixel & operator[] (const OffsetType &o)

void SetRadius (const unsigned long *rad)

Protected Member Functions

virtual void Allocate (unsigned int i)

virtual void ComputeNeighborhoodOffsetTable ()

virtual void ComputeNeighborhoodStrideTable ()

virtual void PrintSelf (std::ostream &, Indent) const

void SetSize ()

Detailed Description

template<class TPixel, unsigned int VDimension = 2, class 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

Definition at line 56 of file itkNeighborhood.h.