InfieldCorrection.h

Go to the documentation of this file.

/*******************************************************************************
 * This file is part of the Zivid API
 *
 * Copyright 2015-2025 (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 "Zivid/Calibration/DetectionResult.h"
#include "Zivid/Calibration/InfieldCorrectionDetectionStatus.h"
#include "Zivid/Camera.h"
#include "Zivid/Detail/CoreExport.h"
#include "Zivid/Detail/Pimpl.h"
#include "Zivid/Point.h"
 
#include <chrono>
#include <iosfwd>
#include <string>
#include <vector>
 
namespace Zivid
{
    namespace Calibration
    {
        class InfieldCorrectionInput
        {
        public:
            ZIVID_CORE_EXPORT InfieldCorrectionInput(const DetectionResult &detectionResult);

            ZIVID_CORE_EXPORT const DetectionResult &detectionResult() const;

            ZIVID_CORE_EXPORT InfieldCorrectionDetectionStatus status() const;

            ZIVID_CORE_EXPORT bool valid() const;

            ZIVID_CORE_EXPORT explicit operator bool() const;

            ZIVID_CORE_EXPORT std::string statusDescription() const;

            ZIVID_CORE_EXPORT std::string toString() const;
 
        private:
            DetectionResult m_detectionResult;
            InfieldCorrectionDetectionStatus m_status;
        };

        ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const InfieldCorrectionInput &input);

        class CameraVerification
        {
            ZIVID_PIMPL_VALUE_SEMANTICS(CameraVerification, ZIVID_CORE_EXPORT);
 
        public:
            ZIVID_CORE_EXPORT float localDimensionTrueness() const;

            ZIVID_CORE_EXPORT PointXYZ position() const;

            ZIVID_CORE_EXPORT std::string toString() const;
        };

        ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const CameraVerification &cameraVerification);

        class AccuracyEstimate
        {
            ZIVID_PIMPL_VALUE_SEMANTICS(AccuracyEstimate, ZIVID_CORE_EXPORT);
 
        public:
            ZIVID_CORE_EXPORT float dimensionAccuracy() const;

            ZIVID_CORE_EXPORT float zMin() const;

            ZIVID_CORE_EXPORT float zMax() const;

            ZIVID_CORE_EXPORT std::string toString() const;
        };

        ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const AccuracyEstimate &accuracyEstimate);

        class CameraCorrection
        {
            ZIVID_PIMPL_VALUE_SEMANTICS(CameraCorrection, ZIVID_CORE_EXPORT);
 
        public:
            ZIVID_CORE_EXPORT AccuracyEstimate accuracyEstimate() const;

            ZIVID_CORE_EXPORT std::string toString() const;
        };

        ZIVID_CORE_EXPORT std::ostream &operator<<(std::ostream &stream, const CameraCorrection &cameraCorrection);

        ZIVID_CORE_EXPORT CameraVerification verifyCamera(const InfieldCorrectionInput &input);

        ZIVID_CORE_EXPORT CameraCorrection computeCameraCorrection(const std::vector<InfieldCorrectionInput> &dataset);

        ZIVID_CORE_EXPORT void writeCameraCorrection(Camera &camera, const CameraCorrection &cameraCorrection);

        ZIVID_CORE_EXPORT void resetCameraCorrection(Camera &camera);

        ZIVID_CORE_EXPORT bool hasCameraCorrection(const Camera &camera);

        ZIVID_CORE_EXPORT std::chrono::time_point<std::chrono::system_clock> cameraCorrectionTimestamp(
            const Camera &camera);
    } // namespace Calibration
} // namespace Zivid