ImageColor.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/ImageColor.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_ImageColor_h
#define __PCL_ImageColor_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/ColorSpace.h>
#include <pcl/Exception.h>
#include <pcl/RGBColorSystem.h>
#include <pcl/String.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
#define m_colorSpace m_color->colorSpace
#define m_RGBWS      m_color->RGBWS
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ImageColor
{
public:
 
   using color_space = ColorSpace::value_type;
 
   const RGBColorSystem& RGBWorkingSpace() const noexcept
   {
      return m_RGBWS;
   }
 
   virtual void SetRGBWorkingSpace( const RGBColorSystem& RGBWS )
   {
      m_RGBWS = RGBWS;
   }
 
   static const RGBColorSystem& DefaultRGBWorkingSpace() noexcept
   {
      return s_defaultRGBWS;
   }
 
   static void SetDefaultRGBWorkingSpace( const RGBColorSystem& RGBWS )
   {
      s_defaultRGBWS = RGBWS;
   }
 
   static void ResetDefaultRGBWorkingSpace()
   {
      s_defaultRGBWS = RGBColorSystem::sRGB;
   }
 
   bool IsColor() const noexcept
   {
      return m_colorSpace != ColorSpace::Gray;
   }
 
   color_space ColorSpace() const noexcept
   {
      return m_colorSpace;
   }
 
   String ChannelId( int c ) const noexcept
   {
      return ColorSpace::ChannelId( m_colorSpace, c );
   }
 
protected:
 
   struct Color
   {
      color_space    colorSpace;
      RGBColorSystem RGBWS;
 
      Color( color_space cs = ColorSpace::Gray )
         : colorSpace( cs )
         , RGBWS( s_defaultRGBWS )
      {
      }
 
      Color( const Color& ) = default;
 
      void Assign( const Color& x )
      {
         colorSpace = x.colorSpace;
         RGBWS = x.RGBWS;
      }
 
      void Reset() noexcept
      {
         colorSpace = ColorSpace::Gray;
      }
   };
 
   Color* m_color = nullptr;
 
   /*
    * The default RGB Working Space
    *
    * Unless explicitly modified, this corresponds to the sRGB space.
    *
    * Note that shared images don't use this default RGBWS, but the global
    * RGBWS currently selected in the PixInsight core application.
    */
   static RGBColorSystem s_defaultRGBWS;
 
   ImageColor() = default;
   ImageColor( const ImageColor& ) = default;
   ImageColor& operator =( const ImageColor& ) = default;
 
   virtual ~ImageColor()
   {
      m_color = nullptr;
   }
 
   void Swap( ImageColor& image ) noexcept
   {
      pcl::Swap( m_color, image.m_color );
   }
};
 
// ----------------------------------------------------------------------------
 
#undef m_colorSpace
#undef m_RGBWS
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_ImageColor_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ImageColor.h - Released 2024-06-18T15:48:54Z