SeparableConvolution.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/SeparableConvolution.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_SeparableConvolution_h
#define __PCL_SeparableConvolution_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/AutoPointer.h>
#include <pcl/InterlacedTransformation.h>
#include <pcl/ParallelProcess.h>
#include <pcl/SeparableFilter.h>
 
#define __PCL_SEPARABLE_CONVOLUTION_TINY_WEIGHT  1.0e-20
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS SeparableConvolution : public InterlacedTransformation,
                                       public ParallelProcess
{
public:
 
   using coefficient = SeparableFilter::coefficient;
 
   using coefficient_vector = SeparableFilter::coefficient_vector;
 
   SeparableConvolution() = default;
 
   SeparableConvolution( const SeparableFilter& filter )
   {
      SetFilter( filter );
   }
 
   SeparableConvolution( const SeparableConvolution& x )
      : InterlacedTransformation( x )
      , ParallelProcess( x )
      , m_weight( x.m_weight )
      , m_highPass( x.m_highPass )
      , m_rawHighPass( x.m_rawHighPass )
      , m_rescaleHighPass( x.m_rescaleHighPass )
      , m_convolveRows( x.m_convolveRows )
      , m_convolveCols( x.m_convolveCols )
   {
      if ( !x.m_filter.IsNull() )
         m_filter = x.m_filter->Clone();
   }
 
   SeparableConvolution( SeparableConvolution&& ) = default;
 
   ~SeparableConvolution() override
   {
   }
 
   SeparableConvolution& operator =( const SeparableConvolution& x )
   {
      if ( &x != this )
      {
         (void)InterlacedTransformation::operator =( x );
         (void)ParallelProcess::operator =( x );
         if ( x.m_filter.IsNull() )
            m_filter.Destroy();
         else
            m_filter = x.m_filter->Clone();
         m_weight = x.m_weight;
         m_highPass = x.m_highPass;
         m_rawHighPass = x.m_rawHighPass;
         m_rescaleHighPass = x.m_rescaleHighPass;
         m_convolveRows = x.m_convolveRows;
         m_convolveCols = x.m_convolveCols;
      }
      return *this;
   }
 
   SeparableConvolution& operator =( SeparableConvolution&& ) = default;
 
   const SeparableFilter& Filter() const
   {
      PCL_PRECONDITION( !m_filter.IsNull() )
      return *m_filter;
   }
 
   coefficient_vector Filter( int phase ) const
   {
      PCL_PRECONDITION( !m_filter.IsNull() )
      return m_filter->Filter( phase );
   }
 
   void SetFilter( const SeparableFilter& filter )
   {
      m_filter = filter.Clone();
      CacheFilterProperties();
   }
 
   double FilterWeight() const
   {
      return m_weight;
   }
 
   bool IsHighPassFilter() const
   {
      return m_highPass;
   }
 
   bool IsHighPassRescalingEnabled() const
   {
      return m_rescaleHighPass;
   }
 
   void EnableHighPassRescaling( bool enable = true )
   {
      m_rescaleHighPass = enable;
   }
 
   void DisableHighPassRescaling( bool disable = true )
   {
      EnableHighPassRescaling( !disable );
   }
 
   bool IsRawHighPassEnabled() const
   {
      return m_rawHighPass;
   }
 
   void EnableRawHighPass( bool enable = true )
   {
      m_rawHighPass = enable;
   }
 
   void DisableRawHighPass( bool disable = true )
   {
      EnableRawHighPass( !disable );
   }
 
   bool IsRowConvolutionEnabled() const
   {
      return m_convolveRows;
   }
 
   void EnableRowConvolution( bool enable = true )
   {
      m_convolveRows = enable;
   }
 
   void DisableRowConvolution( bool disable = true )
   {
      EnableRowConvolution( !disable );
   }
 
   bool IsColumnConvolutionEnabled() const
   {
      return m_convolveCols;
   }
 
   void EnableColumnConvolution( bool enable = true )
   {
      m_convolveCols = enable;
   }
 
   void DisableColumnConvolution( bool disable = true )
   {
      EnableColumnConvolution( !disable );
   }
 
   int OverlappingDistance() const
   {
      PCL_PRECONDITION( !m_filter.IsNull() )
      return m_filter->Size() + (m_filter->Size() - 1)*(InterlacingDistance() - 1);
   }
 
   static constexpr int FasterThanNonseparableFilterSize( int numThreads )
   {
#ifdef __PCL_COMPATIBILITY
 
      // No vectorization
 
      if ( numThreads >= 32 )
         return 15;
      if ( numThreads >= 16 )
         return 11;
      if ( numThreads >= 8 )
         return 9;
      if ( numThreads >= 4 )
         return 7;
      return 5;
 
#else
 
      // Vectorization with SSE4.2 / AVX2 and FMA instructions
 
      if ( numThreads >= 32 )
         return 29;
      if ( numThreads >= 28 )
         return 25;
      if ( numThreads >= 24 )
         return 21;
      if ( numThreads >= 16 )
         return 19;
      if ( numThreads >= 8 )
         return 13;
      if ( numThreads >= 4 )
         return 11;
      if ( numThreads >= 2 )
         return 9;
      return 7;
 
#endif
   }
 
protected:
 
   /*
    * The response function for convolution is a separable filter.
    */
   AutoPointer<SeparableFilter> m_filter;
 
   /*
    * Cached filter properties.
    */
   double m_weight = 0;       // filter weight for low-pass normalization
   bool   m_highPass = false; // true iff this is a high-pass filter
 
   /*
    * User-selectable options.
    */
   bool   m_rawHighPass = false;     // neither truncate nor normalize out-of-range values
   bool   m_rescaleHighPass = false; // truncate out-of-range values instead of normalize
   bool   m_convolveRows = true;     // perform one-dimensional convolution of pixel rows
   bool   m_convolveCols = true;     // perform one-dimensional convolution of pixel columns
 
   /*
    * In-place 2-D separable convolution algorithm.
    */
   void Apply( pcl::Image& ) const override;
   void Apply( pcl::DImage& ) const override;
   void Apply( pcl::UInt8Image& ) const override;
   void Apply( pcl::UInt16Image& ) const override;
   void Apply( pcl::UInt32Image& ) const override;
 
private:
 
   void CacheFilterProperties()
   {
      PCL_PRECONDITION( !m_filter.IsNull() )
      PCL_PRECONDITION( !m_filter->IsEmpty() )
      ValidateFilter();
      m_highPass = m_filter->IsHighPassFilter();
      m_weight = m_filter->Weight();
      if ( pcl::Abs( m_weight ) < __PCL_SEPARABLE_CONVOLUTION_TINY_WEIGHT )
         m_weight = 1;
   }
 
   void ValidateFilter() const;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_SeparableConvolution_h
 
// ----------------------------------------------------------------------------
// EOF pcl/SeparableConvolution.h - Released 2024-01-13T15:47:58Z