LinearFilter.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/LinearFilter.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_LinearFilter_h
#define __PCL_LinearFilter_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/KernelFilter.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS LinearFilter : public KernelFilter
{
public:
 
   LinearFilter() = default;
 
   LinearFilter( int n, float v0 = 1.0F, float v1 = 0.01F, const String& name = String() )
      : KernelFilter( n, name )
   {
      Initialize( v0, v1 );
   }
 
   LinearFilter( const LinearFilter& ) = default;
 
   LinearFilter( LinearFilter&& ) = default;
 
   KernelFilter* Clone() const override
   {
      return new LinearFilter( *this );
   }
 
   LinearFilter& operator =( const LinearFilter& ) = default;
 
   LinearFilter& operator =( LinearFilter&& ) = default;
 
   float CentralValue() const
   {
      return m_centralValue;
   }
 
   float OuterValue() const
   {
      return m_outerValue;
   }
 
   void Set( float v0, float v1 )
   {
      Initialize( v0, v1 );
   }
 
   void Set( float v1 )
   {
      Initialize( m_centralValue, v1 );
   }
 
   void Resize( int n ) override
   {
      KernelFilter::Resize( n );
      Initialize( m_centralValue, m_outerValue );
   }
 
private:
 
   float m_centralValue = 1.0F;
   float m_outerValue = 0.01F;
 
   void Initialize( float v0, float v1 )
   {
      m_centralValue = v0;
      m_outerValue = v1;
      float* h = *coefficients;
      if ( h != nullptr )
      {
         int n2 = Size() >> 1;
         float dvn2 = (v1 - v0)/n2;
         for ( int y = -n2; y <= n2; ++y )
            for ( int x = -n2; x <= n2; ++x )
               *h++ = v0 + Sqrt( float( x*x + y*y ) ) * dvn2;
      }
   }
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_LinearFilter_h
 
// ----------------------------------------------------------------------------
// EOF pcl/LinearFilter.h - Released 2024-06-18T15:48:54Z