IWarper.h

Go to the documentation of this file.

#pragma once

#include <fsdk/IDescriptor.h>
#include <fsdk/Types/Span.h>
#include <fsdk/Types/Transformation.h>

#include <fsdk/vlc/future.h>

namespace fsdk {
    struct EyesEstimation;
    struct GazeEstimation;
}

namespace fsdk {
    
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    DECLARE_SMARTPTR(IWarper);
#endif

    struct IWarper : IRefCounted {
        virtual Transformation
        createTransformation(
            const Detection& detection,
            const Landmarks5& landmarks) const noexcept = 0;

        virtual Result<FSDKError>
        warp(
            const Image& image,
            const Transformation& transformation,
            Image& transformedImage) const noexcept = 0;

        virtual Result<FSDKError>
        warp(
            Span<const Image> images,
            Span<const Transformation> transformations,
            Span<Image> transformedImages) const noexcept = 0;

        virtual Result<FSDKError>
        warp(
            const Landmarks5& landmarks,
            const Transformation& transformation,
            Landmarks5& transformedLandmarks) const noexcept = 0;
        
        virtual Result<FSDKError>
        warp(
            const Landmarks68& landmarks68,
            const Transformation& transformation,
            Landmarks68& transformedLandmarks68) const noexcept = 0;
        
        virtual Result<FSDKError>
        unwarp(
            const EyesEstimation& eyesEstimationInWarpCoordinates,
            const Transformation& transformation,
            EyesEstimation& eyesEstimation) const noexcept = 0;
        
        virtual Result<FSDKError>
        unwarp(
            const Landmarks5& warpedLandmarks5,
            const Transformation& transformation,
            Landmarks5& landmarks5) const noexcept = 0;
        
        virtual Result<FSDKError>
        unwarp(
            const Landmarks68& warpedLandmarks68,
            const Transformation& transformation,
            Landmarks68& landmarks68) const noexcept = 0;

        virtual Result<FSDKError>
        unwarp(
            const GazeEstimation& warpedAngles,
            const Transformation& transformation,
            GazeEstimation& angles
        ) const noexcept = 0;

        using ImageBatch = std::vector<Image>;
        using ImageBatchFuture = vlc::future<ImageBatch>;

        virtual ImageBatchFuture warpAsync(
            Span<const Image> images,
            Span<const Transformation> transformations) const = 0;
    };
}