itk::LaplacianOperator< TPixel, VDimension, TAllocator > Class Template Reference

#include <itkLaplacianOperator.h>

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

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

Detailed Description

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

A NeighborhoodOperator for use in calculating the Laplacian at a pixel.

A NeighborhoodOperator for use in calculating the Laplacian at a pixel. The LaplacianOperator's coefficients are a tightest-fitting convolution kernel.

For example, the simplest Laplacian Operator for 2D has the form:

0   1   0
1  -4   1
0   1   0

The LaplacianOperator is a non-directional NeighborhoodOperator that should be applied to a Neighborhood or NeighborhoodIterator using an inner product method (itkNeighborhoodInnerProduct). To initialize the operator, you need call CreateOperator() before using it.

By default the operator will be created for an isotropic image, but you can modify the operator to handle different pixel spacings by calling SetDerivativeScalings. The argument to SetDerivativeScalings is an array of doubles that is of length VDimension (the dimensionality of the image). Make sure to use 1/pixel_spacing to properly scale derivatives.

See Also

NeighborhoodOperator

Neighborhood

Wiki Examples:

• All Examples
• Create a Laplacian kernel

Examples:

WikiExamples/Operators/LaplacianOperator.cxx.

Definition at line 64 of file itkLaplacianOperator.h.

Public Types
using	PixelType = typename Superclass::PixelType
using	Self = LaplacianOperator
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
void	CreateOperator ()
void	SetDerivativeScalings (const double *s)
	LaplacianOperator ()
	LaplacianOperator (const Self &other)
Self &	operator= (const Self &other)
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
virtual const char *	GetNameOfClass () const
	NeighborhoodOperator ()
	NeighborhoodOperator (const Self &orig)
void	ScaleCoefficients (PixelRealType)
void	SetDirection (const unsigned long &direction)
Self &	operator= (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
Self &	operator= (const Self &other)
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
	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
using	CoefficientVector = typename Superclass::CoefficientVector
Protected Types inherited from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >
using	CoefficientVector = std::vector< PixelRealType >

Protected Member Functions
void	Fill (const CoefficientVector &) 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
double	m_DerivativeScalings [VDimension]

Additional Inherited Members
Static Public Attributes inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
static constexpr unsigned int	NeighborhoodDimension = VDimension

Member Typedef Documentation

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

using itk::LaplacianOperator< TPixel, VDimension, TAllocator >::CoefficientVector = typename Superclass::CoefficientVector

protected

Typedef support for coefficient vector type. Necessary to work around compiler bug on VC++.

Definition at line 127 of file itkLaplacianOperator.h.

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

using itk::LaplacianOperator< TPixel, VDimension, TAllocator >::PixelType = typename Superclass::PixelType

Definition at line 75 of file itkLaplacianOperator.h.

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

using itk::LaplacianOperator< TPixel, VDimension, TAllocator >::Self = LaplacianOperator

Standard "Self" type alias support

Definition at line 70 of file itkLaplacianOperator.h.

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

using itk::LaplacianOperator< TPixel, VDimension, TAllocator >::SizeType = typename Superclass::SizeType

Definition at line 76 of file itkLaplacianOperator.h.

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

using itk::LaplacianOperator< TPixel, VDimension, TAllocator >::Superclass = NeighborhoodOperator< TPixel, VDimension, TAllocator >

Standard "Superclass" type alias.

Definition at line 73 of file itkLaplacianOperator.h.

Constructor & Destructor Documentation

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

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

inline

Default constructor

Definition at line 79 of file itkLaplacianOperator.h.

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

itk::LaplacianOperator< TPixel, VDimension, TAllocator >::LaplacianOperator ( const Self &  other )

inline

Copy constructor

Definition at line 89 of file itkLaplacianOperator.h.

References itk::LaplacianOperator< TPixel, VDimension, TAllocator >::m_DerivativeScalings.

Member Function Documentation

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

void itk::LaplacianOperator< TPixel, VDimension, TAllocator >::CreateOperator

(

)

This function is called to create the operator

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

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

overrideprotected

Arranges coefficients spatially in the memory buffer, default function was NOT used.

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

CoefficientVector itk::LaplacianOperator< 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 >>

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

inline

Assignment operator

Definition at line 103 of file itkLaplacianOperator.h.

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

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

inlineoverridevirtual

Prints some debugging information

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

Definition at line 111 of file itkLaplacianOperator.h.

References itk::Indent::GetNextIndent().

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

void itk::LaplacianOperator< TPixel, VDimension, TAllocator >::SetDerivativeScalings

(

const double *

s

)

Sets the weights that are applied to the derivative in each axial direction when the kernel is computed. These weights are all 1.0 by default. This method must be called BEFORE CreateOperator

Member Data Documentation

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

double itk::LaplacianOperator< TPixel, VDimension, TAllocator >::m_DerivativeScalings[VDimension]

private

Weights applied to derivatives in each axial direction

Definition at line 138 of file itkLaplacianOperator.h.

Referenced by itk::LaplacianOperator< TPixel, VDimension, TAllocator >::LaplacianOperator().

---

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

• itkLaplacianOperator.h