PCL
IntegerResample.h
Go to the documentation of this file.
1 // ____ ______ __
2 // / __ \ / ____// /
3 // / /_/ // / / /
4 // / ____// /___ / /___ PixInsight Class Library
5 // /_/ \____//_____/ PCL 2.1.19
6 // ----------------------------------------------------------------------------
7 // pcl/IntegerResample.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_IntegerResample_h
53 #define __PCL_IntegerResample_h
54 
56 
57 #include <pcl/Defs.h>
58 #include <pcl/Diagnostics.h>
59 
61 
62 namespace pcl
63 {
64 
65 // ----------------------------------------------------------------------------
66 
78 namespace IntegerDownsampleMode
79 {
80  enum value_type
81  {
82  Average,
83  Median,
84  Maximum,
85  Minimum
86  };
87 }
88 
89 // ----------------------------------------------------------------------------
90 
97 class PCL_CLASS IntegerResample : public GeometricTransformation
98 {
99 public:
100 
104  typedef IntegerDownsampleMode::value_type downsample_mode;
105 
110  IntegerResample( int zoom = 0, downsample_mode mode = IntegerDownsampleMode::Average ) :
111  m_zoomFactor( zoom ), m_downsampleMode( mode )
112  {
113  }
114 
118  IntegerResample( const IntegerResample& ) = default;
119 
123  int ZoomFactor() const
124  {
125  return m_zoomFactor;
126  }
127 
147  void SetZoomFactor( int zoom )
148  {
149  m_zoomFactor = (zoom < -1 || zoom > +1) ? zoom : +1;
150  }
151 
155  downsample_mode DownsampleMode() const
156  {
157  return m_downsampleMode;
158  }
159 
171  void SetDownsampleMode( downsample_mode mode )
172  {
173  m_downsampleMode = mode;
174  }
175 
178  void GetNewSizes( int& width, int& height ) const override;
179 
180 protected:
181 
182  /*
183  * Zoom factor: > 1 -> zoom in, < 1 -> zoom out, from -1 to +1 -> no change.
184  */
185  int m_zoomFactor = 0;
186 
187  /*
188  * Downsample mode: average, median, maximum, minimum; see enumeration above.
189  */
190  downsample_mode m_downsampleMode = IntegerDownsampleMode::Average;
191 
192  // Inherited from ImageTransformation.
193  void Apply( pcl::Image& ) const override;
194  void Apply( pcl::DImage& ) const override;
195  void Apply( pcl::UInt8Image& ) const override;
196  void Apply( pcl::UInt16Image& ) const override;
197  void Apply( pcl::UInt32Image& ) const override;
198 };
199 
200 // ----------------------------------------------------------------------------
201 
202 } // pcl
203 
204 #endif // __PCL_IntegerResample_h
205 
206 // ----------------------------------------------------------------------------
207 // EOF pcl/IntegerResample.h - Released 2019-11-07T10:59:34Z
Abstract base class of all PCL geometric image transformations.
A geometric transformation to resample images by integer ratios.
PCL root namespace.
Definition: AbstractImage.h:76
IntegerResample(int zoom=0, downsample_mode mode=IntegerDownsampleMode::Average)
16-bit unsigned integer image.
void Apply(FI i, FI j, F f)
Definition: Utility.h:249
64-bit floating point real image.
32-bit unsigned integer image.
8-bit unsigned integer image.
downsample_mode DownsampleMode() const
void SetDownsampleMode(downsample_mode mode)
IntegerDownsampleMode::value_type downsample_mode
32-bit floating point real image.
void SetZoomFactor(int zoom)