File ImageStatistics.h¶

File List > include > ImageStatistics.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_IMAGESTATISTICS_H
#define FLIR_SPINNAKER_IMAGESTATISTICS_H

#include "Interface/IImageStatistics.h"

namespace Spinnaker
{
    class ImageStatsCalculator;

    class SPINNAKER_API ImageStatistics : public IImageStatistics
    {
      public:
        ImageStatistics();

        virtual ~ImageStatistics();

        ImageStatistics(const ImageStatistics& other);

        ImageStatistics& operator=(const ImageStatistics& other);

        virtual void EnableAll();

        virtual void DisableAll();

        virtual void EnableGreyOnly();

        virtual void EnableRGBOnly();

        virtual void EnableHSLOnly();

        virtual void GetChannelStatus(StatisticsChannel channel, bool* pEnabled) const;

        virtual void SetChannelStatus(StatisticsChannel channel, bool enabled);

        virtual void GetRange(StatisticsChannel channel, unsigned int* pMin, unsigned int* pMax) const;

        virtual void GetPixelValueRange(
            StatisticsChannel channel,
            unsigned int* pPixelValueMin,
            unsigned int* pPixelValueMax) const;

        virtual void GetNumPixelValues(StatisticsChannel channel, unsigned int* pNumPixelValues) const;

        virtual void GetMean(StatisticsChannel channel, float* pPixelValueMean) const;

        virtual void GetHistogram(StatisticsChannel channel, int** ppHistogram) const;

        virtual void GetStatistics(
            StatisticsChannel channel,
            unsigned int* pRangeMin = NULL,
            unsigned int* pRangeMax = NULL,
            unsigned int* pPixelValueMin = NULL,
            unsigned int* pPixelValueMax = NULL,
            unsigned int* pNumPixelValues = NULL,
            float* pPixelValueMean = NULL,
            int** ppHistogram = NULL) const;

      private:
        friend class ImageStatsCalculator;
        struct ImageStatisticsData;
        ImageStatisticsData* m_pData;
    };

} // namespace Spinnaker

#endif // FLIR_SPINNAKER_IMAGESTATISTICS_H