PCL
ImageResolution.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.4.7
6 // ----------------------------------------------------------------------------
7 // pcl/ImageResolution.h - Released 2020-12-17T15:46:29Z
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-2020 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_ImageResolution_h
53 #define __PCL_ImageResolution_h
54 
56 
57 #include <pcl/Defs.h>
58 #include <pcl/Diagnostics.h>
59 
60 namespace pcl
61 {
62 
63 // ----------------------------------------------------------------------------
64 
71 class PCL_CLASS ImageResolution
72 {
73 public:
74 
78  ImageResolution() = default;
79 
83  ImageResolution( const ImageResolution& ) = default;
84 
88  ImageResolution& operator =( const ImageResolution& ) = default;
89 
96  void GetResolution( double& x, double& y )
97  {
98  x = xResolution; y = yResolution;
99  }
100 
106  double HorizontalResolution() const
107  {
108  return xResolution;
109  }
110 
116  double VerticalResolution() const
117  {
118  return yResolution;
119  }
120 
127  void SetResolution( double x, double y )
128  {
129  PCL_PRECONDITION( x >= 0 )
130  PCL_PRECONDITION( y >= 0 )
131  xResolution = pcl::Max( 0.0, x ); yResolution = pcl::Max( 0.0, y );
132  }
133 
142  double Resolution() const
143  {
144  return xResolution;
145  }
146 
155  void SetResolution( double r )
156  {
157  PCL_PRECONDITION( r >= 0 )
158  xResolution = yResolution = pcl::Max( 0.0, r );
159  }
160 
167  bool IsMetricResolution() const
168  {
169  return metric;
170  }
171 
180  void SetMetricResolution( bool m )
181  {
182  metric = m;
183  }
184 
185 protected:
186 
187  /*
188  * Resolution in pixels per resolution unit (centimeters or inches).
189  */
190  double xResolution = 72;
191  double yResolution = 72;
192 
193  /*
194  * Flag true when resolution values are expressed in pixels per centimeter.
195  * Pixels per inch otherwise.
196  */
197  bool metric = false;
198 };
199 
200 // ----------------------------------------------------------------------------
201 
202 } // pcl
203 
204 #endif // __PCL_ImageResolution_h
205 
206 // ----------------------------------------------------------------------------
207 // EOF pcl/ImageResolution.h - Released 2020-12-17T15:46:29Z
double Resolution() const
double VerticalResolution() const
void SetResolution(double r)
PCL root namespace.
Definition: AbstractImage.h:76
double HorizontalResolution() const
constexpr const T & Max(const T &a, const T &b) noexcept
Definition: Utility.h:119
bool IsMetricResolution() const
void SetResolution(double x, double y)
void GetResolution(double &x, double &y)
Image resolution data
void SetMetricResolution(bool m)