#include <itkNeighborhoodOperator.h>

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

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

Detailed Description

template<typename TPixel, unsigned int VDimension, typename 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) GenerateCoefficients – the algorithm that computes the scalar coefficients of the operator.

(2) Fill – 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 66 of file itkNeighborhoodOperator.h.

Public Types
typedef NumericTraits< TPixel > ::RealType	PixelRealType

typedef TPixel	PixelType

typedef NeighborhoodOperator	Self

typedef Superclass::SizeType	SizeType

typedef SliceIterator< TPixel, Self >	SliceIteratorType

typedef Neighborhood< TPixel, VDimension, TAllocator >	Superclass

Public Types inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
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 Member Functions
virtual void	CreateDirectional ()

virtual void	CreateToRadius (const SizeType &)

virtual void	CreateToRadius (const SizeValueType)

virtual void	FlipAxes ()

unsigned long	GetDirection () const

virtual const char *	GetNameOfClass () const

	NeighborhoodOperator ()

	NeighborhoodOperator (const Self &orig)

void	ScaleCoefficients (PixelRealType)

void	SetDirection (const unsigned long &direction)


Self &	operator= (const Self &orig)


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

Public Member Functions inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
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)

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 SizeType &)

void	SetRadius (const SizeValueType)

NeighborIndexType	Size () const

virtual	~Neighborhood ()

	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

Protected Types
typedef std::vector < PixelRealType >	CoefficientVector

Protected Member Functions
virtual void	Fill (const CoefficientVector &)=0

virtual void	FillCenteredDirectional (const CoefficientVector &)

virtual CoefficientVector	GenerateCoefficients ()=0


void	InitializeToZero ()

Protected Member Functions inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
virtual void	Allocate (NeighborIndexType i)

virtual void	ComputeNeighborhoodOffsetTable ()

virtual void	ComputeNeighborhoodStrideTable ()

void	SetSize ()

Private Attributes
unsigned long	m_Direction

Additional Inherited Members
Public Attributes inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
typedef::itk::Size< VDimension >	RadiusType

typedef::itk::Size< VDimension >	SizeType

Static Public Attributes inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
static const unsigned int	NeighborhoodDimension = VDimension

Member Typedef Documentation

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

typedef std::vector< PixelRealType > 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 151 of file itkNeighborhoodOperator.h.

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

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

Definition at line 142 of file itkNeighborhoodOperator.h.

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

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

External support for pixel type

Definition at line 80 of file itkNeighborhoodOperator.h.

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

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

Standard class typedefs.

Definition at line 71 of file itkNeighborhoodOperator.h.

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

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

Size object typedef support

Definition at line 74 of file itkNeighborhoodOperator.h.

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

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

Slice iterator typedef support

Definition at line 83 of file itkNeighborhoodOperator.h.

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

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

Definition at line 72 of file itkNeighborhoodOperator.h.

Constructor & Destructor Documentation

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

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

inline

Constructor.

Definition at line 86 of file itkNeighborhoodOperator.h.

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

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

inline

Copy constructor

Definition at line 90 of file itkNeighborhoodOperator.h.

Member Function Documentation

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

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

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

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

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

Referenced by itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >::CreateDirectional().

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

virtual void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateToRadius ( const SizeValueType )

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

template<typename TPixel, unsigned int VDimension, typename 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.

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

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

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.

Referenced by itk::ForwardDifferenceOperator< TPixel, VDimension, TAllocator >::Fill(), itk::DerivativeOperator< OutputImagePixelType, itkGetStaticConstMacro(ImageDimension)>::Fill(), itk::HigherOrderAccurateDerivativeOperator< TPixel, VDimension, TAllocator >::Fill(), itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >::Fill(), and itk::GaussianOperator< ScalarType, Superclass::Dimension >::Fill().

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

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

virtual

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

template<typename TPixel, unsigned int VDimension, typename 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<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>

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

inline

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

Definition at line 108 of file itkNeighborhoodOperator.h.

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

virtual const char* itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::GetNameOfClass ( ) const

virtual

Reimplemented in itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< FixedGradientPixelType, itkGetStaticConstMacro(FixedImageDimension) >, itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >, itk::AnnulusOperator< TPixel, TDimension, TAllocator >, itk::GaussianOperator< TPixel, VDimension, TAllocator >, itk::HigherOrderAccurateDerivativeOperator< TPixel, VDimension, TAllocator >, itk::GaussianOperator< ScalarType, NDimensions >, itk::GaussianOperator< ScalarType, Superclass::Dimension >, and itk::ImageKernelOperator< TPixel, VDimension, TAllocator >.

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

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

inlineprotected

Initializes all the coefficients in the neighborhood to zero values

Definition at line 169 of file itkNeighborhoodOperator.h.

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

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

inline

Assignment operator.

Definition at line 95 of file itkNeighborhoodOperator.h.

Referenced by itk::ForwardDifferenceOperator< TPixel, VDimension, TAllocator >::operator=(), itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::operator=(), itk::DerivativeOperator< OutputImagePixelType, itkGetStaticConstMacro(ImageDimension)>::operator=(), itk::HigherOrderAccurateDerivativeOperator< TPixel, VDimension, TAllocator >::operator=(), itk::GaussianOperator< ScalarType, Superclass::Dimension >::operator=(), itk::LaplacianOperator< TPixel, VDimension, TAllocator >::operator=(), and itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >::operator=().

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

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

inlineoverridevirtual

Prints some debugging information.

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

Reimplemented in 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::HigherOrderAccurateDerivativeOperator< TPixel, VDimension, TAllocator >, 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 >.

Definition at line 134 of file itkNeighborhoodOperator.h.

Referenced by itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::PrintSelf(), itk::DerivativeOperator< OutputImagePixelType, itkGetStaticConstMacro(ImageDimension)>::PrintSelf(), itk::LaplacianOperator< TPixel, VDimension, TAllocator >::PrintSelf(), itk::HigherOrderAccurateDerivativeOperator< TPixel, VDimension, TAllocator >::PrintSelf(), itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >::PrintSelf(), and itk::GaussianOperator< ScalarType, Superclass::Dimension >::PrintSelf().

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

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

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

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

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

inline

Sets the dimensional direction of a directional operator.

Examples:: Examples/Iterators/NeighborhoodIterators2.cxx, WikiExamples/Operators/DerivativeOperator.cxx, WikiExamples/Operators/ForwardDifferenceOperator.cxx, WikiExamples/Operators/GaussianDerivativeOperator.cxx, WikiExamples/Operators/GaussianOperator.cxx, and WikiExamples/Operators/SobelOperator.cxx.

Definition at line 104 of file itkNeighborhoodOperator.h.

Member Data Documentation

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

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

private

Direction (dimension number) of the derivative.

Definition at line 180 of file itkNeighborhoodOperator.h.

Referenced by itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >::GetDirection(), itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >::NeighborhoodOperator(), itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >::operator=(), itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >::PrintSelf(), and itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >::SetDirection().

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

itkNeighborhoodOperator.h

Detailed Description

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

Public Types

Public Member Functions

Protected Types

Protected Member Functions

Private Attributes

Additional Inherited Members

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

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