ITK  5.0.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Member Functions | Private Attributes | List of all members
itk::ImageKernelOperator< TPixel, VDimension, TAllocator > Class Template Reference

#include <itkImageKernelOperator.h>

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

Detailed Description

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

A NeighborhoodOperator whose coefficients are from an image.

This code was contributed in the Insight Journal paper:

"Image Kernel Convolution" by Tustison N., Gee J. https://hdl.handle.net/1926/1323 http://www.insight-journal.org/browse/publication/208

See Also
NeighborhoodOperator
NeighborhoodIterator
Neighborhood
Examples:
WikiExamples/Images/NormalizedCorrelationImageFilter.cxx.

Definition at line 48 of file itkImageKernelOperator.h.

Public Types

using CoefficientVector = typename Superclass::CoefficientVector
 
using ImageType = Image< TPixel, VDimension >
 
using Self = ImageKernelOperator
 
using SizeType = typename Superclass::SizeType
 
using Superclass = NeighborhoodOperator< TPixel, VDimension, TAllocator >
 
- Public Types inherited from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >
using PixelRealType = typename NumericTraits< TPixel >::RealType
 
using PixelType = TPixel
 
using Self = NeighborhoodOperator
 
using SizeType = typename Superclass::SizeType
 
using SliceIteratorType = SliceIterator< TPixel, Self >
 
using Superclass = Neighborhood< TPixel, VDimension, TAllocator >
 
- Public Types inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
using AllocatorType = TAllocator
 
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

const ImageTypeGetImageKernel () const
 
virtual const char * GetNameOfClass () const
 
 ImageKernelOperator ()=default
 
 ImageKernelOperator (const Self &orig)
 
void SetImageKernel (const ImageType *kernel)
 
Selfoperator= (const Self &orig)
 
void PrintSelf (std::ostream &os, Indent i) const override
 
- Public Member Functions inherited from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >
virtual void CreateDirectional ()
 
virtual void CreateToRadius (const SizeType &)
 
virtual void CreateToRadius (const SizeValueType)
 
virtual void FlipAxes ()
 
unsigned long GetDirection () const
 
 NeighborhoodOperator ()
 
 NeighborhoodOperator (const Self &orig)
 
void ScaleCoefficients (PixelRealType)
 
void SetDirection (const unsigned long &direction)
 
Selfoperator= (const Self &orig)
 
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)
 
 Neighborhood (Self &&)=default
 
bool operator!= (const Self &other) const
 
Selfoperator= (const Self &other)
 
Selfoperator= (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
 
 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)
 
AllocatorTypeGetBufferReference ()
 
const AllocatorTypeGetBufferReference () const
 
TPixel & operator[] (const OffsetType &o)
 
const TPixel & operator[] (const OffsetType &o) const
 

Protected Member Functions

void Fill (const CoefficientVector &coeff) override
 
CoefficientVector GenerateCoefficients () override
 
- Protected Member Functions inherited from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >
virtual void Fill (const CoefficientVector &)=0
 
virtual void FillCenteredDirectional (const CoefficientVector &)
 
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

ImageType::ConstPointer m_ImageKernel
 

Additional Inherited Members

- Static Public Attributes inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
static constexpr unsigned int NeighborhoodDimension = VDimension
 
- Protected Types inherited from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >
using CoefficientVector = std::vector< PixelRealType >
 

Member Typedef Documentation

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
using itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::CoefficientVector = typename Superclass::CoefficientVector

Definition at line 59 of file itkImageKernelOperator.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
using itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::ImageType = Image< TPixel, VDimension >

Definition at line 57 of file itkImageKernelOperator.h.

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

Standard class type aliases.

Definition at line 54 of file itkImageKernelOperator.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
using itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::SizeType = typename Superclass::SizeType

Definition at line 58 of file itkImageKernelOperator.h.

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

Definition at line 55 of file itkImageKernelOperator.h.

Constructor & Destructor Documentation

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::ImageKernelOperator ( )
default

Constructor.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::ImageKernelOperator ( const Self orig)
inline

Copy constructor

Definition at line 67 of file itkImageKernelOperator.h.

Member Function Documentation

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
void itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::Fill ( const CoefficientVector coeff)
overrideprotected

Arranges coefficients spatially in the memory buffer.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
CoefficientVector itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::GenerateCoefficients ( )
overrideprotectedvirtual

Calculates operator coefficients.

Implements itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
const ImageType* itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::GetImageKernel ( ) const

Get the image kernel.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
virtual const char* itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::GetNameOfClass ( ) const
virtual
template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
Self& itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::operator= ( const Self orig)
inline

Assignment operator.

Definition at line 72 of file itkImageKernelOperator.h.

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

Prints information about the object.

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

Definition at line 88 of file itkImageKernelOperator.h.

References itk::Indent::GetNextIndent().

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
void itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::SetImageKernel ( const ImageType kernel)

Set the image kernel. Only images with odd size in all dimensions are allowed. If an image with an even size is passed as an argument, an exception will be thrown.

Member Data Documentation

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
ImageType::ConstPointer itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::m_ImageKernel
private

Definition at line 104 of file itkImageKernelOperator.h.


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