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

    struct NeckOcclusionEstimation {
        enum class Type {
            NeckCovered = 0, 
            NeckOpen = 1,    
            NeckUnknown = 2, 
        };

        float coveredScore; 
        float openScore;    
        float unknownScore; 

        Type result; 
    };

    struct INeckOcclusionEstimator : IRefCounted {
        virtual Result<FSDKError> estimate(
            const Image& image,
            const Detection& detection,
            NeckOcclusionEstimation& estimation) const noexcept = 0;

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

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

} // namespace fsdk