PSFEstimator.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.11
// ----------------------------------------------------------------------------
// pcl/PSFEstimator.h - Released 2024-05-07T15:27:32Z
// ----------------------------------------------------------------------------
// 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_PSFEstimator_h
#define __PCL_PSFEstimator_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/StarDetector.h>
#include <pcl/PSFFit.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS PSFEstimator : public ParallelProcess
{
public:
 
   using psf_function = StarDetector::psf_function;
 
   PSFEstimator() = default;
 
   PSFEstimator( const PSFEstimator& ) = default;
 
   ~PSFEstimator() override
   {
   }
 
   PSFEstimator& operator =( const PSFEstimator& ) = default;
 
   const StarDetector& Detector() const
   {
      return const_cast<const StarDetector&>( m_starDetector );
   }
 
   StarDetector& Detector()
   {
      return m_starDetector;
   }
 
   psf_function PSFType() const
   {
      return m_psfType;
   }
 
   void SetPSFType( psf_function type )
   {
      m_psfType = type;
   }
 
   float PSFCentroidTolerance() const
   {
      return m_psfCentroidTolerance;
   }
 
   void SetPSFCentroidTolerance( float t )
   {
      PCL_PRECONDITION( t >= 0 )
      m_psfCentroidTolerance = Max( 0.0F, t );
   }
 
   float SaturationThreshold() const
   {
      return m_saturationThreshold;
   }
 
   void SetSaturationThreshold( float t )
   {
      PCL_PRECONDITION( t >= 0.1 && t <= 1.0 )
      m_saturationThreshold = Range( t, 0.1F, 1.0F );
   }
 
   bool IsRelativeSaturationEnabled() const
   {
      return m_saturationRelative;
   }
 
   void EnableRelativeSaturation( bool enable = true )
   {
      m_saturationRelative = enable;
   }
 
   void DisableRelativeSaturation( bool disable = true )
   {
      EnableRelativeSaturation( !disable );
   }
 
   float RejectionLimit() const
   {
      return m_rejectionLimit;
   }
 
   void SetRejectionLimit( float r )
   {
      PCL_PRECONDITION( r >= 0.5 && r <= 1 )
      m_rejectionLimit = Range( r, 0.5F, 1.0F );
   }
 
   float GrowthFactorForFluxMeasurement() const
   {
      return m_growthForFlux;
   }
 
   void SetGrowthFactorForFluxMeasurement( float k )
   {
      PCL_PRECONDITION( k >= 0.5 && k <= 2.0 )
      m_growthForFlux = Range( k, 0.5F, 2.0F );
   }
 
   int MaxStars() const
   {
      return m_maxStars;
   }
 
   void SetMaxStars( int n )
   {
      PCL_PRECONDITION( n >= 0 )
      m_maxStars = Max( 0, n );
   }
 
   bool IsPSFWeightingEnabled() const
   {
      return m_weighted;
   }
 
   void EnablePSFWeighting( bool enable = true )
   {
      m_weighted = enable;
   }
 
   void DisablePSFWeighting( bool disable = true )
   {
      EnablePSFWeighting( !disable );
   }
 
   Array<PSFData> FitStars( const ImageVariant& image ) const;
 
protected:
 
   mutable pcl::StarDetector m_starDetector;
           psf_function      m_psfType = PSFunction::Moffat4;
           float             m_psfCentroidTolerance = 1.5F;
           float             m_saturationThreshold = 0.75F;
           bool              m_saturationRelative = true;
           float             m_rejectionLimit = 1.0F;
           float             m_growthForFlux = 1.0F;
           int               m_maxStars = 0;
           bool              m_weighted = false;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_PSFEstimator_h
 
// ----------------------------------------------------------------------------
// EOF pcl/PSFEstimator.h - Released 2024-05-07T15:27:32Z