| Face Engine SDK 5.12.0 A face detection, recognition and tracking engine.

Public Member Functions | List of all members
fsdk::IHumanWarper Struct Referenceabstract

Human detection area warper interface. More...

`#include <IHumanWarper.h>`

Inheritance diagram for fsdk::IHumanWarper:

## Public Member Functions
virtual Result< FSDKError > | warp (const Image image, const Detection &detection, Image &transformedImage) const noexcept=0
| Warp human detection. More...
virtual Result< FSDKError > | warp (Span< const Image > images, Span< const Detection > detections, Span< Image > transformedImages) const noexcept=0
| Warps humans on multiple images. More...
Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t | retain () noexcept=0
| Increase strong reference count. More...
virtual int32_t | retainLocked () noexcept=0
| Increase strong reference count thread safely. More...
virtual int32_t | release () noexcept=0
| Decrease strong reference count. More...
virtual int32_t | getRefCount () const noexcept=0
| Get actual strong reference count. More...
virtual int32_t | retainWeak () noexcept=0
| Increase weak reference count. More...
virtual int32_t | releaseWeak () noexcept=0
| Decrease weak reference count. More...
virtual int32_t | getWeakRefCount () const noexcept=0
| Get actual weak reference count. More...

## Detailed Description

Human detection area warper interface.

Performs cropping and resizing of an image for human descriptor extraction.

## Member Function Documentation

## ◆ warp() [1/2]

virtual Result<FSDKError> fsdk::IHumanWarper::warp | ( | const Image | image,
|  | const Detection & | detection,
|  | Image & | transformedImage
| ) |  | const
| pure virtual noexcept

Warp human detection.

Parameters

  [in] | image | source image.
  [in] | detection | detection coordinates in image space.
  | [in/out] | transformedImage warped image output.

Note
  if transformedImage has the same width, height, format as the standard human warp and the same memory residence as source image has, then output data will be just copied to transformedImage without any memory allocation. New image will be allocated otherwise.

Returns
  Result with error code.

See also
  Image, Detection, Result and FSDKError for details.

Note
  image format must be R8G8B8,

See also
  Format.

## ◆ warp() [2/2]

virtual Result<FSDKError> fsdk::IHumanWarper::warp | ( | Span< const Image > | images,
|  | Span< const Detection > | detections,
|  | Span< Image > | transformedImages
| ) |  | const
| pure virtual noexcept

Warps humans on multiple images.

Parameters

  [in] | images | span of source images.
  [in] | detections | span of detection coordinates in corresponding source images space.
  | [in/out] | transformedImages span of input/output images where result will be stored.

Note
  each detection in detections span corresponds to an image where this detection was taken from by the same index(i.e detections[i] <–> images[i]), therefore, if there are multiple detections on the same image user must duplicate those images in order for the first statement to hold true.
  if output images in transformed images span has the same image parameters as the standard warped image, then output data will be just copied to those images without any memory allocation. New images will be allocated otherwise.

Returns
  Result with error code.

See also
  Span, Image, Detection, Result and FSDKError for details.

Note
  images format must be R8G8B8,

See also
  Format.

Note
  all spans should be based on user owned continuous collections.
  all spans should be equal size.

The documentation for this struct was generated from the following file:

- include/fsdk/IHumanWarper.h