Crop.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.1.19
// ----------------------------------------------------------------------------
// pcl/Crop.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_Crop_h
#define __PCL_Crop_h


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

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

namespace pcl
{

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

namespace CropMode
{
   enum value_type
   {
      RelativeMargins,     // Cropping margins are relative to current image dimensions
      AbsolutePixels,      // Absolute cropping margins in pixels
      AbsoluteCentimeters, // Absolute cropping margins in centimeters
      AbsoluteInches       // Absolute cropping margins in inches
   };
}

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

class PCL_CLASS Crop : public GeometricTransformation,
                       public ImageResolution
{
public:

   typedef CropMode::value_type  crop_mode;

   Crop( double left = 0, double top = 0, double right = 0, double bottom = 0 ) :
      m_margins( left, top, right, bottom ), m_mode( CropMode::RelativeMargins )
   {
   }

   template <typename T>
   Crop( const GenericRectangle<T>& r ) :
      m_margins( r ), m_mode( CropMode::RelativeMargins )
   {
   }

   Crop( const Crop& ) = default;

   Crop& operator =( const Crop& ) = default;

   DRect Margins() const
   {
      return m_margins;
   }

   template <typename T>
   void SetMargins( const GenericRectangle<T>& r )
   {
      m_margins = r;
   }

   void SetMargins( int left, int top, int right, int bottom )
   {
      m_margins = Rect( left, top, right, bottom );
   }

   crop_mode Mode() const
   {
      return m_mode;
   }

   bool IsRelative() const
   {
      return m_mode == CropMode::RelativeMargins;
   }

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

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

   const DVector& FillValues() const
   {
      return m_fillValues;
   }

   void SetFillValues( const DVector& fillValues )
   {
      m_fillValues = fillValues;
   }

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

protected:

   DRect     m_margins;
   crop_mode m_mode;
   DVector   m_fillValues;

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

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

} // pcl

#endif   // __PCL_Crop_h

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