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

    enum class LightStatus : uint8_t {
        NonNatural = 0,     
        Natural = 1         
    };

    struct NaturalLightEstimation {
        LightStatus status;  
        float score;          
    };

    struct INaturalLightEstimator : IRefCounted {

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

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

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

} // namespace fsdk