CArcImage.h

// +------------------------------------------------------------------------------------------------------------------+
// |  FILE:  CArcImage.h  ( GenIV )                                                                                   |
// +------------------------------------------------------------------------------------------------------------------+
// |  PURPOSE: This file defines the standard ARC image operations interface.                                         |
// |                                                                                                                  |
// |  AUTHOR:  Scott Streit         DATE: October 17, 2014                                                            |
// |                                                                                                                  |
// |  Copyright 2014 Astronomical Research Cameras, Inc. All rights reserved.                                         |
// +------------------------------------------------------------------------------------------------------------------+
#pragma once
 
#ifdef _WINDOWS
    #pragma warning( disable: 4251 )
#endif
 
#include <stdexcept>
#include <cstdint>
#include <memory>
 
#include <functional>
 
#include <CArcImageDllMain.h>
#include <CArcBase.h>
 
 
 
namespace arc
{
    namespace gen4
    {
        namespace image
        {
 
            using BPP_16 = std::uint16_t;
 
 
            using BPP_32 = std::uint32_t;
 
 
            struct GEN4_CARCIMAGE_API avgStats_t final
            {
                avgStats_t( const std::uint32_t channelCount );
 
                ~avgStats_t( void ) = default;
 
                std::unique_ptr<double[]> pAverageMin;          
                std::unique_ptr<double[]> pAverageMax;          
                std::unique_ptr<double[]> pAverageMean;         
                std::unique_ptr<double[]> pAverageStdDev;       
                double gMeanOfMeans;                            
                double gStdDevOfMeans;                          
                double gAvgAvgStdDev;                           
                std::uint32_t uiChannelCount;                   
                std::uint32_t uiImageCount;                     
            };
 
 
            struct GEN4_CARCIMAGE_API stats_t final
            {
                stats_t( void );
 
                ~stats_t( void ) = default;
 
                const std::string toString( void ) const noexcept;
 
                double gTotalPixels;        
                double gMin;                
                double gMax;                
                double gMean;               
                double gVariance;           
                double gStdDev;             
                double gSaturatedCount;     
            };
 
 
            struct GEN4_CARCIMAGE_API difStats_t final
            {
                difStats_t( void ) = default;
 
                ~difStats_t( void ) = default;
 
                const std::string toString( void ) const noexcept;
 
                stats_t tImage1Stats;           
                stats_t tImage2Stats;           
                stats_t tDiffStats;             
            };
 
        }   // end image namespace
 
 
 
        template <typename T = arc::gen4::image::BPP_16>
        class GEN4_CARCIMAGE_API CArcImage : public arc::gen4::CArcBase
        {
            public:
 
                virtual ~CArcImage( void ) = default;
 
                static auto version( void ) noexcept -> const std::string;
 
                static auto fill( T* pBuf, const std::uint32_t uiCols, const std::uint32_t uiRows, const T uiValue ) -> void;
 
                static auto fill( T* pBuf, const std::size_t uiBytes, const T uiValue ) -> void;
 
                static auto fillWithGradient( T* pBuf, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> void;
 
                static auto fillWithSmiley( T* pBuf, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> void;
 
                static auto fillWithRamp( T* pBuf, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> void;
 
                static auto containsValidRamp( const T* pBuf, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> void;
 
                static auto containsValidArc440Synthetic( const T* pBuf, const std::uint32_t uiPixelsPerChannel, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> void;
 
                static auto containsValidArc420Synthetic( const T* pBuf, const std::uint16_t uwValue1 = 0x1234, const std::uint16_t uwValue2 = 0x6789 ) -> void;
 
                static auto countPixels( const T* pBuf, const std::uint32_t uiCols, const std::uint32_t uiRows, const std::uint16_t uwValue ) -> std::uint32_t;
 
                static auto countPixels( const T* pBuf, const std::size_t uiBufSize, const std::uint16_t uwValue ) -> std::uint32_t;
 
                static auto getChannel( const T* pBuf, const std::uint32_t uiChannel, const std::uint32_t uiChannelCount, const std::uint32_t uiStart, const std::uint32_t uiEnd, const std::uint32_t uiCols, const std::uint32_t uiRows, std::uint32_t& uiCount ) -> std::unique_ptr<T[]>;
 
                static auto getPixel( const T* pBuf, const std::uint32_t uiCol, const std::uint32_t uiRow, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> T;
 
                static auto getRegion( const T* pBuf, const std::uint32_t uiCol1, const std::uint32_t uiCol2, const std::uint32_t uiRow1, const std::uint32_t uiRow2, const std::uint32_t uiCols, const std::uint32_t uiRows, std::uint32_t& uiCount ) -> std::unique_ptr<T[]>;
 
                static auto getRow( const T* pBuf, const std::uint32_t uiCol1, const std::uint32_t uiCol2, const std::uint32_t uiRow, const std::uint32_t uiCols, const std::uint32_t uiRows, std::uint32_t& uiCount ) -> std::unique_ptr<T[]>;
 
                static auto getCol( const T* pBuf, const std::uint32_t uiCol, const std::uint32_t uiRow1, const std::uint32_t uiRow2, const std::uint32_t uiCols, std::uint32_t& uiCount ) -> std::unique_ptr<T[]>;
 
                static auto getRowArea( const T* pBuf, const std::uint32_t uiCol1, const std::uint32_t uiCol2, const std::uint32_t uiRow1, const std::uint32_t uiRow2, const std::uint32_t uiCols, const std::uint32_t uiRows, std::uint32_t& uiCount ) -> std::unique_ptr<double[]>;
 
                static auto getColArea( const T* pBuf, const std::uint32_t uiCol1, const std::uint32_t uiCol2, const std::uint32_t uiRow1, const std::uint32_t uiRow2, const std::uint32_t uiCols, const std::uint32_t uiRows, std::uint32_t& uiCount ) -> std::unique_ptr<double[]>;
 
                static auto getStats( std::vector<T*> vBufferList, const std::uint32_t uiChannelCount, const std::uint32_t uiCol1, const std::uint32_t uiCol2, const std::uint32_t uiRow1, const std::uint32_t uiRow2, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> std::unique_ptr<arc::gen4::image::avgStats_t>;
 
                static auto getStats( const T* pBuf, const std::uint32_t uiCol1, const std::uint32_t uiCol2, const std::uint32_t uiRow1, const std::uint32_t uiRow2, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> std::unique_ptr<arc::gen4::image::stats_t>;
 
                static auto getStats( const T* pBuf, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> std::unique_ptr<arc::gen4::image::stats_t>;
 
                static auto getDiffStats( const T* pBuf1, const T* pBuf2, const std::uint32_t uiCol1, std::uint32_t uiCol2, const std::uint32_t uiRow1, std::uint32_t uiRow2, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> std::unique_ptr<arc::gen4::image::difStats_t>;
 
                static auto getDiffStats( const T* pBuf1, const T* pBuf2, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> std::unique_ptr<arc::gen4::image::difStats_t>;
 
                static auto histogram( const T* pBuf, const std::uint32_t uiCol1, std::uint32_t uiCol2, const std::uint32_t uiRow1, std::uint32_t uiRow2, const std::uint32_t uiCols, const std::uint32_t uiRows, std::uint32_t& uiCount ) -> std::unique_ptr<std::uint32_t[]>;
 
                static auto histogram( const T* pBuf, const std::uint32_t uiCols, const std::uint32_t uiRows, std::uint32_t& uiCount ) -> std::unique_ptr<std::uint32_t[]>;
 
                static auto add( const T* pBuf1, const T* pBuf2, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> std::unique_ptr<std::uint64_t[]>;
 
                static auto subtract( const T* pBuf1, const T* pBuf2, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> std::unique_ptr<T[]>;
 
                static auto subtractHalves( T* pBuf, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> void;
 
                static auto divide( const T* pBuf1, const T* pBuf2, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> std::unique_ptr<T[]>;
 
                static auto copy( T* pDstBuf, const T* pSrcBuf, const std::uint32_t uiCols, const std::uint32_t uiRows ) -> void;
 
                static auto copy( T* pDstBuf, const T* pSrcBuf, const std::size_t uiSize ) -> void;
 
                static auto maxTVal( void ) -> std::uint32_t;
 
            private:
 
                CArcImage( void ) = default;
 
                CArcImage( const CArcImage& ) = delete;
 
                CArcImage( CArcImage&& ) = delete;
 
                CArcImage& operator=( const CArcImage& ) = delete;
 
                CArcImage& operator=( CArcImage&& ) = delete;
 
                static inline auto verifyRow( const std::uint32_t uiRow, const std::uint32_t uiRows ) -> void;
 
                static inline auto verifyRows( const std::uint32_t uiRows ) -> void;
 
                static inline auto verifyColumns( const std::uint32_t uiCols ) -> void;
 
                static inline auto verifyColumn( const std::uint32_t uiCol, const std::uint32_t uiCols ) -> void;
 
                static inline auto verifyRangeOrder( const std::uint32_t uiValue1, const std::uint32_t uiValue2 ) -> void;
 
                static auto drawSemiCircle( const std::uint32_t uiXCenter, const std::uint32_t uiYCenter, const std::uint32_t uiRadius, const double gStartAngle, const double gEndAngle, const std::uint32_t uiCols, T* pBuf, const T uiColor = 0 ) -> void;
 
                static auto drawFillCircle( const std::uint32_t uiXCenter, const std::uint32_t uiYCenter, const std::uint32_t uiRadius, const std::uint32_t uiCols, T* pBuf, const T uiColor = 0 ) -> void;
 
                static auto drawGradientFillCircle( const std::uint32_t uiRadius, const std::uint32_t uiCols, const std::uint32_t uiRows, T* pBuf ) -> void;
 
                static auto drawCircle( const std::uint32_t uiXCenter, const std::uint32_t uiYCenter, const std::uint32_t uiRadius, const std::uint32_t uiCols, T* pBuf, const T uiColor = 0 ) -> void;
 
                static const std::string m_sVersion;
        };
 
 
    }   // end gen4 namespace
}       // end arc namespace