IntegrationMetadata.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.7.0
// ----------------------------------------------------------------------------
// pcl/IntegrationMetadata.h - Released 2024-06-18T15:48:54Z
// ----------------------------------------------------------------------------
// 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_IntegrationMetadata_h
#define __PCL_IntegrationMetadata_h
 
 
#include <pcl/Console.h>
#include <pcl/FITSHeaderKeyword.h>
#include <pcl/Property.h>
#include <pcl/TimePoint.h>
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
template <class T>
class PCL_CLASS ConsistentlyDefined
{
public:
 
   ConsistentlyDefined()
      : m_value() // N.B: this initialization prevents warnings such as
   {              // 'ConsistentlyDefined<>::m_value may be used uninitialized...'
   }
 
   ConsistentlyDefined( const ConsistentlyDefined& ) = default;
 
   /*
    * Move constructor.
    */
   ConsistentlyDefined( ConsistentlyDefined&& ) = default;
 
   ConsistentlyDefined( const T& value )
      : m_value( value )
      , m_defined( true )
   {
   }
 
   T& operator =( const T& value )
   {
      m_value = value;
      m_defined = m_consistent = true;
      return m_value;
   }
 
   ConsistentlyDefined& operator =( const ConsistentlyDefined& other )
   {
      if ( m_consistent )
         if ( other.m_defined )
         {
            if ( m_defined )
            {
               if ( m_value != other.m_value )
                  m_consistent = false;
            }
            else
            {
               m_value = other.m_value;
               m_defined = true;
            }
         }
         else
         {
            if ( m_defined )
               m_consistent = false;
         }
 
      return *this;
   }
 
   ConsistentlyDefined& operator +=( const ConsistentlyDefined& other )
   {
      if ( m_consistent )
         if ( other.m_defined )
         {
            if ( m_defined )
               m_value += other.m_value;
            else
            {
               m_value = other.m_value;
               m_defined = true;
            }
         }
         else
         {
            if ( m_defined )
               m_consistent = false;
         }
 
      return *this;
   }
 
   ConsistentlyDefined& operator +=( const T& otherValue )
   {
      if ( m_consistent )
         if ( m_defined )
            m_value += otherValue;
         else
         {
            m_value = otherValue;
            m_defined = true;
         }
 
      return *this;
   }
 
   const T& operator ()() const
   {
      return m_value;
   }
 
   bool IsDefined() const
   {
      return m_defined;
   }
 
   bool IsConsistent() const
   {
      return m_consistent;
   }
 
   bool IsConsistentlyDefined( const String& what = String() ) const
   {
      if ( m_defined )
      {
         if ( m_consistent )
            return true;
         if ( !what.IsEmpty() )
            Console().WarningLn( "<end><cbr>** Warning: Inconsistent " + what + " value(s) - metadata not generated." );
      }
      return false;
   }
 
   void Undefine()
   {
      m_defined = false;
   }
 
   void SetInconsistent()
   {
      m_consistent = false;
   }
 
   void ForceValue( const T& value )
   {
      m_value = value;
   }
 
   String ToString() const
   {
      return m_defined ? String( m_value ) : String();
   }
 
private:
 
   T    m_value;
   bool m_defined = false;
   bool m_consistent = true;
};
 
// ----------------------------------------------------------------------------
 
#define __PCL_INTEGRATION_METADATA_VERSION   "1.2"
 
/*
 * Optional, consistently defined metadata of an integrable image.
 *
 * ### N.B. Internal use - Not a public interface.
 */
class IntegrationMetadata
{
public:
 
   String                         version = __PCL_INTEGRATION_METADATA_VERSION;
   ConsistentlyDefined<String>    author;
   ConsistentlyDefined<String>    observer;
   ConsistentlyDefined<String>    instrumentName;
   ConsistentlyDefined<String>    frameType;
   ConsistentlyDefined<String>    filterName;
   ConsistentlyDefined<IsoString> cfaPatternName;
   ConsistentlyDefined<IsoString> cfaPattern;
   ConsistentlyDefined<int>       cfaXOffset;    // px
   ConsistentlyDefined<int>       cfaYOffset;    // px
   ConsistentlyDefined<double>    pedestal;      // DN
   ConsistentlyDefined<double>    expTime;       // s
   ConsistentlyDefined<double>    sensorTemp;    // C
   ConsistentlyDefined<double>    xPixSize;      // um
   ConsistentlyDefined<double>    yPixSize;      // um
   ConsistentlyDefined<double>    cameraGain;
   ConsistentlyDefined<unsigned>  cameraISO;
   ConsistentlyDefined<unsigned>  xBinning;
   ConsistentlyDefined<unsigned>  yBinning;
   ConsistentlyDefined<unsigned>  xOrigin;       // px
   ConsistentlyDefined<unsigned>  yOrigin;       // px
   ConsistentlyDefined<String>    telescopeName;
   ConsistentlyDefined<double>    focalLength;   // mm
   ConsistentlyDefined<double>    aperture;      // mm
   ConsistentlyDefined<double>    apertureArea;  // mm^2
   ConsistentlyDefined<String>    objectName;
   ConsistentlyDefined<TimePoint> startTime;     // UTC
   ConsistentlyDefined<TimePoint> endTime;       // UTC
   ConsistentlyDefined<double>    ra;            // deg (-180,+180]
   ConsistentlyDefined<double>    dec;           // deg [-90,+90]
   ConsistentlyDefined<IsoString> celCrdSys;     // ICRS, FK5
   ConsistentlyDefined<double>    equinox;       // yr
   ConsistentlyDefined<double>    longObs;       // deg (-180,+180]
   ConsistentlyDefined<double>    latObs;        // deg [-90,+90]
   ConsistentlyDefined<double>    altObs;        // m
 
   IntegrationMetadata() = default;
   IntegrationMetadata( const IntegrationMetadata& ) = default;
 
   IntegrationMetadata( const PropertyArray&, const FITSKeywordArray& );
   IntegrationMetadata( const String& serialization );
 
   String Serialize() const;
 
   bool IsValid() const
   {
      return m_valid;
   }
 
   void UpdatePropertiesAndKeywords( PropertyArray&, FITSKeywordArray& ) const;
 
   static IntegrationMetadata Summary( const Array<IntegrationMetadata>& );
 
private:
 
   bool m_valid = false;
 
   // Block separators for text metadata serialization (UTF-16).
   constexpr static char16_type ItemSeparator = char16_type( 0x2028 );  // Unicode Line Separator
   constexpr static char16_type TokenSeparator = char16_type( 0x2029 ); // Unicode Paragraph Separator
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_IntegrationMetadata_h
 
// ----------------------------------------------------------------------------
// EOF pcl/IntegrationMetadata.h - Released 2024-06-18T15:48:54Z