AbstractImage.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/AbstractImage.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// 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_AbstractImage_h
#define __PCL_AbstractImage_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Array.h>
#include <pcl/ImageColor.h>
#include <pcl/ImageGeometry.h>
#include <pcl/ImageSelections.h>
#include <pcl/Mutex.h>
#include <pcl/ParallelProcess.h>
#include <pcl/ReferenceArray.h>
#include <pcl/StatusMonitor.h>
#include <pcl/Thread.h>
 
#ifdef __PCL_BUILDING_PIXINSIGHT_APPLICATION
namespace pi
{
class SharedImage;
}
#endif
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
#define m_width            m_geometry->width
#define m_height           m_geometry->height
#define m_numberOfChannels m_geometry->numberOfChannels
 
#define m_colorSpace       m_color->colorSpace
#define m_RGBWS            m_color->RGBWS
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS AbstractImage : public ImageGeometry,
                                public ImageColor,
                                public ParallelProcess
{
public:
 
   using selection_stack = Array<ImageSelections>;
 
   using color_space = ImageColor::color_space;
 
   ~AbstractImage() override
   {
   }
 
   int NumberOfNominalChannels() const noexcept
   {
      return ColorSpace::NumberOfNominalChannels( m_colorSpace );
   }
 
   size_type NumberOfNominalSamples() const noexcept
   {
      return NumberOfPixels() * NumberOfNominalChannels();
   }
 
   bool HasAlphaChannels() const noexcept
   {
      PCL_PRECONDITION( NumberOfChannels() != 0 )
      return NumberOfChannels() > NumberOfNominalChannels();
   }
 
   int NumberOfAlphaChannels() const noexcept
   {
      PCL_PRECONDITION( NumberOfChannels() != 0 )
      return NumberOfChannels() - NumberOfNominalChannels();
   }
 
   size_type NumberOfAlphaSamples() const noexcept
   {
      return NumberOfPixels() * NumberOfAlphaChannels();
   }
 
   // -------------------------------------------------------------------------
 
   void SelectChannel( int c ) const noexcept
   {
      PCL_PRECONDITION( 0 <= c && c < m_numberOfChannels )
      m_selected.channel = m_selected.lastChannel = c;
      ValidateChannelRange();
   }
 
   int SelectedChannel() const noexcept
   {
      return m_selected.channel;
   }
 
   void SelectChannelRange( int c0, int c1 ) const noexcept
   {
      PCL_PRECONDITION( 0 <= c0 && c0 < m_numberOfChannels )
      PCL_PRECONDITION( 0 <= c1 && c1 < m_numberOfChannels )
      m_selected.channel = c0;
      m_selected.lastChannel = c1;
      ValidateChannelRange();
   }
 
   void SelectNominalChannels() const noexcept
   {
      m_selected.channel = 0;
      m_selected.lastChannel = NumberOfNominalChannels()-1;
      ValidateChannelRange();
   }
 
   void SelectAlphaChannels() const noexcept
   {
      m_selected.channel = NumberOfNominalChannels();
      m_selected.lastChannel = m_numberOfChannels-1;
      ValidateChannelRange();
   }
 
   void ResetChannelRange() const noexcept
   {
      m_selected.channel = 0;
      m_selected.lastChannel = pcl::Max( 0, m_numberOfChannels-1 );
   }
 
   int NumberOfSelectedChannels() const noexcept
   {
      return 1 + m_selected.lastChannel - m_selected.channel;
   }
 
   int FirstSelectedChannel() const noexcept
   {
      return m_selected.channel;
   }
 
   int LastSelectedChannel() const noexcept
   {
      return m_selected.lastChannel;
   }
 
   void GetSelectedChannelRange( int& c0, int& c1 ) const noexcept
   {
      c0 = m_selected.channel;
      c1 = m_selected.lastChannel;
   }
 
   void SelectPoint( int x, int y ) const noexcept
   {
      m_selected.point.MoveTo( x, y );
   }
 
   void SelectPoint( const Point& p ) const noexcept
   {
      m_selected.point = p;
   }
 
   void ResetPoint() const noexcept
   {
      m_selected.point = 0;
   }
 
   const Point& SelectedPoint() const noexcept
   {
      return m_selected.point;
   }
 
   void SelectRectangle( int x0, int y0, int x1, int y1 ) const noexcept
   {
      m_selected.rectangle.Set( x0, y0, x1, y1 );
      Clip( m_selected.rectangle );
   }
 
   void SelectRectangle( const Point& p0, const Point& p1 ) const noexcept
   {
      SelectRectangle( p0.x, p0.y, p1.x, p1.y );
   }
 
   void SelectRectangle( const Rect& r ) const noexcept
   {
      SelectRectangle( r.x0, r.y0, r.x1, r.y1 );
   }
 
   void ResetSelection() const noexcept
   {
      m_selected.rectangle.Set( 0, 0, m_width, m_height );
   }
 
   bool IsEmptySelection() const noexcept
   {
      return m_selected.rectangle.IsPointOrLine();
   }
 
   bool IsFullSelection() const noexcept
   {
      return m_selected.rectangle.x0 <= 0 &&
             m_selected.rectangle.y0 <= 0 &&
             m_selected.rectangle.x1 >= m_width &&
             m_selected.rectangle.y1 >= m_height;
   }
 
   const Rect& SelectedRectangle() const noexcept
   {
      return m_selected.rectangle;
   }
 
   bool IsCompletelySelected() const noexcept
   {
      return m_selected.channel == 0 &&
             m_selected.lastChannel >= m_numberOfChannels-1 &&
             m_selected.rectangle.x0 <= 0 &&
             m_selected.rectangle.y0 <= 0 &&
             m_selected.rectangle.x1 >= m_width &&
             m_selected.rectangle.y1 >= m_height;
   }
 
   size_type NumberOfSelectedPixels() const noexcept
   {
      return size_type( m_selected.rectangle.Width() ) * size_type( m_selected.rectangle.Height() );
      // ### N.B. Rect::Area() cannot be used here because it performs a
      //          *signed* multiplication of two 32-bit signed integers.
      //return m_selected.rectangle.Area();
   }
 
   size_type NumberOfSelectedSamples() const noexcept
   {
      return NumberOfSelectedPixels()*size_type( NumberOfSelectedChannels() );
   }
 
   bool IsRangeClippingEnabled() const noexcept
   {
      return m_selected.clippedLow || m_selected.clippedHigh;
   }
 
   bool IsLowRangeClippingEnabled() const noexcept
   {
      return m_selected.clippedLow;
   }
 
   bool IsHighRangeClippingEnabled() const noexcept
   {
      return m_selected.clippedHigh;
   }
 
   void EnableRangeClipping( bool enableLow = true, bool enableHigh = true ) const noexcept
   {
      m_selected.clippedLow = enableLow;
      m_selected.clippedHigh = enableHigh;
   }
 
   void DisableRangeClipping( bool disableLow = true, bool disableHigh = true ) const noexcept
   {
      m_selected.clippedLow = !disableLow;
      m_selected.clippedHigh = !disableHigh;
   }
 
   double RangeClipLow() const noexcept
   {
      return m_selected.clipLow;
   }
 
   double RangeClipHigh() const noexcept
   {
      return m_selected.clipHigh;
   }
 
   void SetRangeClipLow( double clipLow ) const noexcept
   {
      m_selected.clipLow = clipLow;
      if ( m_selected.clipHigh < m_selected.clipLow )
         pcl::Swap( m_selected.clipLow, m_selected.clipHigh );
   }
 
   void SetRangeClipHigh( double clipHigh ) const noexcept
   {
      m_selected.clipHigh = clipHigh;
      if ( m_selected.clipHigh < m_selected.clipLow )
         pcl::Swap( m_selected.clipLow, m_selected.clipHigh );
   }
 
   void SetRangeClipping( double clipLow, double clipHigh ) const noexcept
   {
      if ( clipHigh < clipLow )
         pcl::Swap( clipLow, clipHigh );
      m_selected.clipLow = clipLow;
      m_selected.clipHigh = clipHigh;
      m_selected.clippedLow = m_selected.clippedHigh = true;
   }
 
   void ResetRangeClipping() const noexcept
   {
      m_selected.clipLow = 0;
      m_selected.clipHigh = 1;
      m_selected.clippedLow = m_selected.clippedHigh = false;
   }
 
   void ResetSelections() const noexcept
   {
      ResetChannelRange();
      ResetPoint();
      ResetSelection();
      ResetRangeClipping();
   }
 
   ImageSelections& Selections() const noexcept
   {
      return m_selected;
   }
 
   void PushSelections() const
   {
      m_savedSelections.Append( m_selected );
   }
 
   void PopSelections() const
   {
      if ( CanPopSelections() )
      {
         selection_stack::iterator i = m_savedSelections.ReverseBegin();
         m_selected = *i;
         m_savedSelections.Remove( i );
      }
   }
 
   bool CanPopSelections() const noexcept
   {
      return !m_savedSelections.IsEmpty();
   }
 
   bool ParseRect( Rect& rect ) const noexcept
   {
      if ( !rect.IsRect() )
      {
         rect = m_selected.rectangle;
         if ( !rect.IsRect() )
            return false;
      }
      if ( !Clip( rect ) )
         return false;
      return true;
   }
 
   bool ParseChannel( int& channel ) const noexcept
   {
      if ( channel < 0 )
      {
         channel = m_selected.channel;
         if ( channel < 0 )
            return false;
      }
      if ( channel >= m_numberOfChannels )
         return false;
 
      return true;
   }
 
   bool ParseSelection( Rect& rect, int& firstChannel, int& lastChannel ) const noexcept
   {
      if ( !ParseRect( rect ) || !ParseChannel( firstChannel ) )
         return false;
 
      if ( lastChannel < 0 )
      {
         lastChannel = m_selected.lastChannel;
         if ( lastChannel < 0 )
            return false;
      }
      if ( lastChannel >= m_numberOfChannels )
         return false;
 
      if ( lastChannel < firstChannel )
         pcl::Swap( firstChannel, lastChannel );
 
      return true;
   }
 
   bool ParseSelection( Rect& rect, int& channel ) const noexcept
   {
      return ParseRect( rect ) && ParseChannel( channel );
   }
 
   // -------------------------------------------------------------------------
 
   StatusMonitor& Status() const noexcept
   {
      return m_status;
   }
 
   pcl::StatusCallback* StatusCallback() const noexcept
   {
      return m_status.Callback();
   }
 
   pcl::StatusCallback* GetStatusCallback() const noexcept
   {
      return StatusCallback();
   }
 
   void SetStatusCallback( pcl::StatusCallback* callback ) const noexcept
   {
      m_status.SetCallback( callback );
   }
 
   int NumberOfThreads( size_type count, int maxProcessors = 0, size_type overheadLimit = 16u ) const noexcept
   {
      return m_parallel ? pcl::Min( (maxProcessors > 0) ? maxProcessors : m_maxProcessors,
                                    Thread::NumberOfThreads( count, overheadLimit ) ) : 1;
   }
 
   int NumberOfThreadsForRows( int rowCount = 0, int rowWidth = 0, int maxProcessors = 0, size_type overheadLimitPx = 1024u ) const noexcept
   {
      return NumberOfThreads( (rowCount > 0) ? rowCount : Height(),
                              maxProcessors,
                              pcl::Max( size_type( 1 ), size_type( overheadLimitPx/((rowWidth > 0) ? rowWidth : Width()) ) ) );
   }
 
   Array<size_type> OptimalThreadRows( int rowCount = 0, int rowWidth = 0, int maxProcessors = 0, size_type overheadLimitPx = 1024u ) const noexcept
   {
      return Thread::OptimalThreadLoads( (rowCount > 0) ? rowCount : Height(),
                                         pcl::Max( size_type( 1 ), size_type( overheadLimitPx/((rowWidth > 0) ? rowWidth : Width()) ) ),
                                         m_parallel ? ((maxProcessors > 0) ? maxProcessors : m_maxProcessors) : 1 );
   }
 
   // -------------------------------------------------------------------------
 
   struct ThreadData
   {
      mutable StatusMonitor status;         
      mutable Mutex         mutex;          
      mutable size_type     count = 0;      
              size_type     total = 0;      
              size_type     numThreads = 0; 
 
      ThreadData() = default;
 
      ThreadData( const AbstractImage& image, size_type N )
         : status( image.Status() )
         , total( N )
      {
      }
 
      ThreadData( const StatusMonitor& a_status, size_type N )
         : status( a_status )
         , total( N )
      {
      }
   };
 
   template <class thread>
   static void RunThreads( ReferenceArray<thread>& threads, ThreadData& data, bool useAffinity = true )
   {
      if ( threads.IsEmpty() )
         return;
 
      data.numThreads = threads.Length();
      if ( data.numThreads == 1 )
      {
         try
         {
            threads[0].Run();
            return;
         }
         catch ( ... )
         {
            threads.Destroy();
            throw;
         }
      }
 
      if ( useAffinity )
         if ( !Thread::IsRootThread() )
            useAffinity = false;
 
      {
         int n = 0;
         for ( thread& t : threads )
            t.Start( ThreadPriority::DefaultMax, useAffinity ? n++ : -1 );
      }
 
      uint32 waitTime = StatusMonitor::RefreshRate() >> 1;
      waitTime += waitTime >> 2; // waitTime = 0.625 * StatusMonitor::RefreshRate()
 
      for ( size_type lastCount = 0; ; )
      {
         for ( typename ReferenceArray<thread>::iterator i = threads.Begin(); ; )
         {
            if ( !i->Wait( waitTime ) )
               break;
 
            if ( ++i == threads.End() )
            {
               if ( data.total > 0 )
                  data.status += data.total - lastCount;
               return;
            }
         }
 
         if ( data.mutex.TryLock() )
         {
            try
            {
               if ( data.total > 0 )
               {
                  data.status += data.count - lastCount;
                  lastCount = data.count;
               }
               else
                  ++data.status;
 
               data.mutex.Unlock();
            }
            catch ( ... )
            {
               data.mutex.Unlock();
               for ( thread& t : threads )
                  t.Abort();
               for ( thread& t : threads )
                  t.Wait();
               threads.Destroy();
               throw ProcessAborted();
            }
         }
      }
   }
 
protected:
 
   mutable ImageSelections m_selected;
   mutable selection_stack m_savedSelections;
   mutable StatusMonitor   m_status;
 
   AbstractImage() = default;
 
   AbstractImage( const AbstractImage& ) = default;
 
   AbstractImage& operator =( const AbstractImage& ) = default;
 
   void Swap( AbstractImage& image ) noexcept
   {
      ImageGeometry::Swap( image );
      ImageColor::Swap( image );
      ParallelProcess::Swap( image );
      pcl::Swap( m_selected, image.m_selected );
      pcl::Swap( m_savedSelections, image.m_savedSelections );
      pcl::Swap( m_status, image.m_status );
   }
 
   void ValidateChannelRange() const noexcept
   {
      if ( m_numberOfChannels > 0 )
      {
         if ( m_selected.channel < 0 )
            m_selected.channel = 0;
         else if ( m_selected.channel >= m_numberOfChannels )
            m_selected.channel = m_numberOfChannels-1;
 
         if ( m_selected.lastChannel < 0 )
            m_selected.lastChannel = 0;
         else if ( m_selected.lastChannel >= m_numberOfChannels )
            m_selected.lastChannel = m_numberOfChannels-1;
 
         if ( m_selected.lastChannel < m_selected.channel )
            pcl::Swap( m_selected.channel, m_selected.lastChannel );
      }
      else
      {
         m_selected.channel = m_selected.lastChannel = 0;
      }
   }
 
#ifdef __PCL_BUILDING_PIXINSIGHT_APPLICATION
   friend class pi::SharedImage;
#endif
};
 
// ----------------------------------------------------------------------------
 
#undef m_width
#undef m_height
#undef m_numberOfChannels
#undef m_colorSpace
#undef m_RGBWS
 
// ----------------------------------------------------------------------------
 
#define INIT_THREAD_MONITOR()             \
   size_type ___n___ = 0, ___n1___ = 0;
 
#define UPDATE_THREAD_MONITOR( N )                    \
   if ( ++___n1___ == (N) )                           \
   {                                                  \
      if ( this->m_data.numThreads > 1 )              \
      {                                               \
         if ( this->TryIsAborted() )                  \
            return;                                   \
         ___n___ += (N);                              \
         if ( this->m_data.total > 0 )                \
            if ( this->m_data.mutex.TryLock() )       \
            {                                         \
               this->m_data.count += ___n___;         \
               this->m_data.mutex.Unlock();           \
               ___n___ = 0;                           \
            }                                         \
      }                                               \
      else                                            \
      {                                               \
         if ( this->m_data.total > 0 )                \
            this->m_data.status += (N);               \
         else                                         \
            ++this->m_data.status;                    \
      }                                               \
      ___n1___ = 0;                                   \
   }
 
#define UPDATE_THREAD_MONITOR_CHUNK( N, chunkSize )   \
   if ( (___n1___ += (chunkSize)) == (N) )            \
   {                                                  \
      if ( this->m_data.numThreads > 1 )              \
      {                                               \
         if ( this->TryIsAborted() )                  \
            return;                                   \
         ___n___ += (N);                              \
         if ( this->m_data.total > 0 )                \
            if ( this->m_data.mutex.TryLock() )       \
            {                                         \
               this->m_data.count += ___n___;         \
               this->m_data.mutex.Unlock();           \
               ___n___ = 0;                           \
            }                                         \
      }                                               \
      else                                            \
      {                                               \
         if ( this->m_data.total > 0 )                \
            this->m_data.status += (N);               \
         else                                         \
            ++this->m_data.status;                    \
      }                                               \
      ___n1___ = 0;                                   \
   }
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_AbstractImage_h
 
// ----------------------------------------------------------------------------
// EOF pcl/AbstractImage.h - Released 2024-01-13T15:47:58Z