File ImageUtilityHeatmap.h¶

File List > include > ImageUtilityHeatmap.h
//=============================================================================
// Copyright (c) 2026 FLIR Integrated Imaging Solutions, Inc. All Rights Reserved.
//
// This software is the confidential and proprietary information of FLIR
// Integrated Imaging Solutions, Inc. ("Confidential Information"). You
// shall not disclose such Confidential Information and shall use it only in
// accordance with the terms of the license agreement you entered into
// with FLIR Integrated Imaging Solutions, Inc. (FLIR).
//
// FLIR MAKES NO REPRESENTATIONS OR WARRANTIES ABOUT THE SUITABILITY OF THE
// SOFTWARE, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE
// IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
// PURPOSE, OR NON-INFRINGEMENT. FLIR SHALL NOT BE LIABLE FOR ANY DAMAGES
// SUFFERED BY LICENSEE AS A RESULT OF USING, MODIFYING OR DISTRIBUTING
// THIS SOFTWARE OR ITS DERIVATIVES.
//=============================================================================

#ifndef FLIR_SPINNAKER_IMAGE_UTILITY_HEATMAP_H
#define FLIR_SPINNAKER_IMAGE_UTILITY_HEATMAP_H

#include "SpinnakerPlatform.h"
#include "SpinnakerDefs.h"

namespace Spinnaker
{
    class ImagePtr;

    class SPINNAKER_API ImageUtilityHeatmap
    {
      public:
        static ImagePtr CreateHeatmap(const ImagePtr& srcImage);

        static void CreateHeatmap(const ImagePtr& srcImage, ImagePtr& destImage);

        static ImagePtr CreateHeatmap(
            const ImagePtr& srcImage,
            const float minPixelValue,
            const float maxPixelValue,
            const HeatmapColor lowColor,
            const HeatmapColor highColor,
            const bool doCheckInvalidVal,
            const unsigned int invalidVal);

        static void CreateHeatmap(
            const ImagePtr& srcImage,
            ImagePtr& destImage,
            const float minPixelValue,
            const float maxPixelValue,
            const HeatmapColor lowColor,
            const HeatmapColor highColor,
            const bool doCheckInvalidVal,
            const unsigned int invalidVal);

        static void SetHeatmapColorGradient(const HeatmapColor newLowColor, const HeatmapColor newHighColor);

        static void GetHeatmapColorGradient(HeatmapColor& currentLowColor, HeatmapColor& currentHighColor);

        static void SetHeatmapRange(const unsigned int newLowValue, const unsigned int newHighValue);

        static void GetHeatmapRange(unsigned int& currentLowValue, unsigned int& currentHighValue);
    };

} // namespace Spinnaker

#endif // FLIR_SPINNAKER_IMAGE_UTILITY_HEATMAP_H