ReadoutOptions.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.11
// ----------------------------------------------------------------------------
// pcl/ReadoutOptions.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_ReadoutOptions_h
#define __PCL_ReadoutOptions_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Utility.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace ReadoutData
{
   enum value_type
   {
      RGBK,            // RGB components or grayscale
      RGBL,            // RGB components + CIE L*
      RGBY,            // RGB components + CIE Y
      CIEXYZ,          // CIE XYZ unit vectors
      CIELab,          // CIE L*a*b* normalized components
      CIELch,          // CIE L*c*h* normalized components
      HSV,             // HSV components
      HSI,             // HSI components
      NumberOfModes
   };
}
 
// ----------------------------------------------------------------------------
 
namespace ReadoutMode
{
   enum value_type
   {
      Mean,            // Average of probe pixel values
      Median,          // Median of probe pixel values
      Minimum,         // The maximum pixel value in the probe area
      Maximum,         // The minimum pixel value in the probe area
      NumberOfModes
   };
}
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ReadoutOptions
{
public:
 
   using readout_data = ReadoutData::value_type;
 
   using readout_mode = ReadoutMode::value_type;
 
   enum { MaxProbeSize = 15 };
 
   enum { MaxPrecision = 15 };
 
   enum { MinPreviewSize = 15, MaxPreviewSize = 127 };
 
   enum { MaxPreviewZoomFactor = 16 };
 
   ReadoutOptions() = default;
 
   ReadoutOptions( const ReadoutOptions& ) = default;
 
   ReadoutOptions& operator =( const ReadoutOptions& ) = default;
 
   static ReadoutOptions GetCurrentOptions();
 
   static void SetCurrentOptions( const ReadoutOptions& );
 
   readout_data Data() const
   {
      return data;
   }
 
   void SetData( readout_data d )
   {
      data = d;
   }
 
   readout_mode Mode() const
   {
      return mode;
   }
 
   void SetMode( readout_mode m )
   {
      mode = m;
   }
 
   bool ShowAlphaChannel() const
   {
      return showAlpha;
   }
 
   void EnableAlphaChannel( bool enable = true )
   {
      showAlpha = enable;
   }
 
   void DisableAlphaChannel( bool disable = true )
   {
      EnableAlphaChannel( !disable );
   }
 
   bool ShowMaskChannel() const
   {
      return showMask;
   }
 
   void EnableMaskChannel( bool enable = true )
   {
      showMask = enable;
   }
 
   void DisableMaskChannel( bool disable = true )
   {
      EnableMaskChannel( !disable );
   }
 
   int ProbeSize() const
   {
      return probeSize;
   }
 
   void SetProbeSize( int sz )
   {
      probeSize = pcl::Range( sz, 1, int( MaxProbeSize ) ) | 1;
   }
 
   int PreviewSize() const
   {
      return previewSize;
   }
 
   void SetPreviewSize( int sz )
   {
      previewSize = pcl::Range( sz, int( MinPreviewSize ), int( MaxPreviewSize ) ) | 1;
   }
 
   int PreviewZoomFactor() const
   {
      return previewZoom;
   }
 
   void SetPreviewZoomFactor( int zoom )
   {
      previewZoom = pcl::Range( zoom, 1, int( MaxPreviewZoomFactor ) );
   }
 
   bool ShowPreview() const
   {
      return showPreview;
   }
 
   void EnablePreview( bool enable = true )
   {
      showPreview = enable;
   }
 
   void DisablePreview( bool disable = true )
   {
      EnablePreview( !disable );
   }
 
   bool ShowPreviewCenter() const
   {
      return previewCenter;
   }
 
   void EnablePreviewCenter( bool enable = true )
   {
      previewCenter = enable;
   }
 
   void DisablePreviewCenter( bool disable = true )
   {
      EnablePreviewCenter( !disable );
   }
 
   bool ShowEquatorialCoordinates() const
   {
      return showEquatorial;
   }
 
   void EnableEquatorialCoordinates( bool enable = true )
   {
      showEquatorial = enable;
   }
 
   void DisableEquatorialCoordinates( bool disable = true )
   {
      EnableEquatorialCoordinates( !disable );
   }
 
   bool ShowEclipticCoordinates() const
   {
      return showEcliptic;
   }
 
   void EnableEclipticCoordinates( bool enable = true )
   {
      showEcliptic = enable;
   }
 
   void DisableEclipticCoordinates( bool disable = true )
   {
      EnableEclipticCoordinates( !disable );
   }
 
   bool ShowGalacticCoordinates() const
   {
      return showGalactic;
   }
 
   void EnableGalacticCoordinates( bool enable = true )
   {
      showGalactic = enable;
   }
 
   void DisableGalacticCoordinates( bool disable = true )
   {
      EnableGalacticCoordinates( !disable );
   }
 
   int CoordinateItems() const
   {
      return coordinateItems;
   }
 
   void SetCoordinateItems( int n )
   {
      coordinateItems = Range( n, 1, 3 );
   }
 
   int CoordinatePrecision() const
   {
      return coordinatePrecision;
   }
 
   int RealCoordinatePrecision() const
   {
      return Range( coordinatePrecision, 0, 3 + 2*(3 - coordinateItems) );
   }
 
   void SetCoordinatePrecision( int n )
   {
      coordinatePrecision = Range( n, 0, 8 );
   }
 
   bool IsBroadcastEnabled() const
   {
      return broadcast;
   }
 
   void EnableBroadcast( bool enable = true )
   {
      broadcast = enable;
   }
 
   void DisableBroadcast( bool disable = true )
   {
      EnableBroadcast( !disable );
   }
 
   bool IsReal() const
   {
      return real;
   }
 
   void SetReal( bool b = true )
   {
      real = b;
   }
 
   bool IsInteger() const
   {
      return !IsReal();
   }
 
   void SetInteger( bool b = true )
   {
      SetReal( !b );
   }
 
   int Precision() const
   {
      return precision;
   }
 
   void SetPrecision( int n )
   {
      precision = pcl::Range( n, 0, int( MaxPrecision ) );
   }
 
   unsigned IntegerRange() const
   {
      return range;
   }
 
   void SetIntegerRange( unsigned n )
   {
      range = pcl::Range( uint32( n ), uint32( 1 ), ~uint32( 0 ) );
   }
 
   void Set8BitRange()
   {
      SetIntegerRange( uint8_max );
   }
 
   void Set16BitRange()
   {
      SetIntegerRange( uint16_max );
   }
 
   void Set32BitRange()
   {
      SetIntegerRange( uint32_max );
   }
 
#ifdef __PCL_BUILDING_PIXINSIGHT_APPLICATION
protected:
#else
private:
#endif
 
   readout_data data = ReadoutData::RGBK;
   readout_mode mode = ReadoutMode::Mean;
   int          probeSize = 1;           // size of the square probe - must be an odd number
   int          previewSize = 25;        // size of the square preview - must be an odd number
   int          previewZoom = 8;         // readout preview zoom factor >= 1
   int          precision = 4;           // number of decimal digits if real==true
   unsigned     range = uint16_max;      // maximum discrete value if real==false
   bool         showAlpha = true;        // show alpha channel readouts?
   bool         showMask = true;         // show mask channel readouts?
   bool         showPreview = true;      // show real-time readout previews?
   bool         previewCenter = true;    // draw center crosshairs on readout previews?
   bool         showEquatorial = true;   // show equatorial coordinates
   bool         showEcliptic = false;    // show ecliptic coordinates
   bool         showGalactic = false;    // show galactic coordinates
   int          coordinateItems = 3;     // 1=degrees/hours 2=minutes 3=seconds
   int          coordinatePrecision = 2; // decimal digits of last represented item
   bool         broadcast = true;        // broadcast readouts?
   bool         real = true;             // true=real, false=integer
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_ReadoutOptions_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ReadoutOptions.h - Released 2024-05-07T15:27:32Z