PSFScaleEstimator.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/PSFScaleEstimator.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_PSFScaleEstimator_h
#define __PCL_PSFScaleEstimator_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/PSFEstimator.h>
#include <pcl/SurfaceSpline.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS PSFScaleEstimator : public PSFEstimator
{
public:
 
   using psf_function = PSFEstimator::psf_function;
 
   using local_model = SurfaceSpline<double>;
 
   struct Estimates
   {
      double      scale = 1; 
      double      sigma = 0; 
      int         total = 0; 
      int         count = 0; 
      local_model local;     
 
      operator double() const
      {
         return scale;
      }
 
      bool IsValid() const
      {
         return count > 0 && 1 + scale != 1;
      }
   };
 
   PSFScaleEstimator() = default;
 
   PSFScaleEstimator( const PSFScaleEstimator& ) = default;
 
   ~PSFScaleEstimator() override
   {
   }
 
   PSFScaleEstimator& operator =( const PSFScaleEstimator& ) = default;
 
   float PSFSearchTolerance() const
   {
      return m_psfSearchTolerance;
   }
 
   void SetPSFSearchTolerance( float t )
   {
      PCL_PRECONDITION( t >= 0 )
      m_psfSearchTolerance = Max( 0.0F, t );
   }
 
   float RejectionLimit() const
   {
      return m_rejectionLimit;
   }
 
   void SetRejectionLimit( float r )
   {
      PCL_PRECONDITION( r > 0 && r < 1 )
      m_rejectionLimit = Range( r, 0.0F, 1.0F );
   }
 
   int SetReference( const ImageVariant& image );
 
   bool IsLocalModelEnabled() const
   {
      return m_enableLocalModel;
   }
 
   void EnableLocalModel( bool enable = true )
   {
      m_enableLocalModel = enable;
   }
 
   void DisableLocalModel( bool disable = true )
   {
      EnableLocalModel( !disable );
   }
 
   Estimates EstimateScale( const ImageVariant& image ) const;
 
   Estimates operator()( const ImageVariant& image ) const
   {
      return EstimateScale( image );
   }
 
private:
 
   Array<PSFData> m_psfReference;
   float          m_psfSearchTolerance = 4.0F; // px
   float          m_rejectionLimit = 0.3F;
   bool           m_enableLocalModel = false;
 
   /*
    * Auxiliary structure for generation of first-order local scale models.
    */
   struct Sample
   {
      double x, y, z;
 
      operator double() const
      {
         return z;
      }
 
      bool operator <( const Sample& s ) const
      {
         return z < s.z;
      }
   };
 
   using sample_vector = GenericVector<Sample>;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_PSFScaleEstimator_h
 
// ----------------------------------------------------------------------------
// EOF pcl/PSFScaleEstimator.h - Released 2024-06-18T15:48:54Z