PCL
ImageInfo.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.7.0
6 // ----------------------------------------------------------------------------
7 // pcl/ImageInfo.h - Released 2024-06-18T15:48:54Z
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_ImageInfo_h
53 #define __PCL_ImageInfo_h
54 
56 
57 #include <pcl/Defs.h>
58 
59 #include <pcl/AbstractImage.h>
60 #include <pcl/Relational.h>
61 
62 namespace pcl
63 {
64 
65 // ----------------------------------------------------------------------------
66 
71 class PCL_CLASS ImageInfo
72 {
73 public:
74 
79  using color_space = ColorSpace::value_type;
80 
81  int width;
82  int height;
84  color_space colorSpace;
85  bool supported;
86 
91  {
92  Reset();
93  }
94 
98  ImageInfo( const ImageInfo& ) = default;
99 
103  ImageInfo& operator =( const ImageInfo& ) = default;
104 
113  ImageInfo( const AbstractImage& image )
114  {
115  width = image.SelectedRectangle().Width();
116  height = image.SelectedRectangle().Height();
117  numberOfChannels = image.NumberOfSelectedChannels();
118  colorSpace = image.ColorSpace();
119  supported = IsValid();
120  }
121 
126  {
127  return size_type( width )*size_type( height );
128  }
129 
135  {
136  return NumberOfPixels()*size_type( numberOfChannels );
137  }
138 
143  void Reset()
144  {
145  width = height = numberOfChannels = 0;
146  colorSpace = ColorSpace::Unknown;
147  supported = false;
148  }
149 
153  bool IsValid() const
154  {
155  return width > 0 &&
156  height > 0 &&
157  colorSpace != ColorSpace::Unknown &&
158  numberOfChannels >= ((colorSpace == ColorSpace::Gray) ? 1 : 3);
159  }
160 
164  bool operator ==( const ImageInfo& x ) const
165  {
166  return width == x.width &&
167  height == x.height &&
168  numberOfChannels == x.numberOfChannels &&
169  colorSpace == x.colorSpace;
170  }
171 };
172 
173 // ----------------------------------------------------------------------------
174 
175 } // pcl
176 
177 #endif // __PCL_ImageInfo_h
178 
179 // ----------------------------------------------------------------------------
180 // EOF pcl/ImageInfo.h - Released 2024-06-18T15:48:54Z
Base class of all two-dimensional images in PCL.
int NumberOfSelectedChannels() const noexcept
const Rect & SelectedRectangle() const noexcept
component Width() const noexcept
Definition: Rectangle.h:635
component Height() const noexcept
Definition: Rectangle.h:644
color_space ColorSpace() const noexcept
Definition: ImageColor.h:178
A simple structure to hold basic information about images.
Definition: ImageInfo.h:72
ImageInfo(const AbstractImage &image)
Definition: ImageInfo.h:113
bool IsValid() const
Definition: ImageInfo.h:153
size_type NumberOfPixels() const
Definition: ImageInfo.h:125
int height
Image height in pixels
Definition: ImageInfo.h:82
bool supported
Whether we support this image.
Definition: ImageInfo.h:85
ImageInfo(const ImageInfo &)=default
color_space colorSpace
Color space, compatible with ImageColor::color_space
Definition: ImageInfo.h:84
void Reset()
Definition: ImageInfo.h:143
size_type NumberOfSamples() const
Definition: ImageInfo.h:134
int width
Image width in pixels
Definition: ImageInfo.h:81
int numberOfChannels
Number of channels, including alpha channels.
Definition: ImageInfo.h:83
bool operator==(const Array< T, A > &x1, const Array< T, A > &x2) noexcept
Definition: Array.h:2267
size_t size_type
Definition: Defs.h:609
PCL root namespace.
Definition: AbstractImage.h:77