LocalNormalizationData.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.6.5
// ----------------------------------------------------------------------------
// pcl/LocalNormalizationData.h - Released 2024-01-13T15:47:58Z
// ----------------------------------------------------------------------------
// 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_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:
 
   using normalization_matrices = Image;
 
   using normalization_coefficient = normalization_matrices::sample;
 
   using matrix_interpolation = BicubicBSplineInterpolation<normalization_coefficient>;
 
   using matrix_interpolations = Array<matrix_interpolation>;
 
   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;
   }
 
   const Vector& Bias() const
   {
      return m_C;
   }
 
   void SetLocalNormalizationParameters( const normalization_matrices& A, const normalization_matrices& B, const Vector& C = Vector() )
   {
      if ( A.Bounds() != B.Bounds() )
         throw Error( "LocalNormalizationData::SetLocalNormalizationParameters(): Incompatible matrix dimensions." );
      if ( A.NumberOfChannels() != B.NumberOfChannels() )
         throw Error( "LocalNormalizationData::SetLocalNormalizationParameters(): Incompatible number of normalization matrices." );
      m_A = A;
      m_B = B;
      if ( !C.IsEmpty() )
      {
         if ( C.Length() != A.NumberOfChannels() )
            throw Error( "LocalNormalizationData::SetLocalNormalizationParameters(): Incompatible bias vector length." );
         m_C = C;
      }
   }
 
   const Vector& GlobalReferenceLocation() const
   {
      return m_Rc;
   }
 
   const Vector& GlobalTargetLocation() const
   {
      return m_Rc;
   }
 
   const Vector& GlobalScalingFactors() const
   {
      return m_S;
   }
 
   void SetGlobalNormalizationParameters( const Vector& Rc, const Vector& Tc, const Vector& S )
   {
      if ( m_B.IsEmpty() )
         throw Error( "LocalNormalizationData::SetGlobalNormalizationParameters(): No zero offset coefficient matrix has been defined." );
      if ( Rc.Length() != m_B.NumberOfChannels() || Tc.Length() != m_B.NumberOfChannels() || S.Length() != m_B.NumberOfChannels() )
         throw Error( "LocalNormalizationData::SetGlobalNormalizationParameters(): Incompatible vector lengths." );
      m_Rc = Rc;
      m_Tc = Tc;
      m_S = S;
   }
 
   const Vector& RelativeScaleFactors() const
   {
      return m_relScale;
   }
 
   void SetRelativeScaleFactors( const Vector& s )
   {
      if ( m_B.IsEmpty() )
         throw Error( "LocalNormalizationData::SetRelativeScaleFactors(): No zero offset coefficient matrix has been defined." );
      if ( s.Length() != m_B.NumberOfChannels() )
         throw Error( "LocalNormalizationData::SetRelativeScaleFactors(): Incompatible vector lengths." );
      m_relScale = s;
   }
 
   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;
      if ( likely( m_S.IsEmpty() ) )
         return m_UA[c]( sx, sy )*(z - m_C[c]) + m_UB[c]( sx, sy );
      return (m_UA[c]( sx, sy )*(z - m_C[c]) + m_UB[c]( sx, sy ) - m_Tc[c])*m_S[c] + m_Rc[c];
   }
 
   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 );
   }
 
   int Version() const
   {
      return m_version;
   }
 
   void SetVersion( int version )
   {
      m_version = version;
   }
 
   bool IsTaggedAsInvalid() const
   {
      return m_invalid;
   }
 
   void TagAsInvalid()
   {
      m_invalid = true;
   }
 
   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
   Vector                 m_C;                    // input bias
   matrix_interpolations  m_UA;                   // interpolators for m_A
   matrix_interpolations  m_UB;                   // interpolators for m_B
   Vector                 m_Rc;                   // global normalization, reference center
   Vector                 m_Tc;                   // global normalization, target center
   Vector                 m_S;                    // global normalization, scale factor
   Vector                 m_relScale;             // relative scale factor
   double                 m_sx;                   // coordinate scaling factor, X axis
   double                 m_sy;                   // coordinate scaling factor, Y axis
   TimePoint              m_creationTime;
   bool                   m_compressionEnabled = true;
   int                    m_version = 0;
   bool                   m_invalid = false;
 
   void ParseNormalizationMatrices( normalization_matrices&, const XMLElement& ) const;
   void SerializeNormalizationMatrices( XMLElement*, const normalization_matrices& ) const;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_LocalNormalizationData_h
 
// ----------------------------------------------------------------------------
// EOF pcl/LocalNormalizationData.h - Released 2024-01-13T15:47:58Z