libCZI_Utilities.h

//******************************************************************************
// 
// libCZI is a reader for the CZI fileformat written in C++
// Copyright (C) 2017  Zeiss Microscopy GmbH
// 
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
// 
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU General Public License for more details.
// 
// You should have received a copy of the GNU General Public License
// along with this program.  If not, see <http://www.gnu.org/licenses/>.
// 
// To obtain a commercial version please contact Zeiss Microscopy GmbH.
// 
//******************************************************************************

#pragma once

#include "libCZI_Metadata.h"

namespace libCZI
{
    class ISubBlockRepository;
    class IDisplaySettings;

    class LIBCZI_API Utils
    {
    public:
        static char DimensionToChar(libCZI::DimensionIndex dim);

        static libCZI::DimensionIndex CharToDimension(char c);

        static int CalcMd5SumHash(libCZI::IBitmapData* bm, std::uint8_t* ptrHash, int hashSize);

        static int CalcMd5SumHash(const void* ptrData, size_t sizeData, std::uint8_t* ptrHash, int hashSize);

        static std::vector<std::uint8_t> Create8BitLookUpTableFromSplines(int tableElementCnt, float blackPoint, float whitePoint, const std::vector<libCZI::IDisplaySettings::SplineData>& splineData);

        static std::vector<std::uint8_t> Create8BitLookUpTableFromGamma(int tableElementCnt, float blackPoint, float whitePoint, float gamma);

        static std::vector<libCZI::IDisplaySettings::SplineData> CalcSplineDataFromPoints(int pointCnt, std::function< std::tuple<double, double>(int idx)> getPoint);

        static std::shared_ptr<libCZI::IBitmapData > NearestNeighborResize(libCZI::IBitmapData* bmSrc, int dstWidth, int dstHeight);

        static std::shared_ptr<libCZI::IBitmapData > NearestNeighborResize(libCZI::IBitmapData* bmSrc, int dstWidth, int dstHeight, const DblRect& roiSrc, const DblRect& roiDest);

        static float CalcZoom(const libCZI::IntRect& logicalRect, const libCZI::IntSize& physicalSize)
        {
            if (physicalSize.w > physicalSize.h)
            {
                return float(physicalSize.w) / logicalRect.w;
            }
            else
            {
                return float(physicalSize.h) / logicalRect.h;
            }
        }

        static float CalcZoom(const libCZI::IntSize& logicalSize, const libCZI::IntSize& physicalSize)
        {
            if (physicalSize.w > physicalSize.h)
            {
                return float(physicalSize.w) / logicalSize.w;
            }
            else
            {
                return float(physicalSize.h) / logicalSize.h;
            }
        }

        static const char* PixelTypeToInformalString(libCZI::PixelType pixeltype);

        static const char* CompressionModeToInformalString(libCZI::CompressionMode compressionMode);

        static std::string DimCoordinateToString(const libCZI::IDimCoordinate* coord);

        static bool StringToDimCoordinate(const char* sz, libCZI::CDimCoordinate* coord);

        static std::string DimBoundsToString(const libCZI::IDimBounds* bounds);

        static std::shared_ptr<libCZI::IIndexSet> IndexSetFromString(const std::wstring& s);

        static libCZI::PixelType TryDeterminePixelTypeForChannel(libCZI::ISubBlockRepository* repository, int channelIdx);

        static int Compare(const IDimCoordinate* a, const IDimCoordinate* b);

        static bool HasSameDimensions(const IDimCoordinate* a, const IDimCoordinate* b);

        static bool EnumAllCoordinates(const libCZI::CDimBounds& bounds, const std::function<bool(std::uint64_t, const libCZI::CDimCoordinate& coord)>& func);

        static void FillBitmap(libCZI::IBitmapData* bm, const libCZI::RgbFloatColor& floatColor);
    };
}