otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost > Class Template Reference

#include <otbWaveletPacketTransform.h>

Inheritance diagram for otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >:

Collaboration diagram for otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >:

Public Types
typedef itk::SmartPointer< const Self >	ConstPointer
typedef CostType::Pointer	CostPointerType
typedef TCost	CostType
typedef Wavelet::WaveletDirection	DirectionOfTransformationEnumType
typedef FilterListType::Iterator	FilterListIterator
typedef FilterListType::Pointer	FilterListPointerType
typedef ObjectList< FilterType >	FilterListType
typedef FilterType::Pointer	FilterPointerType
typedef TFilter	FilterType
typedef InputImageType::ConstPointer	InputImageConstPointerType
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::Pointer	InputImagePointerType
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef OutputImageListType::Iterator	OutputImageIterator
typedef OutputImageListType::Pointer	OutputImageListPointerType
typedef Superclass::OutputImageListType	OutputImageListType
typedef Superclass::OutputImagePointerType	OutputImagePointerType
typedef Superclass::OutputImageType	OutputImageType
typedef itk::SmartPointer< Self >	Pointer
typedef WaveletPacketTransform	Self
typedef InputImageType::SizeType	SizeType
typedef ImageToImageListFilter< TInputImage, TOutputImage >	Superclass
typedef InputImageType::ValueType	ValueType
Public Types inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef InputImageType::PixelType	InputImagePixelType
typedef InputImageType::ConstPointer	InputImagePointer
typedef InputImageType::RegionType	InputImageRegionType
typedef TInputImage	InputImageType
typedef Superclass::OutputImageListType	OutputImageListType
typedef Superclass::OutputImagePointerType	OutputImagePointerType
typedef Superclass::OutputImageType	OutputImageType
typedef itk::SmartPointer< Self >	Pointer
typedef ImageToImageListFilter	Self
typedef InputImageType::SizeType	SizeType
typedef ImageListSource< TOutputImage >	Superclass
typedef InputImageType::ValueType	ValueType
Public Types inherited from otb::ImageListSource< TOutputImage >
typedef itk::SmartPointer< const Self >	ConstPointer
typedef itk::DataObject::Pointer	DataObjectPointer
typedef OutputImageListType::ConstPointer	OutputImageListConstPointerType
typedef OutputImageListType::Pointer	OutputImageListPointerType
typedef ImageList< OutputImageType >	OutputImageListType
typedef OutputImageType::Pointer	OutputImagePointerType
typedef TOutputImage	OutputImageType
typedef itk::SmartPointer< Self >	Pointer
typedef ImageListSource	Self
typedef itk::ProcessObject	Superclass

Public Member Functions
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual const char *	GetNameOfClass () const
const std::vector< bool > &	GetWaveletPacketRule () const
	itkGetObjectMacro (Cost, CostType)
	itkGetObjectMacro (FilterList, FilterListType)
Public Member Functions inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual void	SetInput (const InputImageType *image)
InputImageType *	GetInput (void)
Public Member Functions inherited from otb::ImageListSource< TOutputImage >
virtual ::itk::LightObject::Pointer	CreateAnother (void) const
virtual OutputImageListType *	GetOutput (void)

Static Public Member Functions
static Pointer	New ()
Static Public Member Functions inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
static Pointer	New ()
Static Public Member Functions inherited from otb::ImageListSource< TOutputImage >
static Pointer	New ()

Static Public Attributes
static const DirectionOfTransformationEnumType	DirectionOfTransformation = Wavelet::FORWARD
Static Public Attributes inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
static const unsigned int	InputImageDimension = TInputImage::ImageDimension
unsigned int	m_SubsampleImageFactor
unsigned int	m_NumberOfFilters
unsigned int	m_DepthOfDecomposition
FilterListPointerType	m_FilterList
CostPointerType	m_Cost
std::vector< bool >	m_WaveletPacketRule
virtual unsigned int	GetNumberOfFilters ()
virtual unsigned int	GetDepthOfDecomposition ()
virtual unsigned int	GetSubsampleImageFactor ()
virtual void	SetSubsampleImageFactor (unsigned int _arg)
	WaveletPacketTransform ()
	~WaveletPacketTransform () override
void	GenerateData () override
virtual void	GenerateData (unsigned int depth, OutputImageType *outputPtr, itk::ProgressAccumulator *accumulator)
	WaveletPacketTransform (const Self &)
void	operator= (const Self &)

Additional Inherited Members
Protected Member Functions inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
	ImageToImageListFilter ()
	~ImageToImageListFilter () override
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
Protected Member Functions inherited from otb::ImageListSource< TOutputImage >
	ImageListSource ()
void	PrintSelf (std::ostream &os, itk::Indent indent) const override
	~ImageListSource () override

Detailed Description

template<class TInputImage, class TOutputImage, class TFilter, class TCost>
class otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >

Definition at line 118 of file otbWaveletPacketTransform.h.

Member Typedef Documentation

ConstPointer

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef itk::SmartPointer<const Self> otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::ConstPointer

Definition at line 125 of file otbWaveletPacketTransform.h.

CostPointerType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef CostType::Pointer otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::CostPointerType

Definition at line 156 of file otbWaveletPacketTransform.h.

CostType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef TCost otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::CostType

Definition at line 155 of file otbWaveletPacketTransform.h.

DirectionOfTransformationEnumType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef Wavelet::WaveletDirection otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::DirectionOfTransformationEnumType

Definition at line 159 of file otbWaveletPacketTransform.h.

FilterListIterator

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef FilterListType::Iterator otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::FilterListIterator

Definition at line 151 of file otbWaveletPacketTransform.h.

FilterListPointerType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef FilterListType::Pointer otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::FilterListPointerType

Definition at line 150 of file otbWaveletPacketTransform.h.

FilterListType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef ObjectList<FilterType> otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::FilterListType

Definition at line 149 of file otbWaveletPacketTransform.h.

FilterPointerType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef FilterType::Pointer otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::FilterPointerType

Definition at line 148 of file otbWaveletPacketTransform.h.

FilterType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef TFilter otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::FilterType

Definition at line 147 of file otbWaveletPacketTransform.h.

InputImageConstPointerType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef InputImageType::ConstPointer otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::InputImageConstPointerType

Definition at line 135 of file otbWaveletPacketTransform.h.

InputImagePixelType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef InputImageType::PixelType otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::InputImagePixelType

Definition at line 137 of file otbWaveletPacketTransform.h.

InputImagePointerType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef InputImageType::Pointer otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::InputImagePointerType

Definition at line 134 of file otbWaveletPacketTransform.h.

InputImageRegionType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef InputImageType::RegionType otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::InputImageRegionType

Definition at line 136 of file otbWaveletPacketTransform.h.

InputImageType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef TInputImage otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::InputImageType

Definition at line 131 of file otbWaveletPacketTransform.h.

OutputImageIterator

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef OutputImageListType::Iterator otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::OutputImageIterator

Definition at line 145 of file otbWaveletPacketTransform.h.

OutputImageListPointerType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef OutputImageListType::Pointer otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::OutputImageListPointerType

Definition at line 144 of file otbWaveletPacketTransform.h.

OutputImageListType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef Superclass::OutputImageListType otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::OutputImageListType

Definition at line 143 of file otbWaveletPacketTransform.h.

OutputImagePointerType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef Superclass::OutputImagePointerType otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::OutputImagePointerType

Definition at line 142 of file otbWaveletPacketTransform.h.

OutputImageType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef Superclass::OutputImageType otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::OutputImageType

Definition at line 141 of file otbWaveletPacketTransform.h.

Pointer

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef itk::SmartPointer<Self> otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::Pointer

Definition at line 124 of file otbWaveletPacketTransform.h.

Self

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef WaveletPacketTransform otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::Self

Standard typedefs

Definition at line 122 of file otbWaveletPacketTransform.h.

SizeType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef InputImageType::SizeType otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::SizeType

Definition at line 138 of file otbWaveletPacketTransform.h.

Superclass

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef ImageToImageListFilter<TInputImage, TOutputImage> otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::Superclass

Definition at line 123 of file otbWaveletPacketTransform.h.

ValueType

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

typedef InputImageType::ValueType otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::ValueType

Definition at line 139 of file otbWaveletPacketTransform.h.

Constructor & Destructor Documentation

WaveletPacketTransform() [1/2]

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform

protected

Template specialization for the Wavelet::FORWARD transformation

Definition at line 36 of file otbWaveletPacketTransform.hxx.

~WaveletPacketTransform()

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::~WaveletPacketTransform ( )

inlineoverrideprotected

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

Definition at line 189 of file otbWaveletPacketTransform.h.

WaveletPacketTransform() [2/2]

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::WaveletPacketTransform ( const Self &  )

private

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

Member Function Documentation

CreateAnother()

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

virtual::itk::LightObject::Pointer otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::CreateAnother

(

void

)

const

GenerateData() [1/2]

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

void otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::GenerateData

overrideprotected

Generate data redefinition. This class does not performs multi-threading directly. But it uses step by step the GenerateData() of TFilter. If This one can thread, the transformation is threaded (e.g. WaveletFilterBank)

Definition at line 48 of file otbWaveletPacketTransform.hxx.

GenerateData() [2/2]

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

void otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::GenerateData ( unsigned int  depth, OutputImageType *  outputPtr, itk::ProgressAccumulator *  accumulator  )

protectedvirtual

Performs (if any) the local decomposition (called recursively)

Definition at line 66 of file otbWaveletPacketTransform.hxx.

GetDepthOfDecomposition()

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

virtual unsigned int otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::GetDepthOfDecomposition ( )

virtual

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

GetNameOfClass()

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

virtual const char* otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::GetNameOfClass ( ) const

virtual

Creation through object factory macro

Reimplemented from otb::ImageToImageListFilter< TInputImage, TOutputImage >.

GetNumberOfFilters()

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

virtual unsigned int otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::GetNumberOfFilters ( )

virtual

Get information on the decomposition

GetSubsampleImageFactor()

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

virtual unsigned int otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::GetSubsampleImageFactor ( )

virtual

Set/Get the level of down sampling of the image used in forward algorithm. (or upsampling in the inverse case)

In this implementation, we are not (yet?) dealing with M-band decomposition then m_SubsampleImageFactor is most likely to be 1 or 2... but in any case integer and not real...

GetWaveletPacketRule()

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

const std::vector<bool>& otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::GetWaveletPacketRule ( ) const

inline

Get the recursive description of the packet decomposition

Definition at line 163 of file otbWaveletPacketTransform.h.

itkGetObjectMacro() [1/2]

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::itkGetObjectMacro	(	Cost	,
		CostType
	)

itkGetObjectMacro() [2/2]

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::itkGetObjectMacro	(	FilterList	,
		FilterListType
	)

New()

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

static Pointer otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::New ( )

static

Type macro

operator=()

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

void otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::operator= ( const Self &  )

private

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

SetSubsampleImageFactor()

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

virtual void otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::SetSubsampleImageFactor ( unsigned int  _arg )

virtual

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

Member Data Documentation

DirectionOfTransformation

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

const DirectionOfTransformationEnumType otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::DirectionOfTransformation = Wavelet::FORWARD

static

Definition at line 160 of file otbWaveletPacketTransform.h.

InputImageDimension

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

const unsigned int otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::InputImageDimension = TInputImage::ImageDimension

static

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

Definition at line 173 of file otbWaveletPacketTransform.h.

m_Cost

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

CostPointerType otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::m_Cost

private

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

Definition at line 219 of file otbWaveletPacketTransform.h.

m_DepthOfDecomposition

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

unsigned int otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::m_DepthOfDecomposition

private

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

Definition at line 216 of file otbWaveletPacketTransform.h.

m_FilterList

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

FilterListPointerType otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::m_FilterList

private

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

Definition at line 218 of file otbWaveletPacketTransform.h.

m_NumberOfFilters

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

unsigned int otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::m_NumberOfFilters

private

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

Definition at line 215 of file otbWaveletPacketTransform.h.

m_SubsampleImageFactor

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

unsigned int otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::m_SubsampleImageFactor

private

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

Definition at line 212 of file otbWaveletPacketTransform.h.

m_WaveletPacketRule

template<class TInputImage , class TOutputImage , class TFilter , class TCost >

std::vector<bool> otb::WaveletPacketTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD, TCost >::m_WaveletPacketRule

private

For multiscale decomposition, m_SubsampleImageFactor is set to 1. It yields also a stationnary decomposition. For multiresolution decomposition, most of the time, m_SubsampleImageFactor is to be set to 2. This is its default value.

Definition at line 220 of file otbWaveletPacketTransform.h.

---

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

• otbWaveletPacketTransform.h
• otbWaveletPacketTransform.hxx