IBackgroundEstimator.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(IBackgroundEstimator);
#endif

    enum class BackgroundStatus : uint8_t {
        NonSolid = 0, 
        Solid = 1     
    };

    struct BackgroundEstimation {
        BackgroundStatus status; 
        float backgroundScore;   
        float backgroundColorScore; 
    };

    struct IBackgroundEstimator : IRefCounted {

        virtual Result<FSDKError> estimate(
            const Image& image,
            const Detection& detection,
            BackgroundEstimation& estimation) const noexcept = 0;

        virtual Result<FSDKError> estimate(
            Span<const Image> images,
            Span<const Detection> detections,
            Span<BackgroundEstimation> estimations) const noexcept = 0;

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

} // namespace fsdk