ColorFilterArray.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/ColorFilterArray.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_ColorFilterArray_h
#define __PCL_ColorFilterArray_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/Exception.h>
#include <pcl/String.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ColorFilterArray
{
public:
 
   ColorFilterArray( const IsoString& pattern, int width, int height, const String& name = String() )
      : m_pattern( pattern.Uppercase() )
      , m_width( width )
      , m_height( height )
      , m_name( name )
   {
      if ( m_width < 1 || m_height < 1 || size_type( NumberOfElements() ) != m_pattern.Length() )
         throw Error( "Malformed CFA pattern" );
      for ( auto element : m_pattern )
         if ( !IsValidCFAElement( element ) )
            throw Error( "Invalid CFA pattern \'" + m_pattern + "\'" );
   }
 
   ColorFilterArray() = default;
 
   ColorFilterArray( const ColorFilterArray& ) = default;
 
   ColorFilterArray( ColorFilterArray&& ) = default;
 
   ColorFilterArray& operator =( const ColorFilterArray& ) = default;
 
   ColorFilterArray& operator =( ColorFilterArray&& ) = default;
 
   const IsoString& Pattern() const
   {
      return m_pattern;
   }
 
   int Width() const
   {
      return m_width;
   }
 
   int Height() const
   {
      return m_height;
   }
 
   int NumberOfElements() const
   {
      return int( m_pattern.Length() );
   }
 
   bool IsEmpty() const
   {
      return m_pattern.IsEmpty();
   }
 
   const String& Name() const
   {
      return m_name;
   }
 
   bool IsBayerFilter() const
   {
      return m_pattern == "BGGR" || m_pattern == "GRBG" || m_pattern == "GBRG" || m_pattern == "RGGB";
   }
 
   char Element( int x, int y ) const
   {
      size_type i = y*m_width + x;
      if ( i < m_pattern.Length() )
         return m_pattern[i];
      return '\0';
   }
 
   /*
    * Clears all internal structures to yield an empty CFA.
    */
   void Clear()
   {
      m_pattern.Clear();
      m_width = m_height = 0;
      m_name.Clear();
   }
 
   bool operator ==( const ColorFilterArray& x ) const
   {
      return m_pattern == x.m_pattern && m_width == x.m_width && m_height == x.m_height;
   }
 
   bool operator <( const ColorFilterArray& x ) const
   {
      return m_pattern < x.m_pattern;
   }
 
   static bool IsValidCFAElement( char element )
   {
      return strchr( "0RGBWCMY", element ) != nullptr;
   }
 
private:
 
   IsoString m_pattern;
   int       m_width  = 0;
   int       m_height = 0;
   String    m_name;
};
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS BayerFilterRGGB : public ColorFilterArray
{
public:
 
   BayerFilterRGGB()
      : ColorFilterArray( "RGGB", 2, 2, "RGGB Bayer Filter" )
   {
   }
};
 
class PCL_CLASS BayerFilterBGGR : public ColorFilterArray
{
public:
 
   BayerFilterBGGR()
      : ColorFilterArray( "BGGR", 2, 2, "BGGR Bayer Filter" )
   {
   }
};
 
class PCL_CLASS BayerFilterGBRG : public ColorFilterArray
{
public:
 
   BayerFilterGBRG()
      : ColorFilterArray( "GBRG", 2, 2, "GBRG Bayer Filter" )
   {
   }
};
 
class PCL_CLASS BayerFilterGRBG : public ColorFilterArray
{
public:
 
   BayerFilterGRBG()
      : ColorFilterArray( "GRBG", 2, 2, "GRBG Bayer Filter" )
   {
   }
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_ColorFilterArray_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ColorFilterArray.h - Released 2024-01-13T15:47:58Z