OTB  9.0.0
Orfeo Toolbox
otbWaveletImageFilter.h
Go to the documentation of this file.
1 /*
2  * Copyright (C) 2005-2022 Centre National d'Etudes Spatiales (CNES)
3  *
4  * This file is part of Orfeo Toolbox
5  *
6  * https://www.orfeo-toolbox.org/
7  *
8  * Licensed under the Apache License, Version 2.0 (the "License");
9  * you may not use this file except in compliance with the License.
10  * You may obtain a copy of the License at
11  *
12  * http://www.apache.org/licenses/LICENSE-2.0
13  *
14  * Unless required by applicable law or agreed to in writing, software
15  * distributed under the License is distributed on an "AS IS" BASIS,
16  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17  * See the License for the specific language governing permissions and
18  * limitations under the License.
19  */
20 
21 
22 #ifndef otbWaveletImageFilter_h
23 #define otbWaveletImageFilter_h
24 
25 #include "otbWaveletOperator.h"
26 #include "otbWaveletFilterBank.h"
27 #include "otbWaveletTransform.h"
29 
30 namespace otb
31 {
32 
44 template <class TInputImage, class TOutputImage, Wavelet::Wavelet TMotherWaveletOperator>
45 class WaveletImageFilter : public itk::ImageToImageFilter<TInputImage, TOutputImage>
46 {
47 public:
49  typedef TInputImage InputImageType;
50  typedef TOutputImage OutputImageType;
51 
52  itkStaticConstMacro(ImageDimension, unsigned int, InputImageType::ImageDimension);
53  itkStaticConstMacro(MotherWaveletOperator, short, TMotherWaveletOperator);
54  itkStaticConstMacro(DirectionOfTransformation, short, otb::Wavelet::FORWARD);
55 
57  typedef itk::ImageToImageFilter<InputImageType, OutputImageType> Superclass;
58  typedef itk::SmartPointer<Self> Pointer;
59  typedef itk::SmartPointer<const Self> ConstPointer;
60 
61  typedef typename InputImageType::PixelType InputPixelType;
62 
67 
68  typedef typename WaveletTransformFilterType::OutputImageListType WaveletTransformFilterOutputImageListType;
72 
73 
75  itkNewMacro(Self);
76 
78  itkTypeMacro(WaveletImageFilter, ImageToImageFilter);
79 
80  itkGetMacro(NumberOfDecompositions, unsigned int);
81  itkSetMacro(NumberOfDecompositions, unsigned int);
82 
83 protected:
85  virtual ~WaveletImageFilter();
86 
87  virtual void GenerateInputRequestedRegion() override;
88 
89  virtual void GenerateData() override;
90 
91  virtual void PrintSelf(std::ostream& os, itk::Indent indent) const override;
92 
93 private:
94  WaveletImageFilter(const Self&) = delete;
95  void operator=(const Self&) = delete;
96 
100 };
101 }
102 
103 #ifndef OTB_MANUAL_INSTANTIATION
104 #include "otbWaveletImageFilter.hxx"
105 #endif
106 
107 #endif
otbWaveletTransform.h
otb::WaveletImageFilter::WaveletBandsListToWaveletsSynopsisImageFilterPointerType
WaveletBandsListToWaveletsSynopsisImageFilterType::Pointer WaveletBandsListToWaveletsSynopsisImageFilterPointerType
Definition: otbWaveletImageFilter.h:71
otb::WaveletTransform
Wavelet transformation framework.
Definition: otbWaveletTransform.h:58
otbWaveletImageFilter.hxx
otb::WaveletImageFilter::InputImageType
TInputImage InputImageType
Definition: otbWaveletImageFilter.h:49
otb::WaveletImageFilter::operator=
void operator=(const Self &)=delete
otb::WaveletsBandsListToWaveletsSynopsisImageFilter
Converts a list of wavelets bands to the traditional multi-resolution wavelets view.
Definition: otbWaveletsBandsListToWaveletsSynopsisImageFilter.h:40
otb::WaveletImageFilter::GenerateData
virtual void GenerateData() override
Definition: otbWaveletImageFilter.hxx:71
otb::WaveletImageFilter::m_NumberOfDecompositions
unsigned int m_NumberOfDecompositions
Definition: otbWaveletImageFilter.h:99
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::WaveletOperator
A Generic NeighborhoodOperator wavelets filter set defined for templation.
Definition: otbWaveletOperator.h:56
otb::WaveletImageFilter::FilterBankType
otb::WaveletFilterBank< InputImageType, InputImageType, WaveletOperatorType, otb::Wavelet::FORWARD > FilterBankType
Definition: otbWaveletImageFilter.h:64
otb::WaveletImageFilter::WaveletTransformFilterType
otb::WaveletTransform< InputImageType, InputImageType, FilterBankType, otb::Wavelet::FORWARD > WaveletTransformFilterType
Definition: otbWaveletImageFilter.h:65
otb::WaveletsBandsListToWaveletsSynopsisImageFilter::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbWaveletsBandsListToWaveletsSynopsisImageFilter.h:46
otb::WaveletImageFilter::DirectionOfTransformation
static const short DirectionOfTransformation
Definition: otbWaveletImageFilter.h:54
otb::WaveletImageFilter::OutputImageType
TOutputImage OutputImageType
Definition: otbWaveletImageFilter.h:50
otb::WaveletImageFilter::m_WaveletBandsListToWaveletsSynopsis
WaveletBandsListToWaveletsSynopsisImageFilterPointerType m_WaveletBandsListToWaveletsSynopsis
Definition: otbWaveletImageFilter.h:98
otb::WaveletImageFilter::WaveletImageFilter
WaveletImageFilter()
Definition: otbWaveletImageFilter.hxx:31
otb::WaveletImageFilter::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbWaveletImageFilter.h:59
otb::WaveletImageFilter::WaveletTransformFilterOutputImageListType
WaveletTransformFilterType::OutputImageListType WaveletTransformFilterOutputImageListType
Definition: otbWaveletImageFilter.h:68
otb::WaveletImageFilter::WaveletOperatorType
otb::WaveletOperator< TMotherWaveletOperator, otb::Wavelet::FORWARD, InputPixelType, ImageDimension > WaveletOperatorType
Definition: otbWaveletImageFilter.h:63
otb::WaveletImageFilter::GenerateInputRequestedRegion
virtual void GenerateInputRequestedRegion() override
Definition: otbWaveletImageFilter.hxx:51
otbWaveletOperator.h
otb::WaveletImageFilter::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbWaveletImageFilter.h:58
otb::WaveletImageFilter
This filter performs wavelet forward transform. It takes three template arguments: Input,...
Definition: otbWaveletImageFilter.h:45
otb::WaveletImageFilter::Superclass
itk::ImageToImageFilter< InputImageType, OutputImageType > Superclass
Definition: otbWaveletImageFilter.h:57
otbWaveletFilterBank.h
otb::WaveletTransform::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbWaveletTransform.h:64
otbWaveletsBandsListToWaveletsSynopsisImageFilter.h
otb::WaveletImageFilter::MotherWaveletOperator
static const short MotherWaveletOperator
Definition: otbWaveletImageFilter.h:53
otb::WaveletImageFilter::m_WaveletTransform
WaveletTransformFilterPointerType m_WaveletTransform
Definition: otbWaveletImageFilter.h:97
otb::Wavelet::FORWARD
@ FORWARD
Definition: otbWaveletOperatorBase.h:38
otb::WaveletFilterBank
One level stationary wavelet transform.
Definition: otbWaveletFilterBank.h:87
otb::WaveletImageFilter::PrintSelf
virtual void PrintSelf(std::ostream &os, itk::Indent indent) const override
Definition: otbWaveletImageFilter.hxx:85
otb::WaveletImageFilter::Self
WaveletImageFilter< InputImageType, OutputImageType, TMotherWaveletOperator > Self
Definition: otbWaveletImageFilter.h:56
otb::WaveletImageFilter::~WaveletImageFilter
virtual ~WaveletImageFilter()
Definition: otbWaveletImageFilter.hxx:43
otb::WaveletImageFilter::InputPixelType
InputImageType::PixelType InputPixelType
Definition: otbWaveletImageFilter.h:61
otb::WaveletImageFilter::ImageDimension
static const unsigned int ImageDimension
Definition: otbWaveletImageFilter.h:52
otb::WaveletImageFilter::WaveletTransformFilterPointerType
WaveletTransformFilterType::Pointer WaveletTransformFilterPointerType
Definition: otbWaveletImageFilter.h:66
otb::WaveletImageFilter::WaveletBandsListToWaveletsSynopsisImageFilterType
otb::WaveletsBandsListToWaveletsSynopsisImageFilter< WaveletTransformFilterOutputImageListType, OutputImageType > WaveletBandsListToWaveletsSynopsisImageFilterType
Definition: otbWaveletImageFilter.h:70