ICredibilityCheckEstimator.h

#pragma once

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

namespace fsdk {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(ICredibilityCheckEstimator);
#endif
    
    enum class CredibilityStatus : uint8_t {
        Reliable    = 1,
        NonReliable = 2,
    };

    struct CredibilityCheckEstimation {
        float value; 

        CredibilityStatus credibilityStatus;
    };

    struct ICredibilityCheckEstimator : IRefCounted {

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

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

    };
}