StarDetector.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/StarDetector.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_StarDetector_h
#define __PCL_StarDetector_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/ImageVariant.h>
#include <pcl/ParallelProcess.h>
#include <pcl/PSFFit.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS StarDetector : public ParallelProcess
{
public:
 
   using psf_function = PSFFit::psf_function;
 
   struct Star
   {
      using component = DPoint::component;
 
      DPoint pos = 0.0;     
      Rect   rect = 0;      
      Rect   srect = 0;     
      float  area = 0;      
      float  flux = 0;      
      float  signal = 0;    
      float  mad = 0;       
      Star*  ref = nullptr; 
 
      Star() = default;
 
      Star( const DPoint& p, const Rect& r, const Rect& sr = 0, float a = 0, float f = 0, float s = 0, float m = 0 )
         : pos( p ), rect( r ), srect( sr ), area( a ), flux( f ), signal( s ), mad( m )
      {
      }
 
      Star( const DPoint& p, float f = 0 )
         : pos( p ), flux( f )
      {
      }
 
      Star( double x, double y, float f = 0 )
         : pos( x, y ), flux( f )
      {
      }
 
      Star( const Star& ) = default;
 
      Star& operator =( const Star& ) = default;
 
      bool operator ==( const Star& s ) const
      {
         return pos == s.pos;
      }
 
      bool operator <( const Star& s ) const
      {
         return flux > s.flux;
      }
 
      component operator []( int i ) const
      {
         return pos[i];
      }
   };
 
   using star_list = Array<Star>;
 
   StarDetector() = default;
 
   StarDetector( const StarDetector& ) = default;
 
   StarDetector& operator =( const StarDetector& ) = default;
 
   ~StarDetector() override
   {
   }
 
   int StructureLayers() const
   {
      return m_structureLayers;
   }
 
   void SetStructureLayers( int n )
   {
      PCL_PRECONDITION( n > 0 && n <= 8 )
      m_structureLayers = Range( n, 1, 8 );
   }
 
   int NoiseLayers() const
   {
      return m_noiseLayers;
   }
 
   void SetNoiseLayers( int n )
   {
      PCL_PRECONDITION( n >= 0 && n <= 4 )
      m_noiseLayers = Range( n, 0, 4 );
   }
 
   int HotPixelFilterRadius() const
   {
      return m_hotPixelFilterRadius;
   }
 
   void SetHotPixelFilterRadius( int n )
   {
      PCL_PRECONDITION( n >= 0 && n <= 3 )
      m_hotPixelFilterRadius = Range( n, 0, 3 );
   }
 
   int NoiseReductionFilterRadius() const
   {
      return m_noiseReductionFilterRadius;
   }
 
   void SetNoiseReductionFilterRadius( int n )
   {
      PCL_PRECONDITION( n >= 0 && n <= 64 )
      m_noiseReductionFilterRadius = Range( n, 0, 64 );
   }
 
   int MinStructureSize() const
   {
      return m_minStructureSize;
   }
 
   void SetMinStructureSize( int n )
   {
      PCL_PRECONDITION( n >= 0 )
      m_minStructureSize = Max( 0, n );
   }
 
   int MinStarSize() const
   {
      return m_minStarSize;
   }
 
   float Sensitivity() const
   {
      return m_sensitivity;
   }
 
   void SetSensitivity( float s )
   {
      PCL_PRECONDITION( s >= 0 && s <= 1 )
      m_sensitivity = Range( s, 0.0F, 1.0F );
   }
 
   float PeakResponse() const
   {
      return m_peakResponse;
   }
 
   void SetPeakResponse( float r )
   {
      PCL_PRECONDITION( r >= 0 && r <= 1 )
      m_peakResponse = Range( r, 0.0F, 1.0F );
   }
 
   float MinSNR() const
   {
      return m_minSNR;
   }
 
   void SetMinSNR( float snr )
   {
      PCL_PRECONDITION( snr >= 0 )
      m_minSNR = Max( 0.0F, snr );
   }
 
   float BrightThreshold() const
   {
      return m_brightThreshold;
   }
 
   void SetBrightThreshold( float r )
   {
      PCL_PRECONDITION( r >= 1 && r <= 100 )
      m_brightThreshold = Range( r, 1.0F, 100.0F );
   }
 
   float MaxDistortion() const
   {
      return m_maxDistortion;
   }
 
   void SetMaxDistortion( float d )
   {
      PCL_PRECONDITION( d >= 0 && d <= 1 )
      m_maxDistortion = Range( d, 0.0F, 1.0F );
   }
 
   bool IsClusteredSourcesEnabled() const
   {
      return m_allowClusteredSources;
   }
 
   void EnableClusteredSources( bool enable = true )
   {
      m_allowClusteredSources = enable;
   }
 
   void DisableClusteredSources( bool disable = true )
   {
      EnableClusteredSources( !disable );
   }
 
   int LocalDetectionFilterRadius() const
   {
      return m_localDetectionFilterRadius;
   }
 
   void SetLocalDetectionFilterRadius( int n )
   {
      PCL_PRECONDITION( n >= 1 && n <= 5 )
      m_localDetectionFilterRadius = Range( n, 1, 5 );
   }
 
   float LocalMaximaDetectionLimit() const
   {
      return m_localMaximaDetectionLimit;
   }
 
   void SetLocalMaximaDetectionLimit( float v )
   {
      PCL_PRECONDITION( v >= 0 && v <= 1 )
      m_localMaximaDetectionLimit = Range( v, 0.1F, 1.0F );
   }
 
   bool IsLocalMaximaDetectionEnabled() const
   {
      return !m_noLocalMaximaDetection;
   }
 
   void EnableLocalMaximaDetection( bool enable = true )
   {
      m_noLocalMaximaDetection = !enable;
   }
 
   void DisableLocalMaximaDetection( bool disable = true )
   {
      EnableLocalMaximaDetection( !disable );
   }
 
   float UpperLimit() const
   {
      return m_upperLimit;
   }
 
   void SetUpperLimit( float u )
   {
      PCL_PRECONDITION( u >= 0 && u <= 1 )
      m_upperLimit = Range( u, 0.0F, 1.0F );
   }
 
   bool IsImageInversionEnabled() const
   {
      return m_invert;
   }
 
   void EnableImageInversion( bool enabled = true )
   {
      m_invert = enabled;
   }
 
   void DisableImageInversion( bool disable = true )
   {
      EnableImageInversion( !disable );
   }
 
   bool IsPSFFittingEnabled() const
   {
      return m_fitPSF;
   }
 
   void EnablePSFFitting( bool enable = true )
   {
      m_fitPSF = enable;
   }
 
   void DisablePSFFitting( bool disable = true )
   {
      EnablePSFFitting( !disable );
   }
 
   psf_function PSFType() const
   {
      return m_psfType;
   }
 
   void SetPSFType( psf_function type )
   {
      m_psfType = type;
   }
 
   bool IsEllipticPSF() const
   {
      return m_psfElliptic;
   }
 
   void EnableEllipticPSF( bool enable = true )
   {
      m_psfElliptic = enable;
   }
 
   void DisableEllipticPSF( bool disable = true )
   {
      EnableEllipticPSF( !disable );
   }
 
   float PSFCentroidTolerance() const
   {
      return m_psfCentroidTolerance;
   }
 
   void SetPSFCentroidTolerance( float t )
   {
      PCL_PRECONDITION( t >= 0 )
      m_psfCentroidTolerance = Max( 0.0F, t );
   }
 
   const UInt8Image* DetectionMask() const
   {
      return m_mask;
   }
 
   void SetDetectionMask( const UInt8Image* mask )
   {
      if ( mask != nullptr )
         if ( mask->IsEmpty() )
            mask = nullptr;
      m_mask = mask;
   }
 
   star_list DetectStars( const ImageVariant& image ) const;
 
   star_list operator()( const ImageVariant& image ) const
   {
      return DetectStars( image );
   }
 
   Image StructureMap( const ImageVariant& image ) const;
 
   Image Structures( const ImageVariant& image ) const;
 
protected:
 
         int          m_structureLayers = 5;
         int          m_noiseLayers = 0;
         int          m_hotPixelFilterRadius = 1;
         int          m_noiseReductionFilterRadius = 0;
         int          m_minStructureSize = 0; // automatic mode by default
 mutable int          m_minStarSize = 0; // when minStructureSize=0
         float        m_sensitivity = 0.5F;
         float        m_peakResponse = 0.5F;
         float        m_minSNR = 0.0F;
         float        m_brightThreshold = 3.0F;
         float        m_maxDistortion = 0.6F;
         bool         m_allowClusteredSources = false;
         int          m_localDetectionFilterRadius = 2;
         float        m_localMaximaDetectionLimit = 0.75F;
         bool         m_noLocalMaximaDetection = false;
         float        m_upperLimit = 1.0F;
         bool         m_invert = false;
         bool         m_fitPSF = false;
         psf_function m_psfType = PSFunction::Gaussian;
         bool         m_psfElliptic = false;
         float        m_psfCentroidTolerance = 1.5F;
   const UInt8Image*  m_mask = nullptr;
 
private:
 
   star_list DetectStars( Image& image ) const;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_StarDetector_h
 
// ----------------------------------------------------------------------------
// EOF pcl/StarDetector.h - Released 2024-06-18T15:48:54Z