PCL
MultiscaleMedianTransform.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.4.0
6 // ----------------------------------------------------------------------------
7 // pcl/MultiscaleMedianTransform.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_MultiscaleMedianTransform_h
53 #define __PCL_MultiscaleMedianTransform_h
54 
56 
57 #include <pcl/Defs.h>
58 #include <pcl/Diagnostics.h>
59 
61 
62 namespace pcl
63 {
64 
65 // ----------------------------------------------------------------------------
66 
125 {
126 public:
127 
132 
137 
142 
167  MultiscaleMedianTransform( int n = 4, int d = 0 )
169  {
170  }
171 
176 
181 
187  {
188  }
189 
193  MultiscaleMedianTransform& operator =( const MultiscaleMedianTransform& ) = default;
194 
198  MultiscaleMedianTransform& operator =( MultiscaleMedianTransform&& ) = default;
199 
207  {
208  return m_multiwayStructures;
209  }
210 
218  void EnableMultiwayStructures( bool enable = true )
219  {
220  DestroyLayers();
221  m_multiwayStructures = enable;
222  }
223 
231  void DisableMultiwayStructures( bool disable = true )
232  {
233  EnableMultiwayStructures( !disable );
234  }
235 
241  {
242  return m_medianWaveletTransform;
243  }
244 
258  void SetMedianWaveletTransform( float threshold = 5 )
259  {
260  DestroyLayers();
261  m_medianWaveletTransform = true;
262  m_medianWaveletThreshold = Max( 0.F, threshold );
263  }
264 
279  void SetMedianWaveletThreshold( float threshold )
280  {
281  DestroyLayers();
282  m_medianWaveletThreshold = Max( 0.F, threshold );
283  }
284 
290  {
291  return m_medianWaveletThreshold;
292  }
293 
301  {
302  DestroyLayers();
303  m_medianWaveletTransform = false;
304  }
305 
306 private:
307 
308  /*
309  * Use multiway structural elements for improved isotropy.
310  */
311  bool m_multiwayStructures = true;
312 
313  /*
314  * Compute a wavelet-median transform.
315  */
316  bool m_medianWaveletTransform = false;
317 
318  /*
319  * Median-wavelet threshold in sigma units.
320  */
321  float m_medianWaveletThreshold = 5.0F;
322 
323  /*
324  * Transform (decomposition)
325  */
326  void Transform( const pcl::Image& ) override;
327  void Transform( const pcl::DImage& ) override;
328  void Transform( const pcl::ComplexImage& ) override;
329  void Transform( const pcl::DComplexImage& ) override;
330  void Transform( const pcl::UInt8Image& ) override;
331  void Transform( const pcl::UInt16Image& ) override;
332  void Transform( const pcl::UInt32Image& ) override;
333 
334  friend class MMTDecomposition;
335 };
336 
337 // ----------------------------------------------------------------------------
338 
339 } // pcl
340 
341 #endif // __PCL_MultiscaleMedianTransform_h
342 
343 // ----------------------------------------------------------------------------
344 // EOF pcl/MultiscaleMedianTransform.h - Released 2020-07-31T19:33:04Z
Multiscale median transform / hybrid median-wavelet transform.
PCL root namespace.
Definition: AbstractImage.h:76
RedundantMultiscaleTransform::transform transform
void SetMedianWaveletTransform(float threshold=5)
16-bit unsigned integer image.
RedundantMultiscaleTransform::layer layer
32-bit floating point complex image.
Base class of all redundant multiscale transforms.
constexpr const T & Max(const T &a, const T &b)
Definition: Utility.h:119
void SetMedianWaveletThreshold(float threshold)
64-bit floating point real image.
32-bit unsigned integer image.
8-bit unsigned integer image.
void DisableMultiwayStructures(bool disable=true)
64-bit floating point complex image.
void EnableMultiwayStructures(bool enable=true)
32-bit floating point real image.
RedundantMultiscaleTransform::layer_state_set layer_state_set