Frame2DStreamStatistics.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2026 (C) Zivid AS
 * All rights reserved.
 *
 * Zivid Software License, v1.0
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution.
 *
 * 3. Neither the name of Zivid AS nor the names of its contributors may be used
 * to endorse or promote products derived from this software without specific
 * prior written permission.
 *
 * 4. This software, with or without modification, must not be used with any
 * other 3D camera than from Zivid AS.
 *
 * 5. Any software provided in binary form under this license must not be
 * reverse engineered, decompiled, modified and/or disassembled.
 *
 * THIS SOFTWARE IS PROVIDED BY ZIVID AS "AS IS" AND ANY EXPRESS OR IMPLIED
 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL ZIVID AS OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Contact: Zivid Customer Success Team <customersuccess@zivid.com>
 * Info:    http://www.zivid.com
 ******************************************************************************/
 
#pragma once
 
#include <array>
#include <chrono>
#include <cmath>
#include <ctime>
#include <iomanip>
#include <memory>
#include <set>
#include <sstream>
#include <string>
#include <tuple>
#include <utility>
#include <vector>
 
#include "Zivid/DataModel/Detail/Detail.h"
#include "Zivid/DataModel/NodeType.h"
#include "Zivid/DataModel/Traits.h"
#include "Zivid/Detail/CoreExport.h"
#include "Zivid/Detail/TypeTraits.h"
#include "Zivid/Range.h"
 
#ifdef _MSC_VER
#    pragma warning(push)
#    pragma warning(disable : 4251) // "X needs to have dll-interface to be used by clients of class Y."
#endif
 
namespace Zivid
{

 
    // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
    class ZIVID_CORE_EXPORT Frame2DStreamStatistics
    {
    public:
        static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group;

        static constexpr const char *path{ "" };

        static constexpr const char *name{ "Frame2DStreamStatistics" };

        static constexpr const char *description{
            R"description(Streaming performance statistics for Frame2DGrabber.)description"
        };
 
        static constexpr size_t version{ 1 };
 
#ifndef NO_DOC
        template<size_t>
        struct Version;
 
        using LatestVersion = Zivid::Frame2DStreamStatistics;
 
        // Short identifier. This value is not guaranteed to be universally unique
        // Todo(ZIVID-2808): Move this to internal DataModelExt header
        static constexpr std::array<uint8_t, 3> binaryId{ 'f', '2', 's' };
 
#endif

 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT AverageGrabInterval
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

            static constexpr const char *path{ "AverageGrabInterval" };

            static constexpr const char *name{ "AverageGrabInterval" };

            static constexpr const char *description{
                R"description(Average interval between successfully grabbed streamed frames.)description"
            };

            using ValueType = std::chrono::microseconds;

            static constexpr Range<std::chrono::microseconds> validRange()
            {
                return { std::chrono::microseconds::min(), std::chrono::microseconds::max() };
            }

            AverageGrabInterval() = default;

            explicit constexpr AverageGrabInterval(std::chrono::microseconds value)
                : m_value{ value }
            {}

            std::chrono::microseconds value() const;

            std::string toString() const;

            bool operator==(const AverageGrabInterval &other) const
            {
                return m_value == other.m_value;
            }

            bool operator!=(const AverageGrabInterval &other) const
            {
                return m_value != other.m_value;
            }

            bool operator<(const AverageGrabInterval &other) const
            {
                return m_value < other.m_value;
            }

            bool operator>(const AverageGrabInterval &other) const
            {
                return m_value > other.m_value;
            }

            bool operator<=(const AverageGrabInterval &other) const
            {
                return m_value <= other.m_value;
            }

            bool operator>=(const AverageGrabInterval &other) const
            {
                return m_value >= other.m_value;
            }

            friend std::ostream &operator<<(std::ostream &stream, const AverageGrabInterval &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            std::chrono::microseconds m_value{ -1 };
 
            friend struct DataModel::Detail::Befriend<AverageGrabInterval>;
        };

 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT AverageGrabRateHz
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

            static constexpr const char *path{ "AverageGrabRateHz" };

            static constexpr const char *name{ "AverageGrabRateHz" };

            static constexpr const char *description{
                R"description(Average rate of successfully grabbed streamed frames in frames per second.)description"
            };

            using ValueType = double;

            static constexpr Range<double> validRange()
            {
                return { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max() };
            }

            AverageGrabRateHz() = default;

            explicit constexpr AverageGrabRateHz(double value)
                : m_value{ value }
            {}

            double value() const;

            std::string toString() const;

            bool operator==(const AverageGrabRateHz &other) const
            {
                return m_value == other.m_value;
            }

            bool operator!=(const AverageGrabRateHz &other) const
            {
                return m_value != other.m_value;
            }

            bool operator<(const AverageGrabRateHz &other) const
            {
                return m_value < other.m_value;
            }

            bool operator>(const AverageGrabRateHz &other) const
            {
                return m_value > other.m_value;
            }

            bool operator<=(const AverageGrabRateHz &other) const
            {
                return m_value <= other.m_value;
            }

            bool operator>=(const AverageGrabRateHz &other) const
            {
                return m_value >= other.m_value;
            }

            friend std::ostream &operator<<(std::ostream &stream, const AverageGrabRateHz &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            double m_value{ 0.0 };
 
            friend struct DataModel::Detail::Befriend<AverageGrabRateHz>;
        };

 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT KernelComputeTime
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

            static constexpr const char *path{ "KernelComputeTime" };

            static constexpr const char *name{ "KernelComputeTime" };

            static constexpr const char *description{
                R"description(Average kernel compute time on the GPU per streamed frame.)description"
            };

            using ValueType = std::chrono::microseconds;

            static constexpr Range<std::chrono::microseconds> validRange()
            {
                return { std::chrono::microseconds::min(), std::chrono::microseconds::max() };
            }

            KernelComputeTime() = default;

            explicit constexpr KernelComputeTime(std::chrono::microseconds value)
                : m_value{ value }
            {}

            std::chrono::microseconds value() const;

            std::string toString() const;

            bool operator==(const KernelComputeTime &other) const
            {
                return m_value == other.m_value;
            }

            bool operator!=(const KernelComputeTime &other) const
            {
                return m_value != other.m_value;
            }

            bool operator<(const KernelComputeTime &other) const
            {
                return m_value < other.m_value;
            }

            bool operator>(const KernelComputeTime &other) const
            {
                return m_value > other.m_value;
            }

            bool operator<=(const KernelComputeTime &other) const
            {
                return m_value <= other.m_value;
            }

            bool operator>=(const KernelComputeTime &other) const
            {
                return m_value >= other.m_value;
            }

            friend std::ostream &operator<<(std::ostream &stream, const KernelComputeTime &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            std::chrono::microseconds m_value{ -1 };
 
            friend struct DataModel::Detail::Befriend<KernelComputeTime>;
        };

 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT NumberOfFramesUsedForStatistics
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;

            static constexpr const char *path{ "NumberOfFramesUsedForStatistics" };

            static constexpr const char *name{ "NumberOfFramesUsedForStatistics" };

            static constexpr const char *description{
                R"description(Number of streamed frames included in the stream-level averages.)description"
            };

            using ValueType = uint64_t;

            static constexpr Range<uint64_t> validRange()
            {
                return { std::numeric_limits<uint64_t>::lowest(), std::numeric_limits<uint64_t>::max() };
            }

            NumberOfFramesUsedForStatistics() = default;

            explicit constexpr NumberOfFramesUsedForStatistics(uint64_t value)
                : m_value{ value }
            {}

            uint64_t value() const;

            std::string toString() const;

            bool operator==(const NumberOfFramesUsedForStatistics &other) const
            {
                return m_value == other.m_value;
            }

            bool operator!=(const NumberOfFramesUsedForStatistics &other) const
            {
                return m_value != other.m_value;
            }

            bool operator<(const NumberOfFramesUsedForStatistics &other) const
            {
                return m_value < other.m_value;
            }

            bool operator>(const NumberOfFramesUsedForStatistics &other) const
            {
                return m_value > other.m_value;
            }

            bool operator<=(const NumberOfFramesUsedForStatistics &other) const
            {
                return m_value <= other.m_value;
            }

            bool operator>=(const NumberOfFramesUsedForStatistics &other) const
            {
                return m_value >= other.m_value;
            }

            friend std::ostream &operator<<(std::ostream &stream, const NumberOfFramesUsedForStatistics &value)
            {
                return stream << value.toString();
            }
 
        private:
            void setFromString(const std::string &value);
 
            uint64_t m_value{ 0 };
 
            friend struct DataModel::Detail::Befriend<NumberOfFramesUsedForStatistics>;
        };
 
        using Descendants = std::tuple<
            Frame2DStreamStatistics::AverageGrabInterval,
            Frame2DStreamStatistics::AverageGrabRateHz,
            Frame2DStreamStatistics::KernelComputeTime,
            Frame2DStreamStatistics::NumberOfFramesUsedForStatistics>;

        Frame2DStreamStatistics();

        explicit Frame2DStreamStatistics(const std::string &fileName);

        [[nodiscard]] static Frame2DStreamStatistics fromSerialized(const std::string &value);

        std::string serialize() const;

#ifndef NO_DOC
        template<
            typename... Args,
            typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0,
            typename std::enable_if<
                Zivid::Detail::TypeTraits::AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>::value,
                int>::type = 0>
#else
        template<typename... Args>
#endif
        explicit Frame2DStreamStatistics(Args &&...args)
        {
            using namespace Zivid::Detail::TypeTraits;
 
            static_assert(
                AllArgsDecayedAreUnique<Args...>::value,
                "Found duplicate types among the arguments passed to Frame2DStreamStatistics(...). "
                "Types should be listed at most once.");
 
            set(std::forward<Args>(args)...);
        }

#ifndef NO_DOC
        template<typename... Args, typename std::enable_if<sizeof...(Args) >= 2, int>::type = 0>
#else
        template<typename... Args>
#endif
        void set(Args &&...args)
        {
            using namespace Zivid::Detail::TypeTraits;
 
            using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
            static_assert(
                AllArgsAreDescendantNodes::value, "All arguments passed to set(...) must be descendant nodes.");
 
            static_assert(
                AllArgsDecayedAreUnique<Args...>::value,
                "Found duplicate types among the arguments passed to set(...). "
                "Types should be listed at most once.");
 
            Zivid::DataModel::Detail::invokeSetWithEachArgument(*this, std::forward<Args>(args)...);
        }

#ifndef NO_DOC
        template<typename... Args, typename std::enable_if<sizeof...(Args) >= 1, int>::type = 0>
#else
        template<typename... Args>
#endif
        Frame2DStreamStatistics copyWith(Args &&...args) const
        {
            using namespace Zivid::Detail::TypeTraits;
 
            using AllArgsAreDescendantNodes = AllArgsAreInTuple<Descendants, typename std::decay<Args>::type...>;
            static_assert(
                AllArgsAreDescendantNodes::value, "All arguments passed to copyWith(...) must be descendant nodes.");
 
            static_assert(
                AllArgsDecayedAreUnique<Args...>::value,
                "Found duplicate types among the arguments passed to copyWith(...). "
                "Types should be listed at most once.");
 
            auto copy{ *this };
            copy.set(std::forward<Args>(args)...);
            return copy;
        }

        const AverageGrabInterval &averageGrabInterval() const
        {
            return m_averageGrabInterval;
        }

        AverageGrabInterval &averageGrabInterval()
        {
            return m_averageGrabInterval;
        }

        Frame2DStreamStatistics &set(const AverageGrabInterval &value)
        {
            m_averageGrabInterval = value;
            return *this;
        }

        const AverageGrabRateHz &averageGrabRateHz() const
        {
            return m_averageGrabRateHz;
        }

        AverageGrabRateHz &averageGrabRateHz()
        {
            return m_averageGrabRateHz;
        }

        Frame2DStreamStatistics &set(const AverageGrabRateHz &value)
        {
            m_averageGrabRateHz = value;
            return *this;
        }

        const KernelComputeTime &kernelComputeTime() const
        {
            return m_kernelComputeTime;
        }

        KernelComputeTime &kernelComputeTime()
        {
            return m_kernelComputeTime;
        }

        Frame2DStreamStatistics &set(const KernelComputeTime &value)
        {
            m_kernelComputeTime = value;
            return *this;
        }

        const NumberOfFramesUsedForStatistics &numberOfFramesUsedForStatistics() const
        {
            return m_numberOfFramesUsedForStatistics;
        }

        NumberOfFramesUsedForStatistics &numberOfFramesUsedForStatistics()
        {
            return m_numberOfFramesUsedForStatistics;
        }

        Frame2DStreamStatistics &set(const NumberOfFramesUsedForStatistics &value)
        {
            m_numberOfFramesUsedForStatistics = value;
            return *this;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, Frame2DStreamStatistics::AverageGrabInterval>::value, int>::type =
                0>
        const Frame2DStreamStatistics::AverageGrabInterval &get() const
        {
            return m_averageGrabInterval;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, Frame2DStreamStatistics::AverageGrabRateHz>::value, int>::type = 0>
        const Frame2DStreamStatistics::AverageGrabRateHz &get() const
        {
            return m_averageGrabRateHz;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, Frame2DStreamStatistics::KernelComputeTime>::value, int>::type = 0>
        const Frame2DStreamStatistics::KernelComputeTime &get() const
        {
            return m_kernelComputeTime;
        }
 
        template<
            typename T,
            typename std::enable_if<
                std::is_same<T, Frame2DStreamStatistics::NumberOfFramesUsedForStatistics>::value,
                int>::type = 0>
        const Frame2DStreamStatistics::NumberOfFramesUsedForStatistics &get() const
        {
            return m_numberOfFramesUsedForStatistics;
        }
 
        template<size_t i, typename std::enable_if<i == 0, int>::type = 0>
        const Frame2DStreamStatistics::AverageGrabInterval &get() const
        {
            return m_averageGrabInterval;
        }
 
        template<size_t i, typename std::enable_if<i == 1, int>::type = 0>
        const Frame2DStreamStatistics::AverageGrabRateHz &get() const
        {
            return m_averageGrabRateHz;
        }
 
        template<size_t i, typename std::enable_if<i == 2, int>::type = 0>
        const Frame2DStreamStatistics::KernelComputeTime &get() const
        {
            return m_kernelComputeTime;
        }
 
        template<size_t i, typename std::enable_if<i == 3, int>::type = 0>
        const Frame2DStreamStatistics::NumberOfFramesUsedForStatistics &get() const
        {
            return m_numberOfFramesUsedForStatistics;
        }

        template<typename F>
        void forEach(const F &f) const
        {
            f(m_averageGrabInterval);
            f(m_averageGrabRateHz);
            f(m_kernelComputeTime);
            f(m_numberOfFramesUsedForStatistics);
        }

        template<typename F>
        void forEach(const F &f)
        {
            f(m_averageGrabInterval);
            f(m_averageGrabRateHz);
            f(m_kernelComputeTime);
            f(m_numberOfFramesUsedForStatistics);
        }

        bool operator==(const Frame2DStreamStatistics &other) const;

        bool operator!=(const Frame2DStreamStatistics &other) const;

        std::string toString() const;

        friend std::ostream &operator<<(std::ostream &stream, const Frame2DStreamStatistics &value)
        {
            return stream << value.toString();
        }

        void save(const std::string &fileName) const;

        void load(const std::string &fileName);
 
    private:
        void setFromString(const std::string &value);
 
        void setFromString(const std::string &fullPath, const std::string &value);
 
        std::string getString(const std::string &fullPath) const;
 
        AverageGrabInterval m_averageGrabInterval;
        AverageGrabRateHz m_averageGrabRateHz;
        KernelComputeTime m_kernelComputeTime;
        NumberOfFramesUsedForStatistics m_numberOfFramesUsedForStatistics;
 
        friend struct DataModel::Detail::Befriend<Frame2DStreamStatistics>;
    };
 
#ifndef NO_DOC
    template<>
    struct Frame2DStreamStatistics::Version<1>
    {
        using Type = Frame2DStreamStatistics;
    };
#endif
 
} // namespace Zivid
 
#ifndef NO_DOC
namespace Zivid::Detail
{
 
    ZIVID_CORE_EXPORT void save(const Zivid::Frame2DStreamStatistics &dataModel, std::ostream &ostream);
    ZIVID_CORE_EXPORT void load(Zivid::Frame2DStreamStatistics &dataModel, std::istream &istream);
 
} // namespace Zivid::Detail
#endif
 
#ifdef _MSC_VER
#    pragma warning(pop)
#endif
 
#ifndef NO_DOC
#    if !(defined(_MSC_VER) && (_MSC_VER <= 1900))
namespace std // NOLINT
{
 
    template<>
    struct tuple_size<Zivid::Frame2DStreamStatistics> : integral_constant<size_t, 4>
    {};
 
    template<size_t i>
    struct tuple_element<i, Zivid::Frame2DStreamStatistics>
    {
        static_assert(i < tuple_size<Zivid::Frame2DStreamStatistics>::value, "Index must be less than 4");
 
        using type // NOLINT
            = decltype(declval<Zivid::Frame2DStreamStatistics>().get<i>());
    };
 
} // namespace std
#    endif
#endif
 
// If we have access to the DataModel library, automatically include internal DataModel
// header. This header is necessary for serialization and deserialization.
#if defined(__has_include) && !defined(NO_DOC)
#    if __has_include("Zivid/Frame2DStreamStatisticsInternal.h") && __has_include("Zivid/DataModelNodeMetaData.h")
#        include "Zivid/Frame2DStreamStatisticsInternal.h"
#    endif
#endif