OTB  9.0.0
Orfeo Toolbox
otbWindowedSincInterpolateImageWelchFunction.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 #ifndef otbWindowedSincInterpolateImageWelchFunction_h
22 #define otbWindowedSincInterpolateImageWelchFunction_h
23 
25 #include "vnl/vnl_math.h"
26 
27 namespace otb
28 {
29 
30 namespace Function
31 {
40 template <class TInput = double, class TOutput = double>
42 {
43 public:
45  {
46  } // default radius is 1 at construction
47  void SetRadius(unsigned int radius)
48  {
49  m_Radius = radius;
50  m_Factor = 1 / static_cast<double>(radius * radius);
51  }
52  unsigned int GetRadius() const
53  {
54  return m_Radius;
55  }
56  double GetFactor()
57  {
58  return m_Factor;
59  }
61 
62  inline TOutput operator()(const TInput& A) const
63  {
64  double x = static_cast<double>(A);
65  double px = CONST_PI * x;
66  double temp = 1.0 - x * m_Factor * x;
67  return (x == 0.0) ? static_cast<TOutput>(temp) : static_cast<TOutput>(temp * std::sin(px) / px);
68  }
69 
70 private:
71  unsigned int m_Radius;
72  // Equal to \f$ \frac{1}{m^2} \f$
73  double m_Factor;
74 };
75 } // namespace Function
76 
92 template <class TInputImage, class TBoundaryCondition = itk::ConstantBoundaryCondition<TInputImage>, class TCoordRep = double,
93  class TInputInterpolator = double, class TOutputInterpolator = double>
95  : public WindowedSincInterpolateImageFunctionBase<TInputImage, typename Function::WelchWindowFunction<TInputInterpolator, TOutputInterpolator>,
96  TBoundaryCondition, TCoordRep>
97 {
98 public:
99 
103  TBoundaryCondition, TCoordRep>
105  typedef itk::SmartPointer<Self> Pointer;
106  typedef itk::SmartPointer<const Self> ConstPointer;
107 
110 
112  itkNewMacro(Self);
113 
117 
119  itkStaticConstMacro(ImageDimension, unsigned int, Superclass::ImageDimension);
120 
123  typedef typename Superclass::SizeType SizeType;
124  typedef typename Superclass::RealType RealType;
127 
128 protected:
131  {
132  }
133  void PrintSelf(std::ostream& os, itk::Indent indent) const override
134  {
135  Superclass::PrintSelf(os, indent);
136  }
137 
138 private:
139  WindowedSincInterpolateImageWelchFunction(const Self&) = delete;
140  void operator=(const Self&) = delete;
141 };
142 
143 } // end namespace otb
144 
145 #endif
otb::WindowedSincInterpolateImageWelchFunction::IndexType
Superclass::IndexType IndexType
Definition: otbWindowedSincInterpolateImageWelchFunction.h:122
otb::WindowedSincInterpolateImageWelchFunction::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbWindowedSincInterpolateImageWelchFunction.h:105
otb::WindowedSincInterpolateImageFunctionBase::InputImageType
Superclass::InputImageType InputImageType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:154
otb::CONST_PI
constexpr double CONST_PI
Definition: otbMath.h:49
otb::WindowedSincInterpolateImageWelchFunction::~WindowedSincInterpolateImageWelchFunction
~WindowedSincInterpolateImageWelchFunction() override
Definition: otbWindowedSincInterpolateImageWelchFunction.h:130
otb::WindowedSincInterpolateImageFunctionBase::IndexType
Superclass::IndexType IndexType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:164
otb::WindowedSincInterpolateImageFunctionBase::SizeType
Superclass::SizeType SizeType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:165
otb::WindowedSincInterpolateImageFunctionBase::RealType
Superclass::RealType RealType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:166
otb::WindowedSincInterpolateImageWelchFunction::ContinuousIndexType
Superclass::ContinuousIndexType ContinuousIndexType
Definition: otbWindowedSincInterpolateImageWelchFunction.h:126
otb::WindowedSincInterpolateImageWelchFunction
Use the WindowedSincInterpolateImageFunctionBase with a Welch Function.
Definition: otbWindowedSincInterpolateImageWelchFunction.h:94
otb::WindowedSincInterpolateImageWelchFunction::OutputType
Superclass::OutputType OutputType
Definition: otbWindowedSincInterpolateImageWelchFunction.h:116
otb::WindowedSincInterpolateImageWelchFunction::WindowedSincInterpolateImageWelchFunction
WindowedSincInterpolateImageWelchFunction()
Definition: otbWindowedSincInterpolateImageWelchFunction.h:129
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::WindowedSincInterpolateImageWelchFunction::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbWindowedSincInterpolateImageWelchFunction.h:106
otb::Function::WelchWindowFunction
Window function for sinc interpolation.
Definition: otbWindowedSincInterpolateImageWelchFunction.h:41
otb::WindowedSincInterpolateImageWelchFunction::PrintSelf
void PrintSelf(std::ostream &os, itk::Indent indent) const override
Definition: otbWindowedSincInterpolateImageWelchFunction.h:133
otb::WindowedSincInterpolateImageFunctionBase::OutputType
Superclass::OutputType OutputType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:158
otb::WindowedSincInterpolateImageWelchFunction::IteratorType
Superclass::IteratorType IteratorType
Definition: otbWindowedSincInterpolateImageWelchFunction.h:125
otb::WindowedSincInterpolateImageWelchFunction::InputImageType
Superclass::InputImageType InputImageType
Definition: otbWindowedSincInterpolateImageWelchFunction.h:112
otb::Function::WelchWindowFunction::m_Factor
double m_Factor
Definition: otbWindowedSincInterpolateImageWelchFunction.h:73
otb::Function::WelchWindowFunction::GetFactor
double GetFactor()
Definition: otbWindowedSincInterpolateImageWelchFunction.h:56
otb::WindowedSincInterpolateImageFunctionBase::ContinuousIndexType
Superclass::ContinuousIndexType ContinuousIndexType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:168
otb::Function::WelchWindowFunction::WelchWindowFunction
WelchWindowFunction()
Definition: otbWindowedSincInterpolateImageWelchFunction.h:44
otb::WindowedSincInterpolateImageWelchFunction::SizeType
Superclass::SizeType SizeType
Definition: otbWindowedSincInterpolateImageWelchFunction.h:123
otb::Function::WelchWindowFunction::GetRadius
unsigned int GetRadius() const
Definition: otbWindowedSincInterpolateImageWelchFunction.h:52
otb::WindowedSincInterpolateImageFunctionBase::IteratorType
Superclass::IteratorType IteratorType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:167
otb::WindowedSincInterpolateImageWelchFunction::Superclass
WindowedSincInterpolateImageFunctionBase< TInputImage, typename Function::WelchWindowFunction< TInputInterpolator, TOutputInterpolator >, TBoundaryCondition, TCoordRep > Superclass
Definition: otbWindowedSincInterpolateImageWelchFunction.h:104
otb::WindowedSincInterpolateImageWelchFunction::Self
WindowedSincInterpolateImageWelchFunction Self
Definition: otbWindowedSincInterpolateImageWelchFunction.h:101
otb::WindowedSincInterpolateImageWelchFunction::RealType
Superclass::RealType RealType
Definition: otbWindowedSincInterpolateImageWelchFunction.h:124
otbWindowedSincInterpolateImageFunctionBase.h
otb::WindowedSincInterpolateImageFunctionBase
Use the windowed sinc function to interpolate.
Definition: otbWindowedSincInterpolateImageFunctionBase.h:140
otb::Function::WelchWindowFunction::SetRadius
void SetRadius(unsigned int radius)
Definition: otbWindowedSincInterpolateImageWelchFunction.h:47
otb::Function::WelchWindowFunction::m_Radius
unsigned int m_Radius
Definition: otbWindowedSincInterpolateImageWelchFunction.h:71
otb::Function::WelchWindowFunction::operator()
TOutput operator()(const TInput &A) const
Definition: otbWindowedSincInterpolateImageWelchFunction.h:62