PyramidalWaveletTransform.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/PyramidalWaveletTransform.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// 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_PyramidalWaveletTransform_h
#define __PCL_PyramidalWaveletTransform_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/ImageTransformation.h>
#include <pcl/String.h>
#include <pcl/Vector.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS WaveletFilter
{
public:
 
   WaveletFilter() = default;
 
   virtual ~WaveletFilter()
   {
   }
 
   virtual String Name() const = 0;
 
   template <typename T>
   void operator ()( T* f, size_type n, bool inverse = false ) const
   {
      Apply( f, n, inverse );
   }
 
protected:
 
   const double* Kc = nullptr; // wavelet filter coefficients
   Vector        Kr;           // transpose of filter coefficients
   int           N = 0;        // number of coefficients
   int           ioff = 0;
   int           joff = 0;
 
   void Initialize()
   {
      PCL_CHECK( Kc != nullptr && N > 0 )
      Kr = Vector( N );
      for ( int k = 0, sig = -1; k < N; ++k )
      {
         Kr[N-1-k] = sig*Kc[k];
         sig = -sig;
      }
   // ioff = joff = -(N >> 1);
      ioff = -2;
      joff = -N + 2;
   }
 
private:
 
   void Apply( float*, size_type, bool ) const;
   void Apply( double*, size_type, bool ) const;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Daubechies4Filter : public WaveletFilter
{
public:
 
   Daubechies4Filter();
 
   String Name() const override
   {
      return "Daubechies-4";
   }
};
 
extern PCL_DATA Daubechies4Filter Daubechies4;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Daubechies6Filter : public WaveletFilter
{
public:
 
   Daubechies6Filter();
 
   String Name() const override
   {
      return "Daubechies-6";
   }
};
 
extern PCL_DATA Daubechies6Filter Daubechies6;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Daubechies8Filter : public WaveletFilter
{
public:
 
   Daubechies8Filter();
 
   String Name() const override
   {
      return "Daubechies-8";
   }
};
 
extern PCL_DATA Daubechies8Filter Daubechies8;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Daubechies10Filter : public WaveletFilter
{
public:
 
   Daubechies10Filter();
 
   String Name() const override
   {
      return "Daubechies-10";
   }
};
 
extern PCL_DATA Daubechies10Filter Daubechies10;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Daubechies12Filter : public WaveletFilter
{
public:
 
   Daubechies12Filter();
 
   String Name() const override
   {
      return "Daubechies-12";
   }
};
 
extern PCL_DATA Daubechies12Filter Daubechies12;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS Daubechies20Filter : public WaveletFilter
{
public:
 
   Daubechies20Filter();
 
   String Name() const override
   {
      return "Daubechies-20";
   }
};
 
extern PCL_DATA Daubechies20Filter Daubechies20;
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS PyramidalWaveletTransform : public BidirectionalImageTransformation
{
public:
 
   PyramidalWaveletTransform() = default;
 
   PyramidalWaveletTransform( const WaveletFilter& f )
      : m_scalingFunction( &f )
   {
      PCL_CHECK( m_scalingFunction != nullptr )
   }
 
   PyramidalWaveletTransform( const PyramidalWaveletTransform& ) = default;
 
   PyramidalWaveletTransform( PyramidalWaveletTransform&& ) = default;
 
   ~PyramidalWaveletTransform() override
   {
   }
 
   PyramidalWaveletTransform& operator =( const PyramidalWaveletTransform& ) = default;
 
   PyramidalWaveletTransform& operator =( PyramidalWaveletTransform&& ) = default;
 
   const WaveletFilter& ScalingFunction() const
   {
      PCL_PRECONDITION( m_scalingFunction != nullptr )
      return *m_scalingFunction;
   }
 
   void SetScalingFunction( const WaveletFilter& f )
   {
      Clear();
      m_scalingFunction = &f;
      PCL_CHECK( m_scalingFunction != nullptr )
   }
 
   bool IsStandard() const
   {
      return !m_nonstandard;
   }
 
   bool IsNonstandard() const
   {
      return m_nonstandard;
   }
 
   void SetStandard( bool b = true )
   {
      Clear();
      m_nonstandard = !b;
   }
 
   void SetNonstandard( bool b = true )
   {
      Clear();
      m_nonstandard = b;
   }
 
   const Image& Transform() const
   {
      return m_transform;
   }
 
   Image& Transform()
   {
      return m_transform;
   }
 
   void Clear()
   {
      m_transform.FreeData();
   }
 
protected:
 
   /*
    * Scaling function, or wavelet filter.
    */
   const WaveletFilter* m_scalingFunction = nullptr;
 
   /*
    * Flag true if nonstandard transforms are being used.
    * Standard transforms are used otherwise (and by default).
    */
   bool m_nonstandard = true;
 
   /*
    * Wavelet transform
    */
   pcl::Image m_transform;
 
   void Validate() const;
   void DoTransform( StatusMonitor& );
 
   // Transform (decomposition)
   void Transform( const pcl::Image& ) override;
   void Transform( const pcl::DImage& ) override;
   void Transform( const pcl::ComplexImage& ) override;
   void Transform( const pcl::DComplexImage& ) override;
   void Transform( const pcl::UInt8Image& ) override;
   void Transform( const pcl::UInt16Image& ) override;
   void Transform( const pcl::UInt32Image& ) override;
 
   // Inverse transform (reconstruction)
   void Apply( pcl::Image& ) const override;
   void Apply( pcl::DImage& ) const override;
   void Apply( pcl::ComplexImage& ) const override;
   void Apply( pcl::DComplexImage& ) const override;
   void Apply( pcl::UInt8Image& ) const override;
   void Apply( pcl::UInt16Image& ) const override;
   void Apply( pcl::UInt32Image& ) const override;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_PyramidalWaveletTransform_h
 
// ----------------------------------------------------------------------------
// EOF pcl/PyramidalWaveletTransform.h - Released 2024-01-13T15:47:58Z