RedundantMultiscaleTransform.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/RedundantMultiscaleTransform.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// 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_RedundantMultiscaleTransform_h
#define __PCL_RedundantMultiscaleTransform_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/ImageTransformation.h>
#include <pcl/ParallelProcess.h>
#include <pcl/Vector.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS RedundantMultiscaleTransform : public BidirectionalImageTransformation,
                                               public ParallelProcess
{
public:
 
   using layer = Image;
 
   using transform = Array<layer>;
 
   using layer_state_set = GenericVector<bool>;
 
   RedundantMultiscaleTransform( int n = 4, int d = 0 )
      : m_delta( Max( 0, d ) )
      , m_numberOfLayers( Max( 1, n ) )
   {
      PCL_PRECONDITION( n >= 1 )
      PCL_PRECONDITION( d >= 0 )
      InitializeLayersAndStates();
   }
 
   RedundantMultiscaleTransform( const RedundantMultiscaleTransform& x )
      : BidirectionalImageTransformation( x )
      , ParallelProcess( x )
      , m_delta( x.m_delta )
      , m_numberOfLayers( x.m_numberOfLayers )
      , m_transform( x.m_transform )
      , m_layerEnabled( x.m_layerEnabled )
   {
      m_transform.EnsureUnique();
   }
 
   RedundantMultiscaleTransform( RedundantMultiscaleTransform&& ) = default;
 
   ~RedundantMultiscaleTransform() override
   {
   }
 
   RedundantMultiscaleTransform& operator =( const RedundantMultiscaleTransform& x )
   {
      (void)BidirectionalImageTransformation::operator =( x );
      (void)ParallelProcess::operator =( x );
      m_delta          = x.m_delta;
      m_numberOfLayers = x.m_numberOfLayers;
      m_transform      = x.m_transform;
      m_transform.EnsureUnique();
      m_layerEnabled   = x.m_layerEnabled;
      return *this;
   }
 
   RedundantMultiscaleTransform& operator =( RedundantMultiscaleTransform&& ) = default;
 
   int ScalingSequence() const
   {
      return m_delta;
   }
 
   void SetScalingSequence( int d )
   {
      PCL_PRECONDITION( d >= 0 )
      DestroyLayers();
      m_delta = Max( 0, d );
   }
 
   void SetDyadicScalingSequence()
   {
      SetScalingSequence( 0 );
   }
 
   void SetLinearScalingSequence( int d = 1 )
   {
      PCL_PRECONDITION( d >= 1 )
      SetScalingSequence( Max( 1, d ) );
   }
 
   int FilterSize( int j ) const
   {
      return 1 + (((m_delta < 1) ? 1 << j : (1 + j)*m_delta) << 1);
   }
 
   int NumberOfLayers() const
   {
      return m_numberOfLayers;
   }
 
   void SetNumberOfLayers( int n )
   {
      PCL_PRECONDITION( n >= 1 )
      m_numberOfLayers = Max( 1, n );
      InitializeLayersAndStates();
   }
 
   const layer& Layer( int i ) const
   {
      ValidateLayerAccess( i );
      return m_transform[i];
   }
 
   layer& Layer( int i )
   {
      ValidateLayerAccess( i );
      return m_transform[i];
   }
 
   const layer& operator []( int i ) const
   {
      return Layer( i );
   }
 
   layer& operator []( int i )
   {
      return Layer( i );
   }
 
   void DeleteLayer( int i )
   {
      ValidateLayerAccess( i );
      m_transform[i].FreeData();
   }
 
   bool IsLayer( int i ) const
   {
      ValidateLayerIndex( i );
      return !m_transform[i].IsEmpty();
   }
 
   void EnableLayer( int i, bool enable = true )
   {
      ValidateLayerIndex( i );
      m_layerEnabled[i] = enable;
   }
 
   void DisableLayer( int i, bool disable = true )
   {
      EnableLayer( i, !disable );
   }
 
   bool IsLayerEnabled( int i ) const
   {
      ValidateLayerIndex( i );
      return m_layerEnabled[i];
   }
 
   void BiasLayer( int i, float k )
   {
      ValidateLayerAccess( i );
      if ( k != 0 )
         m_transform[i] *= (k > 0) ? (1 + k) : 1/(1 - k);
   }
 
   virtual transform ReleaseTransform()
   {
      transform r = m_transform;
      DestroyLayers();
      return r;
   }
 
   virtual void Reset()
   {
      InitializeLayersAndStates();
   }
 
protected:
 
   /*
    * delta >= 1 :
    *    Linear scaling sequence. delta is the constant scale difference
    *    between two consecutive layers.
    *
    * delta  < 1 :
    *    Dyadic scaling sequence (1, 2, 4, 8, 16, ...).
    */
   int m_delta = 0;
 
   /*
    * Number of detail layers, *not including* the residual smoothed layer,
    * which is always generated in a multiscale transform.
    */
   int m_numberOfLayers = 4;
 
   /*
    * Array of transform layers, including the residual layer, so the length
    * of this array is numberOfLayers+1.
    */
   transform m_transform;
 
   /*
    * Vector of layer enable/disable states.
    */
   layer_state_set m_layerEnabled;
 
   /*
    * Inverse transform (reconstruction)
    */
   void Apply( pcl::Image& ) const override;
   void Apply( pcl::DImage& ) const override;
   void Apply( pcl::ComplexImage& ) const override;
   void Apply( pcl::DComplexImage& ) const override;
   void Apply( pcl::UInt8Image& ) const override;
   void Apply( pcl::UInt16Image& ) const override;
   void Apply( pcl::UInt32Image& ) const override;
 
   void InitializeLayersAndStates()
   {
      DestroyLayers();
      m_layerEnabled = layer_state_set( true, m_numberOfLayers+1 );
   }
 
   void DestroyLayers()
   {
      m_transform = transform( size_type( m_numberOfLayers+1 ) );
   }
 
   void ValidateLayerIndex( int j ) const;
   void ValidateLayerAccess( int j ) const;
 
   friend class MTReconstruction;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_RedundantMultiscaleTransform_h
 
// ----------------------------------------------------------------------------
// EOF pcl/RedundantMultiscaleTransform.h - Released 2024-06-18T15:48:54Z