Virtual class that defines a common interface to all neighborhood operator subtypes. More...

#include <itkNeighborhoodOperator.h>

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

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

Public Types
typedef TAllocator	AllocatorType

typedef AllocatorType::const_iterator	ConstIterator

typedef AllocatorType::iterator	Iterator

typedef Offset< VDimension >	OffsetType

typedef NumericTraits< TPixel > ::RealType	PixelRealType

typedef TPixel	PixelType

typedef ::itk::Size< VDimension >	RadiusType

typedef NeighborhoodOperator	Self

typedef Superclass::SizeType	SizeType

typedef SizeType::SizeValueType	SizeValueType

typedef SliceIterator< TPixel, Self >	SliceIteratorType

typedef Neighborhood< TPixel, VDimension, TAllocator >	Superclass

Public Member Functions
	NeighborhoodOperator ()

	NeighborhoodOperator (const Self &orig)

Iterator	Begin ()

ConstIterator	Begin () const

virtual void	CreateDirectional ()

virtual void	CreateToRadius (const SizeType &)

virtual void	CreateToRadius (const unsigned long)

Iterator	End ()

ConstIterator	End () const

virtual void	FlipAxes ()

AllocatorType &	GetBufferReference ()

const AllocatorType &	GetBufferReference () const

unsigned int	GetCenterNeighborhoodIndex () const

TPixel	GetCenterValue () const

unsigned long	GetDirection () 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 &orig)

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

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

void	ScaleCoefficients (PixelRealType)

void	SetDirection (const unsigned long &direction)

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 Types
typedef std::vector< double >	CoefficientVector

Protected Member Functions
virtual void	Allocate (unsigned int i)

virtual void	ComputeNeighborhoodOffsetTable ()

virtual void	ComputeNeighborhoodStrideTable ()

virtual void	Fill (const CoefficientVector &)=0

virtual void	FillCenteredDirectional (const CoefficientVector &)

virtual CoefficientVector	GenerateCoefficients ()=0

void	InitializeToZero ()

void	SetSize ()

Private Attributes
unsigned long	m_Direction

Detailed Description

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>
class itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >

Virtual class that defines a common interface to all neighborhood operator subtypes.

A NeighborhoodOperator is a set of pixel values that can be applied to a Neighborhood to perform a user-defined operation (i.e. convolution kernel, morphological structuring element). A NeighborhoodOperator is itself a specialized Neighborhood, with functionality to generate its coefficients according to user-defined parameters. Because the operator is a subclass of Neighborhood, it is a valid operand in any of the operations defined on the Neighborhood object (convolution, inner product, etc.).

NeighborhoodOperator is a pure virtual object that must be subclassed to be used. A user's subclass must implement two methods:

(1) GenerateScalarCoefficients – the algorithm that computes the scalar coefficients of the operator.

(2) ScalarFill – the algorithm that places the scalar coefficients into the memory buffer of the operator (arranges them spatially in the neighborhood).

NeighborhoodOperator supports the concept of a "directional operator." A directional operator is defined in this context to be an operator that is applied along a single dimension. Examples of this type of operator are directional derivatives and the individual, directional components of separable processes such as Gaussian smoothing.

How a NeighborhoodOperator is applied to data is up to the user who defines it. One possible use of an operator would be to take its inner product with a neighborhood of values to produce a scalar result. This process effects convolution when applied to successive neighborhoods across a region of interest in an image.

Definition at line 64 of file itkNeighborhoodOperator.h.

Member Typedef Documentation

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

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

inherited

External support for allocator type.

Definition at line 63 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef std::vector<double> itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CoefficientVector

protected

Typedef support for coefficient vector type. Necessary to fix bug in the microsoft VC++ compiler.

Definition at line 144 of file itkNeighborhoodOperator.h.

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

typedef AllocatorType::const_iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::ConstIterator

inherited

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

inherited

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

inherited

Offset type used to reference neighbor locations

Definition at line 85 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef NumericTraits< TPixel >::RealType itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::PixelRealType

Definition at line 136 of file itkNeighborhoodOperator.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef TPixel itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::PixelType

External support for pixel type

Definition at line 76 of file itkNeighborhoodOperator.h.

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

typedef ::itk::Size<VDimension> itk::Neighborhood< TPixel, VDimension, TAllocator >::RadiusType

inherited

Radius typedef support.

Definition at line 82 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef NeighborhoodOperator itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::Self

Standard class typedefs.

Definition at line 69 of file itkNeighborhoodOperator.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef Superclass::SizeType itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::SizeType

Size object typedef support

Definition at line 73 of file itkNeighborhoodOperator.h.

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

typedef SizeType::SizeValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::SizeValueType

inherited

Definition at line 79 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef SliceIterator<TPixel, Self> itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::SliceIteratorType

Slice iterator typedef support

Definition at line 79 of file itkNeighborhoodOperator.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef Neighborhood<TPixel, VDimension, TAllocator> itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::Superclass

Definition at line 70 of file itkNeighborhoodOperator.h.

Constructor & Destructor Documentation

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

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

inline

Constructor.

Definition at line 82 of file itkNeighborhoodOperator.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::NeighborhoodOperator ( const Self & orig )

inline

Copy constructor

Definition at line 86 of file itkNeighborhoodOperator.h.

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 )

inlineprotectedvirtualinherited

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 )

inlineinherited

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::VectorNeighborhoodInnerProduct< TImage >::operator()(), itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::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

inlineinherited

Definition at line 158 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >

void itk::Neighborhood< TPixel, VDimension, TContainer >::ComputeNeighborhoodOffsetTable ( )

protectedvirtualinherited

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

protectedvirtualinherited

Computes the entries for the stride table

Definition at line 28 of file itkNeighborhood.txx.

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateDirectional ( )

virtual

Creates the operator with length only in the specified direction. The radius of the operator will be 0 except along the axis on which the operator will work.

See Also: CreateToRadius; FillCenteredDirectional; SetDirection(); GetDirection()

Reimplemented in itk::SobelOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< FixedGradientPixelType, itkGetStaticConstMacro(FixedImageDimension) >, and itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >.

Definition at line 59 of file itkNeighborhoodOperator.txx.

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateToRadius ( const SizeType & sz )

virtual

Creates the operator with a specified radius. The spatial location of the coefficients within the operator is defined by the subclass implementation of the Fill method.

See Also: CreateDirectional; Fill

Definition at line 83 of file itkNeighborhoodOperator.txx.

Referenced by itk::ConvolutionImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData().

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateToRadius ( const unsigned long sz )

virtual

Creates the operator with a specified radius ("square", same length on each side). The spatial location of the coefficients within the operator is defined by the subclass implementation of the Fill method.

See Also: CreateDirectional; Fill

Definition at line 94 of file itkNeighborhoodOperator.txx.

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

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

inlineinherited

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

inlineinherited

Definition at line 156 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

virtual void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::Fill ( const CoefficientVector & )

protectedpure virtual

A subclass-specific algorithm that positions the coefficients spatially in the operator.

Referenced by itk::AnnulusOperator< TPixel, TDimension, TAllocator >::AnnulusOperator().

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::FillCenteredDirectional ( const CoefficientVector & coeff )

protectedvirtual

A pre-defined Fill function that can be called by a subclass Fill function to center coefficients along the axis specified by the SetDirection method. Useful for creating directional operators, or centering coefficients in an N-dimensional neighborhood.

Definition at line 107 of file itkNeighborhoodOperator.txx.

References itk::SliceIterator< TPixel, TContainer >::Begin(), and itk::SliceIterator< TPixel, TContainer >::End().

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::FlipAxes ( )

virtual

Reverses the direction of all axes of the operator by reversing the order of the coefficients.

Definition at line 38 of file itkNeighborhoodOperator.txx.

Referenced by itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateData(), and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ThreadedGenerateData().

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

virtual CoefficientVector itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::GenerateCoefficients ( )

protectedpure virtual

A subclass-specific algorithm that computes the coefficients of the operator.

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

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

inlineinherited

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

inlineinherited

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

inlineinherited

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

inlineinherited

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, class TAllocator = NeighborhoodAllocator<TPixel>>

unsigned long itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::GetDirection ( void ) const

inline

Returns the direction (dimension number) of a directional operator.

Definition at line 103 of file itkNeighborhoodOperator.h.

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

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

inlineinherited

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

virtualinherited

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

inlineinherited

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

inlineinherited

Returns the radius of the neighborhood.

Definition at line 128 of file itkNeighborhood.h.

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

unsigned long itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius ( const unsigned long n ) const

inlineinherited

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

inlineinherited

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

inlineinherited

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

inherited

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

inlineinherited

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.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::InitializeToZero ( )

inlineprotected

Initializes all the coefficients in the neighborhood to zero values

Definition at line 162 of file itkNeighborhoodOperator.h.

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

bool itk::Neighborhood< TPixel, VDimension, TAllocator >::operator!= ( const Self & other ) const

inlineinherited

Not Equal operator.

Definition at line 120 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

Self& itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::operator= ( const Self & orig )

inline

Assignment operator.

Definition at line 91 of file itkNeighborhoodOperator.h.

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

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

inlineinherited

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 )

inlineinherited

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

inlineinherited

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 )

inlineinherited

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

inlineinherited

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

inlineinherited

Standard itk object method.

Definition at line 196 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

virtual void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::PrintSelf	(	std::ostream &	os,
		Indent	i
	)		const

inlinevirtual

Prints some debugging information.

Reimplemented from itk::Neighborhood< TPixel, VDimension, TAllocator >.

Reimplemented in itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >, itk::AnnulusOperator< TPixel, TDimension, TAllocator >, otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >, itk::GaussianOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< FixedGradientPixelType, itkGetStaticConstMacro(FixedImageDimension) >, itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >, 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 129 of file itkNeighborhoodOperator.h.

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::ScaleCoefficients ( PixelRealType s )

Multiplies all of the coefficients of the kernel by a single scalar value.

Definition at line 27 of file itkNeighborhoodOperator.txx.

Referenced by itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >::GenerateCoefficients(), itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ThreadedGenerateData().

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::SetDirection ( const unsigned long & direction )

inline

Sets the dimensional direction of a directional operator.

Definition at line 99 of file itkNeighborhoodOperator.h.

Referenced by itk::VectorAnisotropicDiffusionFunction< TImage >::CalculateAverageGradientMagnitudeSquared(), itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >::GenerateCoefficients(), itk::SobelEdgeDetectionImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GenerateInputRequestedRegion(), itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), main(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ThreadedGenerateData().

template<class TPixel , unsigned int VDimension, class TContainer >

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

inherited

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.

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

void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius ( const unsigned long * rad )

inlineinherited

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 )

inherited

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

inlineprotectedinherited

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

inlineinherited

More STL-style support.

Definition at line 162 of file itkNeighborhood.h.

Member Data Documentation

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

unsigned long itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::m_Direction

private

Direction (dimension number) of the derivative.

Definition at line 172 of file itkNeighborhoodOperator.h.

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

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

staticinherited

External support for dimensionality.

Definition at line 66 of file itkNeighborhood.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Private Attributes

Detailed Description

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>> class itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>
class itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >