OTB  9.0.0
Orfeo Toolbox
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD > Class Template Reference

#include <otbWaveletTransform.h>

+ Inheritance diagram for otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >:
+ Collaboration diagram for otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >:

Public Types

typedef itk::SmartPointer< const SelfConstPointer
 
typedef Wavelet::WaveletDirection DirectionOfTransformationEnumType
 
typedef FilterListType::Iterator FilterListIterator
 
typedef FilterListType::Pointer FilterListPointerType
 
typedef ObjectList< FilterTypeFilterListType
 
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< SelfPointer
 
typedef WaveletTransform 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 SelfConstPointer
 
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< SelfPointer
 
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 SelfConstPointer
 
typedef itk::DataObject::Pointer DataObjectPointer
 
typedef OutputImageListType::ConstPointer OutputImageListConstPointerType
 
typedef OutputImageListType::Pointer OutputImageListPointerType
 
typedef ImageList< OutputImageTypeOutputImageListType
 
typedef OutputImageType::Pointer OutputImagePointerType
 
typedef TOutputImage OutputImageType
 
typedef itk::SmartPointer< SelfPointer
 
typedef ImageListSource Self
 
typedef itk::ProcessObject Superclass
 

Public Member Functions

virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual const char * GetNameOfClass () const
 
FilterTypeGetNthFilter (unsigned int idx) const
 
virtual unsigned int GetNumberOfDecompositions ()
 
 itkGetObjectMacro (FilterList, FilterListType)
 
virtual void SetNumberOfDecompositions (unsigned int _arg)
 
- Public Member Functions inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual void SetInput (const InputImageType *image)
 
InputImageTypeGetInput (void)
 
- Public Member Functions inherited from otb::ImageListSource< TOutputImage >
virtual ::itk::LightObject::Pointer CreateAnother (void) const
 
virtual OutputImageListTypeGetOutput (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 const unsigned int InputImageDimension = TInputImage::ImageDimension
 
- Static Public Attributes inherited from otb::ImageToImageListFilter< TInputImage, TOutputImage >
static const unsigned int InputImageDimension = TInputImage::ImageDimension
 
unsigned int m_NumberOfDecompositions
 
unsigned int m_SubsampleImageFactor
 
FilterListPointerType m_FilterList
 
virtual unsigned int GetSubsampleImageFactor ()
 
virtual void SetSubsampleImageFactor (unsigned int _arg)
 
 WaveletTransform ()
 
 ~WaveletTransform () override
 
void GenerateData () override
 
 WaveletTransform (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 otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >

Definition at line 109 of file otbWaveletTransform.h.

Member Typedef Documentation

◆ ConstPointer

template<class TInputImage , class TOutputImage , class TFilter >
typedef itk::SmartPointer<const Self> otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::ConstPointer

Definition at line 116 of file otbWaveletTransform.h.

◆ DirectionOfTransformationEnumType

template<class TInputImage , class TOutputImage , class TFilter >
typedef Wavelet::WaveletDirection otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::DirectionOfTransformationEnumType

Definition at line 155 of file otbWaveletTransform.h.

◆ FilterListIterator

template<class TInputImage , class TOutputImage , class TFilter >
typedef FilterListType::Iterator otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::FilterListIterator

Definition at line 142 of file otbWaveletTransform.h.

◆ FilterListPointerType

template<class TInputImage , class TOutputImage , class TFilter >
typedef FilterListType::Pointer otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::FilterListPointerType

Definition at line 141 of file otbWaveletTransform.h.

◆ FilterListType

template<class TInputImage , class TOutputImage , class TFilter >
typedef ObjectList<FilterType> otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::FilterListType

Definition at line 140 of file otbWaveletTransform.h.

◆ FilterPointerType

template<class TInputImage , class TOutputImage , class TFilter >
typedef FilterType::Pointer otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::FilterPointerType

Definition at line 139 of file otbWaveletTransform.h.

◆ FilterType

template<class TInputImage , class TOutputImage , class TFilter >
typedef TFilter otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::FilterType

Definition at line 138 of file otbWaveletTransform.h.

◆ InputImageConstPointerType

template<class TInputImage , class TOutputImage , class TFilter >
typedef InputImageType::ConstPointer otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::InputImageConstPointerType

Definition at line 126 of file otbWaveletTransform.h.

◆ InputImagePixelType

template<class TInputImage , class TOutputImage , class TFilter >
typedef InputImageType::PixelType otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::InputImagePixelType

Definition at line 128 of file otbWaveletTransform.h.

◆ InputImagePointerType

template<class TInputImage , class TOutputImage , class TFilter >
typedef InputImageType::Pointer otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::InputImagePointerType

Definition at line 125 of file otbWaveletTransform.h.

◆ InputImageRegionType

template<class TInputImage , class TOutputImage , class TFilter >
typedef InputImageType::RegionType otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::InputImageRegionType

Definition at line 127 of file otbWaveletTransform.h.

◆ InputImageType

template<class TInputImage , class TOutputImage , class TFilter >
typedef TInputImage otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::InputImageType

Definition at line 122 of file otbWaveletTransform.h.

◆ OutputImageIterator

template<class TInputImage , class TOutputImage , class TFilter >
typedef OutputImageListType::Iterator otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::OutputImageIterator

Definition at line 136 of file otbWaveletTransform.h.

◆ OutputImageListPointerType

template<class TInputImage , class TOutputImage , class TFilter >
typedef OutputImageListType::Pointer otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::OutputImageListPointerType

Definition at line 135 of file otbWaveletTransform.h.

◆ OutputImageListType

template<class TInputImage , class TOutputImage , class TFilter >
typedef Superclass::OutputImageListType otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::OutputImageListType

Definition at line 134 of file otbWaveletTransform.h.

◆ OutputImagePointerType

template<class TInputImage , class TOutputImage , class TFilter >
typedef Superclass::OutputImagePointerType otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::OutputImagePointerType

Definition at line 133 of file otbWaveletTransform.h.

◆ OutputImageType

template<class TInputImage , class TOutputImage , class TFilter >
typedef Superclass::OutputImageType otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::OutputImageType

Definition at line 132 of file otbWaveletTransform.h.

◆ Pointer

template<class TInputImage , class TOutputImage , class TFilter >
typedef itk::SmartPointer<Self> otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::Pointer

Definition at line 115 of file otbWaveletTransform.h.

◆ Self

template<class TInputImage , class TOutputImage , class TFilter >
typedef WaveletTransform otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::Self

Standard typedefs

Definition at line 113 of file otbWaveletTransform.h.

◆ SizeType

template<class TInputImage , class TOutputImage , class TFilter >
typedef InputImageType::SizeType otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::SizeType

Definition at line 129 of file otbWaveletTransform.h.

◆ Superclass

template<class TInputImage , class TOutputImage , class TFilter >
typedef ImageToImageListFilter<TInputImage, TOutputImage> otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::Superclass

Definition at line 114 of file otbWaveletTransform.h.

◆ ValueType

template<class TInputImage , class TOutputImage , class TFilter >
typedef InputImageType::ValueType otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::ValueType

Definition at line 130 of file otbWaveletTransform.h.

Constructor & Destructor Documentation

◆ WaveletTransform() [1/2]

template<class TInputImage , class TOutputImage , class TFilter >
otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform
protected

Template Specialization for the Wavelet::FORWARD case

Definition at line 39 of file otbWaveletTransform.hxx.

◆ ~WaveletTransform()

template<class TInputImage , class TOutputImage , class TFilter >
otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::~WaveletTransform ( )
inlineoverrideprotected

Number of decomposition of the multi-scale/-resolution decomposition.

Definition at line 177 of file otbWaveletTransform.h.

◆ WaveletTransform() [2/2]

template<class TInputImage , class TOutputImage , class TFilter >
otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::WaveletTransform ( const Self )
private

Number of decomposition of the multi-scale/-resolution decomposition.

Member Function Documentation

◆ CreateAnother()

template<class TInputImage , class TOutputImage , class TFilter >
virtual::itk::LightObject::Pointer otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::CreateAnother ( void  ) const

◆ GenerateData()

template<class TInputImage , class TOutputImage , class TFilter >
void otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::GenerateData
overrideprotected

Generate data redefinition

Definition at line 50 of file otbWaveletTransform.hxx.

References otbMsgDevMacro.

◆ GetNameOfClass()

template<class TInputImage , class TOutputImage , class TFilter >
virtual const char* otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::GetNameOfClass ( ) const
virtual

Creation through object factory macro

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

◆ GetNthFilter()

template<class TInputImage , class TOutputImage , class TFilter >
FilterType* otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::GetNthFilter ( unsigned int  idx) const
inline

Definition at line 145 of file otbWaveletTransform.h.

◆ GetNumberOfDecompositions()

template<class TInputImage , class TOutputImage , class TFilter >
virtual unsigned int otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::GetNumberOfDecompositions ( )
virtual

◆ GetSubsampleImageFactor()

template<class TInputImage , class TOutputImage , class TFilter >
virtual unsigned int otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::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...

◆ itkGetObjectMacro()

template<class TInputImage , class TOutputImage , class TFilter >
otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::itkGetObjectMacro ( FilterList  ,
FilterListType   
)

◆ New()

template<class TInputImage , class TOutputImage , class TFilter >
static Pointer otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::New ( )
static

Type macro

◆ operator=()

template<class TInputImage , class TOutputImage , class TFilter >
void otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::operator= ( const Self )
private

Number of decomposition of the multi-scale/-resolution decomposition.

◆ SetNumberOfDecompositions()

template<class TInputImage , class TOutputImage , class TFilter >
virtual void otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::SetNumberOfDecompositions ( unsigned int  _arg)
virtual

◆ SetSubsampleImageFactor()

template<class TInputImage , class TOutputImage , class TFilter >
virtual void otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::SetSubsampleImageFactor ( unsigned int  _arg)
virtual

Number of decomposition of the multi-scale/-resolution decomposition.

Member Data Documentation

◆ DirectionOfTransformation

template<class TInputImage , class TOutputImage , class TFilter >
const DirectionOfTransformationEnumType otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::DirectionOfTransformation = Wavelet::FORWARD
static

Definition at line 156 of file otbWaveletTransform.h.

◆ InputImageDimension

template<class TInputImage , class TOutputImage , class TFilter >
const unsigned int otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::InputImageDimension = TInputImage::ImageDimension
static

Definition at line 161 of file otbWaveletTransform.h.

◆ m_FilterList

template<class TInputImage , class TOutputImage , class TFilter >
FilterListPointerType otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::m_FilterList
private

The list of filter is necessary to keep the pipeline updated.

Definition at line 204 of file otbWaveletTransform.h.

◆ m_NumberOfDecompositions

template<class TInputImage , class TOutputImage , class TFilter >
unsigned int otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::m_NumberOfDecompositions
private

Number of decomposition of the multi-scale/-resolution decomposition.

Definition at line 191 of file otbWaveletTransform.h.

◆ m_SubsampleImageFactor

template<class TInputImage , class TOutputImage , class TFilter >
unsigned int otb::WaveletTransform< TInputImage, TOutputImage, TFilter, Wavelet::FORWARD >::m_SubsampleImageFactor
private

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

Definition at line 199 of file otbWaveletTransform.h.


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