PCL
UnidimensionalInterpolation.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/UnidimensionalInterpolation.h - Released 2024-06-18T15:48:54Z
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-2024 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 (https://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_UnidimensionalInterpolation_h
53 #define __PCL_UnidimensionalInterpolation_h
54 
56 
57 #include <pcl/Defs.h>
58 #include <pcl/Diagnostics.h>
59 
60 #include <pcl/Vector.h>
61 
62 namespace pcl
63 {
64 
65 // ----------------------------------------------------------------------------
66 
74 template <typename T>
76 {
77 public:
78 
83 
88 
93 
98  {
99  Clear();
100  }
101 
114  virtual void Initialize( const vector_type& x, const vector_type& y )
115  {
116  if ( !y || x && x.Length() < y.Length() )
117  throw Error( "Invalid vector length in UnidimensionalInterpolation::Initialize()" );
118  m_x = x;
119  m_y = y;
120  }
121 
141  void Initialize( const T* x, const T* y, int n )
142  {
143  Initialize( vector_type( x, n ), vector_type( y, n ) );
144  }
145 
149  virtual double operator()( double x ) const = 0;
150 
156  virtual void Clear()
157  {
158  m_x.Clear();
159  m_y.Clear();
160  }
161 
166  virtual bool IsValid() const
167  {
168  return m_y;
169  }
170 
175  const vector_type& X() const
176  {
177  return m_x;
178  }
179 
183  const vector_type& Y() const
184  {
185  return m_y;
186  }
187 
192  bool UsingImplicitX() const
193  {
194  return !m_x && m_y;
195  }
196 
200  int Length() const
201  {
202  return m_y.Length();
203  }
204 
205 protected:
206 
207  vector_type m_x; // x-vector (empty if implicit grid x-values)
208  vector_type m_y; // y-vector
209 };
210 
211 // ----------------------------------------------------------------------------
212 
213 } // pcl
214 
215 #endif // __PCL_UnidimensionalInterpolation_h
216 
217 // ----------------------------------------------------------------------------
218 // EOF pcl/UnidimensionalInterpolation.h - Released 2024-06-18T15:48:54Z
A simple exception with an associated error message.
Definition: Exception.h:239
Generic vector of arbitrary length.
Definition: Vector.h:107
int Length() const noexcept
Definition: Vector.h:1784
A generic interface to one-dimensional interpolation algorithms.
void Initialize(const T *x, const T *y, int n)
virtual double operator()(double x) const =0
virtual void Initialize(const vector_type &x, const vector_type &y)
UnidimensionalInterpolation(const UnidimensionalInterpolation &)=default
PCL root namespace.
Definition: AbstractImage.h:77