BidimensionalInterpolation.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/BidimensionalInterpolation.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------
 
#ifndef __PCL_BidimensionalInterpolation_h
#define __PCL_BidimensionalInterpolation_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/Exception.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
template <typename T>
class PCL_CLASS BidimensionalInterpolation
{
public:
 
   BidimensionalInterpolation() = default;
 
   BidimensionalInterpolation( const BidimensionalInterpolation& ) = default;
 
   virtual ~BidimensionalInterpolation()
   {
      Clear();
   }
 
   virtual void Initialize( const T* data, int width, int height )
   {
      if ( data == nullptr )
         throw Error( "Null data pointer in BidimensionalInterpolation::Initialize()" );
      if ( width <= 0 || height <= 0 )
         throw Error( "Invalid dimensions in BidimensionalInterpolation::Initialize()" );
      m_data = data;
      m_width = width;
      m_height = height;
   }
 
   virtual double operator()( double x, double y ) const = 0;
 
   virtual void Clear()
   {
      m_data = nullptr;
      m_width = m_height = 0;
   }
 
   const T* BeingInterpolated() const
   {
      return m_data;
   }
 
   int Width() const
   {
      return m_width;
   }
 
   int Height() const
   {
      return m_height;
   }
 
   void EnableBorderFilling( bool enable = true )
   {
      m_fillBorder = enable;
   }
 
   void DisableBorderFilling( bool disable = true )
   {
      m_fillBorder = !disable;
   }
 
   bool IsBorderFillingEnabled() const
   {
      return m_fillBorder;
   }
 
   void SetBorderFillValue( double v )
   {
      m_fillValue = v;
   }
 
   double BorderFillValue() const
   {
      return m_fillValue;
   }
 
protected:
 
   const T* m_data       = nullptr; // functional data being interpolated
   int      m_width      = 0;       // width of the data table
   int      m_height     = 0;       // height of the data table
   double   m_fillValue  = 0;       // fill value, when m_fillBorder = true
   bool     m_fillBorder = false;   // don't apply Neumann boundary conditions
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif  // __PCL_BidimensionalInterpolation_h
 
// ----------------------------------------------------------------------------
// EOF pcl/BidimensionalInterpolation.h - Released 2024-06-18T15:48:54Z