SeparableFilter.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.8.5
// ----------------------------------------------------------------------------
// pcl/SeparableFilter.h - Released 2024-12-28T16:53:48Z
// ----------------------------------------------------------------------------
// 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_SeparableFilter_h
#define __PCL_SeparableFilter_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/Matrix.h>
#include <pcl/Vector.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS SeparableFilter
{
public:
 
   using coefficient = float;
 
   using coefficient_vector = GenericVector<coefficient>;
 
   using coefficient_matrix = GenericMatrix<coefficient>;
 
   SeparableFilter( const String& name = String() )
      : m_filterName( name )
   {
   }
 
   SeparableFilter( int n, const String& name = String() )
      : m_rowFilter( PCL_VALID_KERNEL_SIZE( n ) )
      , m_colFilter( PCL_VALID_KERNEL_SIZE( n ) )
      , m_filterName( name )
   {
      PCL_PRECONDITION( n == 0 || n >= 3 )
      PCL_PRECONDITION( n == 0 || (n & 1) )
   }
 
   template <typename T>
   SeparableFilter( int n, const T& x, const String& name = String() )
      : m_rowFilter( x, PCL_VALID_KERNEL_SIZE( n ) )
      , m_colFilter( x, PCL_VALID_KERNEL_SIZE( n ) )
      , m_filterName( name )
   {
      PCL_PRECONDITION( n == 0 || n >= 3 )
      PCL_PRECONDITION( n == 0 || (n & 1) )
   }
 
   SeparableFilter( const coefficient_vector& h, const coefficient_vector& v, const String& name = String() )
      : m_rowFilter( h )
      , m_colFilter( v )
      , m_filterName( name )
   {
      PCL_PRECONDITION( v.Length() == h.Length() )
      PCL_PRECONDITION( v.IsEmpty() || v.Length() >= 3 )
      PCL_PRECONDITION( v.IsEmpty() || (v.Length() & 1) )
   }
 
   template <typename T>
   SeparableFilter( const T* h, const T* v, int n, const String& name = String() )
      : m_rowFilter( h, PCL_VALID_KERNEL_SIZE( n ) )
      , m_colFilter( v, PCL_VALID_KERNEL_SIZE( n ) )
      , m_filterName( name )
   {
      PCL_PRECONDITION( n == 0 || n >= 3 )
      PCL_PRECONDITION( n == 0 || (n & 1) )
   }
 
   SeparableFilter( const SeparableFilter& ) = default;
 
   SeparableFilter( SeparableFilter&& ) = default;
 
   virtual ~SeparableFilter()
   {
   }
 
   virtual SeparableFilter* Clone() const
   {
      return new SeparableFilter( *this );
   }
 
   SeparableFilter& operator =( const SeparableFilter& ) = default;
 
   SeparableFilter& operator =( SeparableFilter&& ) = default;
 
   SeparableFilter& operator =( const coefficient& x )
   {
      m_rowFilter = x;
      m_colFilter = x;
      return *this;
   }
 
   bool operator ==( const SeparableFilter& f ) const
   {
      return Name() == f.Name() && SameCoefficients( f );
   }
 
   String Name() const
   {
      return m_filterName;
   }
 
   virtual void Rename( const String& newName )
   {
      m_filterName = newName.Trimmed();
   }
 
   int Size() const
   {
      return m_rowFilter.Length(); // both 1D filters have the same length
   }
 
   virtual void Resize( int n )
   {
      PCL_PRECONDITION( n == 0 || n >= 3 )
      PCL_PRECONDITION( n == 0 || (n & 1) )
      if ( n == 0 )
         m_colFilter = m_rowFilter = coefficient_vector();
      else
         m_colFilter = m_rowFilter = coefficient_vector( PCL_VALID_KERNEL_SIZE( n ) );
   }
 
   bool IsEmpty() const
   {
      return m_rowFilter.IsEmpty(); // both 1D filters have the same length
   }
 
   coefficient_vector RowFilter() const
   {
      return m_rowFilter;
   }
 
   coefficient_vector ColumnFilter() const
   {
      return m_colFilter;
   }
 
   coefficient_vector ColFilter() const
   {
      return ColumnFilter();
   }
 
   template <typename T>
   GenericVector<T> RowFilterAs( T* ) const
   {
      return GenericVector<T>( m_rowFilter.Begin(), m_rowFilter.Length() );
   }
 
   template <typename T>
   GenericVector<T> ColumnFilterAs( T* ) const
   {
      return GenericVector<T>( m_colFilter.Begin(), m_rowFilter.Length() );
   }
 
   template <typename T>
   GenericVector<T> ColFilterAs( T* ) const
   {
      return ColumnFilterAs( (T*)0 );
   }
 
   coefficient_vector Filter( int phase ) const
   {
      return phase ? m_colFilter : m_rowFilter;
   }
 
   template <typename T>
   GenericVector<T> FilterAs( int phase, T* ) const
   {
      return phase ? ColumnFilterAs( (T*)0 ) : RowFilterAs( (T*)0 );
   }
 
   double Weight() const
   {
      return m_rowFilter.Sum() * m_colFilter.Sum();
   }
 
   bool IsHighPassFilter() const
   {
      int s = -1;
      for ( coefficient_vector::const_iterator i = m_rowFilter.Begin(); i < m_rowFilter.End(); ++i )
         if ( *i != 0 )
            for ( s = *i < 0; ++i < m_rowFilter.End(); )
               if ( *i != 0 && (*i < 0) != s )
                  return true;
      for ( coefficient_vector::const_iterator i = m_colFilter.Begin(); i < m_colFilter.End(); ++i )
         if ( *i != 0 )
            for ( s = (s < 0) ? *i++ < 0 : s; i < m_colFilter.End(); ++i )
               if ( *i != 0 && (*i < 0) != s )
                  return true;
      return false;
   }
 
   bool SameCoefficients( const SeparableFilter& f ) const
   {
      return m_colFilter == f.m_colFilter && m_rowFilter == f.m_rowFilter;
   }
 
   virtual void Clear()
   {
      m_colFilter = m_rowFilter = coefficient_vector();
   }
 
protected:
 
   /*
    * Horizontal and vertical one-dimensional filters. The 2D filter matrix is
    * equal to the product of these two vectors.
    */
   coefficient_vector m_rowFilter;
   coefficient_vector m_colFilter;
 
   /*
    * Identifying name.
    */
   String m_filterName;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_SeparableFilter_h
 
// ----------------------------------------------------------------------------
// EOF pcl/SeparableFilter.h - Released 2024-12-28T16:53:48Z