IHumanDetector.h

#pragma once

#include "FSDKError.h"
#include "IHumanDetectionBatch.h"
#include "IObject.h"
#include "Types/Human.h"

namespace fsdk {

#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(IHumanDetector);
#endif

    enum HumanDetectionType {
        HDT_BOX    = 0,     
        HDT_POINTS = 1<<0,  
        HDT_ALL    = 0xffff 
    };

    inline HumanDetectionType operator | (HumanDetectionType a, HumanDetectionType b) { 
        return static_cast<HumanDetectionType>(static_cast<int>(a) | static_cast<int>(b));
    }

    struct IHumanDetector : IRefCounted {
        /*
         * @brief Batched detect of human bodies
         * @param images input images span; format must be R8G8B8.
         * @param rects input rectangles of interest span.
         * @param detectionPerImageNum max number of detections per input image.
         * @param type Human detection type. @see HumanDetectionType for details.
         * @return ResultValue with error code and IHumanDetectionBatch object.
         * @note all spans should be based on user owned continuous collections.
         * @note all spans should be equal size.
         * @see ResultValue, FSDKError, Ref, IHumanDetectionBatch, Span,
         * Image, Rect, HumanDetectionType for details
         */
        virtual ResultValue<FSDKError, Ref<IHumanDetectionBatch>>
        detect(
            Span<const Image> images,
            Span<const Rect> rects,
            uint32_t detectionPerImageNum,
            HumanDetectionType type = HDT_BOX) const noexcept = 0;

        /*
         * @brief redetect one person from input image;
         * @param image source image;
         * @param detection detection to make a redetect;
         * @param type Human detection type. @see HumanDetectionType for details.
         * @return ResultValue with ErrorCode and Human (invalid - if detection not found);
         **/
        virtual ResultValue<FSDKError, Human>
        redetectOne(
            const Image& image,
            const Detection& detection,
            HumanDetectionType type = HDT_BOX) const noexcept = 0;

        virtual ResultValue<FSDKError, IHumanDetectionBatchPtr>
        redetect(
            Span<const Image> images,
            Ref<IHumanDetectionBatch> detectionBatch,
            HumanDetectionType type = HDT_BOX) const noexcept = 0;

        virtual ResultValue<FSDKError, IHumanDetectionBatchPtr>
        redetect(
            Span<const Image> images,
            Span<Span<const Detection>> detections,
            HumanDetectionType type = HDT_BOX) const noexcept = 0;

        virtual Result<FSDKError>
        validate(
            Span<const Image> images,
            Span<const Rect> rects,
            uint32_t detectionPerImageNum,
            Span<Result<FSDKError>> outErrors) const noexcept = 0;

        virtual Result<FSDKError> validate(
            Span<const Image> images,
            Ref<IHumanDetectionBatch> detectionBatch,
            Span<Result<FSDKError>> outErrors) const noexcept = 0;

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

    };

}