PCL
LinearFilter.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.6.5
6 // ----------------------------------------------------------------------------
7 // pcl/LinearFilter.h - Released 2024-01-13T15:47:58Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_LinearFilter_h
53 #define __PCL_LinearFilter_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 #include <pcl/KernelFilter.h>
60 
61 namespace pcl
62 {
63 
64 // ----------------------------------------------------------------------------
65 
83 class PCL_CLASS LinearFilter : public KernelFilter
84 {
85 public:
86 
91  LinearFilter() = default;
92 
98  LinearFilter( int n, float v0 = 1.0F, float v1 = 0.01F, const String& name = String() )
99  : KernelFilter( n, name )
100  {
101  Initialize( v0, v1 );
102  }
103 
107  LinearFilter( const LinearFilter& ) = default;
108 
112  LinearFilter( LinearFilter&& ) = default;
113 
116  KernelFilter* Clone() const override
117  {
118  return new LinearFilter( *this );
119  }
120 
124  LinearFilter& operator =( const LinearFilter& ) = default;
125 
129  LinearFilter& operator =( LinearFilter&& ) = default;
130 
134  float CentralValue() const
135  {
136  return m_centralValue;
137  }
138 
142  float OuterValue() const
143  {
144  return m_outerValue;
145  }
146 
151  void Set( float v0, float v1 )
152  {
153  Initialize( v0, v1 );
154  }
155 
160  void Set( float v1 )
161  {
162  Initialize( m_centralValue, v1 );
163  }
164 
169  void Resize( int n ) override
170  {
172  Initialize( m_centralValue, m_outerValue );
173  }
174 
175 private:
176 
177  float m_centralValue = 1.0F;
178  float m_outerValue = 0.01F;
179 
180  void Initialize( float v0, float v1 )
181  {
182  m_centralValue = v0;
183  m_outerValue = v1;
184  float* h = *coefficients;
185  if ( h != nullptr )
186  {
187  int n2 = Size() >> 1;
188  float dvn2 = (v1 - v0)/n2;
189  for ( int y = -n2; y <= n2; ++y )
190  for ( int x = -n2; x <= n2; ++x )
191  *h++ = v0 + Sqrt( float( x*x + y*y ) ) * dvn2;
192  }
193  }
194 };
195 
196 // ----------------------------------------------------------------------------
197 
198 } // pcl
199 
200 #endif // __PCL_LinearFilter_h
201 
202 // ----------------------------------------------------------------------------
203 // EOF pcl/LinearFilter.h - Released 2024-01-13T15:47:58Z
pcl
PCL root namespace.
Definition: AbstractImage.h:76
pcl::LinearFilter::Set
void Set(float v1)
Definition: LinearFilter.h:160
pcl::String
Unicode (UTF-16) string.
Definition: String.h:8112
pcl::LinearFilter::Set
void Set(float v0, float v1)
Definition: LinearFilter.h:151
pcl::LinearFilter::CentralValue
float CentralValue() const
Definition: LinearFilter.h:134
pcl::LinearFilter::Resize
void Resize(int n) override
Definition: LinearFilter.h:169
KernelFilter.h
pcl::LinearFilter
A kernel filter that follows a discrete linear distribution with radial symmetry in two dimensions.
Definition: LinearFilter.h:83
pcl::LinearFilter::Clone
KernelFilter * Clone() const override
Definition: LinearFilter.h:116
pcl::Sqrt
Complex< T > Sqrt(const Complex< T > &c) noexcept
Definition: Complex.h:674
pcl::KernelFilter
Kernel filter in two dimensions.
Definition: KernelFilter.h:89
pcl::LinearFilter::OuterValue
float OuterValue() const
Definition: LinearFilter.h:142
pcl::LinearFilter::LinearFilter
LinearFilter(int n, float v0=1.0F, float v1=0.01F, const String &name=String())
Definition: LinearFilter.h:98
Defs.h
pcl::KernelFilter::Resize
virtual void Resize(int n)
Definition: KernelFilter.h:309