MultiscaleMedianTransform.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/MultiscaleMedianTransform.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// 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_MultiscaleMedianTransform_h
#define __PCL_MultiscaleMedianTransform_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/RedundantMultiscaleTransform.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS MultiscaleMedianTransform : public RedundantMultiscaleTransform
{
public:
 
   using layer = RedundantMultiscaleTransform::layer;
 
   using transform = RedundantMultiscaleTransform::transform;
 
   using layer_state_set = RedundantMultiscaleTransform::layer_state_set;
 
   MultiscaleMedianTransform( int n = 4, int d = 0 )
      : RedundantMultiscaleTransform( n, d )
   {
   }
 
   MultiscaleMedianTransform( const MultiscaleMedianTransform& ) = default;
 
   MultiscaleMedianTransform( MultiscaleMedianTransform&& ) = default;
 
   ~MultiscaleMedianTransform() override
   {
   }
 
   MultiscaleMedianTransform& operator =( const MultiscaleMedianTransform& ) = default;
 
   MultiscaleMedianTransform& operator =( MultiscaleMedianTransform&& ) = default;
 
   bool UsingMultiwayStructures() const
   {
      return m_multiwayStructures;
   }
 
   void EnableMultiwayStructures( bool enable = true )
   {
      DestroyLayers();
      m_multiwayStructures = enable;
   }
 
   void DisableMultiwayStructures( bool disable = true )
   {
      EnableMultiwayStructures( !disable );
   }
 
   bool IsMedianWaveletTransform() const
   {
      return m_medianWaveletTransform;
   }
 
   void SetMedianWaveletTransform( float threshold = 5 )
   {
      DestroyLayers();
      m_medianWaveletTransform = true;
      m_medianWaveletThreshold = Max( 0.F, threshold );
   }
 
   void SetMedianWaveletThreshold( float threshold )
   {
      DestroyLayers();
      m_medianWaveletThreshold = Max( 0.F, threshold );
   }
 
   float MedianWaveletThreshold() const
   {
      return m_medianWaveletThreshold;
   }
 
   void SetMultiscaleMedianTransform()
   {
      DestroyLayers();
      m_medianWaveletTransform = false;
   }
 
private:
 
   /*
    * Use multiway structural elements for improved isotropy.
    */
   bool m_multiwayStructures = true;
 
   /*
    * Compute a wavelet-median transform.
    */
   bool m_medianWaveletTransform = false;
 
   /*
    * Median-wavelet threshold in sigma units.
    */
   float m_medianWaveletThreshold = 5.0F;
 
   /*
    * Transform (decomposition)
    */
   void Transform( const pcl::Image& ) override;
   void Transform( const pcl::DImage& ) override;
   void Transform( const pcl::ComplexImage& ) override;
   void Transform( const pcl::DComplexImage& ) override;
   void Transform( const pcl::UInt8Image& ) override;
   void Transform( const pcl::UInt16Image& ) override;
   void Transform( const pcl::UInt32Image& ) override;
 
   friend class MMTDecomposition;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_MultiscaleMedianTransform_h
 
// ----------------------------------------------------------------------------
// EOF pcl/MultiscaleMedianTransform.h - Released 2024-01-13T15:47:58Z