CameraIntrinsics.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2024 (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 CameraIntrinsics
    {
    public:
        static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group;
 
        static constexpr const char *path{ "" };
 
        static constexpr const char *name{ "CameraIntrinsics" };
 
        static constexpr const char *description{
            R"description(Information about the intrinsic parameters of the camera (OpenCV model))description"
        };
 
        static constexpr size_t version{ 1 };
 
#ifndef NO_DOC
        template<size_t>
        struct Version;
 
        using LatestVersion = Zivid::CameraIntrinsics;
 
        // 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{ 'c', 'i', 'n' };
 
#endif
 
 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT CameraMatrix
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group;
 
            static constexpr const char *path{ "CameraMatrix" };
 
            static constexpr const char *name{ "CameraMatrix" };
 
            static constexpr const char *description{
                R"description(The camera matrix K (=[fx,0,cx;0,fy,cy;0,0,1]))description"
            };
 
 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT CX
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "CameraMatrix/CX" };
 
                static constexpr const char *name{ "CX" };
 
                static constexpr const char *description{
                    R"description(x coordinate of the principal point)description"
                };
 
                using ValueType = double;
 
                static constexpr Range<double> validRange()
                {
                    return { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max() };
                }
 
                CX() = default;
 
                explicit constexpr CX(double value)
                    : m_value{ value }
                {}
 
                double value() const;
 
                std::string toString() const;
 
                bool operator==(const CX &other) const
                {
                    return m_value == other.m_value;
                }
 
                bool operator!=(const CX &other) const
                {
                    return m_value != other.m_value;
                }
 
                bool operator<(const CX &other) const
                {
                    return m_value < other.m_value;
                }
 
                bool operator>(const CX &other) const
                {
                    return m_value > other.m_value;
                }
 
                bool operator<=(const CX &other) const
                {
                    return m_value <= other.m_value;
                }
 
                bool operator>=(const CX &other) const
                {
                    return m_value >= other.m_value;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const CX &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                double m_value{ 0.0 };
 
                friend struct DataModel::Detail::Befriend<CX>;
            };
 
 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT CY
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "CameraMatrix/CY" };
 
                static constexpr const char *name{ "CY" };
 
                static constexpr const char *description{
                    R"description(y coordinate of the principal point)description"
                };
 
                using ValueType = double;
 
                static constexpr Range<double> validRange()
                {
                    return { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max() };
                }
 
                CY() = default;
 
                explicit constexpr CY(double value)
                    : m_value{ value }
                {}
 
                double value() const;
 
                std::string toString() const;
 
                bool operator==(const CY &other) const
                {
                    return m_value == other.m_value;
                }
 
                bool operator!=(const CY &other) const
                {
                    return m_value != other.m_value;
                }
 
                bool operator<(const CY &other) const
                {
                    return m_value < other.m_value;
                }
 
                bool operator>(const CY &other) const
                {
                    return m_value > other.m_value;
                }
 
                bool operator<=(const CY &other) const
                {
                    return m_value <= other.m_value;
                }
 
                bool operator>=(const CY &other) const
                {
                    return m_value >= other.m_value;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const CY &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                double m_value{ 0.0 };
 
                friend struct DataModel::Detail::Befriend<CY>;
            };
 
 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT FX
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "CameraMatrix/FX" };
 
                static constexpr const char *name{ "FX" };
 
                static constexpr const char *description{ R"description(Focal length in x)description" };
 
                using ValueType = double;
 
                static constexpr Range<double> validRange()
                {
                    return { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max() };
                }
 
                FX() = default;
 
                explicit constexpr FX(double value)
                    : m_value{ value }
                {}
 
                double value() const;
 
                std::string toString() const;
 
                bool operator==(const FX &other) const
                {
                    return m_value == other.m_value;
                }
 
                bool operator!=(const FX &other) const
                {
                    return m_value != other.m_value;
                }
 
                bool operator<(const FX &other) const
                {
                    return m_value < other.m_value;
                }
 
                bool operator>(const FX &other) const
                {
                    return m_value > other.m_value;
                }
 
                bool operator<=(const FX &other) const
                {
                    return m_value <= other.m_value;
                }
 
                bool operator>=(const FX &other) const
                {
                    return m_value >= other.m_value;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const FX &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                double m_value{ 0.0 };
 
                friend struct DataModel::Detail::Befriend<FX>;
            };
 
 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT FY
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "CameraMatrix/FY" };
 
                static constexpr const char *name{ "FY" };
 
                static constexpr const char *description{ R"description(Focal length in y)description" };
 
                using ValueType = double;
 
                static constexpr Range<double> validRange()
                {
                    return { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max() };
                }
 
                FY() = default;
 
                explicit constexpr FY(double value)
                    : m_value{ value }
                {}
 
                double value() const;
 
                std::string toString() const;
 
                bool operator==(const FY &other) const
                {
                    return m_value == other.m_value;
                }
 
                bool operator!=(const FY &other) const
                {
                    return m_value != other.m_value;
                }
 
                bool operator<(const FY &other) const
                {
                    return m_value < other.m_value;
                }
 
                bool operator>(const FY &other) const
                {
                    return m_value > other.m_value;
                }
 
                bool operator<=(const FY &other) const
                {
                    return m_value <= other.m_value;
                }
 
                bool operator>=(const FY &other) const
                {
                    return m_value >= other.m_value;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const FY &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                double m_value{ 0.0 };
 
                friend struct DataModel::Detail::Befriend<FY>;
            };
 
            using Descendants = std::tuple<
                CameraIntrinsics::CameraMatrix::CX,
                CameraIntrinsics::CameraMatrix::CY,
                CameraIntrinsics::CameraMatrix::FX,
                CameraIntrinsics::CameraMatrix::FY>;
 
            CameraMatrix();
 
#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 CameraMatrix(Args &&...args)
            {
                using namespace Zivid::Detail::TypeTraits;
 
                static_assert(
                    AllArgsDecayedAreUnique<Args...>::value,
                    "Found duplicate types among the arguments passed to CameraMatrix(...). "
                    "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
            CameraMatrix 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 CX &cx() const
            {
                return m_cx;
            }
 
            CX &cx()
            {
                return m_cx;
            }
 
            CameraMatrix &set(const CX &value)
            {
                m_cx = value;
                return *this;
            }
 
            const CY &cy() const
            {
                return m_cy;
            }
 
            CY &cy()
            {
                return m_cy;
            }
 
            CameraMatrix &set(const CY &value)
            {
                m_cy = value;
                return *this;
            }
 
            const FX &fx() const
            {
                return m_fx;
            }
 
            FX &fx()
            {
                return m_fx;
            }
 
            CameraMatrix &set(const FX &value)
            {
                m_fx = value;
                return *this;
            }
 
            const FY &fy() const
            {
                return m_fy;
            }
 
            FY &fy()
            {
                return m_fy;
            }
 
            CameraMatrix &set(const FY &value)
            {
                m_fy = value;
                return *this;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraIntrinsics::CameraMatrix::CX>::value, int>::type = 0>
            const CameraIntrinsics::CameraMatrix::CX &get() const
            {
                return m_cx;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraIntrinsics::CameraMatrix::CY>::value, int>::type = 0>
            const CameraIntrinsics::CameraMatrix::CY &get() const
            {
                return m_cy;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraIntrinsics::CameraMatrix::FX>::value, int>::type = 0>
            const CameraIntrinsics::CameraMatrix::FX &get() const
            {
                return m_fx;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraIntrinsics::CameraMatrix::FY>::value, int>::type = 0>
            const CameraIntrinsics::CameraMatrix::FY &get() const
            {
                return m_fy;
            }
 
            template<size_t i, typename std::enable_if<i == 0, int>::type = 0>
            const CameraIntrinsics::CameraMatrix::CX &get() const
            {
                return m_cx;
            }
 
            template<size_t i, typename std::enable_if<i == 1, int>::type = 0>
            const CameraIntrinsics::CameraMatrix::CY &get() const
            {
                return m_cy;
            }
 
            template<size_t i, typename std::enable_if<i == 2, int>::type = 0>
            const CameraIntrinsics::CameraMatrix::FX &get() const
            {
                return m_fx;
            }
 
            template<size_t i, typename std::enable_if<i == 3, int>::type = 0>
            const CameraIntrinsics::CameraMatrix::FY &get() const
            {
                return m_fy;
            }
 
            template<typename F>
            void forEach(const F &f) const
            {
                f(m_cx);
                f(m_cy);
                f(m_fx);
                f(m_fy);
            }
 
            template<typename F>
            void forEach(const F &f)
            {
                f(m_cx);
                f(m_cy);
                f(m_fx);
                f(m_fy);
            }
 
            bool operator==(const CameraMatrix &other) const;
 
            bool operator!=(const CameraMatrix &other) const;
 
            std::string toString() const;
 
            friend std::ostream &operator<<(std::ostream &stream, const CameraMatrix &value)
            {
                return stream << value.toString();
            }
 
        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;
 
            CX m_cx;
            CY m_cy;
            FX m_fx;
            FY m_fy;
 
            friend struct DataModel::Detail::Befriend<CameraMatrix>;
        };
 
 
        // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
        class ZIVID_CORE_EXPORT Distortion
        {
        public:
            static constexpr DataModel::NodeType nodeType = DataModel::NodeType::group;
 
            static constexpr const char *path{ "Distortion" };
 
            static constexpr const char *name{ "Distortion" };
 
            static constexpr const char *description{
                R"description(The radial and tangential distortion parameters)description"
            };
 
 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT K1
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "Distortion/K1" };
 
                static constexpr const char *name{ "K1" };
 
                static constexpr const char *description{ R"description(First radial distortion term)description" };
 
                using ValueType = double;
 
                static constexpr Range<double> validRange()
                {
                    return { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max() };
                }
 
                K1() = default;
 
                explicit constexpr K1(double value)
                    : m_value{ value }
                {}
 
                double value() const;
 
                std::string toString() const;
 
                bool operator==(const K1 &other) const
                {
                    return m_value == other.m_value;
                }
 
                bool operator!=(const K1 &other) const
                {
                    return m_value != other.m_value;
                }
 
                bool operator<(const K1 &other) const
                {
                    return m_value < other.m_value;
                }
 
                bool operator>(const K1 &other) const
                {
                    return m_value > other.m_value;
                }
 
                bool operator<=(const K1 &other) const
                {
                    return m_value <= other.m_value;
                }
 
                bool operator>=(const K1 &other) const
                {
                    return m_value >= other.m_value;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const K1 &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                double m_value{ 0.0 };
 
                friend struct DataModel::Detail::Befriend<K1>;
            };
 
 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT K2
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "Distortion/K2" };
 
                static constexpr const char *name{ "K2" };
 
                static constexpr const char *description{ R"description(Second radial distortion term)description" };
 
                using ValueType = double;
 
                static constexpr Range<double> validRange()
                {
                    return { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max() };
                }
 
                K2() = default;
 
                explicit constexpr K2(double value)
                    : m_value{ value }
                {}
 
                double value() const;
 
                std::string toString() const;
 
                bool operator==(const K2 &other) const
                {
                    return m_value == other.m_value;
                }
 
                bool operator!=(const K2 &other) const
                {
                    return m_value != other.m_value;
                }
 
                bool operator<(const K2 &other) const
                {
                    return m_value < other.m_value;
                }
 
                bool operator>(const K2 &other) const
                {
                    return m_value > other.m_value;
                }
 
                bool operator<=(const K2 &other) const
                {
                    return m_value <= other.m_value;
                }
 
                bool operator>=(const K2 &other) const
                {
                    return m_value >= other.m_value;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const K2 &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                double m_value{ 0.0 };
 
                friend struct DataModel::Detail::Befriend<K2>;
            };
 
 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT K3
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "Distortion/K3" };
 
                static constexpr const char *name{ "K3" };
 
                static constexpr const char *description{ R"description(Third radial distortion term)description" };
 
                using ValueType = double;
 
                static constexpr Range<double> validRange()
                {
                    return { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max() };
                }
 
                K3() = default;
 
                explicit constexpr K3(double value)
                    : m_value{ value }
                {}
 
                double value() const;
 
                std::string toString() const;
 
                bool operator==(const K3 &other) const
                {
                    return m_value == other.m_value;
                }
 
                bool operator!=(const K3 &other) const
                {
                    return m_value != other.m_value;
                }
 
                bool operator<(const K3 &other) const
                {
                    return m_value < other.m_value;
                }
 
                bool operator>(const K3 &other) const
                {
                    return m_value > other.m_value;
                }
 
                bool operator<=(const K3 &other) const
                {
                    return m_value <= other.m_value;
                }
 
                bool operator>=(const K3 &other) const
                {
                    return m_value >= other.m_value;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const K3 &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                double m_value{ 0.0 };
 
                friend struct DataModel::Detail::Befriend<K3>;
            };
 
 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT P1
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "Distortion/P1" };
 
                static constexpr const char *name{ "P1" };
 
                static constexpr const char *description{ R"description(First tangential distortion term)description" };
 
                using ValueType = double;
 
                static constexpr Range<double> validRange()
                {
                    return { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max() };
                }
 
                P1() = default;
 
                explicit constexpr P1(double value)
                    : m_value{ value }
                {}
 
                double value() const;
 
                std::string toString() const;
 
                bool operator==(const P1 &other) const
                {
                    return m_value == other.m_value;
                }
 
                bool operator!=(const P1 &other) const
                {
                    return m_value != other.m_value;
                }
 
                bool operator<(const P1 &other) const
                {
                    return m_value < other.m_value;
                }
 
                bool operator>(const P1 &other) const
                {
                    return m_value > other.m_value;
                }
 
                bool operator<=(const P1 &other) const
                {
                    return m_value <= other.m_value;
                }
 
                bool operator>=(const P1 &other) const
                {
                    return m_value >= other.m_value;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const P1 &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                double m_value{ 0.0 };
 
                friend struct DataModel::Detail::Befriend<P1>;
            };
 
 
            // NOLINTNEXTLINE(clang-analyzer-optin.performance.Padding)
            class ZIVID_CORE_EXPORT P2
            {
            public:
                static constexpr DataModel::NodeType nodeType = DataModel::NodeType::leafValue;
 
                static constexpr const char *path{ "Distortion/P2" };
 
                static constexpr const char *name{ "P2" };
 
                static constexpr const char *description{
                    R"description(Second tangential distortion term)description"
                };
 
                using ValueType = double;
 
                static constexpr Range<double> validRange()
                {
                    return { std::numeric_limits<double>::lowest(), std::numeric_limits<double>::max() };
                }
 
                P2() = default;
 
                explicit constexpr P2(double value)
                    : m_value{ value }
                {}
 
                double value() const;
 
                std::string toString() const;
 
                bool operator==(const P2 &other) const
                {
                    return m_value == other.m_value;
                }
 
                bool operator!=(const P2 &other) const
                {
                    return m_value != other.m_value;
                }
 
                bool operator<(const P2 &other) const
                {
                    return m_value < other.m_value;
                }
 
                bool operator>(const P2 &other) const
                {
                    return m_value > other.m_value;
                }
 
                bool operator<=(const P2 &other) const
                {
                    return m_value <= other.m_value;
                }
 
                bool operator>=(const P2 &other) const
                {
                    return m_value >= other.m_value;
                }
 
                friend std::ostream &operator<<(std::ostream &stream, const P2 &value)
                {
                    return stream << value.toString();
                }
 
            private:
                void setFromString(const std::string &value);
 
                double m_value{ 0.0 };
 
                friend struct DataModel::Detail::Befriend<P2>;
            };
 
            using Descendants = std::tuple<
                CameraIntrinsics::Distortion::K1,
                CameraIntrinsics::Distortion::K2,
                CameraIntrinsics::Distortion::K3,
                CameraIntrinsics::Distortion::P1,
                CameraIntrinsics::Distortion::P2>;
 
            Distortion();
 
#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 Distortion(Args &&...args)
            {
                using namespace Zivid::Detail::TypeTraits;
 
                static_assert(
                    AllArgsDecayedAreUnique<Args...>::value,
                    "Found duplicate types among the arguments passed to Distortion(...). "
                    "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
            Distortion 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 K1 &k1() const
            {
                return m_k1;
            }
 
            K1 &k1()
            {
                return m_k1;
            }
 
            Distortion &set(const K1 &value)
            {
                m_k1 = value;
                return *this;
            }
 
            const K2 &k2() const
            {
                return m_k2;
            }
 
            K2 &k2()
            {
                return m_k2;
            }
 
            Distortion &set(const K2 &value)
            {
                m_k2 = value;
                return *this;
            }
 
            const K3 &k3() const
            {
                return m_k3;
            }
 
            K3 &k3()
            {
                return m_k3;
            }
 
            Distortion &set(const K3 &value)
            {
                m_k3 = value;
                return *this;
            }
 
            const P1 &p1() const
            {
                return m_p1;
            }
 
            P1 &p1()
            {
                return m_p1;
            }
 
            Distortion &set(const P1 &value)
            {
                m_p1 = value;
                return *this;
            }
 
            const P2 &p2() const
            {
                return m_p2;
            }
 
            P2 &p2()
            {
                return m_p2;
            }
 
            Distortion &set(const P2 &value)
            {
                m_p2 = value;
                return *this;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraIntrinsics::Distortion::K1>::value, int>::type = 0>
            const CameraIntrinsics::Distortion::K1 &get() const
            {
                return m_k1;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraIntrinsics::Distortion::K2>::value, int>::type = 0>
            const CameraIntrinsics::Distortion::K2 &get() const
            {
                return m_k2;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraIntrinsics::Distortion::K3>::value, int>::type = 0>
            const CameraIntrinsics::Distortion::K3 &get() const
            {
                return m_k3;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraIntrinsics::Distortion::P1>::value, int>::type = 0>
            const CameraIntrinsics::Distortion::P1 &get() const
            {
                return m_p1;
            }
 
            template<
                typename T,
                typename std::enable_if<std::is_same<T, CameraIntrinsics::Distortion::P2>::value, int>::type = 0>
            const CameraIntrinsics::Distortion::P2 &get() const
            {
                return m_p2;
            }
 
            template<size_t i, typename std::enable_if<i == 0, int>::type = 0>
            const CameraIntrinsics::Distortion::K1 &get() const
            {
                return m_k1;
            }
 
            template<size_t i, typename std::enable_if<i == 1, int>::type = 0>
            const CameraIntrinsics::Distortion::K2 &get() const
            {
                return m_k2;
            }
 
            template<size_t i, typename std::enable_if<i == 2, int>::type = 0>
            const CameraIntrinsics::Distortion::K3 &get() const
            {
                return m_k3;
            }
 
            template<size_t i, typename std::enable_if<i == 3, int>::type = 0>
            const CameraIntrinsics::Distortion::P1 &get() const
            {
                return m_p1;
            }
 
            template<size_t i, typename std::enable_if<i == 4, int>::type = 0>
            const CameraIntrinsics::Distortion::P2 &get() const
            {
                return m_p2;
            }
 
            template<typename F>
            void forEach(const F &f) const
            {
                f(m_k1);
                f(m_k2);
                f(m_k3);
                f(m_p1);
                f(m_p2);
            }
 
            template<typename F>
            void forEach(const F &f)
            {
                f(m_k1);
                f(m_k2);
                f(m_k3);
                f(m_p1);
                f(m_p2);
            }
 
            bool operator==(const Distortion &other) const;
 
            bool operator!=(const Distortion &other) const;
 
            std::string toString() const;
 
            friend std::ostream &operator<<(std::ostream &stream, const Distortion &value)
            {
                return stream << value.toString();
            }
 
        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;
 
            K1 m_k1;
            K2 m_k2;
            K3 m_k3;
            P1 m_p1;
            P2 m_p2;
 
            friend struct DataModel::Detail::Befriend<Distortion>;
        };
 
        using Descendants = std::tuple<
            CameraIntrinsics::CameraMatrix,
            CameraIntrinsics::CameraMatrix::CX,
            CameraIntrinsics::CameraMatrix::CY,
            CameraIntrinsics::CameraMatrix::FX,
            CameraIntrinsics::CameraMatrix::FY,
            CameraIntrinsics::Distortion,
            CameraIntrinsics::Distortion::K1,
            CameraIntrinsics::Distortion::K2,
            CameraIntrinsics::Distortion::K3,
            CameraIntrinsics::Distortion::P1,
            CameraIntrinsics::Distortion::P2>;
 
        CameraIntrinsics();
 
        explicit CameraIntrinsics(const std::string &fileName);
 
        [[nodiscard]] static CameraIntrinsics 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 CameraIntrinsics(Args &&...args)
        {
            using namespace Zivid::Detail::TypeTraits;
 
            static_assert(
                AllArgsDecayedAreUnique<Args...>::value,
                "Found duplicate types among the arguments passed to CameraIntrinsics(...). "
                "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
        CameraIntrinsics 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 CameraMatrix &cameraMatrix() const
        {
            return m_cameraMatrix;
        }
 
        CameraMatrix &cameraMatrix()
        {
            return m_cameraMatrix;
        }
 
        CameraIntrinsics &set(const CameraMatrix &value)
        {
            m_cameraMatrix = value;
            return *this;
        }
 
        CameraIntrinsics &set(const CameraMatrix::CX &value)
        {
            m_cameraMatrix.set(value);
            return *this;
        }
 
        CameraIntrinsics &set(const CameraMatrix::CY &value)
        {
            m_cameraMatrix.set(value);
            return *this;
        }
 
        CameraIntrinsics &set(const CameraMatrix::FX &value)
        {
            m_cameraMatrix.set(value);
            return *this;
        }
 
        CameraIntrinsics &set(const CameraMatrix::FY &value)
        {
            m_cameraMatrix.set(value);
            return *this;
        }
 
        const Distortion &distortion() const
        {
            return m_distortion;
        }
 
        Distortion &distortion()
        {
            return m_distortion;
        }
 
        CameraIntrinsics &set(const Distortion &value)
        {
            m_distortion = value;
            return *this;
        }
 
        CameraIntrinsics &set(const Distortion::K1 &value)
        {
            m_distortion.set(value);
            return *this;
        }
 
        CameraIntrinsics &set(const Distortion::K2 &value)
        {
            m_distortion.set(value);
            return *this;
        }
 
        CameraIntrinsics &set(const Distortion::K3 &value)
        {
            m_distortion.set(value);
            return *this;
        }
 
        CameraIntrinsics &set(const Distortion::P1 &value)
        {
            m_distortion.set(value);
            return *this;
        }
 
        CameraIntrinsics &set(const Distortion::P2 &value)
        {
            m_distortion.set(value);
            return *this;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraIntrinsics::CameraMatrix>::value, int>::type = 0>
        const CameraIntrinsics::CameraMatrix &get() const
        {
            return m_cameraMatrix;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraIntrinsics::CameraMatrix::CX>::value, int>::type = 0>
        const CameraIntrinsics::CameraMatrix::CX &get() const
        {
            return m_cameraMatrix.get<CameraIntrinsics::CameraMatrix::CX>();
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraIntrinsics::CameraMatrix::CY>::value, int>::type = 0>
        const CameraIntrinsics::CameraMatrix::CY &get() const
        {
            return m_cameraMatrix.get<CameraIntrinsics::CameraMatrix::CY>();
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraIntrinsics::CameraMatrix::FX>::value, int>::type = 0>
        const CameraIntrinsics::CameraMatrix::FX &get() const
        {
            return m_cameraMatrix.get<CameraIntrinsics::CameraMatrix::FX>();
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraIntrinsics::CameraMatrix::FY>::value, int>::type = 0>
        const CameraIntrinsics::CameraMatrix::FY &get() const
        {
            return m_cameraMatrix.get<CameraIntrinsics::CameraMatrix::FY>();
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraIntrinsics::Distortion>::value, int>::type = 0>
        const CameraIntrinsics::Distortion &get() const
        {
            return m_distortion;
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraIntrinsics::Distortion::K1>::value, int>::type = 0>
        const CameraIntrinsics::Distortion::K1 &get() const
        {
            return m_distortion.get<CameraIntrinsics::Distortion::K1>();
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraIntrinsics::Distortion::K2>::value, int>::type = 0>
        const CameraIntrinsics::Distortion::K2 &get() const
        {
            return m_distortion.get<CameraIntrinsics::Distortion::K2>();
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraIntrinsics::Distortion::K3>::value, int>::type = 0>
        const CameraIntrinsics::Distortion::K3 &get() const
        {
            return m_distortion.get<CameraIntrinsics::Distortion::K3>();
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraIntrinsics::Distortion::P1>::value, int>::type = 0>
        const CameraIntrinsics::Distortion::P1 &get() const
        {
            return m_distortion.get<CameraIntrinsics::Distortion::P1>();
        }
 
        template<
            typename T,
            typename std::enable_if<std::is_same<T, CameraIntrinsics::Distortion::P2>::value, int>::type = 0>
        const CameraIntrinsics::Distortion::P2 &get() const
        {
            return m_distortion.get<CameraIntrinsics::Distortion::P2>();
        }
 
        template<size_t i, typename std::enable_if<i == 0, int>::type = 0>
        const CameraIntrinsics::CameraMatrix &get() const
        {
            return m_cameraMatrix;
        }
 
        template<size_t i, typename std::enable_if<i == 1, int>::type = 0>
        const CameraIntrinsics::Distortion &get() const
        {
            return m_distortion;
        }
 
        template<typename F>
        void forEach(const F &f) const
        {
            f(m_cameraMatrix);
            f(m_distortion);
        }
 
        template<typename F>
        void forEach(const F &f)
        {
            f(m_cameraMatrix);
            f(m_distortion);
        }
 
        bool operator==(const CameraIntrinsics &other) const;
 
        bool operator!=(const CameraIntrinsics &other) const;
 
        std::string toString() const;
 
        friend std::ostream &operator<<(std::ostream &stream, const CameraIntrinsics &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;
 
        CameraMatrix m_cameraMatrix;
        Distortion m_distortion;
 
        friend struct DataModel::Detail::Befriend<CameraIntrinsics>;
    };
 
#ifndef NO_DOC
    template<>
    struct CameraIntrinsics::Version<1>
    {
        using Type = CameraIntrinsics;
    };
#endif
 
} // namespace Zivid
 
#ifndef NO_DOC
namespace Zivid::Detail
{
 
    ZIVID_CORE_EXPORT void save(const Zivid::CameraIntrinsics &dataModel, std::ostream &ostream);
    ZIVID_CORE_EXPORT void load(Zivid::CameraIntrinsics &dataModel, std::istream &istream);
 
    ZIVID_CORE_EXPORT std::vector<uint8_t> serializeToBinaryVector(const Zivid::CameraIntrinsics &source);
    ZIVID_CORE_EXPORT void deserializeFromBinaryVector(Zivid::CameraIntrinsics &dest, const std::vector<uint8_t> &data);
 
} // 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::CameraIntrinsics::CameraMatrix> : integral_constant<size_t, 4>
    {};
 
    template<size_t i>
    struct tuple_element<i, Zivid::CameraIntrinsics::CameraMatrix>
    {
        static_assert(i < tuple_size<Zivid::CameraIntrinsics::CameraMatrix>::value, "Index must be less than 4");
 
        using type // NOLINT
            = decltype(declval<Zivid::CameraIntrinsics::CameraMatrix>().get<i>());
    };
 
    template<>
    struct tuple_size<Zivid::CameraIntrinsics::Distortion> : integral_constant<size_t, 5>
    {};
 
    template<size_t i>
    struct tuple_element<i, Zivid::CameraIntrinsics::Distortion>
    {
        static_assert(i < tuple_size<Zivid::CameraIntrinsics::Distortion>::value, "Index must be less than 5");
 
        using type // NOLINT
            = decltype(declval<Zivid::CameraIntrinsics::Distortion>().get<i>());
    };
 
    template<>
    struct tuple_size<Zivid::CameraIntrinsics> : integral_constant<size_t, 2>
    {};
 
    template<size_t i>
    struct tuple_element<i, Zivid::CameraIntrinsics>
    {
        static_assert(i < tuple_size<Zivid::CameraIntrinsics>::value, "Index must be less than 2");
 
        using type // NOLINT
            = decltype(declval<Zivid::CameraIntrinsics>().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/CameraIntrinsicsInternal.h") && __has_include("Zivid/DataModelNodeMetaData.h")
#        include "Zivid/CameraIntrinsicsInternal.h"
#    endif
#endif