Resample.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.1.19
// ----------------------------------------------------------------------------
// pcl/Resample.h - Released 2019-11-07T10:59:34Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2019 Pleiades Astrophoto S.L. All Rights Reserved.
//
// Redistribution and use in both source and binary forms, with or without
// modification, is permitted provided that the following conditions are met:
//
// 1. All redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//
// 2. All redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//
// 3. Neither the names "PixInsight" and "Pleiades Astrophoto", nor the names
//    of their contributors, may be used to endorse or promote products derived
//    from this software without specific prior written permission. For written
//    permission, please contact info@pixinsight.com.
//
// 4. All products derived from this software, in any form whatsoever, must
//    reproduce the following acknowledgment in the end-user documentation
//    and/or other materials provided with the product:
//
//    "This product is based on software from the PixInsight project, developed
//    by Pleiades Astrophoto and its contributors (http://pixinsight.com/)."
//
//    Alternatively, if that is where third-party acknowledgments normally
//    appear, this acknowledgment must be reproduced in the product itself.
//
// THIS SOFTWARE IS PROVIDED BY PLEIADES ASTROPHOTO AND ITS CONTRIBUTORS
// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
// TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
// PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL PLEIADES ASTROPHOTO OR ITS
// CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
// EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, BUSINESS
// INTERRUPTION; PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; AND LOSS OF USE,
// DATA OR PROFITS) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
// CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
// ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
// POSSIBILITY OF SUCH DAMAGE.
// ----------------------------------------------------------------------------

#ifndef __PCL_Resample_h
#define __PCL_Resample_h


#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>

#include <pcl/GeometricTransformation.h>
#include <pcl/ImageResolution.h>
#include <pcl/ParallelProcess.h>

namespace pcl
{

// ----------------------------------------------------------------------------

namespace ResizeMode
{
   enum value_type
   {
      RelativeDimensions,  // Resize relative to current image dimensions
      AbsolutePixels,      // ... to absolute dimensions in pixels
      AbsoluteCentimeters, // ... to absolute dimensions in centimeters
      AbsoluteInches,      // ... to absolute dimensions in inches
      ForceArea,           // Force number of pixels, keep aspect ratio
      NumberOfResizeModes,
      Default = RelativeDimensions
   };
}

// ----------------------------------------------------------------------------

namespace AbsoluteResizeMode
{
   enum value_type
   {
      ForceWidthAndHeight, // Force both dimensions
      ForceWidth,          // Force width, preserve aspect ratio
      ForceHeight,         // Force height, preserve aspect ratio
      NumberOfAbsoluteResizeModes,
      Default = ForceWidthAndHeight
   };
}

// ----------------------------------------------------------------------------

class PCL_CLASS Resample : public InterpolatingGeometricTransformation,
                           public ImageResolution,
                           public ParallelProcess
{
public:

   typedef ResizeMode::value_type         resize_mode;

   typedef AbsoluteResizeMode::value_type abs_resize_mode;

   Resample( PixelInterpolation& p, double scale = 1.0 ) :
      InterpolatingGeometricTransformation( p ),
      m_xSize( scale ), m_ySize( scale )
   {
   }

   Resample( PixelInterpolation& p, double scaleX, double scaleY ) :
      InterpolatingGeometricTransformation( p ),
      m_xSize( scaleX ), m_ySize( scaleY )
   {
   }

   Resample( const Resample& ) = default;

   void GetSizes( double& width, double& height ) const
   {
      width = m_xSize; height = m_ySize;
   }

   double XSize() const
   {
      return m_xSize;
   }

   double YSize() const
   {
      return m_ySize;
   }

   void SetSizes( double width, double height )
   {
      m_xSize = width; m_ySize = height;
   }

   void SetXSize( double width )
   {
      m_xSize = width;
   }

   void SetYSize( double height )
   {
      m_ySize = height;
   }

   void GetScalingFactors( double& sx, double& sy ) const
   {
      GetSizes( sx, sy );
   }

   double XScale() const
   {
      return XSize();
   }

   double YScale() const
   {
      return YSize();
   }

   void SetScalingFactors( double sx, double sy )
   {
      SetSizes( sx, sy );
   }

   void SetXScale( double sx )
   {
      SetXSize( sx );
   }

   void SetYScale( double sy )
   {
      SetYSize( sy );
   }

   resize_mode Mode() const
   {
      return m_mode;
   }

   bool IsRelative() const
   {
      return m_mode == ResizeMode::RelativeDimensions;
   }

   bool IsAbsolute() const
   {
      return !IsRelative();
   }

   void SetMode( resize_mode mode )
   {
      m_mode = mode;
   }

   abs_resize_mode AbsMode() const
   {
      return m_absMode;
   }

   void SetAbsMode( abs_resize_mode absMode )
   {
      m_absMode = absMode;
   }

   void GetNewSizes( int& width, int& height ) const override;

protected:

   double          m_xSize = 1.0;
   double          m_ySize = 1.0;
   resize_mode     m_mode = ResizeMode::Default;
   abs_resize_mode m_absMode = AbsoluteResizeMode::Default;

   // Inherited from ImageTransformation.
   void Apply( pcl::Image& ) const override;
   void Apply( pcl::DImage& ) const override;
   void Apply( pcl::UInt8Image& ) const override;
   void Apply( pcl::UInt16Image& ) const override;
   void Apply( pcl::UInt32Image& ) const override;
};

// ----------------------------------------------------------------------------

} // pcl

#endif   // __PCL_Resample_h

// ----------------------------------------------------------------------------
// EOF pcl/Resample.h - Released 2019-11-07T10:59:34Z