ImageRenderingModes.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/ImageRenderingModes.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_ImageRenderingModes_h
#define __PCL_ImageRenderingModes_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/Flags.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace DisplayChannel
{
   enum value_type
   {
      Invalid = -1,
      RGBK = 0,            // Composite RGB or Gray (normal display mode)
      Red,                 // Red channel as grayscale
      Green,               // Green channel as grayscale
      Blue,                // Blue channel as grayscale
      CIE_L,               // CIE L*
      Lightness = CIE_L,   // Lightness = CIE L*
      Luminance = CIE_L,   // ### Deprecated - retained for compatibility -> suppress in PCL 2.0
      ChrominanceRG,       // Chrominance, CIE a*,b* as red+green composite
      ChrominanceLFixed,   // Chrominance, CIE L* fixed to 0.5
      CIE_a,               // CIE a*
      CIE_b,               // CIE b*
      CIE_c,               // CIE c*
      CIE_h,               // CIE h*
      CIE_X,               // CIE X
      CIE_Y,               // CIE Y
      CIE_Z,               // CIE Z
      Hue,                 // Hue from the HSV/HSI spaces
      SaturationHSV,       // Saturation from HSV
      SaturationHSI,       // Saturation from HSI
      Value,               // Value from HSV (V = Max(R,G,B))
      Intensity,           // Intensity from HSI (I = 0.5*(Min(R,G,B) + Max(R,G,B)))
      Alpha                // First alpha channel (the rest as Alpha+n)
   };
 
   inline bool IsLuminanceOrChrominance( value_type c )
   {
      return c >= Lightness && c < Hue;
   }
}
 
// ----------------------------------------------------------------------------
 
namespace MaskMode
{
   enum value_type
   {
      Replace,             // Replaces the image by the mask
      Multiply,            // Multiplies the image by the mask (PI's traditional mode)
      OverlayRed,          // Red mask
      OverlayGreen,        // Green mask
      OverlayBlue,         // Blue mask
      OverlayYellow,       // Yellow mask (red+green)
      OverlayMagenta,      // Magenta mask (red+blue)
      OverlayCyan,         // Cyan mask (green+blue)
      OverlayOrange,       // Orange mask (red + 1/2*green)
      OverlayViolet,       // Violet mask (1/2*red + blue)
 
      NumberOfModes,
 
      Default = OverlayRed
   };
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_ImageRenderingModes_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ImageRenderingModes.h - Released 2024-06-18T15:48:54Z