ITK  4.8.0
Insight Segmentation and Registration Toolkit
Public Types | Public Member Functions | Protected Types | Protected Member Functions | Private Member Functions | List of all members
itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator > Class Template Reference

#include <itkBackwardDifferenceOperator.h>

+ Inheritance diagram for itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >:
+ Collaboration diagram for itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >:

Detailed Description

template<typename TPixel, unsigned int TDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
class itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >

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

BackwardDifferenceOperator uses backward differences i.e. F(x) - F(x-1) 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:
Examples:
SphinxExamples/src/Core/Common/CreateABackwardDifferenceOperator/Code.cxx, and WikiExamples/Operators/BackwardDifferenceOperator.cxx.

Definition at line 46 of file itkBackwardDifferenceOperator.h.

Public Types

typedef Superclass::PixelType PixelType
 
typedef BackwardDifferenceOperator Self
 
typedef NeighborhoodOperator
< TPixel, TDimension,
TAllocator > 
Superclass
 
- Public Types inherited from itk::NeighborhoodOperator< TPixel, TDimension, 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

 BackwardDifferenceOperator ()
 
- Public Member Functions inherited from itk::NeighborhoodOperator< TPixel, TDimension, 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)
 
Selfoperator= (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
 
Selfoperator= (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)
 
AllocatorTypeGetBufferReference ()
 
const AllocatorTypeGetBufferReference () 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, TDimension, TAllocator >
typedef std::vector
< PixelRealType
CoefficientVector
 

Protected Member Functions

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

Private Member Functions

 BackwardDifferenceOperator (const Self &other)
 
Selfoperator= (const Self &other)
 

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 TDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef Superclass::CoefficientVector itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >::CoefficientVector
protected

Necessary to work around a compiler bug in VC++.

Definition at line 63 of file itkBackwardDifferenceOperator.h.

template<typename TPixel , unsigned int TDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef Superclass::PixelType itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >::PixelType

From Superclass

Definition at line 56 of file itkBackwardDifferenceOperator.h.

template<typename TPixel , unsigned int TDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef BackwardDifferenceOperator itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >::Self

Standard class typedefs.

Definition at line 52 of file itkBackwardDifferenceOperator.h.

template<typename TPixel , unsigned int TDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef NeighborhoodOperator< TPixel, TDimension, TAllocator > itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >::Superclass

Definition at line 53 of file itkBackwardDifferenceOperator.h.

Constructor & Destructor Documentation

template<typename TPixel , unsigned int TDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >::BackwardDifferenceOperator ( )
inline

Constructor.

Definition at line 59 of file itkBackwardDifferenceOperator.h.

template<typename TPixel , unsigned int TDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >::BackwardDifferenceOperator ( const Self other)
private

Member Function Documentation

template<typename TPixel , unsigned int TDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
void itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >::Fill ( const CoefficientVector coeff)
inlineprotectedvirtual
template<typename TPixel , unsigned int TDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
CoefficientVector itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >::GenerateCoefficients ( )
protectedvirtual

Calculates operator coefficients.

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

template<typename TPixel , unsigned int TDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
Self& itk::BackwardDifferenceOperator< TPixel, TDimension, TAllocator >::operator= ( const Self other)
private

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