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

#include <itkForwardDifferenceOperator.h>

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

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

Detailed Description

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

Operator whose inner product with a neighborhood returns a "half" derivative at the center of the neighborhood.

ForwardDifferenceOperator uses forward differences i.e. F(x+1) - F(x) to calculate a "half" derivative useful, among other things, in solving differential equations. It is a directional NeighborhoodOperator that should be applied to a Neighborhood using the inner product.

Wiki Examples:

• All Examples
• Create a forward difference kernel

Examples:

WikiExamples/Operators/ForwardDifferenceOperator.cxx.

Definition at line 45 of file itkForwardDifferenceOperator.h.

Public Types
typedef Superclass::PixelType	PixelType
typedef ForwardDifferenceOperator	Self
typedef NeighborhoodOperator < TPixel, VDimension, TAllocator >	Superclass
Public Types inherited from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >
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
	ForwardDifferenceOperator ()
	ForwardDifferenceOperator (const Self &other)
Self &	operator= (const Self &other)
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)
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 Superclass::CoefficientVector	CoefficientVector
Protected Types inherited from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >
typedef std::vector < PixelRealType >	CoefficientVector

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

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

typedef Superclass::CoefficientVector itk::ForwardDifferenceOperator< TPixel, VDimension, TAllocator >::CoefficientVector

protected

Necessary to work around VC++ compiler bug.

Definition at line 73 of file itkForwardDifferenceOperator.h.

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

typedef Superclass::PixelType itk::ForwardDifferenceOperator< TPixel, VDimension, TAllocator >::PixelType

Definition at line 54 of file itkForwardDifferenceOperator.h.

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

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

Standard class typedefs.

Definition at line 51 of file itkForwardDifferenceOperator.h.

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

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

Definition at line 52 of file itkForwardDifferenceOperator.h.

Constructor & Destructor Documentation

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

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

inline

Constructor.

Definition at line 57 of file itkForwardDifferenceOperator.h.

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

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

inline

Copy constructor

Definition at line 60 of file itkForwardDifferenceOperator.h.

Member Function Documentation

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

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

inlineprotectedvirtual

Arranges coefficients spatially in the memory buffer.

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

Definition at line 79 of file itkForwardDifferenceOperator.h.

References itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::FillCenteredDirectional().

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

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

protectedvirtual

Calculates operator coefficients.

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

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

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

inline

Assignment operator

Definition at line 64 of file itkForwardDifferenceOperator.h.

References itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::operator=().

---

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

• itkForwardDifferenceOperator.h