PolarTransform.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.4.7
// ----------------------------------------------------------------------------
// pcl/PolarTransform.h - Released 2020-12-17T15:46:29Z
// ----------------------------------------------------------------------------
// This file is part of the PixInsight Class Library (PCL).
// PCL is a multiplatform C++ framework for development of PixInsight modules.
//
// Copyright (c) 2003-2020 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_PolarTransform_h
#define __PCL_PolarTransform_h


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

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

namespace pcl
{

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

class PCL_CLASS PolarTransformBase : public InterpolatingGeometricTransformation,
                                     public ParallelProcess
{
public:

   PolarTransformBase( PixelInterpolation& p )
      : InterpolatingGeometricTransformation( p )
   {
   }

   PolarTransformBase( const PolarTransformBase& ) = default;

   float InitialRotation() const
   {
      return m_initialAngle;
   }

   void SetInitialRotation( float angle )
   {
      PCL_PRECONDITION( angle >= 0 && angle <= pcl::Const<float>::_2pi() )
      if ( (m_initialAngle = angle) > m_finalAngle )
         pcl::Swap( m_initialAngle, m_finalAngle );
   }

   float FinalRotation() const
   {
      return m_finalAngle;
   }

   void SetFinalRotation( float angle )
   {
      PCL_PRECONDITION( angle >= 0 && angle <= pcl::Const<float>::_2pi() )
      if ( (m_finalAngle = angle) < m_initialAngle )
         pcl::Swap( m_initialAngle, m_finalAngle );
   }

   void SetRotationRange( float initialAngle, float finalAngle )
   {
      PCL_PRECONDITION( initialAngle >= 0 && initialAngle <= pcl::Const<float>::_2pi() )
      PCL_PRECONDITION( finalAngle >= 0 && finalAngle <= pcl::Const<float>::_2pi() )
      m_initialAngle = initialAngle;
      m_finalAngle = finalAngle;
      if ( m_finalAngle < m_initialAngle )
         pcl::Swap( m_initialAngle, m_finalAngle );
   }

   void GetNewSizes( int& w, int& h ) const override
   {
      // No change
   }

   virtual bool IsLogPolar() const
   {
      return false;
   }

protected:

   float m_initialAngle = 0; // in radians
   float m_finalAngle = pcl::Const<float>::_2pi();
};

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

class PCL_CLASS PolarTransform : public PolarTransformBase
{
public:

   PolarTransform( PixelInterpolation& p )
      : PolarTransformBase( p )
   {
   }

   PolarTransform( const PolarTransform& ) = default;

protected:

   // 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;
};

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

class PCL_CLASS LogPolarTransform : public PolarTransformBase
{
public:

   LogPolarTransform( PixelInterpolation& p )
      : PolarTransformBase( p )
   {
   }

   LogPolarTransform( const LogPolarTransform& ) = default;

   bool IsLogPolar() const override
   {
      return true;
   }

protected:

   // 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_PolarTransform_h

// ----------------------------------------------------------------------------
// EOF pcl/PolarTransform.h - Released 2020-12-17T15:46:29Z