PCL
MeanFilter.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/MeanFilter.h - Released 2024-06-18T15:48:54Z
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_MeanFilter_h
53 #define __PCL_MeanFilter_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 #include <pcl/KernelFilter.h>
60 #include <pcl/Math.h>
61 
62 namespace pcl
63 {
64 
65 // ----------------------------------------------------------------------------
66 
86 class PCL_CLASS MeanFilter : public KernelFilter
87 {
88 public:
89 
93  MeanFilter() = default;
94 
100  MeanFilter( int n, const String& name = String() )
101  {
102  Initialize( n );
103  Rename( name );
104  }
105 
109  MeanFilter( const MeanFilter& ) = default;
110 
114  MeanFilter( MeanFilter&& ) = default;
115 
118  KernelFilter* Clone() const override
119  {
120  return new MeanFilter( *this );
121  }
122 
129  SeparableFilter AsSeparableFilter( float tolerance = __PCL_DEFAULT_FILTER_SEPARABILITY_TOLERANCE ) const override
130  {
131  FVector v = coefficients.RowVector( Size()>>1 );
132  return SeparableFilter( v, v );
133  }
134 
141  bool IsSeparable() const override
142  {
143  return true;
144  }
145 
149  MeanFilter& operator =( const MeanFilter& ) = default;
150 
154  MeanFilter& operator =( MeanFilter&& ) = default;
155 
159  void Resize( int n ) override
160  {
161  Initialize( n );
162  }
163 
164 private:
165 
166  void Initialize( int n )
167  {
168  PCL_PRECONDITION( n == 0 || n >= 3 && (n & 1) != 0 )
169  KernelFilter::Resize( n );
170  if ( !IsEmpty() )
171  coefficients = 1.0/NumberOfCoefficients();
172  }
173 };
174 
175 // ----------------------------------------------------------------------------
176 
177 } // pcl
178 
179 #endif // __PCL_MeanFilter_h
180 
181 // ----------------------------------------------------------------------------
182 // EOF pcl/MeanFilter.h - Released 2024-06-18T15:48:54Z
Generic vector of arbitrary length.
Definition: Vector.h:107
Kernel filter in two dimensions.
Definition: KernelFilter.h:90
Square block average kernel filter.
Definition: MeanFilter.h:87
SeparableFilter AsSeparableFilter(float tolerance=__PCL_DEFAULT_FILTER_SEPARABILITY_TOLERANCE) const override
Definition: MeanFilter.h:129
MeanFilter()=default
MeanFilter(const MeanFilter &)=default
KernelFilter * Clone() const override
Definition: MeanFilter.h:118
MeanFilter(int n, const String &name=String())
Definition: MeanFilter.h:100
MeanFilter(MeanFilter &&)=default
bool IsSeparable() const override
Definition: MeanFilter.h:141
void Resize(int n) override
Definition: MeanFilter.h:159
Separable filter in two dimensions.
Unicode (UTF-16) string.
Definition: String.h:8113
PCL root namespace.
Definition: AbstractImage.h:77