CArcFitsFile.h

Go to the documentation of this file.

 
// +------------------------------------------------------------------------------------------------------------------+
// |  FILE:  CArcFitsFile.h  ( Gen3 )                                                                                 |
// +------------------------------------------------------------------------------------------------------------------+
// |  PURPOSE: This file defines the standard ARC FITS interface.                                                     |
// |                                                                                                                  |
// |  AUTHOR:  Scott Streit         DATE: March 25, 2020                                                             |
// |                                                                                                                  |
// |  Copyright 2013 Astronomical Research Cameras, Inc. All rights reserved.                                         |
// +------------------------------------------------------------------------------------------------------------------+
 
#pragma once
 
#ifdef _WINDOWS
#pragma warning( disable: 4251 )
#endif
 
#include <filesystem>
#include <version>
#include <stdexcept>
#include <cstdint>
#include <utility>
#include <memory>
#include <string>
 
#ifdef __cpp_lib_variant
    #include <variant>
#else
    #include <tuple>
#endif
 
#include <CArcFitsFileDllMain.h>
#include <CArcStringList.h>
#include <CArcBase.h>
 
#include <fitsio.h>     // This header MUST be last to prevent winnt.h constant error!
 
 
namespace arc
{
    namespace gen3
    {
 
        namespace fits
        {
 
            using BPP_16 = std::uint16_t;
 
            using BPP_32 = std::uint32_t;
 
 
            #ifdef __cpp_lib_variant
                using keywordValue_t = std::variant<std::uint32_t, std::int32_t, std::uint64_t, std::int64_t, double, std::string>;
            #else
                using keywordValue_t = std::tuple<std::uint32_t, std::int32_t, std::uint64_t, std::int64_t, double, std::string>;
            #endif
 
 
            enum class e_ReadMode : std::int32_t
            {
                READMODE = READONLY,
                READWRITEMODE = READWRITE
            };
 
 
            enum class e_Type : std::int32_t
            {
                FITS_INVALID_KEY = -1,
                FITS_STRING_KEY = 0,
                FITS_INT_KEY,
                FITS_UINT_KEY,
                FITS_SHORT_KEY,
                FITS_USHORT_KEY,
                FITS_FLOAT_KEY,
                FITS_DOUBLE_KEY,
                FITS_BYTE_KEY,
                FITS_LONG_KEY,
                FITS_ULONG_KEY,
                FITS_LONGLONG_KEY,
                FITS_LOGICAL_KEY,
                FITS_COMMENT_KEY,
                FITS_HISTORY_KEY,
                FITS_DATE_KEY
            };
 
 
            class GEN3_CARCFITSFILE_API CParam
            {
                public:
 
                    std::uint32_t getCols( void ) noexcept;
 
                    std::uint32_t getRows( void ) noexcept;
 
                    std::uint32_t getFrames( void ) noexcept;
 
                    std::uint32_t getNAxis( void ) noexcept;
 
                    std::uint32_t getBpp( void ) noexcept;
 
                    CParam( void );
 
                    ~CParam( void );
 
                    //  Data members. Although public, intended for interal use only.
                    // +----------------------------------------------------------------+
 
                    long m_lNAxes[ 3 ];
 
                    long* m_plCols;
 
                    long* m_plRows;
 
                    long* m_plFrames;
 
                    int m_iNAxis;
 
                    int m_iBpp;
 
                    // +----------------------------------------------------------------+
            };
 
 
            template <typename T>
            struct GEN3_CARCFITSFILE_API ArrayDeleter
            {
                void operator()( T* p ) const
                {
                    if ( p != nullptr )
                    {
                        delete[] p;
                    }
                }
            };
 
 
            // +----------------------------------------------------------------------------------------------------------+
            // |  Definitions for Point data type                                                                         |
            // +----------------------------------------------------------------------------------------------------------+
 
            using Point = std::pair<long, long>;
 
 
            constexpr auto MAKE_POINT( std::uint32_t uiColumn, std::uint32_t uiRow ) { return std::make_pair( uiColumn, uiRow ); }
 
        }   // end fits namespace
 
 
        template <typename T = arc::gen3::fits::BPP_16>
        class GEN3_CARCFITSFILE_API CArcFitsFile : public arc::gen3::CArcBase
        {
            public:
 
                CArcFitsFile( void );
 
                virtual ~CArcFitsFile( void );
 
                static const std::string version( void ) noexcept;
 
                static const std::string cfitsioVersion( void ) noexcept;
 
                std::string getType( void ) noexcept;
 
                void create( const std::filesystem::path& tFileName, const std::uint32_t uiCols, const std::uint32_t uiRows );
 
                void create3D( const std::filesystem::path& tFileName, const std::uint32_t uiCols, const std::uint32_t uiRows );
 
                void open( const std::filesystem::path& tFileName, arc::gen3::fits::e_ReadMode eMode = arc::gen3::fits::e_ReadMode::READMODE );
 
                void close( void ) noexcept;
 
                std::unique_ptr<arc::gen3::CArcStringList> getHeader( void );
 
                const std::string getFileName( void );
 
                arc::gen3::fits::keywordValue_t readKeyword( const std::string& sKey, arc::gen3::fits::e_Type eType );
 
                void writeKeyword( const std::string& sKey, void* pValue, arc::gen3::fits::e_Type eType, const std::string& sComment = "" );
 
                void updateKeyword( const std::string& sKey, void* pValue, arc::gen3::fits::e_Type eType, const std::string& sComment = "" );
 
                std::unique_ptr<arc::gen3::fits::CParam> getParameters( void );
 
                std::uint32_t getNumberOfFrames( void );
 
                std::uint32_t getRows( void );
 
                std::uint32_t getCols( void );
 
                std::uint32_t getNAxis( void );
 
                std::uint32_t getBitsPerPixel( void );
 
                void generateTestData( void );
 
                void reOpen( void );
 
                void flush( void );
 
                void compare( CArcFitsFile<T>& cFitsFile );
 
                void reSize( const std::uint32_t uiCols, const std::uint32_t uiRows );
 
                void write( T* pBuf );
 
                void write( T* pBuf, const std::int64_t i64Bytes, const std::int64_t i64Pixel = 1 );
 
                void writeSubImage( T* pBuf, const arc::gen3::fits::Point& lowerLeftPoint, const arc::gen3::fits::Point& upperRightPoint );
 
                std::unique_ptr<T[], arc::gen3::fits::ArrayDeleter<T>> readSubImage( arc::gen3::fits::Point lowerLeftPoint, arc::gen3::fits::Point upperRightPoint );
 
                std::unique_ptr<T[], arc::gen3::fits::ArrayDeleter<T>> read( void );
 
                void read( T* pBuf, const std::uint32_t uiCols, const std::uint32_t uiRows );
 
                void write3D( T* pBuf );
 
                void reWrite3D( T* pBuf, const std::uint32_t uiImageNumber );
 
                std::unique_ptr<T[], arc::gen3::fits::ArrayDeleter<T>> read3D( const std::uint32_t uiImageNumber );
 
                fitsfile* getBaseFile( void );
 
                std::uint32_t maxTVal( void );
 
            private:
 
                constexpr void verifyFileHandle( void );
 
                void throwFitsError( const std::int32_t iStatus );
 
                static const std::string m_sVersion;
 
                std::int64_t m_i64Pixel;
 
                std::int32_t m_iFrame;
 
                fitsfile* m_pFits;
        };
 
 
    }   // end gen3 namespace
}       // end arc namespace
 
 
 
namespace std
{
    template<>
    class GEN3_CARCFITSFILE_API default_delete< arc::gen3::fits::CParam >
    {
    public:
 
        void operator()( arc::gen3::fits::CParam* pObj );
    };
}