Orfeo Toolbox  4.0
Public Types | Public Member Functions | Public Attributes | Static Public Attributes | Protected Types | Protected Member Functions | Private Attributes | List of all members
itk::NeighborhoodOperator< TPixel, VDimension, TAllocator > Class Template Referenceabstract

Virtual class that defines a common interface to all neighborhood operator subtypes. More...

#include <itkNeighborhoodOperator.h>

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

Public Types

typedef TAllocator AllocatorType
 
typedef
AllocatorType::const_iterator 
ConstIterator
 
typedef unsigned int DimensionValueType
 
typedef AllocatorType::iterator Iterator
 
typedef SizeValueType NeighborIndexType
 
typedef Offset< VDimension > OffsetType
 
typedef NumericTraits< TPixel >
::RealType 
PixelRealType
 
typedef TPixel PixelType
 
typedef NeighborhoodOperator Self
 
typedef Superclass::SizeType SizeType
 
typedef SizeType::SizeValueType SizeValueType
 
typedef SliceIterator< TPixel,
Self
SliceIteratorType
 
typedef Neighborhood< TPixel,
VDimension, TAllocator > 
Superclass
 

Public Member Functions

 NeighborhoodOperator ()
 
 NeighborhoodOperator (const Self &orig)
 
Iterator Begin ()
 
ConstIterator Begin () const
 
virtual void CreateDirectional ()
 
virtual void CreateToRadius (const SizeType &)
 
virtual void CreateToRadius (const SizeValueType)
 
Iterator End ()
 
ConstIterator End () const
 
virtual void FlipAxes ()
 
AllocatorTypeGetBufferReference ()
 
const AllocatorTypeGetBufferReference () const
 
NeighborIndexType GetCenterNeighborhoodIndex () const
 
TPixel GetCenterValue () const
 
unsigned long GetDirection () const
 
TPixel & GetElement (NeighborIndexType i)
 
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
 
bool operator!= (const Self &other) const
 
Selfoperator= (const Self &orig)
 
bool operator== (const Self &other) const
 
TPixel & operator[] (NeighborIndexType i)
 
const TPixel & operator[] (NeighborIndexType i) const
 
TPixel & operator[] (const OffsetType &o)
 
const TPixel & operator[] (const OffsetType &o) const
 
void Print (std::ostream &os) const
 
virtual void PrintSelf (std::ostream &os, Indent i) const
 
void ScaleCoefficients (PixelRealType)
 
void SetDirection (const unsigned long &direction)
 
void SetRadius (const SizeType &)
 
void SetRadius (const SizeValueType *rad)
 
void SetRadius (const SizeValueType)
 
NeighborIndexType Size () const
 

Public Attributes

typedef::itk::Size< VDimension > RadiusType
 

Static Public Attributes

static const unsigned int NeighborhoodDimension = VDimension
 

Protected Types

typedef std::vector
< PixelRealType
CoefficientVector
 

Protected Member Functions

virtual void Allocate (NeighborIndexType i)
 
virtual void ComputeNeighborhoodOffsetTable ()
 
virtual void ComputeNeighborhoodStrideTable ()
 
virtual void Fill (const CoefficientVector &)=0
 
virtual void FillCenteredDirectional (const CoefficientVector &)
 
virtual CoefficientVector GenerateCoefficients ()=0
 
void InitializeToZero ()
 
void SetSize ()
 

Private Attributes

unsigned long m_Direction
 

Detailed Description

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

Virtual class that defines a common interface to all neighborhood operator subtypes.

A NeighborhoodOperator is a set of pixel values that can be applied to a Neighborhood to perform a user-defined operation (i.e. convolution kernel, morphological structuring element). A NeighborhoodOperator is itself a specialized Neighborhood, with functionality to generate its coefficients according to user-defined parameters. Because the operator is a subclass of Neighborhood, it is a valid operand in any of the operations defined on the Neighborhood object (convolution, inner product, etc.).

NeighborhoodOperator is a pure virtual object that must be subclassed to be used. A user's subclass must implement two methods:

(1) GenerateCoefficients – the algorithm that computes the scalar coefficients of the operator.

(2) Fill – the algorithm that places the scalar coefficients into the memory buffer of the operator (arranges them spatially in the neighborhood).

NeighborhoodOperator supports the concept of a "directional operator." A directional operator is defined in this context to be an operator that is applied along a single dimension. Examples of this type of operator are directional derivatives and the individual, directional components of separable processes such as Gaussian smoothing.

How a NeighborhoodOperator is applied to data is up to the user who defines it. One possible use of an operator would be to take its inner product with a neighborhood of values to produce a scalar result. This process effects convolution when applied to successive neighborhoods across a region of interest in an image.

Definition at line 66 of file itkNeighborhoodOperator.h.

Member Typedef Documentation

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef TAllocator itk::Neighborhood< TPixel, VDimension, TAllocator >::AllocatorType
inherited

External support for allocator type.

Definition at line 62 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef std::vector< PixelRealType > itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CoefficientVector
protected

Typedef support for coefficient vector type. Necessary to fix bug in the microsoft VC++ compiler.

Definition at line 147 of file itkNeighborhoodOperator.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef AllocatorType::const_iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::ConstIterator
inherited

Definition at line 74 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef unsigned int itk::Neighborhood< TPixel, VDimension, TAllocator >::DimensionValueType
inherited

Type used to refer to space dimensions

Definition at line 90 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef AllocatorType::iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Iterator
inherited

Iterator typedef support. Note the naming is intentional, i.e., AllocatorType::iterator and AllocatorType::const_iterator, because the allocator may be a vnl object or other type, which uses this form.

Definition at line 73 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef SizeValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::NeighborIndexType
inherited

Type used to refer to the elements of the pixel list that are part of the neighborhood.

Definition at line 94 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef Offset< VDimension > itk::Neighborhood< TPixel, VDimension, TAllocator >::OffsetType
inherited

Offset type used to reference neighbor locations

Definition at line 84 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef NumericTraits< TPixel >::RealType itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::PixelRealType

Definition at line 138 of file itkNeighborhoodOperator.h.

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef TPixel itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::PixelType

External support for pixel type

Definition at line 78 of file itkNeighborhoodOperator.h.

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef NeighborhoodOperator itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::Self

Standard class typedefs.

Definition at line 71 of file itkNeighborhoodOperator.h.

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef Superclass::SizeType itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::SizeType

Size object typedef support

Definition at line 75 of file itkNeighborhoodOperator.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef SizeType::SizeValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::SizeValueType
inherited

Definition at line 78 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef SliceIterator< TPixel, Self > itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::SliceIteratorType

Slice iterator typedef support

Definition at line 81 of file itkNeighborhoodOperator.h.

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef Neighborhood< TPixel, VDimension, TAllocator > itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::Superclass

Definition at line 72 of file itkNeighborhoodOperator.h.

Constructor & Destructor Documentation

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::NeighborhoodOperator ( )
inline

Constructor.

Definition at line 84 of file itkNeighborhoodOperator.h.

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

Copy constructor

Definition at line 88 of file itkNeighborhoodOperator.h.

Member Function Documentation

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
virtual void itk::Neighborhood< TPixel, VDimension, TAllocator >::Allocate ( NeighborIndexType  i)
inlineprotectedvirtualinherited

Allocates the neighborhood's memory buffer.

Definition at line 244 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
Iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( void  )
inlineinherited
template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( void  ) const
inlineinherited

Definition at line 164 of file itkNeighborhood.h.

template<typename TPixel , unsigned int VDimension, typename TContainer >
void itk::Neighborhood< TPixel, VDimension, TContainer >::ComputeNeighborhoodOffsetTable ( )
protectedvirtualinherited

Fills entries into the offset lookup table. Called once on initialization.

Definition at line 48 of file itkNeighborhood.hxx.

template<typename TPixel , unsigned int VDimension, typename TContainer >
void itk::Neighborhood< TPixel, VDimension, TContainer >::ComputeNeighborhoodStrideTable ( )
protectedvirtualinherited

Computes the entries for the stride table

Definition at line 29 of file itkNeighborhood.hxx.

template<typename TPixel , unsigned int VDimension, typename TAllocator >
void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateDirectional ( )
virtual
template<typename TPixel , unsigned int VDimension, typename TAllocator >
void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateToRadius ( const SizeType sz)
virtual

Creates the operator with a specified radius. The spatial location of the coefficients within the operator is defined by the subclass implementation of the Fill method.

See Also
CreateDirectional
Fill

Definition at line 85 of file itkNeighborhoodOperator.hxx.

Referenced by itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >::CreateDirectional().

template<typename TPixel , unsigned int VDimension, typename TAllocator >
void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateToRadius ( const SizeValueType  sz)
virtual

Creates the operator with a specified radius ("square", same length on each side). The spatial location of the coefficients within the operator is defined by the subclass implementation of the Fill method.

See Also
CreateDirectional
Fill

Definition at line 97 of file itkNeighborhoodOperator.hxx.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
Iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::End ( void  )
inlineinherited
template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::End ( void  ) const
inlineinherited

Definition at line 162 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
virtual void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::Fill ( const CoefficientVector )
protectedpure virtual
template<typename TPixel , unsigned int VDimension, typename TAllocator >
void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::FillCenteredDirectional ( const CoefficientVector coeff)
protectedvirtual

A pre-defined Fill function that can be called by a subclass Fill function to center coefficients along the axis specified by the SetDirection method. Useful for creating directional operators, or centering coefficients in an N-dimensional neighborhood.

Definition at line 111 of file itkNeighborhoodOperator.hxx.

References itk::SliceIterator< TPixel, TContainer >::Begin(), and itk::SliceIterator< TPixel, TContainer >::End().

Referenced by itk::ForwardDifferenceOperator< TPixel, VDimension, TAllocator >::Fill(), itk::DerivativeOperator< PixelType, itkGetStaticConstMacro(ImageDimension) >::Fill(), and itk::GaussianOperator< ScalarType, Superclass::Dimension >::Fill().

template<typename TPixel , unsigned int VDimension, typename TAllocator >
void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::FlipAxes ( )
virtual

Reverses the direction of all axes of the operator by reversing the order of the coefficients.

Definition at line 40 of file itkNeighborhoodOperator.hxx.

Referenced by itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateData(), and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::ThreadedGenerateData().

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
virtual CoefficientVector itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::GenerateCoefficients ( )
protectedpure virtual
template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
AllocatorType& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetBufferReference ( )
inlineinherited

Returns a reference to the data buffer structure.

Definition at line 208 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
const AllocatorType& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetBufferReference ( ) const
inlineinherited

Definition at line 210 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
NeighborIndexType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetCenterNeighborhoodIndex ( ) const
inlineinherited
template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
TPixel itk::Neighborhood< TPixel, VDimension, TAllocator >::GetCenterValue ( ) const
inlineinherited

Returns the element at the center of the neighborhood.

Definition at line 180 of file itkNeighborhood.h.

Referenced by itk::MRFImageFilter< TInputImage, TClassifiedImage >::DoNeighborhoodOperation().

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
unsigned long itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::GetDirection ( ) const
inline

Returns the direction (dimension number) of a directional operator.

Definition at line 105 of file itkNeighborhoodOperator.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetElement ( NeighborIndexType  i)
inlineinherited

Definition at line 176 of file itkNeighborhood.h.

template<typename TPixel , unsigned int VDimension, typename TContainer >
Neighborhood< TPixel, VDimension, TContainer >::NeighborIndexType itk::Neighborhood< TPixel, VDimension, TContainer >::GetNeighborhoodIndex ( const OffsetType o) const
virtualinherited
template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
OffsetType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetOffset ( NeighborIndexType  i) const
inlineinherited
template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
const SizeType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius ( ) const
inlineinherited

Returns the radius of the neighborhood.

Definition at line 134 of file itkNeighborhood.h.

Referenced by itk::FlatStructuringElement< VDimension >::Annulus(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::AssignOrientation(), itk::FlatStructuringElement< VDimension >::Ball(), itk::VectorAnisotropicDiffusionFunction< TImage >::CalculateAverageGradientMagnitudeSquared(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::ComputeDescriptor(), otb::NCCRegistrationFunction< TFixedImage, TMovingImage, TDisplacementField >::ComputeUpdate(), itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >::CreateActiveListFromNeighborhood(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::LaplacianSharpeningImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::LaplacianImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::SobelEdgeDetectionImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::GenerateInputRequestedRegion(), itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::ThreadedGenerateData().

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
SizeValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius ( DimensionValueType  n) const
inlineinherited

Returns the radius of the neighborhood along a specified dimension.

Definition at line 139 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
SizeValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSize ( DimensionValueType  n) const
inlineinherited
template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
SizeType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSize ( void  ) const
inlineinherited

Returns the size (total length of sides) of the neighborhood.

Definition at line 148 of file itkNeighborhood.h.

template<typename TPixel , unsigned int VDimension, typename TContainer >
std::slice itk::Neighborhood< TPixel, VDimension, TContainer >::GetSlice ( unsigned int  d) const
inherited

Definition at line 140 of file itkNeighborhood.hxx.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
OffsetValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetStride ( DimensionValueType  axis) const
inlineinherited

Returns the stride length for the specified dimension. Stride length is the number of pixels between adjacent pixels along the given dimension.

Definition at line 154 of file itkNeighborhood.h.

Referenced by itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::CannyEdgeDetectionImageFilter(), itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::ComputeCurvature(), itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >::ComputeCurvatureFromSparseImageNeighborhood(), itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold(), itk::CurvatureFlowFunction< TImage >::ComputeUpdate(), itk::CurvatureNDAnisotropicDiffusionFunction< TImage >::CurvatureNDAnisotropicDiffusionFunction(), itk::GPUGradientNDAnisotropicDiffusionFunction< TImage >::GPUGradientNDAnisotropicDiffusionFunction(), itk::GradientNDAnisotropicDiffusionFunction< TImage >::GradientNDAnisotropicDiffusionFunction(), itk::LevelSetFunction< TImageType >::Initialize(), itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::InitializeNormalBandNode(), itk::PeriodicBoundaryCondition< TInputImage, TOutputImage >::operator()(), itk::ZeroFluxNeumannBoundaryCondition< TInputImage, TOutputImage >::operator()(), itk::NormalVectorDiffusionFunction< TSparseImageType >::PrecomputeSparseUpdate(), itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::VectorCurvatureNDAnisotropicDiffusionFunction(), and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::VectorGradientNDAnisotropicDiffusionFunction().

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::InitializeToZero ( )
inlineprotected

Initializes all the coefficients in the neighborhood to zero values

Definition at line 165 of file itkNeighborhoodOperator.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
bool itk::Neighborhood< TPixel, VDimension, TAllocator >::operator!= ( const Self other) const
inlineinherited

Not Equal operator.

Definition at line 126 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
Self& itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::operator= ( const Self orig)
inline
template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
bool itk::Neighborhood< TPixel, VDimension, TAllocator >::operator== ( const Self other) const
inlineinherited

Comparison operator.

Definition at line 118 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( NeighborIndexType  i)
inlineinherited

Pass-through data access methods to the buffer.

Definition at line 172 of file itkNeighborhood.h.

Referenced by itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >::InitializeToZero().

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
const TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( NeighborIndexType  i) const
inlineinherited

Definition at line 174 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( const OffsetType o)
inlineinherited

Get pixel value by offset

Definition at line 214 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< char, TImage::ImageDimension >::operator[]().

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
const TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( const OffsetType o) const
inlineinherited
template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::Print ( std::ostream &  os) const
inlineinherited

Standard itk object method.

Definition at line 204 of file itkNeighborhood.h.

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

Prints some debugging information.

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

Reimplemented in itk::AnnulusOperator< TPixel, TDimension, TAllocator >, itk::GaussianOperator< TPixel, VDimension, TAllocator >, itk::GaussianOperator< ScalarType, NDimensions >, itk::GaussianOperator< ScalarType, Superclass::Dimension >, itk::SobelOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< FixedGradientPixelType, itkGetStaticConstMacro(FixedImageDimension) >, itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >, otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >, itk::DerivativeOperator< TPixel, VDimension, TAllocator >, itk::DerivativeOperator< ScalarValueType, itkGetStaticConstMacro(ImageDimension) >, itk::DerivativeOperator< OutputImagePixelType, itkGetStaticConstMacro(ImageDimension) >, itk::DerivativeOperator< PixelType, itkGetStaticConstMacro(ImageDimension) >, itk::LaplacianOperator< TPixel, VDimension, TAllocator >, itk::ImageKernelOperator< TPixel, VDimension, TAllocator >, otb::WaveletHighPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >, and otb::WaveletLowPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >.

Definition at line 131 of file itkNeighborhoodOperator.h.

Referenced by itk::ImageKernelOperator< TPixel, VDimension, TAllocator >::PrintSelf(), itk::LaplacianOperator< TPixel, VDimension, TAllocator >::PrintSelf(), itk::DerivativeOperator< PixelType, itkGetStaticConstMacro(ImageDimension) >::PrintSelf(), itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >::PrintSelf(), and itk::GaussianOperator< ScalarType, Superclass::Dimension >::PrintSelf().

template<typename TPixel , unsigned int VDimension, typename TAllocator >
void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::ScaleCoefficients ( PixelRealType  s)
template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::SetDirection ( const unsigned long &  direction)
inline
template<typename TPixel , unsigned int VDimension, typename TContainer >
void itk::Neighborhood< TPixel, VDimension, TContainer >::SetRadius ( const SizeType r)
inherited

Sets the radius for the neighborhood, calculates size from the radius, and allocates storage.

Definition at line 91 of file itkNeighborhood.hxx.

Referenced by itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::AnalyzeKernel(), itk::FlatStructuringElement< VDimension >::Annulus(), itk::FlatStructuringElement< VDimension >::Ball(), itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >::BinaryCrossStructuringElement(), itk::FlatStructuringElement< VDimension >::Box(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::CannyEdgeDetectionImageFilter(), itk::MaskFeaturePointSelectionFilter< TImage, TMask, TFeatures >::ComputeConnectivityOffsets(), itk::FlatStructuringElement< VDimension >::Cross(), itk::CurvatureNDAnisotropicDiffusionFunction< TImage >::CurvatureNDAnisotropicDiffusionFunction(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeighborhood(), itk::GPUGradientNDAnisotropicDiffusionFunction< TImage >::GPUGradientNDAnisotropicDiffusionFunction(), itk::GradientNDAnisotropicDiffusionFunction< TImage >::GradientNDAnisotropicDiffusionFunction(), itk::LevelSetFunction< TImageType >::Initialize(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), otb::ScalarImageToHigherOrderTexturesFilter< TInpuImage, TOutputImage >::ScalarImageToHigherOrderTexturesFilter(), itk::Statistics::ScalarImageToRunLengthFeaturesFilter< TImageType, THistogramFrequencyContainer >::ScalarImageToRunLengthFeaturesFilter(), itk::Statistics::ScalarImageToTextureFeaturesFilter< TImageType, THistogramFrequencyContainer >::ScalarImageToTextureFeaturesFilter(), itk::Neighborhood< char, TImage::ImageDimension >::SetRadius(), itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::VectorCurvatureNDAnisotropicDiffusionFunction(), and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::VectorGradientNDAnisotropicDiffusionFunction().

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius ( const SizeValueType rad)
inlineinherited

Sets the radius for the neighborhood. Overloaded to support an unsigned long array.

Definition at line 189 of file itkNeighborhood.h.

template<typename TPixel , unsigned int VDimension, typename TContainer >
void itk::Neighborhood< TPixel, VDimension, TContainer >::SetRadius ( const SizeValueType  s)
inherited

Overloads SetRadius to allow a single long integer argument that is used as the radius of all the dimensions of the Neighborhood (resulting in a "square" neighborhood).

Definition at line 77 of file itkNeighborhood.hxx.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetSize ( )
inlineprotectedinherited

Sets the length along each dimension.

Definition at line 235 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
NeighborIndexType itk::Neighborhood< TPixel, VDimension, TAllocator >::Size ( void  ) const
inlineinherited

More STL-style support.

Definition at line 168 of file itkNeighborhood.h.

Referenced by itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::AnalyzeKernel(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::AssignOrientation(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::CannyEdgeDetectionImageFilter(), itk::MaskFeaturePointSelectionFilter< TImage, TMask, TFeatures >::ComputeConnectivityOffsets(), itk::LevelSetFunctionWithRefitTerm< TImageType, TSparseImageType >::ComputeCurvature(), itk::SparseFieldFourthOrderLevelSetImageFilter< TInputImage, TOutputImage >::ComputeCurvatureFromSparseImageNeighborhood(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::ComputeDescriptor(), itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold(), itk::CurvatureFlowFunction< TImage >::ComputeUpdate(), itk::CurvatureNDAnisotropicDiffusionFunction< TImage >::CurvatureNDAnisotropicDiffusionFunction(), otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >::FillWeightOffsetTable(), itk::Neighborhood< char, TImage::ImageDimension >::GetCenterNeighborhoodIndex(), itk::Neighborhood< char, TImage::ImageDimension >::GetCenterValue(), otb::MRFEnergy< TInput1, TInput2 >::GetValue(), otb::MRFEnergy< TInput2, TInput2 >::GetValue(), itk::GPUGradientNDAnisotropicDiffusionFunction< TImage >::GPUGradientNDAnisotropicDiffusionFunction(), itk::GradientNDAnisotropicDiffusionFunction< TImage >::GradientNDAnisotropicDiffusionFunction(), itk::LevelSetFunction< TImageType >::Initialize(), itk::SparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InitializeActiveLayerValues(), itk::ParallelSparseFieldLevelSetImageFilter< TInputImage, TOutputImage >::InitializeActiveLayerValues(), itk::ImplicitManifoldNormalVectorFilter< TInputImage, TSparseOutputImage >::InitializeNormalBandNode(), itk::ANTSNeighborhoodCorrelationImageToImageMetricv4GetValueAndDerivativeThreader< TDomainPartitioner, TImageToImageMetric, TNeighborhoodCorrelationMetric >::InitializeScanning(), itk::NeighborhoodOperator< TPixel, TDimension, TAllocator >::InitializeToZero(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::IsLocalExtremum(), otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::IsLocalExtremumAround(), otb::Functor::SSDBlockMatching< TInputImage, TOutputMetricImage >::operator()(), itk::NeighborhoodInnerProduct< ImageType >::operator()(), itk::VectorNeighborhoodInnerProduct< ImageType >::operator()(), otb::Functor::SSDDivMeanBlockMatching< TInputImage, TOutputMetricImage >::operator()(), otb::Functor::NCCBlockMatching< TInputImage, TOutputMetricImage >::operator()(), otb::Functor::LPBlockMatching< TInputImage, TOutputMetricImage >::operator()(), itk::NormalVectorDiffusionFunction< TSparseImageType >::PrecomputeSparseUpdate(), itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >::SetInputImage(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType, TOutputImageType >::ThreadedGenerateData(), itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::VectorCurvatureNDAnisotropicDiffusionFunction(), and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::VectorGradientNDAnisotropicDiffusionFunction().

Member Data Documentation

template<typename TPixel, unsigned int VDimension, typename TAllocator = NeighborhoodAllocator< TPixel >>
unsigned long itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::m_Direction
private
template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
const unsigned int itk::Neighborhood< TPixel, VDimension, TAllocator >::NeighborhoodDimension = VDimension
staticinherited

External support for dimensionality.

Definition at line 65 of file itkNeighborhood.h.

template<typename TPixel, unsigned int VDimension = 2, typename TAllocator = NeighborhoodAllocator< TPixel >>
typedef::itk::Size< VDimension > itk::Neighborhood< TPixel, VDimension, TAllocator >::RadiusType
inherited

Radius typedef support.

Definition at line 81 of file itkNeighborhood.h.


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

Generated at Sat Mar 8 2014 17:31:54 for Orfeo Toolbox with doxygen 1.8.3.1