PCL
AdaptiveLocalFilter.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.4.0
6 // ----------------------------------------------------------------------------
7 // pcl/AdaptiveLocalFilter.h - Released 2020-07-31T19:33:04Z
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-2020 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 (http://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_AdaptiveLocalFilter_h
53 #define __PCL_AdaptiveLocalFilter_h
54 
56 
57 #include <pcl/Defs.h>
58 #include <pcl/Diagnostics.h>
59 
61 #include <pcl/ParallelProcess.h>
62 
63 namespace pcl
64 {
65 
66 // ----------------------------------------------------------------------------
67 
80 class PCL_CLASS AdaptiveLocalFilter : public ImageTransformation,
81  public ParallelProcess
82 {
83 public:
84 
108  AdaptiveLocalFilter( double sigma, int size = 5, bool useMAD = false )
109  : m_size( Max( 3, size|1 ) )
110  , m_sigma( Max( 0.0, sigma ) )
111  , m_useMAD( useMAD )
112  {
113  }
114 
118  AdaptiveLocalFilter( const AdaptiveLocalFilter& ) = default;
119 
124  {
125  }
126 
130  int Size() const
131  {
132  return m_size;
133  }
134 
138  void SetSize( int size )
139  {
140  PCL_PRECONDITION( size >= 3 )
141  PCL_PRECONDITION( (size & 1) != 0 )
142  m_size = Max( 3, size|1 );
143  }
144 
153  double Sigma() const
154  {
155  return m_sigma;
156  }
157 
168  void SetSigma( double sigma )
169  {
170  PCL_PRECONDITION( sigma >= 0 )
171  m_sigma = Max( 0.0, sigma );
172  }
173 
178  bool UsingMAD() const
179  {
180  return m_useMAD;
181  }
182 
188  void UseMAD( bool useMAD = true )
189  {
190  m_useMAD = useMAD;
191  }
192 
193 protected:
194 
195  int m_size; // filter size in pixels.
196  double m_sigma = 5; // standard deviation of the noise in the target image.
197  bool m_useMAD = false; // use MAD instead of variance / standard deviation.
198 
199  /*
200  * Adaptive local filter in the spatial domain.
201  */
202  void Apply( pcl::Image& ) const override;
203  void Apply( pcl::DImage& ) const override;
204  void Apply( pcl::UInt8Image& ) const override;
205  void Apply( pcl::UInt16Image& ) const override;
206  void Apply( pcl::UInt32Image& ) const override;
207 };
208 
209 // ----------------------------------------------------------------------------
210 
211 } // pcl
212 
213 #endif // __PCL_AdaptiveLocalFilter_h
214 
215 // ----------------------------------------------------------------------------
216 // EOF pcl/AdaptiveLocalFilter.h - Released 2020-07-31T19:33:04Z
Adaptive, local noise reduction filter in the spatial domain.
PCL root namespace.
Definition: AbstractImage.h:76
16-bit unsigned integer image.
void UseMAD(bool useMAD=true)
AdaptiveLocalFilter(double sigma, int size=5, bool useMAD=false)
void Apply(FI i, FI j, F f)
Definition: Utility.h:249
constexpr const T & Max(const T &a, const T &b)
Definition: Utility.h:119
64-bit floating point real image.
32-bit unsigned integer image.
8-bit unsigned integer image.
Root base class of all PCL image transformations.
32-bit floating point real image.
A process using multiple concurrent execution threads.