ITK  6.0.0
Insight Toolkit
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Attributes | List of all members
itk::NeighborhoodOperator< TPixel, VDimension, TAllocator > Class Template Referenceabstract
Data Processing Objects » Operators | Group Core » Module ITKCommon

#include <itkNeighborhoodOperator.h>

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.

Note
NeighborhoodOperator does not have any user-declared "special member function", following the C++ Rule of Zero: the compiler will generate them if necessary.
ITK Sphinx Examples:
  • <a href=
  • <a href=

Definition at line 72 of file itkNeighborhoodOperator.h.

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

Public Types

using PixelRealType = typename NumericTraits< TPixel >::RealType
 
using PixelType = TPixel
 
using Self = NeighborhoodOperator
 
using SizeType = itk::Size< VDimension >
 
using SliceIteratorType = SliceIterator< TPixel, Self >
 
using Superclass = Neighborhood< TPixel, VDimension, TAllocator >
 
- Public Types inherited from itk::Neighborhood< TPixel, VDimension, NeighborhoodAllocator< TPixel > >
using AllocatorType = NeighborhoodAllocator< TPixel >
 
using ConstIterator = typename AllocatorType::const_iterator
 
using DimensionValueType = unsigned int
 
using Iterator = typename AllocatorType::iterator
 
using NeighborIndexType = SizeValueType
 
using OffsetType = Offset< VDimension >
 
using PixelType = TPixel
 
using RadiusType = itk::Size< VDimension >
 
using Self = Neighborhood
 
using SizeType = itk::Size< VDimension >
 
using SizeValueType = typename SizeType::SizeValueType
 
using SliceIteratorType = SliceIterator< TPixel, Self >
 

Public Member Functions

virtual void CreateDirectional ()
 
virtual void CreateToRadius (const SizeType &)
 
virtual void CreateToRadius (const SizeValueType)
 
virtual void FlipAxes ()
 
unsigned long GetDirection () const
 
const char * GetNameOfClass () const override
 
void PrintSelf (std::ostream &os, Indent indent) const override
 
void ScaleCoefficients (PixelRealType)
 
void SetDirection (const unsigned long direction)
 
- Public Member Functions inherited from itk::Neighborhood< TPixel, VDimension, NeighborhoodAllocator< TPixel > >
NeighborIndexType GetCenterNeighborhoodIndex () const
 
TPixel GetCenterValue () const
 
virtual const char * GetNameOfClass () const
 
virtual NeighborIndexType GetNeighborhoodIndex (const OffsetType &) const
 
OffsetType GetOffset (NeighborIndexType i) const
 
const SizeType GetRadius () const
 
SizeValueType GetRadius (DimensionValueType n) const
 
SizeType GetSize () const
 
SizeValueType GetSize (DimensionValueType n) const
 
std::slice GetSlice (unsigned int) const
 
OffsetValueType GetStride (DimensionValueType axis) const
 
 ITK_UNEQUAL_OPERATOR_MEMBER_FUNCTION (Self)
 
 Neighborhood ()=default
 
 Neighborhood (const Self &)=default
 
 Neighborhood (Self &&)=default
 
Self & operator= (const Self &)=default
 
Self & operator= (Self &&)=default
 
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 ()=default
 
Iterator End ()
 
ConstIterator End () const
 
Iterator Begin ()
 
ConstIterator Begin () const
 
TPixel & operator[] (NeighborIndexType i)
 
const TPixel & operator[] (NeighborIndexType i) const
 
TPixel & GetElement (NeighborIndexType i)
 
TPixel & operator[] (const OffsetType &o)
 
const TPixel & operator[] (const OffsetType &o) const
 
void SetRadius (const SizeValueType *rad)
 
AllocatorType & GetBufferReference ()
 
const AllocatorType & GetBufferReference () const
 

Protected Types

using CoefficientVector = typename std::vector< PixelRealType >
 

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, NeighborhoodAllocator< TPixel > >
virtual void Allocate (NeighborIndexType i)
 
virtual void ComputeNeighborhoodOffsetTable ()
 
virtual void ComputeNeighborhoodStrideTable ()
 
virtual void PrintSelf (std::ostream &, Indent) const
 
void SetSize ()
 

Private Attributes

unsigned long m_Direction { 0 }
 

Additional Inherited Members

- Static Public Attributes inherited from itk::Neighborhood< TPixel, VDimension, NeighborhoodAllocator< TPixel > >
static constexpr unsigned int NeighborhoodDimension
 

Member Typedef Documentation

◆ CoefficientVector

template<typename TPixel , unsigned int VDimension, typename TAllocator = NeighborhoodAllocator<TPixel>>
using itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CoefficientVector = typename std::vector<PixelRealType>
protected

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

Definition at line 153 of file itkNeighborhoodOperator.h.

◆ PixelRealType

template<typename TPixel , unsigned int VDimension, typename TAllocator = NeighborhoodAllocator<TPixel>>
using itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::PixelRealType = typename NumericTraits<TPixel>::RealType

Definition at line 90 of file itkNeighborhoodOperator.h.

◆ PixelType

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

External support for pixel type

Definition at line 85 of file itkNeighborhoodOperator.h.

◆ Self

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

Standard class type aliases.

Definition at line 76 of file itkNeighborhoodOperator.h.

◆ SizeType

template<typename TPixel , unsigned int VDimension, typename TAllocator = NeighborhoodAllocator<TPixel>>
using itk::Neighborhood< TPixel, VDimension, TAllocator >::SizeType = itk::Size<VDimension>

Size and value type alias support

Definition at line 79 of file itkNeighborhood.h.

◆ SliceIteratorType

template<typename TPixel , unsigned int VDimension, typename TAllocator = NeighborhoodAllocator<TPixel>>
using itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::SliceIteratorType = SliceIterator<TPixel, Self>

Slice iterator type alias support

Definition at line 88 of file itkNeighborhoodOperator.h.

◆ Superclass

template<typename TPixel , unsigned int VDimension, typename TAllocator = NeighborhoodAllocator<TPixel>>
using itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::Superclass = Neighborhood<TPixel, VDimension, TAllocator>

Definition at line 77 of file itkNeighborhoodOperator.h.

Member Function Documentation

◆ CreateDirectional()

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, Self::FixedImageDimension >, and itk::SobelOperator< MovedGradientPixelType, Self::MovedImageDimension >.

◆ CreateToRadius() [1/2]

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

◆ CreateToRadius() [2/2]

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

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

Implemented in itk::LaplacianOperator< TPixel, VDimension, TAllocator >, itk::AnnulusOperator< TPixel, TDimension, TAllocator >, itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >, itk::DerivativeOperator< TPixel, VDimension, TAllocator >, itk::DerivativeOperator< OutputImagePixelType, Self::ImageDimension >, itk::DerivativeOperator< PixelType, Self::ImageDimension >, itk::DerivativeOperator< ScalarValueType, Self::ImageDimension >, itk::ForwardDifferenceOperator< TPixel, VDimension, TAllocator >, itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >, itk::GaussianOperator< TPixel, VDimension, TAllocator >, itk::GaussianOperator< ScalarType, VDimension >, itk::GaussianOperator< ScalarType, Superclass::Dimension >, itk::ImageKernelOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< FixedGradientPixelType, Self::FixedImageDimension >, and itk::SobelOperator< MovedGradientPixelType, Self::MovedImageDimension >.

◆ FillCenteredDirectional()

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.

◆ FlipAxes()

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.

◆ GenerateCoefficients()

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.

Implemented in itk::AnnulusOperator< TPixel, TDimension, TAllocator >, itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >, itk::DerivativeOperator< TPixel, VDimension, TAllocator >, itk::DerivativeOperator< OutputImagePixelType, Self::ImageDimension >, itk::DerivativeOperator< PixelType, Self::ImageDimension >, itk::DerivativeOperator< ScalarValueType, Self::ImageDimension >, itk::ForwardDifferenceOperator< TPixel, VDimension, TAllocator >, itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >, itk::GaussianOperator< TPixel, VDimension, TAllocator >, itk::GaussianOperator< ScalarType, VDimension >, itk::GaussianOperator< ScalarType, Superclass::Dimension >, itk::ImageKernelOperator< TPixel, VDimension, TAllocator >, itk::LaplacianOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< FixedGradientPixelType, Self::FixedImageDimension >, and itk::SobelOperator< MovedGradientPixelType, Self::MovedImageDimension >.

◆ GetDirection()

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 107 of file itkNeighborhoodOperator.h.

◆ GetNameOfClass()

template<typename TPixel , unsigned int VDimension, typename TAllocator = NeighborhoodAllocator<TPixel>>
const char * itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::GetNameOfClass ( ) const
overridevirtual
See also
LightObject::GetNameOfClass()

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

Reimplemented in itk::SobelOperator< FixedGradientPixelType, Self::FixedImageDimension >, and itk::SobelOperator< MovedGradientPixelType, Self::MovedImageDimension >.

◆ InitializeToZero()

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 175 of file itkNeighborhoodOperator.h.

◆ PrintSelf()

template<typename TPixel , unsigned int VDimension, typename TAllocator = NeighborhoodAllocator<TPixel>>
void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::PrintSelf ( std::ostream &  ,
Indent   
) const
inlineoverridevirtual

Standard itk object method.

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

Definition at line 139 of file itkNeighborhoodOperator.h.

◆ ScaleCoefficients()

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.

◆ SetDirection()

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.

Definition at line 94 of file itkNeighborhoodOperator.h.

Member Data Documentation

◆ m_Direction

template<typename TPixel , unsigned int VDimension, typename TAllocator = NeighborhoodAllocator<TPixel>>
unsigned long itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::m_Direction { 0 }
private

Direction (dimension number) of the derivative.

Definition at line 186 of file itkNeighborhoodOperator.h.

The documentation for this class was generated from the following file:
Tarballs of the nightly generated Doxygen documentation are available for the html, xml, and tag file. Previous versions of this documentation for version: 5.3, 5.2, 5.1, 5.0, 4.13, 3.20.
Generated on unknown for ITK by   doxygen 1.9.3