IFishEyeEstimator.h

#pragma once

#include <fsdk/IObject.h>
#include <fsdk/FSDKError.h>

#include <fsdk/Types/Image.h>
#include <fsdk/Types/Result.h>
#include <fsdk/Types/Span.h>

namespace fsdk {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(IFishEyeEstimator);
#endif

    enum class FishEye {
        NoFishEyeEffect = 0, 
        FishEyeEffect = 1    
    };

    struct FishEyeEstimation {
        FishEye result; 
        float score;    
    };

    struct IFishEyeEstimator : IRefCounted {
        FSDK_DEPRECATED("This method is deprecated since v.5.13.0, use estimation by warped image instead!")
        virtual Result<FSDKError> estimate(
            const Image& image,
            const Detection& detection,
            FishEyeEstimation& estimation) const noexcept = 0;

        FSDK_DEPRECATED("This method is deprecated since v.5.13.0, use estimation by warped images instead!")
        virtual Result<FSDKError> estimate(
            Span<const Image> images,
            Span<const Detection> detections,
            Span<FishEyeEstimation> estimations) const noexcept = 0;

        virtual Result<FSDKError> estimate(const Image& warp, FishEyeEstimation& estimation) const noexcept = 0;

        virtual Result<FSDKError>
        estimate(Span<const Image> warps, Span<FishEyeEstimation> estimations) const noexcept = 0;

        FSDK_DEPRECATED("This method is deprecated since v.5.13.0, use validation by warped images instead!")
        virtual Result<FSDKError> validate(
            Span<const Image> images,
            Span<const Detection> detections,
            Span<Result<FSDKError>> errors) const noexcept = 0;

        virtual Result<FSDKError>
        validate(Span<const Image> warps, Span<Result<FSDKError>> errors) const noexcept = 0;
    };

} // namespace fsdk