OTB  9.0.0
Orfeo Toolbox
otbWindowedSincInterpolateImageGaussianFunction.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 otbWindowedSincInterpolateImageGaussianFunction_h
22 #define otbWindowedSincInterpolateImageGaussianFunction_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 = -2. / (static_cast<double>(m_Radius * m_Radius) * CONST_PI);
51  }
52  double GetFactor()
53  {
54  return m_Factor;
55  }
56  unsigned int GetRadius() const
57  {
58  return m_Radius;
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 = std::exp(px * px * m_Factor);
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  double m_Factor;
73 };
74 
75 } // namespace Function
76 
92 template <class TInputImage, class TBoundaryCondition = itk::ZeroFluxNeumannBoundaryCondition<TInputImage>, class TCoordRep = double,
93  class TInputInterpolator = double, class TOutputInterpolator = double>
95  : public WindowedSincInterpolateImageFunctionBase<TInputImage, typename Function::GaussianWindowFunction<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  WindowedSincInterpolateImageGaussianFunction(const Self&) = delete;
140  void operator=(const Self&) = delete;
141 };
142 
143 } // end namespace otb
144 
145 #endif
otb::WindowedSincInterpolateImageFunctionBase::InputImageType
Superclass::InputImageType InputImageType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:154
otb::Function::GaussianWindowFunction::GetRadius
unsigned int GetRadius() const
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:56
otb::CONST_PI
constexpr double CONST_PI
Definition: otbMath.h:49
otb::WindowedSincInterpolateImageFunctionBase::IndexType
Superclass::IndexType IndexType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:164
otb::WindowedSincInterpolateImageGaussianFunction::OutputType
Superclass::OutputType OutputType
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:116
otb::Function::GaussianWindowFunction::m_Radius
unsigned int m_Radius
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:71
otb::WindowedSincInterpolateImageFunctionBase::SizeType
Superclass::SizeType SizeType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:165
otb::WindowedSincInterpolateImageGaussianFunction
Use the WindowedSincInterpolateImageFunctionBase with a Gaussian Function.
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:94
otb::WindowedSincInterpolateImageFunctionBase::RealType
Superclass::RealType RealType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:166
otb::WindowedSincInterpolateImageGaussianFunction::RealType
Superclass::RealType RealType
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:124
otb::WindowedSincInterpolateImageGaussianFunction::Self
WindowedSincInterpolateImageGaussianFunction Self
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:101
otb
The "otb" namespace contains all Orfeo Toolbox (OTB) classes.
Definition: otbJoinContainer.h:32
otb::WindowedSincInterpolateImageGaussianFunction::Pointer
itk::SmartPointer< Self > Pointer
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:105
otb::Function::GaussianWindowFunction::SetRadius
void SetRadius(unsigned int radius)
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:47
otb::WindowedSincInterpolateImageGaussianFunction::IndexType
Superclass::IndexType IndexType
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:122
otb::WindowedSincInterpolateImageFunctionBase::OutputType
Superclass::OutputType OutputType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:158
otb::WindowedSincInterpolateImageGaussianFunction::SizeType
Superclass::SizeType SizeType
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:123
otb::WindowedSincInterpolateImageFunctionBase::ContinuousIndexType
Superclass::ContinuousIndexType ContinuousIndexType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:168
otb::Function::GaussianWindowFunction::GetFactor
double GetFactor()
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:52
otb::WindowedSincInterpolateImageFunctionBase::IteratorType
Superclass::IteratorType IteratorType
Definition: otbWindowedSincInterpolateImageFunctionBase.h:167
otb::WindowedSincInterpolateImageGaussianFunction::PrintSelf
void PrintSelf(std::ostream &os, itk::Indent indent) const override
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:133
otb::Function::GaussianWindowFunction::GaussianWindowFunction
GaussianWindowFunction()
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:44
otb::WindowedSincInterpolateImageGaussianFunction::WindowedSincInterpolateImageGaussianFunction
WindowedSincInterpolateImageGaussianFunction()
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:129
otb::WindowedSincInterpolateImageGaussianFunction::ContinuousIndexType
Superclass::ContinuousIndexType ContinuousIndexType
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:126
otb::Function::GaussianWindowFunction::m_Factor
double m_Factor
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:72
otb::WindowedSincInterpolateImageGaussianFunction::~WindowedSincInterpolateImageGaussianFunction
~WindowedSincInterpolateImageGaussianFunction() override
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:130
otb::Function::GaussianWindowFunction
Gaussian interpolation windowing function.
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:41
otb::WindowedSincInterpolateImageGaussianFunction::ConstPointer
itk::SmartPointer< const Self > ConstPointer
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:106
otb::Function::GaussianWindowFunction::operator()
TOutput operator()(const TInput &A) const
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:62
otb::WindowedSincInterpolateImageGaussianFunction::Superclass
WindowedSincInterpolateImageFunctionBase< TInputImage, typename Function::GaussianWindowFunction< TInputInterpolator, TOutputInterpolator >, TBoundaryCondition, TCoordRep > Superclass
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:104
otb::WindowedSincInterpolateImageGaussianFunction::IteratorType
Superclass::IteratorType IteratorType
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:125
otbWindowedSincInterpolateImageFunctionBase.h
otb::WindowedSincInterpolateImageFunctionBase
Use the windowed sinc function to interpolate.
Definition: otbWindowedSincInterpolateImageFunctionBase.h:140
otb::WindowedSincInterpolateImageGaussianFunction::InputImageType
Superclass::InputImageType InputImageType
Definition: otbWindowedSincInterpolateImageGaussianFunction.h:112