Orfeo Toolbox  3.16
Public Types | Public Member Functions | Static Public Attributes | Protected Member Functions | Private Attributes | List of all members
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 >:

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

 Neighborhood ()
 
 Neighborhood (const Self &other)
 
virtual ~Neighborhood ()
 
Iterator Begin ()
 
ConstIterator Begin () const
 
Iterator End ()
 
ConstIterator End () const
 
AllocatorType & GetBufferReference ()
 
const AllocatorType & GetBufferReference () const
 
unsigned int GetCenterNeighborhoodIndex () const
 
TPixel GetCenterValue () const
 
TPixel & GetElement (unsigned int i)
 
virtual unsigned int GetNeighborhoodIndex (const OffsetType &) const
 
OffsetType GetOffset (unsigned int i) const
 
const SizeType GetRadius () const
 
unsigned long GetRadius (const unsigned long n) const
 
unsigned long GetSize (const unsigned long n) const
 
SizeType GetSize () const
 
std::slice GetSlice (unsigned int) const
 
unsigned GetStride (const unsigned axis) const
 
bool operator!= (const Self &other) const
 
Self & operator= (const Self &other)
 
bool operator== (const Self &other) const
 
TPixel & operator[] (unsigned int i)
 
const TPixel & operator[] (unsigned int i) const
 
TPixel & operator[] (const OffsetType &o)
 
const TPixel & operator[] (const OffsetType &o) const
 
void Print (std::ostream &os) const
 
void SetRadius (const SizeType &)
 
void SetRadius (const unsigned long *rad)
 
void SetRadius (const unsigned long)
 
unsigned int Size () const
 

Static Public Attributes

static const unsigned int NeighborhoodDimension = VDimension
 

Protected Member Functions

virtual void Allocate (unsigned int 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
 
unsigned int m_StrideTable [VDimension]
 

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.

Member Typedef Documentation

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

External support for allocator type.

Definition at line 63 of file itkNeighborhood.h.

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

Definition at line 75 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
typedef AllocatorType::iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Iterator

Iterator typedef support. Note the naming is intentional, i.e., ::iterator and ::const_iterator, because the allocator may be a vnl object or other type, which uses this form.

Definition at line 74 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
typedef Offset<VDimension> itk::Neighborhood< TPixel, VDimension, TAllocator >::OffsetType

Offset type used to reference neighbor locations

Definition at line 85 of file itkNeighborhood.h.

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

External support for pixel type.

Definition at line 69 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
typedef ::itk::Size<VDimension> itk::Neighborhood< TPixel, VDimension, TAllocator >::RadiusType

Radius typedef support.

Definition at line 82 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
typedef Neighborhood itk::Neighborhood< TPixel, VDimension, TAllocator >::Self

Standard class typedefs.

Definition at line 60 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
typedef ::itk::Size<VDimension> itk::Neighborhood< TPixel, VDimension, TAllocator >::SizeType

Size and value typedef support.

Definition at line 78 of file itkNeighborhood.h.

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

Definition at line 79 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
typedef SliceIterator<TPixel, Self> itk::Neighborhood< TPixel, VDimension, TAllocator >::SliceIteratorType

External slice iterator type typedef support.

Definition at line 88 of file itkNeighborhood.h.

Constructor & Destructor Documentation

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

Default constructor.

Definition at line 91 of file itkNeighborhood.h.

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

Default destructor.

Definition at line 102 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >
itk::Neighborhood< TPixel, VDimension, TContainer >::Neighborhood ( const Self &  other)

Copy constructor.

Definition at line 109 of file itkNeighborhood.txx.

References itk::Neighborhood< TPixel, VDimension, TAllocator >::m_DataBuffer, itk::Neighborhood< TPixel, VDimension, TAllocator >::m_OffsetTable, itk::Neighborhood< TPixel, VDimension, TAllocator >::m_Radius, itk::Neighborhood< TPixel, VDimension, TAllocator >::m_Size, and itk::Neighborhood< TPixel, VDimension, TAllocator >::m_StrideTable.

Member Function Documentation

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

Allocates the neighborhood's memory buffer.

Definition at line 236 of file itkNeighborhood.h.

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

Definition at line 154 of file itkNeighborhood.h.

Referenced by itk::FlatStructuringElement< VDimension >::Annulus(), itk::FlatStructuringElement< VDimension >::Ball(), itk::FlatStructuringElement< VDimension >::Box(), itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold(), itk::FlatStructuringElement< VDimension >::Cross(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeighborhood(), itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::operator()(), itk::VectorNeighborhoodInnerProduct< TImage >::operator()(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), and itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetNeighborhood().

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

Definition at line 158 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >
void itk::Neighborhood< TPixel, VDimension, TContainer >::ComputeNeighborhoodOffsetTable ( )
protectedvirtual

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

Definition at line 49 of file itkNeighborhood.txx.

template<class TPixel , unsigned int VDimension, class TContainer >
void itk::Neighborhood< TPixel, VDimension, TContainer >::ComputeNeighborhoodStrideTable ( )
protectedvirtual

Computes the entries for the stride table

Definition at line 28 of file itkNeighborhood.txx.

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

STL-style iterator support.

Definition at line 152 of file itkNeighborhood.h.

Referenced by itk::FlatStructuringElement< VDimension >::Box(), itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold(), itk::FlatStructuringElement< VDimension >::Cross(), itk::VectorNeighborhoodInnerProduct< TImage >::operator()(), itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::operator()(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), and itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel().

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

Definition at line 156 of file itkNeighborhood.h.

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

Returns a reference to the data buffer structure.

Definition at line 200 of file itkNeighborhood.h.

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

Definition at line 202 of file itkNeighborhood.h.

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

Definition at line 218 of file itkNeighborhood.h.

Referenced by otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::ComputeDescriptor(), otb::MRFEnergy< TInput1, TInput2 >::GetValue(), otb::MRFEnergy< TInput2, TInput2 >::GetValue(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::IsLocalExtremum(), and otb::PixelWiseBlockMatchingImageFilter< TInputImage, TOutputMetricImage, TOutputDisparityImage, TMaskImage, TBlockMatchingFunctor >::ThreadedGenerateData().

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

Returns the element at the center of the neighborhood.

Definition at line 174 of file itkNeighborhood.h.

Referenced by itk::MRFImageFilter< TInputImage, TClassifiedImage >::DoNeighborhoodOperation().

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

Definition at line 170 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >
unsigned int itk::Neighborhood< TPixel, VDimension, TContainer >::GetNeighborhoodIndex ( const OffsetType &  o) const
virtual

Definition at line 147 of file itkNeighborhood.txx.

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

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

Definition at line 213 of file itkNeighborhood.h.

Referenced by itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::AnalyzeKernel(), otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >::FillWeightOffsetTable(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), and itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >::SetInputImage().

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

Returns the radius of the neighborhood.

Definition at line 128 of file itkNeighborhood.h.

Referenced by itk::FlatStructuringElement< VDimension >::Annulus(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::AssignOrientation(), itk::FlatStructuringElement< VDimension >::Ball(), itk::VectorAnisotropicDiffusionFunction< TImage >::CalculateAverageGradientMagnitudeSquared(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::ComputeDescriptor(), itk::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeUpdate(), otb::NCCRegistrationFunction< TFixedImage, TMovingImage, TDeformationField >::ComputeUpdate(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::LaplacianSharpeningImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GenerateInputRequestedRegion(), itk::SobelEdgeDetectionImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::LaplacianImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), main(), itk::PeriodicBoundaryCondition< TImage >::operator()(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ThreadedGenerateData().

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

Returns the radius of the neighborhood along a specified dimension.

Definition at line 133 of file itkNeighborhood.h.

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

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

Definition at line 138 of file itkNeighborhood.h.

Referenced by itk::FlatStructuringElement< VDimension >::Annulus(), itk::FlatStructuringElement< VDimension >::Ball(), otb::LineSegmentDetector< TInputImage, TPrecision >::GrowRegion(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ThreadedGenerateData().

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

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

Definition at line 142 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >
std::slice itk::Neighborhood< TPixel, VDimension, TContainer >::GetSlice ( unsigned int  d) const

Definition at line 134 of file itkNeighborhood.txx.

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
unsigned itk::Neighborhood< TPixel, VDimension, TAllocator >::GetStride ( const unsigned  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 148 of file itkNeighborhood.h.

Referenced by itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::CannyEdgeDetectionImageFilter(), itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >::ComputeCurvatureFromSparseImageNeighborhood(), itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold(), itk::CurvatureFlowFunction< TImage >::ComputeUpdate(), itk::CurvatureNDAnisotropicDiffusionFunction< TImage >::CurvatureNDAnisotropicDiffusionFunction(), itk::GradientNDAnisotropicDiffusionFunction< TImage >::GradientNDAnisotropicDiffusionFunction(), itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >::Initialize(), itk::LevelSetFunction< TImageType >::Initialize(), itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::InitializeNormalBandNode(), itk::PeriodicBoundaryCondition< TImage >::operator()(), itk::ZeroFluxNeumannBoundaryCondition< TImage >::operator()(), itk::NormalVectorDiffusionFunction< TSparseImageType >::PrecomputeSparseUpdate(), itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), itk::IsoContourDistanceImageFilter< TInputImage, TOutputImage >::ThreadedGenerateDataBand(), itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::VectorCurvatureNDAnisotropicDiffusionFunction(), and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::VectorGradientNDAnisotropicDiffusionFunction().

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

Not Equal operator.

Definition at line 120 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >
Neighborhood< TPixel, VDimension, TContainer > & itk::Neighborhood< TPixel, VDimension, TContainer >::operator= ( const Self &  other)

Assignment operator.

Definition at line 122 of file itkNeighborhood.txx.

References itk::Neighborhood< TPixel, VDimension, TAllocator >::m_DataBuffer, itk::Neighborhood< TPixel, VDimension, TAllocator >::m_OffsetTable, itk::Neighborhood< TPixel, VDimension, TAllocator >::m_Radius, itk::Neighborhood< TPixel, VDimension, TAllocator >::m_Size, and itk::Neighborhood< TPixel, VDimension, TAllocator >::m_StrideTable.

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

Comparison operator.

Definition at line 112 of file itkNeighborhood.h.

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

Pass-through data access methods to the buffer.

Definition at line 166 of file itkNeighborhood.h.

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

Definition at line 168 of file itkNeighborhood.h.

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

Get pixel value by offset

Definition at line 206 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator[]().

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

Definition at line 208 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator[]().

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

Standard itk object method.

Definition at line 196 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >
void itk::Neighborhood< TPixel, VDimension, TContainer >::PrintSelf ( std::ostream &  os,
Indent  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::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >, itk::AnnulusOperator< TPixel, TDimension, TAllocator >, otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >, itk::GaussianOperator< TPixel, VDimension, TAllocator >, 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< TPixel, TDimension, TAllocator >, itk::SobelOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< FixedGradientPixelType, itkGetStaticConstMacro(FixedImageDimension) >, itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >, itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ConstNeighborhoodIterator< TInputImage >, itk::ConstNeighborhoodIterator< TImage >, itk::ConstNeighborhoodIterator< TInput >, itk::ConstNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >, itk::ConstNeighborhoodIterator< FixedImageType >, itk::ConstNeighborhoodIterator< TImageType >, itk::ConstNeighborhoodIterator< TDeformationField >, itk::ConstNeighborhoodIterator< TSparseImageType >, itk::FlatStructuringElement< VDimension >, 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::ImageKernelOperator< TPixel, VDimension, TAllocator >, otb::WaveletHighPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >, and otb::WaveletLowPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >.

Definition at line 160 of file itkNeighborhood.txx.

template<class TPixel , unsigned int VDimension, class TContainer >
void itk::Neighborhood< TPixel, VDimension, TContainer >::SetRadius ( const SizeType &  r)

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

Definition at line 91 of file itkNeighborhood.txx.

References itk::Size< VDimension >::m_Size.

Referenced by itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::AnalyzeKernel(), itk::FlatStructuringElement< VDimension >::Annulus(), itk::FlatStructuringElement< VDimension >::Ball(), itk::FlatStructuringElement< VDimension >::Box(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::CannyEdgeDetectionImageFilter(), itk::FlatStructuringElement< VDimension >::Cross(), itk::CurvatureNDAnisotropicDiffusionFunction< TImage >::CurvatureNDAnisotropicDiffusionFunction(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeighborhood(), itk::GradientNDAnisotropicDiffusionFunction< TImage >::GradientNDAnisotropicDiffusionFunction(), itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >::Initialize(), itk::LevelSetFunction< TImageType >::Initialize(), itk::FlatStructuringElement< VDimension >::Poly(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), itk::Statistics::ScalarImageToGreyLevelRunLengthMatrixGenerator< TImageType, THistogramFrequencyContainer >::ScalarImageToGreyLevelRunLengthMatrixGenerator(), itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::VectorCurvatureNDAnisotropicDiffusionFunction(), and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::VectorGradientNDAnisotropicDiffusionFunction().

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

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

Definition at line 183 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >
void itk::Neighborhood< TPixel, VDimension, TContainer >::SetRadius ( const unsigned long  s)

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

Definition at line 78 of file itkNeighborhood.txx.

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

Sets the length along each dimension.

Definition at line 227 of file itkNeighborhood.h.

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

More STL-style support.

Definition at line 162 of file itkNeighborhood.h.

Referenced by itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::AnalyzeKernel(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::AssignOrientation(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::CannyEdgeDetectionImageFilter(), itk::VectorFuzzyConnectednessImageFilter< TInputImage, TOutputImage >::Compute_Scale(), itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >::ComputeCurvatureFromSparseImageNeighborhood(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::ComputeDescriptor(), itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold(), itk::CurvatureFlowFunction< TImage >::ComputeUpdate(), itk::CurvatureNDAnisotropicDiffusionFunction< TImage >::CurvatureNDAnisotropicDiffusionFunction(), otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >::FillWeightOffsetTable(), itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >::GenerateCoefficients(), itk::StochasticFractalDimensionImageFilter< TInputImage, TMaskImage, TOutputImage >::GenerateData(), otb::MRFEnergy< TInput1, TInput2 >::GetValue(), otb::MRFEnergy< TInput2, TInput2 >::GetValue(), itk::GradientNDAnisotropicDiffusionFunction< TImage >::GradientNDAnisotropicDiffusionFunction(), itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >::Initialize(), itk::LevelSetFunction< TImageType >::Initialize(), itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InitializeActiveLayerValues(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InitializeActiveLayerValues(), itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::InitializeNormalBandNode(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::IsLocalExtremum(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::IsLocalExtremumAround(), otb::Functor::SSDBlockMatching< TInputImage, TOutputMetricImage >::operator()(), itk::NeighborhoodInnerProduct< ImageType >::operator()(), itk::VectorNeighborhoodInnerProduct< ImageType >::operator()(), otb::Functor::NCCBlockMatching< TInputImage, TOutputMetricImage >::operator()(), otb::Functor::LPBlockMatching< TInputImage, TOutputMetricImage >::operator()(), itk::NormalVectorDiffusionFunction< TSparseImageType >::PrecomputeSparseUpdate(), itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >::SetInputImage(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), itk::ZeroCrossingImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ThreadedGenerateData(), itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::VectorCurvatureNDAnisotropicDiffusionFunction(), and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::VectorGradientNDAnisotropicDiffusionFunction().

Member Data Documentation

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

The buffer in which data is stored.

Definition at line 259 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< TPixel, VDimension, TAllocator >::Neighborhood(), itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator!=(), itk::Neighborhood< TPixel, VDimension, TAllocator >::operator=(), and itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator==().

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

Definition at line 266 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< TPixel, VDimension, TAllocator >::Neighborhood(), and itk::Neighborhood< TPixel, VDimension, TAllocator >::operator=().

template<class TPixel, unsigned int VDimension = 2, class 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 252 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< TPixel, VDimension, TAllocator >::Neighborhood(), itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator!=(), itk::Neighborhood< TPixel, VDimension, TAllocator >::operator=(), and itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator==().

template<class TPixel, unsigned int VDimension = 2, class 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 256 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< TPixel, VDimension, TAllocator >::Neighborhood(), itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator!=(), itk::Neighborhood< TPixel, VDimension, TAllocator >::operator=(), and itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator==().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
unsigned int 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 263 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< TPixel, VDimension, TAllocator >::Neighborhood(), and itk::Neighborhood< TPixel, VDimension, TAllocator >::operator=().

template<class TPixel, unsigned int VDimension = 2, class TAllocator = NeighborhoodAllocator<TPixel>>
const unsigned int itk::Neighborhood< TPixel, VDimension, TAllocator >::NeighborhoodDimension = VDimension
static

External support for dimensionality.

Definition at line 66 of file itkNeighborhood.h.

The documentation for this class was generated from the following files:
Generated at Sun May 19 2013 02:20:06 for Orfeo Toolbox with doxygen 1.8.3.1