ImageGeometry.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.11
// ----------------------------------------------------------------------------
// pcl/ImageGeometry.h - Released 2024-05-07T15:27:32Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2024 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 (https://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_ImageGeometry_h
#define __PCL_ImageGeometry_h
 
 
#include <pcl/Defs.h>
#include <pcl/Diagnostics.h>
 
#include <pcl/Point.h>
#include <pcl/Rectangle.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
#define m_width            m_geometry->width
#define m_height           m_geometry->height
#define m_numberOfChannels m_geometry->numberOfChannels
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS ImageGeometry
{
public:
 
   int Width() const noexcept
   {
      return m_width;
   }
 
   int Height() const noexcept
   {
      return m_height;
   }
 
   int NumberOfChannels() const noexcept
   {
      return m_numberOfChannels;
   }
 
   int LastChannel() const noexcept
   {
      return m_numberOfChannels-1;
   }
 
   bool IsValidChannelIndex( int c ) const noexcept
   {
      return c >= 0 && c < m_numberOfChannels;
   }
 
   bool IsEmpty() const noexcept
   {
      return m_width <= 0 || m_height <= 0 || m_numberOfChannels <= 0;
   }
 
   Rect Bounds() const noexcept
   {
      return Rect( m_width, m_height );
   }
 
   template <typename T>
   bool Includes( const GenericPoint<T>& p ) const noexcept
   {
      return Includes( p.x, p.y );
   }
 
   template <typename T>
   bool Includes( const GenericRectangle<T>& r ) const noexcept
   {
      return Includes( r.x0, r.y0, r.x1, r.y1 );
   }
 
   template <typename T>
   bool Includes( T x0, T y0, T x1, T y1 ) const noexcept
   {
      pcl::OrderRect( x0, y0, x1, y1 );
      return Includes( x0, y0 ) && Includes( x1-T( 1 ), y1-T( 1 ) );
   }
 
   template <typename T>
   bool Includes( T x, T y ) const noexcept
   {
      return x < m_width && y < m_height && x >= 0 && y >= 0;
   }
 
   template <typename T>
   bool Intersects( const pcl::GenericRectangle<T>& r ) const noexcept
   {
      return Intersects( r.x0, r.y0, r.x1, r.y1 );
   }
 
   template <typename T>
   bool Intersects( T x0, T y0, T x1, T y1 ) const noexcept
   {
      pcl::OrderRect( x0, y0, x1, y1 );
      return x0 < m_width && y0 < m_height && x1 > T( 0 ) && y1 > T( 0 );
   }
 
   template <typename T>
   bool Clip( pcl::GenericPoint<T>& p ) const noexcept
   {
      return Clip( p.x, p.y );
   }
 
   template <typename T>
   bool Clip( T& x, T& y ) const noexcept
   {
      bool in = false;
 
      if ( x >= T( m_width ) )  x = T( m_width-1 );
      else if ( x < T( 0 ) )    x = T( 0 );
      else                      in = true;
 
      if ( y >= T( m_height ) ) y = T( m_height-1 );
      else if ( y < T( 0 ) )    y = T( 0 );
      else                      return in;
 
      return false;
   }
 
   template <typename T>
   bool Clip( pcl::GenericRectangle<T>& r ) const noexcept
   {
      return Clip( r.x0, r.y0, r.x1, r.y1 );
   }
 
   template <typename T>
   bool Clip( T& x0, T& y0, T& x1, T& y1 ) const noexcept
   {
      pcl::OrderRect( x0, y0, x1, y1 );
 
      int out = 0;
 
      if ( x0 >= T( m_width ) )  x0 = T( m_width ),  ++out;
      else if ( x0 < T( 0 ) )    x0 = T( 0 );
 
      if ( y0 >= T( m_height ) ) y0 = T( m_height ), ++out;
      else if ( y0 < T( 0 ) )    y0 = T( 0 );
 
      if ( x1 > T( m_width ) )   x1 = T( m_width );
      else if ( x1 <= T( 0 ) )   x1 = T( 0 ),        ++out;
 
      if ( y1 > T( m_height ) )  y1 = T( m_height );
      else if ( y1 <= T( 0 ) )   y1 = T( 0 ),        ++out;
 
      return !out;
   }
 
   size_type NumberOfPixels() const noexcept
   {
      return size_type( m_width )*size_type( m_height );
   }
 
   size_type NumberOfSamples() const noexcept
   {
      return NumberOfPixels()*size_type( m_numberOfChannels );
   }
 
   distance_type RowOffset( int y ) const noexcept
   {
      return distance_type( y )*distance_type( m_width );
   }
 
   distance_type PixelOffset( int x, int y ) const noexcept
   {
      return RowOffset( y ) + distance_type( x );
   }
 
protected:
 
   /*
    * Image geometry
    */
   struct Geometry
   {
      int width = 0;
      int height = 0;
      int numberOfChannels = 0;
 
      Geometry() = default;
      Geometry( const Geometry& ) = default;
 
      size_type NumberOfPixels() const noexcept
      {
         return size_type( width )*size_type( height );
      }
 
      void Assign( const Geometry& x ) noexcept
      {
         width = x.width;
         height = x.height;
         numberOfChannels = x.numberOfChannels;
      }
 
      void Reset() noexcept
      {
         width = height = numberOfChannels = 0;
      }
   };
 
   Geometry* m_geometry = nullptr;
 
   ImageGeometry() = default;
   ImageGeometry( const ImageGeometry& ) = default;
   ImageGeometry& operator =( const ImageGeometry& ) = default;
 
   virtual ~ImageGeometry()
   {
      m_geometry = nullptr;
   }
 
   void Swap( ImageGeometry& image ) noexcept
   {
      pcl::Swap( m_geometry, image.m_geometry );
   }
};
 
// ----------------------------------------------------------------------------
 
#undef m_width
#undef m_height
#undef m_numberOfChannels
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_ImageGeometry_h
 
// ----------------------------------------------------------------------------
// EOF pcl/ImageGeometry.h - Released 2024-05-07T15:27:32Z