PSFSignalEstimator.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/PSFSignalEstimator.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_PSFSignalEstimator_h
#define __PCL_PSFSignalEstimator_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/PSFEstimator.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS PSFSignalEstimator : public PSFEstimator
{
public:
 
   using psf_function = PSFEstimator::psf_function;
 
   struct Estimates
   {
      double totalFlux = 0;          
      double totalPowerFlux = 0;     
      double totalMeanFlux = 0;      
      double totalMeanPowerFlux = 0; 
      double MStar = 0;              
      double NStar = 0;              
      int    count = 0;              
 
      operator double() const
      {
         return totalFlux;
      }
 
      bool IsValid() const
      {
         return count > 0 && 1 + totalFlux != 1 && 1 + MStar != 1;
      }
   };
 
   PSFSignalEstimator()
   {
      // Override default PSF estimator parameters with appropriate values for
      // signal evaluation.
      m_saturationThreshold = 1.0F;
      m_saturationRelative = false;
   }
 
   PSFSignalEstimator( const PSFSignalEstimator& ) = default;
 
   ~PSFSignalEstimator() override
   {
   }
 
   PSFSignalEstimator& operator =( const PSFSignalEstimator& ) = default;
 
   int BackgroundModelScale() const
   {
      return m_scale;
   }
 
   void SetBackgroundModelScale( int scale )
   {
      PCL_PRECONDITION( scale >= 32 && scale <= 1024 )
      m_scale = Range( scale, 32, 1024 );
   }
 
   Estimates EstimateSignal( const ImageVariant& image ) const;
 
   Estimates operator()( const ImageVariant& image ) const
   {
      return EstimateSignal( image );
   }
 
   static Array<float> LocalBackgroundResidual( const ImageVariant& image, int scale = 256, int maxThreads = 0 );
 
   template <class T>
   static double NStar_MAD( const T& R )
   {
      return 2.48308 * pcl::MAD( R.Begin(), R.End() );
   }
 
   template <class T>
   static double NStar_Sn( T& R )
   {
      return 2.03636 * pcl::Sn( R.Begin(), R.End() );
   }
 
   template <class T>
   static double NStar( T& R )
   {
      return NStar_Sn( R );
   }
 
   static double PSFSignalWeight( const Estimates& E, double sigmaN = 0 )
   {
      if ( sigmaN <= 0 )
         sigmaN = E.NStar;
      return (5.326e-6 * E.totalFlux * E.totalMeanFlux) / (9.0e+6 * sigmaN * E.MStar);
   }
 
   static double PSFSNR( const Estimates& E, double sigmaN = 0 )
   {
      if ( sigmaN <= 0 )
         sigmaN = E.NStar;
      return (1.316e-7 * E.totalFlux * E.totalFlux) / (4.987e+6 * sigmaN * sigmaN);
   }
 
private:
 
   int m_scale = 256;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_PSFSignalEstimator_h
 
// ----------------------------------------------------------------------------
// EOF pcl/PSFSignalEstimator.h - Released 2024-06-18T15:48:54Z