FluxCalibrationData.h

Go to the documentation of this file.

//     ____   ______ __
//    / __ \ / ____// /
//   / /_/ // /    / /
//  / ____// /___ / /___   PixInsight Class Library
// /_/     \____//_____/   PCL 2.8.4
// ----------------------------------------------------------------------------
// pcl/FluxCalibrationData.h - Released 2024-12-23T11:32:56Z
// ----------------------------------------------------------------------------
// 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_FluxCalibrationData_h
#define __PCL_FluxCalibrationData_h
 
 
#include <pcl/Defs.h>
 
#include <pcl/File.h>
#include <pcl/TimePoint.h>
#include <pcl/Vector.h>
 
/*
 * Normalization factor applied to all SPFC flux samples. This allows us to
 * generate scale factors within manageable ranges for typical deep-sky images,
 * i.e., in [100,0.001] instead of [1e-7,1e-12], for example.
 */
#define __PCL_SPFC_NORMALIZATION_FACTOR   1.0e+08
 
namespace pcl
{
 
// ----------------------------------------------------------------------------
 
class PCL_CLASS XMLDocument;
class PCL_CLASS XMLElement;
 
class PCL_CLASS FluxCalibrationData
{
public:
 
   FluxCalibrationData() = default;
 
   FluxCalibrationData( const FluxCalibrationData& ) = default;
 
   FluxCalibrationData( FluxCalibrationData&& ) = default;
 
   FluxCalibrationData( const String& filePath )
   {
      Parse( filePath );
   }
 
   FluxCalibrationData( const XMLDocument& xml )
   {
      Parse( xml );
   }
 
   FluxCalibrationData( const XMLElement& element )
   {
      Parse( element );
   }
 
   virtual ~FluxCalibrationData()
   {
   }
 
   FluxCalibrationData& operator =( const FluxCalibrationData& ) = default;
 
   FluxCalibrationData& operator =( FluxCalibrationData&& ) = default;
 
   const String& TargetFilePath() const
   {
      return m_targetFilePath;
   }
 
   void SetTargetFilePath( const String& filePath )
   {
      m_targetFilePath = File::FullPath( filePath );
   }
 
   const DVector& FluxScaleFactors() const
   {
      return m_fluxScaleFactors;
   }
 
   void SetFluxScaleFactors( const DVector& v )
   {
      m_fluxScaleFactors = v;
   }
 
   const DVector& FluxScaleSigmas() const
   {
      return m_fluxScaleSigmas;
   }
 
   void SetFluxScaleSigmas( const DVector& v )
   {
      m_fluxScaleSigmas = v;
   }
 
   const FVector& MeanFWHMx() const
   {
      return m_fwhmx;
   }
 
   void SetMeanFWHMx( const FVector& v )
   {
      m_fwhmx = v;
   }
 
   const FVector& MeanFWHMy() const
   {
      return m_fwhmy;
   }
 
   void SetMeanFWHMy( const FVector& v )
   {
      m_fwhmy = v;
   }
 
   const IVector& StarCounts() const
   {
      return m_counts;
   }
 
   void SetStarCounts( const IVector& v )
   {
      m_counts = v;
   }
 
   double ScaleNormalizationFactor() const
   {
      return m_normalizationFactor;
   }
 
   void SetScaleNormalizationFactor( double k )
   {
      PCL_PRECONDITION( k > 0 )
      m_normalizationFactor = k;
   }
 
   uint32 Version() const
   {
      return m_version;
   }
 
   void SetVersion( uint32 v )
   {
      m_version = v;
   }
 
   TimePoint CreationTime() const
   {
      return m_creationTime;
   }
 
   void Clear();
 
   void Parse( const String& filePath );
 
   void Parse( const XMLDocument& xml );
 
   void Parse( const XMLElement& element );
 
   XMLDocument* Serialize() const;
 
   void SerializeToFile( const String& path ) const;
 
private:
 
   String    m_targetFilePath;
   Vector    m_fluxScaleFactors;
   Vector    m_fluxScaleSigmas;
   FVector   m_fwhmx;
   FVector   m_fwhmy;
   IVector   m_counts;
   double    m_normalizationFactor = __PCL_SPFC_NORMALIZATION_FACTOR;
   uint32    m_version;
   TimePoint m_creationTime;
 
   friend class FluxCalibrationDataPrivate;
};
 
// ----------------------------------------------------------------------------
 
} // pcl
 
#endif   // __PCL_FluxCalibrationData_h
 
// ----------------------------------------------------------------------------
// EOF pcl/FluxCalibrationData.h - Released 2024-12-23T11:32:56Z