#include <itkForwardDifferenceOperator.h>

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

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

Public Types
using	PixelType = typename Superclass::PixelType

using	Self = ForwardDifferenceOperator

using	Superclass = NeighborhoodOperator< TPixel, VDimension, TAllocator >

Public Types inherited from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >
using	PixelType = TPixel

using	Self = NeighborhoodOperator

using	SizeType = typename Superclass::SizeType

using	SliceIteratorType = SliceIterator< TPixel, Self >

using	Superclass = Neighborhood< TPixel, VDimension, TAllocator >

using	PixelRealType = typename NumericTraits< TPixel >::RealType

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 >

Protected Types
using	CoefficientVector = typename Superclass::CoefficientVector

Protected Types inherited from itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >
using	CoefficientVector = std::vector< PixelRealType >

Protected Member Functions
CoefficientVector	GenerateCoefficients () override


void	Fill (const CoefficientVector &coeff) 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 >
void	SetSize ()

virtual void	Allocate (NeighborIndexType i)

virtual void	ComputeNeighborhoodStrideTable ()

virtual void	ComputeNeighborhoodOffsetTable ()

Additional Inherited Members
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

void	SetDirection (const unsigned long &direction)

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

void	ScaleCoefficients (PixelRealType)

Public Member Functions inherited from itk::Neighborhood< TPixel, VDimension, TAllocator >
	itkTypeMacroNoParent (Neighborhood)

	Neighborhood ()

virtual	~Neighborhood ()=default

	Neighborhood (const Self &other)

	Neighborhood (Self &&)=default

Self &	operator= (const Self &other)

Self &	operator= (Self &&)=default

bool	operator== (const Self &other) const

bool	operator!= (const Self &other) const

const SizeType	GetRadius () const

SizeValueType	GetRadius (DimensionValueType n) const

SizeValueType	GetSize (DimensionValueType n) const

SizeType	GetSize () const

OffsetValueType	GetStride (DimensionValueType axis) const

Iterator	End ()

Iterator	Begin ()

ConstIterator	End () const

ConstIterator	Begin () const

NeighborIndexType	Size () const

TPixel &	operator[] (NeighborIndexType i)

const TPixel &	operator[] (NeighborIndexType i) const

TPixel &	GetElement (NeighborIndexType i)

TPixel	GetCenterValue () const

void	SetRadius (const SizeType &)

void	SetRadius (const SizeValueType *rad)

void	SetRadius (const SizeValueType)

void	Print (std::ostream &os) const

AllocatorType &	GetBufferReference ()

const AllocatorType &	GetBufferReference () const

TPixel &	operator[] (const OffsetType &o)

const TPixel &	operator[] (const OffsetType &o) const

OffsetType	GetOffset (NeighborIndexType i) const

virtual NeighborIndexType	GetNeighborhoodIndex (const OffsetType &) const

NeighborIndexType	GetCenterNeighborhoodIndex () const

std::slice	GetSlice (unsigned int) const

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

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.

Note: ForwardDifferenceOperator 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:

All ITK Sphinx Examples

Create Forward Difference Kernel

Examples: SphinxExamples/src/Core/Common/CreateForwardDifferenceKernel/Code.cxx, and SphinxExamples/src/Core/Common/DemonstrateAllOperators/Code.cxx.

Definition at line 47 of file itkForwardDifferenceOperator.h.