PCL
ImageOptions.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.1.19
6 // ----------------------------------------------------------------------------
7 // pcl/ImageOptions.h - Released 2019-11-07T10:59:34Z
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-2019 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 (http://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;
113  bool embedPreviewRects : 1;
114  int __rsv__ : 12; // Reserved for future extensions; must be zero.
115 
116  double lowerRange;
117  double upperRange;
118 
119  double xResolution;
120  double yResolution;
121 
122  int isoSpeed;
123  float exposure;
124  float aperture;
125  float focalLength;
126  int cfaType;
127 
132  {
133  Reset();
134  }
135 
139  ImageOptions( const ImageOptions& ) = default;
140 
144  ImageOptions& operator =( const ImageOptions& ) = default;
145 
149  void Reset()
150  {
151  bitsPerSample = 16;
152  ieeefpSampleFormat = false;
153  complexSample = false;
154  signedIntegers = false;
155  metricResolution = false;
156  readNormalized = true;
157  embedICCProfile = true;
158  embedThumbnail = false;
159  embedProperties = true;
160  embedRGBWS = true;
161  embedDisplayFunction = true;
162  embedColorFilterArray = true;
163  embedPreviewRects = false;
164  __rsv__ = 0;
165  lowerRange = 0;
166  upperRange = 1;
167  xResolution = 72;
168  yResolution = 72;
169  isoSpeed = 0;
170  exposure = 0;
171  aperture = 0;
172  focalLength = 0;
173  cfaType = CFAType::None;
174  }
175 };
176 
177 // ----------------------------------------------------------------------------
178 
179 } // pcl
180 
181 #endif // __PCL_ImageOptions_h
182 
183 // ----------------------------------------------------------------------------
184 // EOF pcl/ImageOptions.h - Released 2019-11-07T10:59:34Z
bool complexSample
Sample type: Complex (true) or real (false) samples. The default value is false.
Definition: ImageOptions.h:103
Format-independent fundamental image stream options.
Definition: ImageOptions.h:97
int cfaType
Color Filter Array type. See CFAType namespace for possible values (0=none).
Definition: ImageOptions.h:126
double yResolution
Vertical resolution in pixels per resolution unit. The default value is 72.
Definition: ImageOptions.h:120
unsigned char uint8
Definition: Defs.h:576
PCL root namespace.
Definition: AbstractImage.h:76
bool embedThumbnail
Embed thumbnail images (when available). The default value is false.
Definition: ImageOptions.h:108
bool signedIntegers
Integer sample values are signed (true) or unsigned (false).
Definition: ImageOptions.h:104
float focalLength
Focal length in millimeters (0=unknown)
Definition: ImageOptions.h:125
String Name(int cfa)
bool embedProperties
Embed data properties (when available). The default value is true.
Definition: ImageOptions.h:109
bool embedRGBWS
Embed RGB working space parameters.
Definition: ImageOptions.h:110
int isoSpeed
ISO speed as specified in ISO 12232 (0=unknown)
Definition: ImageOptions.h:122
bool embedColorFilterArray
Embed color filter array (CFA) description.
Definition: ImageOptions.h:112
uint8 bitsPerSample
Number of bits per sample: 8, 16, 32 or 64. The default value is 16.
Definition: ImageOptions.h:101
bool metricResolution
Resolution units: centimeter (true) or inch (false). The default value is false.
Definition: ImageOptions.h:105
bool readNormalized
Normalize floating-point sample values after reading. The default value is true.
Definition: ImageOptions.h:106
double upperRange
Upper limit to normalize read floating-point samples. The default value is 1.
Definition: ImageOptions.h:117
bool embedDisplayFunction
Embed display function (aka STF) parameters.
Definition: ImageOptions.h:111
bool ieeefpSampleFormat
Sample type: IEEE 754 floating point (true) or integers (false). The default value is false...
Definition: ImageOptions.h:102
double xResolution
Horizontal resolution in pixels per resolution unit. The default value is 72.
Definition: ImageOptions.h:119
double lowerRange
Lower limit to normalize read floating-point samples. The default value is 0.
Definition: ImageOptions.h:116
bool embedICCProfile
Embed an ICC profile (when available). The default value is true.
Definition: ImageOptions.h:107
float exposure
Exposure in seconds (0=unknown)
Definition: ImageOptions.h:123
float aperture
Focal length divided by lens diameter (F/D) (0=unknown)
Definition: ImageOptions.h:124
bool embedPreviewRects
Embed preview rectangles and identifiers.
Definition: ImageOptions.h:113