ImageOptions.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.9.3
// ----------------------------------------------------------------------------
// pcl/ImageOptions.h - Released 2025-02-21T12:13: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-2025 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_ImageOptions_h
#define __PCL_ImageOptions_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/String.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
namespace ImageType
{
   enum value_type
   {
      Unknown,
      Bias,
      Dark,
      Flat,
      Light,
      MasterBias,
      MasterDark,
      MasterFlat,
      MasterLight,
      DefectMap,
      RejectionMapHigh,
      RejectionMapLow,
      BinaryRejectionMapHigh,
      BinaryRejectionMapLow,
      SlopeMap,
      WeightMap,
      NumberOfImageTypes
   };
 
   String Name( int type );
 
   inline value_type ToMaster( int type )
   {
      switch ( type )
      {
      case Bias:  return MasterBias;
      case Dark:  return MasterDark;
      case Flat:  return MasterFlat;
      case Light: return MasterLight;
      default:    return (value_type)type;
      }
   }
};
 
namespace CFAType
{
   enum value_type { None, BGGR, GRBG, GBRG, RGGB, CYGM, NumberOfCFATypes };
 
   String Name( int cfa );
}
 
class PCL_CLASS ImageOptions
{
public:
 
   uint8    bitsPerSample          :  8; 
   bool     ieeefpSampleFormat     :  1; 
   bool     complexSample          :  1; 
   bool     signedIntegers         :  1; 
   bool     metricResolution       :  1; 
   bool     readNormalized         :  1; 
   bool     embedICCProfile        :  1; 
   bool     embedThumbnail         :  1; 
   bool     embedProperties        :  1; 
   bool     embedRGBWS             :  1; 
   bool     embedDisplayFunction   :  1; 
   bool     embedColorFilterArray  :  1; 
   bool     embedProcessingHistory :  1; 
   bool     embedPreviewRects      :  1; 
   int      __rsv__                : 11; // Reserved for future extensions; must be zero.
 
   double   lowerRange;    
   double   upperRange;    
 
   double   xResolution;   
   double   yResolution;   
 
   int      isoSpeed;      
   float    exposure;      
   float    aperture;      
   float    focalLength;   
   int      imageType;     
   int      cfaType;       
 
   ImageOptions()
   {
      Reset();
   }
 
   ImageOptions( const ImageOptions& ) = default;
 
   ImageOptions& operator =( const ImageOptions& ) = default;
 
   void Reset()
   {
      bitsPerSample          = 16;
      ieeefpSampleFormat     = false;
      complexSample          = false;
      signedIntegers         = false;
      metricResolution       = false;
      readNormalized         = true;
      embedICCProfile        = true;
      embedThumbnail         = false;
      embedProperties        = true;
      embedRGBWS             = true;
      embedDisplayFunction   = true;
      embedColorFilterArray  = true;
      embedProcessingHistory = false;
      embedPreviewRects      = false;
      __rsv__                = 0;
      lowerRange             = 0;
      upperRange             = 1;
      xResolution            = 72;
      yResolution            = 72;
      isoSpeed               = 0;
      exposure               = 0;
      aperture               = 0;
      focalLength            = 0;
      imageType              = ImageType::Unknown;
      cfaType                = CFAType::None;
   }
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_ImageOptions_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ImageOptions.h - Released 2025-02-21T12:13:32Z