A NeighborhoodOperator wavelet base class. More...

#include <otbWaveletOperatorBase.h>

Inheritance diagram for otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >:

Collaboration diagram for otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >:

Public Types
typedef TAllocator	AllocatorType
typedef AllocatorType::const_iterator	ConstIterator
typedef AllocatorType::iterator	Iterator
typedef Wavelet::Wavelet	MotherWaveletOperatorEnumType
typedef Offset< VDimension >	OffsetType
typedef NumericTraits< TPixel > ::RealType	PixelRealType
typedef ::itk::Size< VDimension >	RadiusType
typedef WaveletOperatorBase	Self
typedef Superclass::SizeType	SizeType
typedef SizeType::SizeValueType	SizeValueType
typedef SliceIterator< TPixel, Self >	SliceIteratorType
typedef itk::NeighborhoodOperator < TPixel, VDimension, TAllocator >	Superclass

Public Member Functions
	WaveletOperatorBase ()
	WaveletOperatorBase (const Self &other)
virtual	~WaveletOperatorBase ()
Iterator	Begin ()
ConstIterator	Begin () const
virtual void	CreateDirectional ()
virtual void	CreateToRadius (const SizeType &)
virtual void	CreateToRadius (const unsigned long)
Iterator	End ()
ConstIterator	End () const
virtual void	FlipAxes ()
AllocatorType &	GetBufferReference ()
const AllocatorType &	GetBufferReference () const
unsigned int	GetCenterNeighborhoodIndex () const
TPixel	GetCenterValue () const
unsigned long	GetDirection () const
TPixel &	GetElement (unsigned int i)
virtual const char *	GetNameOfClass () const
virtual unsigned int	GetNeighborhoodIndex (const OffsetType &) const
OffsetType	GetOffset (unsigned int i) const
const SizeType	GetRadius () const
unsigned long	GetRadius (const unsigned long n) const
unsigned long	GetSize (const unsigned long n) const
SizeType	GetSize () const
std::slice	GetSlice (unsigned int) const
unsigned	GetStride (const unsigned axis) const
unsigned int	GetUpSampleFactor () const
virtual const char *	GetWaveletName () const
bool	operator!= (const Self &other) const
Self &	operator= (const Self &other)
bool	operator== (const Self &other) const
TPixel &	operator[] (unsigned int i)
const TPixel &	operator[] (unsigned int i) const
TPixel &	operator[] (const OffsetType &o)
const TPixel &	operator[] (const OffsetType &o) const
void	Print (std::ostream &os) const
void	ScaleCoefficients (PixelRealType)
void	SetDirection (const unsigned long &direction)
void	SetRadius (const SizeType &)
void	SetRadius (const unsigned long *rad)
void	SetRadius (const unsigned long)
void	SetUpSampleFactor (unsigned int upSampleFactor)
unsigned int	Size () const

Static Public Attributes
static const MotherWaveletOperatorEnumType	MotherWaveletOperator = TMotherWaveletOperator
static const unsigned int	NeighborhoodDimension = VDimension

Protected Types
typedef Superclass::CoefficientVector	CoefficientVector
typedef Superclass::PixelType	PixelType
typedef WaveletGeneratorType::Pointer	WaveletGeneratorPointerType
typedef WaveletGenerator < TMotherWaveletOperator >	WaveletGeneratorType

Protected Member Functions
virtual void	Allocate (unsigned int i)
virtual void	ComputeNeighborhoodOffsetTable ()
virtual void	ComputeNeighborhoodStrideTable ()
void	Fill (const CoefficientVector &coeff)
virtual void	FillCenteredDirectional (const CoefficientVector &)
virtual CoefficientVector	GenerateCoefficients ()=0
void	GenerateInverseHighPassFilterFromLowPassFilter (CoefficientVector &coeff)
void	GenerateInverseLowPassFilterFromHighPassFilter (CoefficientVector &coeff)
void	InitializeToZero ()
virtual void	PrintSelf (std::ostream &os, itk::Indent i) const
void	ReduceFilterLength (CoefficientVector &coeff)
void	RevertFilter (CoefficientVector &coeff)
void	SetSize ()
void	UpSamplingCoefficients (CoefficientVector &coeff)

Protected Attributes
unsigned int	m_UpSampleFactor
WaveletGeneratorPointerType	m_WaveletGenerator

Detailed Description

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel, unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>
class otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >

A NeighborhoodOperator wavelet base class.

This class is the mother class for any wavelet operator that requires "a-trou" approach for shift-invariant wavelet transform. This class has to be derived, it cannot be used directly since GenerateCoefficients() method is still pure virtual.

Any wavelet operator that inherits from this WaveletOperatorBase is to be used as a NeighborhoodOperator that should be applied to a NeighborhoodIterator using the NeighborhoodInnerProduct method.

It is assumed that any wavelet definition is directional.

Set the level of up-sampling though SetUpSampleFactor() before calling CreateDirectional(). Each class that inherits from WaveletOperatorBase has to re-implement GenerateCoefficients().

The name of the wavelet is defined here but left pure virtual. It is defined with the LowPass and HighPass inheritance.

See also:: WaveletLowPassOperator; WaveletHighPassOperator; NeighborhoodOperator; Neighborhood

Definition at line 70 of file otbWaveletOperatorBase.h.

Member Typedef Documentation

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

typedef TAllocator itk::Neighborhood< TPixel, VDimension, TAllocator >::AllocatorType

inherited

External support for allocator type.

Reimplemented in itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >, and itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >.

Definition at line 63 of file itkNeighborhood.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

typedef Superclass::CoefficientVector otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::CoefficientVector

protected

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

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

Reimplemented in otb::WaveletHighPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >, and otb::WaveletLowPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >.

Definition at line 146 of file otbWaveletOperatorBase.h.

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

typedef AllocatorType::const_iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::ConstIterator

inherited

Definition at line 75 of file itkNeighborhood.h.

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

typedef AllocatorType::iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Iterator

inherited

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

Definition at line 74 of file itkNeighborhood.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

typedef Wavelet::Wavelet otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::MotherWaveletOperatorEnumType

Definition at line 81 of file otbWaveletOperatorBase.h.

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

typedef Offset<VDimension> itk::Neighborhood< TPixel, VDimension, TAllocator >::OffsetType

inherited

Offset type used to reference neighbor locations

Definition at line 85 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef NumericTraits< TPixel >::RealType itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::PixelRealType

inherited

Reimplemented in itk::DerivativeOperator< TPixel, VDimension, TAllocator >, itk::DerivativeOperator< ScalarValueType, itkGetStaticConstMacro(ImageDimension)>, itk::DerivativeOperator< OutputImagePixelType, itkGetStaticConstMacro(ImageDimension)>, and itk::DerivativeOperator< PixelType, itkGetStaticConstMacro(ImageDimension)>.

Definition at line 136 of file itkNeighborhoodOperator.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

typedef Superclass::PixelType otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::PixelType

protected

External support for pixel type

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

Reimplemented in otb::WaveletHighPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >, and otb::WaveletLowPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >.

Definition at line 147 of file otbWaveletOperatorBase.h.

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

typedef ::itk::Size<VDimension> itk::Neighborhood< TPixel, VDimension, TAllocator >::RadiusType

inherited

Radius typedef support.

Definition at line 82 of file itkNeighborhood.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

typedef WaveletOperatorBase otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::Self

Standard typedefs

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

Reimplemented in otb::WaveletHighPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >, and otb::WaveletLowPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >.

Definition at line 75 of file otbWaveletOperatorBase.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

typedef Superclass::SizeType otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::SizeType

Size object typedef support

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

Reimplemented in otb::WaveletHighPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >, and otb::WaveletLowPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >.

Definition at line 78 of file otbWaveletOperatorBase.h.

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

typedef SizeType::SizeValueType itk::Neighborhood< TPixel, VDimension, TAllocator >::SizeValueType

inherited

Definition at line 79 of file itkNeighborhood.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

typedef SliceIterator<TPixel, Self> itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::SliceIteratorType

inherited

Slice iterator typedef support

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

Definition at line 79 of file itkNeighborhoodOperator.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

typedef itk::NeighborhoodOperator<TPixel, VDimension, TAllocator> otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::Superclass

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

Reimplemented in otb::WaveletHighPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >, and otb::WaveletLowPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >.

Definition at line 76 of file otbWaveletOperatorBase.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

typedef WaveletGeneratorType::Pointer otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::WaveletGeneratorPointerType

protected

Definition at line 140 of file otbWaveletOperatorBase.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

typedef WaveletGenerator<TMotherWaveletOperator> otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::WaveletGeneratorType

protected

Definition at line 139 of file otbWaveletOperatorBase.h.

Constructor & Destructor Documentation

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::WaveletOperatorBase ( )

inline

Construction

Definition at line 85 of file otbWaveletOperatorBase.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::WaveletOperatorBase ( const Self & other )

inline

Construction by copy

Definition at line 92 of file otbWaveletOperatorBase.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

virtual otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::~WaveletOperatorBase ( )

inlinevirtual

Definition at line 99 of file otbWaveletOperatorBase.h.

Member Function Documentation

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

virtual void itk::Neighborhood< TPixel, VDimension, TAllocator >::Allocate ( unsigned int i )

inlineprotectedvirtualinherited

Allocates the neighborhood's memory buffer.

Definition at line 236 of file itkNeighborhood.h.

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

Iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( void )

inlineinherited

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 154 of file itkNeighborhood.h.

Referenced by itk::FlatStructuringElement< VDimension >::Annulus(), itk::FlatStructuringElement< VDimension >::Ball(), itk::FlatStructuringElement< VDimension >::Box(), itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold(), itk::FlatStructuringElement< VDimension >::Cross(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeighborhood(), itk::VectorNeighborhoodInnerProduct< TImage >::operator()(), itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::operator()(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), and itk::NeighborhoodIterator< TImage, TBoundaryCondition >::SetNeighborhood().

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

ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::Begin ( void ) const

inlineinherited

Reimplemented in itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.

Definition at line 158 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >

void itk::Neighborhood< TPixel, VDimension, TContainer >::ComputeNeighborhoodOffsetTable ( )

protectedvirtualinherited

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

Definition at line 49 of file itkNeighborhood.txx.

template<class TPixel , unsigned int VDimension, class TContainer >

void itk::Neighborhood< TPixel, VDimension, TContainer >::ComputeNeighborhoodStrideTable ( )

protectedvirtualinherited

Computes the entries for the stride table

Definition at line 28 of file itkNeighborhood.txx.

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateDirectional ( )

virtualinherited

Creates the operator with length only in the specified direction. The radius of the operator will be 0 except along the axis on which the operator will work.

See also:: CreateToRadius; FillCenteredDirectional; SetDirection(); GetDirection()

Reimplemented in itk::SobelOperator< TPixel, VDimension, TAllocator >, itk::SobelOperator< FixedGradientPixelType, itkGetStaticConstMacro(FixedImageDimension) >, and itk::SobelOperator< MovedGradientPixelType, itkGetStaticConstMacro(MovedImageDimension) >.

Definition at line 59 of file itkNeighborhoodOperator.txx.

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateToRadius ( const SizeType & sz )

virtualinherited

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 83 of file itkNeighborhoodOperator.txx.

Referenced by itk::ConvolutionImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData().

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::CreateToRadius ( const unsigned long sz )

virtualinherited

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 94 of file itkNeighborhoodOperator.txx.

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

Iterator itk::Neighborhood< TPixel, VDimension, TAllocator >::End ( void )

inlineinherited

STL-style iterator support.

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ShapedNeighborhoodIterator< ImageType >.

Definition at line 152 of file itkNeighborhood.h.

Referenced by itk::FlatStructuringElement< VDimension >::Box(), itk::MinMaxCurvatureFlowFunction< TImage >::ComputeThreshold(), itk::FlatStructuringElement< VDimension >::Cross(), itk::VectorNeighborhoodInnerProduct< TImage >::operator()(), itk::NeighborhoodInnerProduct< TImage, TOperator, TComputation >::operator()(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), and itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel().

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

ConstIterator itk::Neighborhood< TPixel, VDimension, TAllocator >::End ( void ) const

inlineinherited

Reimplemented in itk::ShapedNeighborhoodIterator< TImage, TBoundaryCondition >, itk::ShapedNeighborhoodIterator< ImageType >, itk::ConstShapedNeighborhoodIterator< TImage, TBoundaryCondition >, and itk::ConstShapedNeighborhoodIterator< ImageType, ZeroFluxNeumannBoundaryCondition< ImageType > >.

Definition at line 156 of file itkNeighborhood.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

void otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::Fill ( const CoefficientVector & coeff )

inlineprotectedvirtual

Arranges coefficients spatially in the memory buffer.

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

Definition at line 186 of file otbWaveletOperatorBase.h.

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::FillCenteredDirectional ( const CoefficientVector & coeff )

protectedvirtualinherited

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 107 of file itkNeighborhoodOperator.txx.

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

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::FlipAxes ( )

virtualinherited

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

Definition at line 38 of file itkNeighborhoodOperator.txx.

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

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

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

protectedpure virtualinherited

A subclass-specific algorithm that computes the coefficients of the operator.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator >

void otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::GenerateInverseHighPassFilterFromLowPassFilter ( CoefficientVector & coeff )

protected

Performs the definition of high pass filter in an orthogonal framework It follows conjugate quadrature filter (CQF) of the chapter 5 of "Ten Lecture on Wavelets", of Ingrid Daubechies, Society for Industrial and Applied Mathematics, 1992.

It defines filter coefficients as $G(z) = z H(-z^{-1})$ . According to Daubechies'notation, it concerns the synthesis (Inverse) part of the filter banc.

Definition at line 96 of file otbWaveletOperatorBase.txx.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator >

void otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::GenerateInverseLowPassFilterFromHighPassFilter ( CoefficientVector & coeff )

protected

Performs the definition of low pass filter in the reconstruction step of the conjugate quadrature filter (CQF) framework.

It defines filter coefficients as ${\tilde H}(z) = G(-z)$ .

Definition at line 125 of file otbWaveletOperatorBase.txx.

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

AllocatorType& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetBufferReference ( )

inlineinherited

Returns a reference to the data buffer structure.

Definition at line 200 of file itkNeighborhood.h.

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

const AllocatorType& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetBufferReference ( ) const

inlineinherited

Definition at line 202 of file itkNeighborhood.h.

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

unsigned int itk::Neighborhood< TPixel, VDimension, TAllocator >::GetCenterNeighborhoodIndex ( ) const

inlineinherited

Definition at line 218 of file itkNeighborhood.h.

Referenced by otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::ComputeDescriptor(), otb::MRFEnergy< TInput1, TInput2 >::GetValue(), otb::MRFEnergy< TInput2, TInput2 >::GetValue(), and otb::ImageToSURFKeyPointSetFilter< TInputImage, TOutputPointSet >::IsLocalExtremum().

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

TPixel itk::Neighborhood< TPixel, VDimension, TAllocator >::GetCenterValue ( ) const

inlineinherited

Returns the element at the center of the neighborhood.

Definition at line 174 of file itkNeighborhood.h.

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

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

unsigned long itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::GetDirection ( void ) const

inlineinherited

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

Definition at line 103 of file itkNeighborhoodOperator.h.

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

TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::GetElement ( unsigned int i )

inlineinherited

Definition at line 170 of file itkNeighborhood.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

virtual const char* otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::GetNameOfClass ( ) const

virtual

Reimplemented in otb::WaveletHighPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >, and otb::WaveletLowPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >.

template<class TPixel , unsigned int VDimension, class TContainer >

unsigned int itk::Neighborhood< TPixel, VDimension, TContainer >::GetNeighborhoodIndex ( const OffsetType & o ) const

virtualinherited

Definition at line 147 of file itkNeighborhood.txx.

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

OffsetType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetOffset ( unsigned int i ) const

inlineinherited

Returns the itk::Offset from the center of the Neighborhood to the requested neighbor index.

Definition at line 213 of file itkNeighborhood.h.

Referenced by itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::AnalyzeKernel(), otb::GenericInterpolateImageFunction< TInputImage, TFunction, TBoundaryCondition, TCoordRep >::FillWeightOffsetTable(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), and itk::WindowedSincInterpolateImageFunction< TInputImage, VRadius, TWindowFunction, TBoundaryCondition, TCoordRep >::SetInputImage().

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

const SizeType itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius ( void ) const

inlineinherited

Returns the radius of the neighborhood.

Definition at line 128 of file itkNeighborhood.h.

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

unsigned long itk::Neighborhood< TPixel, VDimension, TAllocator >::GetRadius ( const unsigned long n ) const

inlineinherited

Returns the radius of the neighborhood along a specified dimension.

Definition at line 133 of file itkNeighborhood.h.

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

unsigned long itk::Neighborhood< TPixel, VDimension, TAllocator >::GetSize ( const unsigned long n ) const

inlineinherited

Returns the size (total length) of the neighborhood along a specified dimension.

Definition at line 138 of file itkNeighborhood.h.

Referenced by itk::FlatStructuringElement< VDimension >::Annulus(), itk::FlatStructuringElement< VDimension >::Ball(), otb::LineSegmentDetector< TInputImage, TPrecision >::GrowRegion(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ThreadedGenerateData().

template<class TPixel, unsigned int VDimension = 2, class 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 142 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >

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

inherited

Definition at line 134 of file itkNeighborhood.txx.

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

unsigned itk::Neighborhood< TPixel, VDimension, TAllocator >::GetStride ( const unsigned 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 148 of file itkNeighborhood.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

unsigned int otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::GetUpSampleFactor ( ) const

inline

Get the level of up sampling of the filter

Definition at line 112 of file otbWaveletOperatorBase.h.

Referenced by otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::operator=().

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

virtual const char* otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::GetWaveletName ( ) const

inlinevirtual

Get the name of the wavelet when necessary

Definition at line 128 of file otbWaveletOperatorBase.h.

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::InitializeToZero ( )

inlineprotectedinherited

Initializes all the coefficients in the neighborhood to zero values

Definition at line 162 of file itkNeighborhoodOperator.h.

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

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

inlineinherited

Not Equal operator.

Definition at line 120 of file itkNeighborhood.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

Self& otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::operator= ( const Self & other )

inline

Assignment operator

Definition at line 102 of file otbWaveletOperatorBase.h.

References otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::GetUpSampleFactor().

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

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

inlineinherited

Comparison operator.

Definition at line 112 of file itkNeighborhood.h.

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

TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( unsigned int i )

inlineinherited

Pass-through data access methods to the buffer.

Definition at line 166 of file itkNeighborhood.h.

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

const TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( unsigned int i ) const

inlineinherited

Definition at line 168 of file itkNeighborhood.h.

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

TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( const OffsetType & o )

inlineinherited

Get pixel value by offset

Definition at line 206 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator[]().

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

const TPixel& itk::Neighborhood< TPixel, VDimension, TAllocator >::operator[] ( const OffsetType & o ) const

inlineinherited

Definition at line 208 of file itkNeighborhood.h.

Referenced by itk::Neighborhood< PixelType, itkGetStaticConstMacro(ImageDimension)>::operator[]().

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

void itk::Neighborhood< TPixel, VDimension, TAllocator >::Print ( std::ostream & os ) const

inlineinherited

Standard itk object method.

Definition at line 196 of file itkNeighborhood.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator >

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

protectedvirtual

Prints some debugging information

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

Reimplemented in otb::WaveletHighPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >, and otb::WaveletLowPassOperator< TMotherWaveletOperator, TDirectionOfTransformation, TPixel, VDimension, TAllocator >.

Definition at line 34 of file otbWaveletOperatorBase.txx.

References itk::Indent::GetNextIndent().

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator >

void otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::ReduceFilterLength ( CoefficientVector & coeff )

protected

Reduce extra zeros on filters

Definition at line 155 of file otbWaveletOperatorBase.txx.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator >

void otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::RevertFilter ( CoefficientVector & coeff )

protected

Performs filter reversion, ie. $H(z^{-1})$ .

Definition at line 76 of file otbWaveletOperatorBase.txx.

template<class TPixel , unsigned int VDimension, class TAllocator >

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::ScaleCoefficients ( PixelRealType s )

inherited

Multiplies all of the coefficients of the kernel by a single scalar value.

Definition at line 27 of file itkNeighborhoodOperator.txx.

Referenced by itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >::GenerateCoefficients(), itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ThreadedGenerateData().

template<class TPixel, unsigned int VDimension, class TAllocator = NeighborhoodAllocator<TPixel>>

void itk::NeighborhoodOperator< TPixel, VDimension, TAllocator >::SetDirection ( const unsigned long & direction )

inlineinherited

Sets the dimensional direction of a directional operator.

Definition at line 99 of file itkNeighborhoodOperator.h.

Referenced by itk::VectorAnisotropicDiffusionFunction< TImage >::CalculateAverageGradientMagnitudeSquared(), itk::GaussianDerivativeOperator< TPixel, VDimension, TAllocator >::GenerateCoefficients(), itk::SobelEdgeDetectionImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateData(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::GenerateInputRequestedRegion(), itk::RecursiveMultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::DerivativeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::DiscreteGaussianDerivativeImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::MultiResolutionPyramidImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), itk::DiscreteGaussianImageFilter< TInputImage, TOutputImage >::GenerateInputRequestedRegion(), main(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), itk::GradientMagnitudeImageFilter< TInputImage, TOutputImage >::ThreadedGenerateData(), and itk::GradientImageFilter< TInputImage, TOperatorValueType, TOutputValueType >::ThreadedGenerateData().

template<class TPixel , unsigned int VDimension, class 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.txx.

References itk::Size< VDimension >::m_Size.

Referenced by itk::BinaryMorphologyImageFilter< TInputImage, TOutputImage, TKernel >::AnalyzeKernel(), itk::FlatStructuringElement< VDimension >::Annulus(), itk::FlatStructuringElement< VDimension >::Ball(), itk::FlatStructuringElement< VDimension >::Box(), itk::CannyEdgeDetectionImageFilter< TInputImage, TOutputImage >::CannyEdgeDetectionImageFilter(), itk::FlatStructuringElement< VDimension >::Cross(), itk::CurvatureNDAnisotropicDiffusionFunction< TImage >::CurvatureNDAnisotropicDiffusionFunction(), itk::ConstNeighborhoodIterator< TImage, TBoundaryCondition >::GetNeighborhood(), itk::GradientNDAnisotropicDiffusionFunction< TImage >::GradientNDAnisotropicDiffusionFunction(), itk::RegionBasedLevelSetFunction< TInputImage, TFeatureImage, TSharedData >::Initialize(), itk::LevelSetFunction< TImageType >::Initialize(), itk::FlatStructuringElement< VDimension >::Poly(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianBlurImageFunction< TInputImage, TOutput >::RecomputeContinuousGaussianKernel(), itk::GaussianDerivativeImageFunction< TInputImage, TOutput >::RecomputeGaussianKernel(), itk::Statistics::ScalarImageToGreyLevelRunLengthMatrixGenerator< TImageType, THistogramFrequencyContainer >::ScalarImageToGreyLevelRunLengthMatrixGenerator(), itk::NormalizedCorrelationImageFilter< TInputImage, TMaskImage, TOutputImage, TOperatorValueType >::ThreadedGenerateData(), itk::VectorCurvatureNDAnisotropicDiffusionFunction< TImage >::VectorCurvatureNDAnisotropicDiffusionFunction(), and itk::VectorGradientNDAnisotropicDiffusionFunction< TImage >::VectorGradientNDAnisotropicDiffusionFunction().

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

void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetRadius ( const unsigned long * rad )

inlineinherited

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

Definition at line 183 of file itkNeighborhood.h.

template<class TPixel , unsigned int VDimension, class TContainer >

void itk::Neighborhood< TPixel, VDimension, TContainer >::SetRadius ( const unsigned long 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 78 of file itkNeighborhood.txx.

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

void itk::Neighborhood< TPixel, VDimension, TAllocator >::SetSize ( )

inlineprotectedinherited

Sets the length along each dimension.

Definition at line 227 of file itkNeighborhood.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

void otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::SetUpSampleFactor ( unsigned int upSampleFactor )

inline

Set the level of up sampling of the filter

Definition at line 120 of file otbWaveletOperatorBase.h.

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

unsigned int itk::Neighborhood< TPixel, VDimension, TAllocator >::Size ( void ) const

inlineinherited

More STL-style support.

Definition at line 162 of file itkNeighborhood.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator >

void otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::UpSamplingCoefficients ( CoefficientVector & coeff )

protected

Perform the "a-trou" algorithm for shift-invariant transformation. It transforms the filter $ H(z) $ into $ H(z^2) $ .

Definition at line 53 of file otbWaveletOperatorBase.txx.

Member Data Documentation

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

unsigned int otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::m_UpSampleFactor

protected

Definition at line 268 of file otbWaveletOperatorBase.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

WaveletGeneratorPointerType otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::m_WaveletGenerator

protected

Definition at line 269 of file otbWaveletOperatorBase.h.

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel , unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>

const MotherWaveletOperatorEnumType otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >::MotherWaveletOperator = TMotherWaveletOperator

static

Definition at line 82 of file otbWaveletOperatorBase.h.

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

const unsigned int itk::Neighborhood< TPixel, VDimension, TAllocator >::NeighborhoodDimension = VDimension

staticinherited

External support for dimensionality.

Reimplemented in itk::FlatStructuringElement< VDimension >, itk::BinaryBallStructuringElement< TPixel, VDimension, TAllocator >, and itk::BinaryCrossStructuringElement< TPixel, VDimension, TAllocator >.

Definition at line 66 of file itkNeighborhood.h.

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

Public Types

Public Member Functions

Static Public Attributes

Protected Types

Protected Member Functions

Protected Attributes

Detailed Description

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel, unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>> class otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation

template<Wavelet::Wavelet TMotherWaveletOperator, class TPixel, unsigned int VDimension, class TAllocator = itk::NeighborhoodAllocator<TPixel>>
class otb::WaveletOperatorBase< TMotherWaveletOperator, TPixel, VDimension, TAllocator >