PCL
BidimensionalInterpolation.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.1.19
6 // ----------------------------------------------------------------------------
7 // pcl/BidimensionalInterpolation.h - Released 2019-11-07T10:59:34Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2019 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (http://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_BidimensionalInterpolation_h
53 #define __PCL_BidimensionalInterpolation_h
54 
56 
57 #include <pcl/Defs.h>
58 #include <pcl/Diagnostics.h>
59 
60 #include <pcl/Exception.h>
61 
62 namespace pcl
63 {
64 
65 // ----------------------------------------------------------------------------
66 
74 template <typename T>
76 {
77 public:
78 
82  BidimensionalInterpolation() = default;
83 
88 
93  {
94  Clear();
95  }
96 
110  virtual void Initialize( const T* data, int width, int height )
111  {
112  if ( data == nullptr )
113  throw Error( "Null data pointer in BidimensionalInterpolation::Initialize()" );
114  if ( width <= 0 || height <= 0 )
115  throw Error( "Invalid dimensions in BidimensionalInterpolation::Initialize()" );
116  m_data = data;
117  m_width = width;
118  m_height = height;
119  }
120 
124  virtual double operator()( double x, double y ) const = 0;
125 
131  virtual void Clear()
132  {
133  m_data = nullptr;
134  m_width = m_height = 0;
135  }
136 
140  const T* BeingInterpolated() const
141  {
142  return m_data;
143  }
144 
148  int Width() const
149  {
150  return m_width;
151  }
152 
156  int Height() const
157  {
158  return m_height;
159  }
160 
170  void EnableBorderFilling( bool enable = true )
171  {
172  m_fillBorder = enable;
173  }
174 
182  void DisableBorderFilling( bool disable = true )
183  {
184  m_fillBorder = !disable;
185  }
186 
192  {
193  return m_fillBorder;
194  }
195 
205  void SetBorderFillValue( double v )
206  {
207  m_fillValue = v;
208  }
209 
215  double BorderFillValue() const
216  {
217  return m_fillValue;
218  }
219 
220 protected:
221 
222  const T* m_data = nullptr; // functional data being interpolated
223  int m_width = 0; // width of the data table
224  int m_height = 0; // height of the data table
225  double m_fillValue = 0; // fill value, when m_fillBorder = true
226  bool m_fillBorder = false; // don't apply Neumann boundary conditions
227 };
228 
229 // ----------------------------------------------------------------------------
230 
231 } // pcl
232 
233 #endif // __PCL_BidimensionalInterpolation_h
234 
235 // ----------------------------------------------------------------------------
236 // EOF pcl/BidimensionalInterpolation.h - Released 2019-11-07T10:59:34Z
PCL root namespace.
Definition: AbstractImage.h:76
A generic interface to two-dimensional interpolation algorithms.
A simple exception with an associated error message.
Definition: Exception.h:213
virtual void Initialize(const T *data, int width, int height)