PCL
ImageOptions.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.6.5
6 // ----------------------------------------------------------------------------
7 // pcl/ImageOptions.h - Released 2024-01-13T15:47:58Z
8 // ----------------------------------------------------------------------------
9 // This file is part of the PixInsight Class Library (PCL).
10 // PCL is a multiplatform C++ framework for development of PixInsight modules.
11 //
12 // Copyright (c) 2003-2024 Pleiades Astrophoto S.L. All Rights Reserved.
13 //
14 // Redistribution and use in both source and binary forms, with or without
15 // modification, is permitted provided that the following conditions are met:
16 //
17 // 1. All redistributions of source code must retain the above copyright
18 // notice, this list of conditions and the following disclaimer.
19 //
20 // 2. All redistributions in binary form must reproduce the above copyright
21 // notice, this list of conditions and the following disclaimer in the
22 // documentation and/or other materials provided with the distribution.
23 //
24 // 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
25 // of their contributors, may be used to endorse or promote products derived
26 // from this software without specific prior written permission. For written
27 // permission, please contact info@pixinsight.com.
28 //
29 // 4. All products derived from this software, in any form whatsoever, must
30 // reproduce the following acknowledgment in the end-user documentation
31 // and/or other materials provided with the product:
32 //
33 // "This product is based on software from the PixInsight project, developed
34 // by Pleiades Astrophoto and its contributors (https://pixinsight.com/)."
35 //
36 // Alternatively, if that is where third-party acknowledgments normally
37 // appear, this acknowledgment must be reproduced in the product itself.
38 //
39 // THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
40 // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
41 // TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
42 // PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
43 // CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
44 // EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
45 // INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
46 // DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
47 // CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
48 // ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
49 // POSSIBILITY OF SUCH DAMAGE.
50 // ----------------------------------------------------------------------------
51 
52 #ifndef __PCL_ImageOptions_h
53 #define __PCL_ImageOptions_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 #include <pcl/String.h>
60 
61 namespace pcl
62 {
63 
64 // ----------------------------------------------------------------------------
65 
80 namespace CFAType
81 {
82  enum value_type { None, BGGR, GRBG, GBRG, RGGB, CYGM, NumberOfCFATypes };
83 
90  String Name( int cfa );
91 }
92 
97 class PCL_CLASS ImageOptions
98 {
99 public:
100 
103  bool complexSample : 1;
104  bool signedIntegers : 1;
105  bool metricResolution : 1;
106  bool readNormalized : 1;
107  bool embedICCProfile : 1;
108  bool embedThumbnail : 1;
109  bool embedProperties : 1;
110  bool embedRGBWS : 1;
114  bool embedPreviewRects : 1;
115  int __rsv__ : 11; // Reserved for future extensions; must be zero.
116 
117  double lowerRange;
118  double upperRange;
119 
120  double xResolution;
121  double yResolution;
122 
123  int isoSpeed;
124  float exposure;
125  float aperture;
126  float focalLength;
127  int cfaType;
128 
133  {
134  Reset();
135  }
136 
140  ImageOptions( const ImageOptions& ) = default;
141 
145  ImageOptions& operator =( const ImageOptions& ) = default;
146 
150  void Reset()
151  {
152  bitsPerSample = 16;
153  ieeefpSampleFormat = false;
154  complexSample = false;
155  signedIntegers = false;
156  metricResolution = false;
157  readNormalized = true;
158  embedICCProfile = true;
159  embedThumbnail = false;
160  embedProperties = true;
161  embedRGBWS = true;
162  embedDisplayFunction = true;
163  embedColorFilterArray = true;
164  embedProcessingHistory = false;
165  embedPreviewRects = false;
166  __rsv__ = 0;
167  lowerRange = 0;
168  upperRange = 1;
169  xResolution = 72;
170  yResolution = 72;
171  isoSpeed = 0;
172  exposure = 0;
173  aperture = 0;
174  focalLength = 0;
175  cfaType = CFAType::None;
176  }
177 };
178 
179 // ----------------------------------------------------------------------------
180 
181 } // pcl
182 
183 #endif // __PCL_ImageOptions_h
184 
185 // ----------------------------------------------------------------------------
186 // EOF pcl/ImageOptions.h - Released 2024-01-13T15:47:58Z
pcl
PCL root namespace.
Definition: AbstractImage.h:76
pcl::ImageOptions::metricResolution
bool metricResolution
Resolution units: centimeter (true) or inch (false). The default value is false.
Definition: ImageOptions.h:105
pcl::ImageOptions::xResolution
double xResolution
Horizontal resolution in pixels per resolution unit (0=unknown). The default value is 72.
Definition: ImageOptions.h:120
pcl::ImageOptions::ieeefpSampleFormat
bool ieeefpSampleFormat
Sample type: IEEE 754 floating point (true) or integers (false). The default value is false.
Definition: ImageOptions.h:102
pcl::ImageOptions::isoSpeed
int isoSpeed
ISO speed as specified in ISO 12232 (0=unknown)
Definition: ImageOptions.h:123
pcl::ImageOptions::lowerRange
double lowerRange
Lower limit to normalize read floating-point samples. The default value is 0.
Definition: ImageOptions.h:117
pcl::ImageOptions::complexSample
bool complexSample
Sample type: Complex (true) or real (false) samples. The default value is false.
Definition: ImageOptions.h:103
pcl::ImageOptions::embedICCProfile
bool embedICCProfile
Embed an ICC profile (when available). The default value is true.
Definition: ImageOptions.h:107
pcl::ImageOptions::aperture
float aperture
Focal length divided by lens diameter (F/D) (0=unknown)
Definition: ImageOptions.h:125
pcl::ImageOptions::embedProcessingHistory
bool embedProcessingHistory
Embed existing processing history as an XML document. The default value is false.
Definition: ImageOptions.h:113
pcl::ImageOptions::signedIntegers
bool signedIntegers
Integer sample values are signed (true) or unsigned (false). The default value is false.
Definition: ImageOptions.h:104
pcl::uint8
unsigned char uint8
Definition: Defs.h:645
pcl::ImageOptions
Format-independent, fundamental image stream options.
Definition: ImageOptions.h:97
pcl::ImageOptions::embedColorFilterArray
bool embedColorFilterArray
Embed color filter array (CFA) description. The default value is true.
Definition: ImageOptions.h:112
pcl::ImageOptions::cfaType
int cfaType
Color Filter Array type. See CFAType namespace for possible values (0=none).
Definition: ImageOptions.h:127
pcl::ImageOptions::upperRange
double upperRange
Upper limit to normalize read floating-point samples. The default value is 1.
Definition: ImageOptions.h:118
pcl::ImageOptions::embedPreviewRects
bool embedPreviewRects
Embed existing preview rectangles and their identifiers. The default value is false.
Definition: ImageOptions.h:114
pcl::ImageOptions::bitsPerSample
uint8 bitsPerSample
Number of bits per sample: 8, 16, 32 or 64. The default value is 16.
Definition: ImageOptions.h:101
pcl::ImageOptions::embedProperties
bool embedProperties
Embed data properties (when available). The default value is true.
Definition: ImageOptions.h:109
pcl::ImageOptions::exposure
float exposure
Exposure in seconds (0=unknown)
Definition: ImageOptions.h:124
pcl::ImageOptions::yResolution
double yResolution
Vertical resolution in pixels per resolution unit (0=unknown). The default value is 72.
Definition: ImageOptions.h:121
pcl::ImageOptions::embedThumbnail
bool embedThumbnail
Embed thumbnail images (when available). The default value is false.
Definition: ImageOptions.h:108
String.h
pcl::ImageOptions::ImageOptions
ImageOptions()
Definition: ImageOptions.h:132
pcl::ImageOptions::readNormalized
bool readNormalized
Normalize floating-point sample values after reading. The default value is true.
Definition: ImageOptions.h:106
pcl::ImageOptions::Reset
void Reset()
Definition: ImageOptions.h:150
pcl::ImageOptions::embedRGBWS
bool embedRGBWS
Embed RGB working space parameters. The default value is true.
Definition: ImageOptions.h:110
pcl::CFAType::Name
String Name(int cfa)
Defs.h
pcl::ImageOptions::embedDisplayFunction
bool embedDisplayFunction
Embed display function (aka STF) parameters. The default value is true.
Definition: ImageOptions.h:111
pcl::ImageOptions::focalLength
float focalLength
Focal length in millimeters (0=unknown)
Definition: ImageOptions.h:126