ITK
4.6.0
Insight Segmentation and Registration Toolkit
|
#include <itkNeighborhood.h>
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.
Definition at line 55 of file itkNeighborhood.h.
Public Types | |
typedef TAllocator | AllocatorType |
typedef AllocatorType::const_iterator | ConstIterator |
typedef unsigned int | DimensionValueType |
typedef AllocatorType::iterator | Iterator |
typedef SizeValueType | NeighborIndexType |
typedef Offset< VDimension > | OffsetType |
typedef TPixel | PixelType |
typedef Neighborhood | Self |
typedef SizeType::SizeValueType | SizeValueType |
typedef SliceIterator< TPixel, Self > | SliceIteratorType |
Public Attributes | |
typedef::itk::Size< VDimension > | RadiusType |
typedef::itk::Size< VDimension > | SizeType |
Static Public Attributes | |
static const 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] |
typedef TAllocator itk::Neighborhood< TPixel, VDimension, TAllocator >::AllocatorType |
External support for allocator type.
Definition at line 62 of file itkNeighborhood.h.
typedef AllocatorType::const_iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::ConstIterator |
Definition at line 74 of file itkNeighborhood.h.
typedef unsigned int itk::Neighborhood< TPixel, VDimension, TAllocator >::DimensionValueType |
Type used to refer to space dimensions
Definition at line 90 of file itkNeighborhood.h.
typedef AllocatorType::iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Iterator |
Iterator typedef 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 73 of file itkNeighborhood.h.
typedef SizeValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::NeighborIndexType |
Type used to refer to the elements of the pixel list that are part of the neighborhood.
Definition at line 94 of file itkNeighborhood.h.
typedef Offset< VDimension > itk::Neighborhood< TPixel, VDimension, TAllocator >::OffsetType |
Offset type used to reference neighbor locations
Definition at line 84 of file itkNeighborhood.h.
typedef TPixel itk::Neighborhood< TPixel, VDimension, TAllocator >::PixelType |
External support for pixel type.
Definition at line 68 of file itkNeighborhood.h.
typedef Neighborhood itk::Neighborhood< TPixel, VDimension, TAllocator >::Self |
Standard class typedefs.
Definition at line 59 of file itkNeighborhood.h.
typedef SizeType::SizeValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::SizeValueType |
Definition at line 78 of file itkNeighborhood.h.
typedef SliceIterator< TPixel, Self > itk::Neighborhood< TPixel, VDimension, TAllocator >::SliceIteratorType |
External slice iterator type typedef support.
Definition at line 87 of file itkNeighborhood.h.
|
inline |
Default constructor.
Definition at line 97 of file itkNeighborhood.h.
|
inlinevirtual |
Default destructor.
Definition at line 109 of file itkNeighborhood.h.
itk::Neighborhood< TPixel, VDimension, TAllocator >::Neighborhood | ( | const Self & | other | ) |
Copy constructor.
|
inlineprotectedvirtual |
Allocates the neighborhood's memory buffer.
Definition at line 251 of file itkNeighborhood.h.
|
inline |
STL-style iterator support.
Definition at line 161 of file itkNeighborhood.h.
|
inline |
STL-style iterator support.
Definition at line 165 of file itkNeighborhood.h.
|
protectedvirtual |
Fills entries into the offset lookup table. Called once on initialization.
|
protectedvirtual |
Computes the entries for the stride table
|
inline |
STL-style iterator support.
Definition at line 159 of file itkNeighborhood.h.
|
inline |
STL-style iterator support.
Definition at line 163 of file itkNeighborhood.h.
|
inline |
Returns a reference to the data buffer structure.
Definition at line 212 of file itkNeighborhood.h.
|
inline |
Returns a reference to the data buffer structure.
Definition at line 214 of file itkNeighborhood.h.
|
inline |
Definition at line 232 of file itkNeighborhood.h.
|
inline |
Returns the element at the center of the neighborhood.
Definition at line 183 of file itkNeighborhood.h.
|
inline |
Pass-through data access methods to the buffer.
Definition at line 178 of file itkNeighborhood.h.
|
virtual |
|
inline |
Returns the itk::Offset from the center of the Neighborhood to the requested neighbor index.
Definition at line 227 of file itkNeighborhood.h.
Referenced by itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::ConstIterator::GetNeighborhoodOffset().
|
inline |
Returns the radius of the neighborhood.
Definition at line 135 of file itkNeighborhood.h.
|
inline |
Returns the radius of the neighborhood along a specified dimension.
Definition at line 140 of file itkNeighborhood.h.
|
inline |
Returns the size (total length) of the neighborhood along a specified dimension.
Definition at line 145 of file itkNeighborhood.h.
|
inline |
Returns the size (total length of sides) of the neighborhood.
Definition at line 149 of file itkNeighborhood.h.
std::slice itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSlice | ( | unsigned | int | ) | 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 155 of file itkNeighborhood.h.
Referenced by itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >::Initialize().
|
inline |
Not Equal operator.
Definition at line 127 of file itkNeighborhood.h.
Self& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator= | ( | const Self & | other | ) |
|
inline |
Comparison operator.
Definition at line 119 of file itkNeighborhood.h.
|
inline |
Pass-through data access methods to the buffer.
Definition at line 174 of file itkNeighborhood.h.
Referenced by itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >::InitializeToZero(), and itk::Neighborhood< char, TImage::ImageDimension >::operator[]().
|
inline |
Pass-through data access methods to the buffer.
Definition at line 176 of file itkNeighborhood.h.
|
inline |
Get pixel value by offset
Definition at line 219 of file itkNeighborhood.h.
|
inline |
Get pixel value by offset
Definition at line 221 of file itkNeighborhood.h.
|
inline |
Standard itk object method.
Definition at line 208 of file itkNeighborhood.h.
|
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::AnnulusOperator< TPixel, TDimension, TAllocator >, 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, itkGetStaticConstMacro(FixedImageDimension) >, itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(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::ConstNeighborhoodIteratorWithOnlyIndex< TImage >, itk::LaplacianOperator< TPixel, VDimension, TAllocator >, itk::DerivativeOperator< TPixel, VDimension, TAllocator >, itk::DerivativeOperator< ScalarValueType, itkGetStaticConstMacro(ImageDimension) >, itk::DerivativeOperator< OutputImagePixelType, itkGetStaticConstMacro(ImageDimension) >, itk::DerivativeOperator< PixelType, itkGetStaticConstMacro(ImageDimension) >, itk::DerivativeOperator< OutputImagePixelType, itkGetStaticConstMacro(ImageDimension)>, and itk::ImageKernelOperator< TPixel, VDimension, TAllocator >.
Referenced by itk::Neighborhood< char, TImage::ImageDimension >::Print(), and itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >::PrintSelf().
void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius | ( | const SizeType & | ) |
Sets the radius for the neighborhood, calculates size from the radius, and allocates storage.
Referenced by itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::BinaryCrossStructuringElement(), itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >::Initialize(), and itk::Neighborhood< char, TImage::ImageDimension >::SetRadius().
|
inline |
Sets the radius for the neighborhood. Overloaded to support an unsigned long array.
Definition at line 192 of file itkNeighborhood.h.
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).
|
inlineprotected |
Sets the length along each dimension.
Definition at line 241 of file itkNeighborhood.h.
|
inline |
More STL-style support.
Definition at line 170 of file itkNeighborhood.h.
Referenced by itk::Neighborhood< char, TImage::ImageDimension >::GetCenterNeighborhoodIndex(), itk::Neighborhood< char, TImage::ImageDimension >::GetCenterValue(), itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >::Initialize(), itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >::InitializeToZero(), itk::NeighborhoodInnerProduct< ImageType >::operator()(), and itk::VectorNeighborhoodInnerProduct< ImageType >::operator()().
|
private |
The buffer in which data is stored.
Definition at line 274 of file itkNeighborhood.h.
Referenced by itk::Neighborhood< char, TImage::ImageDimension >::Allocate(), itk::Neighborhood< char, TImage::ImageDimension >::Begin(), itk::Neighborhood< char, TImage::ImageDimension >::End(), itk::Neighborhood< char, TImage::ImageDimension >::GetBufferReference(), itk::Neighborhood< char, TImage::ImageDimension >::GetElement(), itk::Neighborhood< char, TImage::ImageDimension >::operator!=(), itk::Neighborhood< char, TImage::ImageDimension >::operator==(), itk::Neighborhood< char, TImage::ImageDimension >::operator[](), and itk::Neighborhood< char, TImage::ImageDimension >::Size().
|
private |
Definition at line 281 of file itkNeighborhood.h.
Referenced by itk::Neighborhood< char, TImage::ImageDimension >::GetOffset().
|
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 267 of file itkNeighborhood.h.
Referenced by itk::Neighborhood< char, TImage::ImageDimension >::GetRadius(), itk::Neighborhood< char, TImage::ImageDimension >::Neighborhood(), itk::Neighborhood< char, TImage::ImageDimension >::operator!=(), itk::Neighborhood< char, TImage::ImageDimension >::operator==(), and itk::Neighborhood< char, TImage::ImageDimension >::SetSize().
|
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 271 of file itkNeighborhood.h.
Referenced by itk::Neighborhood< char, TImage::ImageDimension >::GetSize(), itk::Neighborhood< char, TImage::ImageDimension >::Neighborhood(), itk::Neighborhood< char, TImage::ImageDimension >::operator!=(), itk::Neighborhood< char, TImage::ImageDimension >::operator==(), and itk::Neighborhood< char, TImage::ImageDimension >::SetSize().
|
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 278 of file itkNeighborhood.h.
Referenced by itk::Neighborhood< char, TImage::ImageDimension >::GetStride(), and itk::Neighborhood< char, TImage::ImageDimension >::Neighborhood().
|
static |
External support for dimensionality.
Definition at line 65 of file itkNeighborhood.h.
typedef::itk::Size< VDimension > itk::Neighborhood< TPixel, VDimension, TAllocator >::RadiusType |
Radius typedef support.
Definition at line 81 of file itkNeighborhood.h.
typedef::itk::Size< VDimension > itk::Neighborhood< TPixel, VDimension, TAllocator >::SizeType |
Size and value typedef support.
Definition at line 77 of file itkNeighborhood.h.
Referenced by itk::Neighborhood< char, TImage::ImageDimension >::SetRadius().