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

    enum class HeadWearState {
        Yes = 0, //< there is headwear
        No,      //< there is no headwear
        Count
    };

    struct HeadWearStateEstimation {
        HeadWearState result;                                 
        float scores[static_cast<int>(HeadWearState::Count)]; 

        inline float getScore(HeadWearState state) const;
    };

    enum class HeadWearType : uint8_t {
        NoHeadWear = 0,  //< there is no headwear on the head
        BaseballCap,     //< there is baseball cap on the head
        Beanie,          //< there is beanie on the head
        PeakedCap,       //< there is peaked cap on the head
        Shawl,           //< there is shawl on the head
        HatWithEarFlaps, //< there is hat with ear flaps on the head
        Helmet,          //< there is helmet on the head
        Hood,            //< there is hood on the head
        Hat,             //< there is hat on the head
        Other,           //< something other is on the head
        Count
    };

    struct HeadWearTypeEstimation {
        HeadWearType result;                                 
        float scores[static_cast<int>(HeadWearType::Count)]; 

        inline float getScore(HeadWearType type) const;
    };

    struct HeadWearEstimation {
        HeadWearStateEstimation state; 
        HeadWearTypeEstimation type;   
    };

    struct IHeadWearEstimator : IRefCounted {
        virtual Result<FSDKError> estimate(const Image& warp, HeadWearEstimation& estimation) const noexcept = 0;

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

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

    /*
        Implementation details.
    */
    float HeadWearStateEstimation::getScore(HeadWearState state) const {
        switch(state) {
        case HeadWearState::Yes:
        case HeadWearState::No:
            return scores[static_cast<int>(state)];
        default:
            return -1.0f;
        }
    }

    /*
        Implementation details.
    */
    float HeadWearTypeEstimation::getScore(HeadWearType type) const {
        switch(type) {
        case HeadWearType::NoHeadWear:
        case HeadWearType::BaseballCap:
        case HeadWearType::Beanie:
        case HeadWearType::PeakedCap:
        case HeadWearType::Shawl:
        case HeadWearType::HatWithEarFlaps:
        case HeadWearType::Helmet:
        case HeadWearType::Hood:
        case HeadWearType::Hat:
        case HeadWearType::Other:
            return scores[static_cast<int>(type)];
        default:
            return -1.0f;
        }
    }

} // namespace fsdk