LocalNormalizationData.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.4.0
// ----------------------------------------------------------------------------
// pcl/LocalNormalizationData.h - Released 2020-07-31T19:33:04Z
// ----------------------------------------------------------------------------
// 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 (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_LocalNormalizationData_h
#define __PCL_LocalNormalizationData_h


#include <pcl/Defs.h>

#include <pcl/BicubicInterpolation.h>
#include <pcl/File.h>
#include <pcl/Image.h>
#include <pcl/TimePoint.h>

namespace pcl
{

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

class PCL_CLASS XMLDocument;
class PCL_CLASS XMLElement;

class PCL_CLASS LocalNormalizationData
{
public:

   typedef DImage                            normalization_matrices;

   typedef normalization_matrices::sample    normalization_coefficient;

   typedef BicubicBSplineInterpolation<normalization_coefficient>
                                             matrix_interpolation;

   typedef Array<matrix_interpolation>       matrix_interpolations;

   LocalNormalizationData() = default;

   LocalNormalizationData( const LocalNormalizationData& ) = default;

   LocalNormalizationData( LocalNormalizationData&& ) = default;

   LocalNormalizationData( const String& filePath, bool ignoreNormalizationData = false )
   {
      Parse( filePath, ignoreNormalizationData );
   }

   LocalNormalizationData( const XMLDocument& xml, bool ignoreNormalizationData = false )
   {
      Parse( xml, ignoreNormalizationData );
   }

   LocalNormalizationData( const XMLElement& element, bool ignoreNormalizationData = false )
   {
      Parse( element, ignoreNormalizationData );
   }

   virtual ~LocalNormalizationData()
   {
   }

   const String& ReferenceFilePath() const
   {
      return m_referenceFilePath;
   }

   void SetReferenceFilePath( const String& filePath )
   {
      m_referenceFilePath = File::FullPath( filePath );
   }

   const String& TargetFilePath() const
   {
      return m_targetFilePath;
   }

   void SetTargetFilePath( const String& filePath )
   {
      m_targetFilePath = File::FullPath( filePath );
   }

   int NormalizationScale() const
   {
      return m_scale;
   }

   void SetNormalizationScale( int scale )
   {
      m_scale = scale;
   }

   int ReferenceWidth() const
   {
      return m_referenceWidth;
   }

   int ReferenceHeight() const
   {
      return m_referenceHeight;
   }

   void SetReferenceDimensions( int width, int height )
   {
      m_referenceWidth = width;
      m_referenceHeight = height;
   }

   int NumberOfChannels() const
   {
      return m_A.NumberOfChannels();
   }

   const normalization_matrices& ZeroOffset() const
   {
      return m_B;
   }

   const normalization_matrices& Scale() const
   {
      return m_A;
   }

   void SetNormalizationMatrices( const normalization_matrices& A, const normalization_matrices& B )
   {
      if ( A.Bounds() != B.Bounds() || A.NumberOfChannels() != B.NumberOfChannels() )
         throw Error( "LocalNormalizationData::SetNormalizationMatrices(): Incompatible matrix dimensions." );
      m_A = A;
      m_B = B;
   }

   void InitInterpolations();

   bool HasInterpolations() const
   {
      return !m_UA.IsEmpty() && !m_UB.IsEmpty();
   }

   double operator()( double z, int x, int y, int c = 0 ) const
   {
      double sx = m_sx*x;
      double sy = m_sy*y;
      return m_UA[c]( sx, sy )*z + m_UB[c]( sx, sy );
   }

   TimePoint CreationTime() const
   {
      return m_creationTime;
   }

   void Clear();

   void Parse( const String& filePath, bool ignoreNormalizationData = false );

   void Parse( const XMLDocument& xml, bool ignoreNormalizationData = false );

   void Parse( const XMLElement& element, bool ignoreNormalizationData = false );

   bool IsCompressionEnabled() const
   {
      return m_compressionEnabled;
   }

   void EnableCompression( bool enable = true )
   {
      m_compressionEnabled = enable;
   }

   void DisableCompression( bool disable = true )
   {
      EnableCompression( !disable );
   }

   XMLDocument* Serialize() const;

   void SerializeToFile( const String& path ) const;

private:

   String                 m_referenceFilePath;    // path to the normalization reference image
   String                 m_targetFilePath;       // path to the normalization target image
   int                    m_scale = -1;           // normalization scale in px
   int                    m_referenceWidth = -1;  // reference image width in px
   int                    m_referenceHeight = -1; // reference image height in px
   normalization_matrices m_A;                    // scaling coefficients
   normalization_matrices m_B;                    // zero offset coefficients
   matrix_interpolations  m_UA;                   // interpolators for m_A
   matrix_interpolations  m_UB;                   // interpolators for m_B
   double                 m_sx;                   // coordinate scaling factor, X axis
   double                 m_sy;                   // coordinate scaling factor, Y axis
   TimePoint              m_creationTime;
   bool                   m_compressionEnabled = true;

   void ParseNormalizationMatrices( normalization_matrices&, const XMLElement& ) const;
   void SerializeNormalizationMatrices( XMLElement*, const normalization_matrices& ) const;
};

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

} // pcl

#endif   // __PCL_LocalNormalizationData_h

// ----------------------------------------------------------------------------
// EOF pcl/LocalNormalizationData.h - Released 2020-07-31T19:33:04Z