fsdk::IFaceLandmarksDetector Struct Reference

Inheritance diagram for fsdk::IFaceLandmarksDetector:

Public Types
using	FaceLandmarksBatchFuture = vlc::future<IFaceLandmarksBatchPtr>
	Common alias for IFaceLandmarksDetector asynchronous interface.

Public Member Functions
virtual ResultValue< FSDKError, Ref< IFaceLandmarksBatch > >	detectLandmarks5 (Span< const Image > images, Span< Span< const Detection > > detections) const noexcept=0
	Detects landmarks5 on multiple images.
virtual ResultValue< FSDKError, Ref< IFaceLandmarksBatch > >	detectLandmarks68 (Span< const Image > images, Span< Span< const Detection > > detections) const noexcept=0
	Detects landmarks68 on multiple images.
virtual Result< FSDKError >	validate (Span< const Image > images, Span< Span< const Detection > > detections, Span< Span< Result< FSDKError > > > errors) const noexcept=0
	Validates input of multiple frames in a single function call.
virtual Result< FSDKError >	detectLandmarks5 (const Image &image, Span< const Detection > detections, Span< Landmarks5 > landmarks) const noexcept=0
	Detects landmarks5 in a photo.
virtual Result< FSDKError >	detectLandmarks68 (const Image &image, Span< const Detection > detections, Span< Landmarks68 > landmarks) const noexcept=0
	Detects landmarks68 in a photo.
virtual Result< FSDKError >	validate (const Image &images, Span< const Detection > detections, Span< Result< FSDKError > > errors) const noexcept=0
	Validates input of frame and detections in a single function call.
virtual Result< FSDKError >	validate (Span< const Image > images, Span< Span< const Detection > > detections, DetectionType detectionType, Span< Span< Result< FSDKError > > > errors) const noexcept=0
	Validates frames, detections, detectionType in a single function call.
virtual FaceLandmarksBatchFuture	detectLandmarksAsync (Span< const Image > images, Span< Span< const Detection > > detections, DetectionType detectionType) const =0
	Asynchronously detects landmarks5 and/or landmarks68 on multiple images.
Public Member Functions inherited from fsdk::IRefCounted
virtual int32_t	retain () noexcept=0
	Increase strong reference count.
virtual int32_t	retainLocked () noexcept=0
	Increase strong reference count thread safely.
virtual int32_t	release () noexcept=0
	Decrease strong reference count.
virtual int32_t	getRefCount () const noexcept=0
	Get actual strong reference count.
virtual int32_t	retainWeak () noexcept=0
	Increase weak reference count.
virtual int32_t	releaseWeak () noexcept=0
	Decrease weak reference count.
virtual int32_t	getWeakRefCount () const noexcept=0
	Get actual weak reference count.

Member Function Documentation

detectLandmarks5() [1/2]

virtual Result< FSDKError > fsdk::IFaceLandmarksDetector::detectLandmarks5 ( const Image & image, Span< const Detection > detections, Span< Landmarks5 > landmarks ) const

pure virtualnoexcept

Detects landmarks5 in a photo.

Parameters

[in]	image	source images.
[in]	detections	input detections.
[out]	landmarks	output span of landmarks5 for each detection.

Returns

ResultValue with error code and a IFaceDetectionBatch object (detection bbox, landmarks, etc).

See also

Ref, Span, Image, Detection, Landmarks5, IFaceDetectionBatch, ResultValue 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.

detectLandmarks5() [2/2]

virtual ResultValue< FSDKError, Ref< IFaceLandmarksBatch > > fsdk::IFaceLandmarksDetector::detectLandmarks5 ( Span< const Image > images, Span< Span< const Detection > > detections ) const

pure virtualnoexcept

Detects landmarks5 on multiple images.

Parameters

[in]	images	span of source images.
[in]	detections	span of detection coordinates in corresponding source images space from the previous frames. It is a two dimensional Span. There is one Span of Detections for each image.

Returns

ResultValue with error code and IFaceLandmarksBatch object.

See also

Ref, Span, Image, Detection, Landmarks5, IFaceLandmarksBatch, ResultValue 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.

detectLandmarks68() [1/2]

virtual Result< FSDKError > fsdk::IFaceLandmarksDetector::detectLandmarks68 ( const Image & image, Span< const Detection > detections, Span< Landmarks68 > landmarks ) const

pure virtualnoexcept

Detects landmarks68 in a photo.

Parameters

[in]	image	source images.
[in]	detections	input detections.
[out]	landmarks	output span of landmarks68 for each detection.

Returns

Result with error code.

See also

Ref, Span, Image, Detection, Landmarks68, IFaceLandmarksBatch, ResultValue 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.

detectLandmarks68() [2/2]

virtual ResultValue< FSDKError, Ref< IFaceLandmarksBatch > > fsdk::IFaceLandmarksDetector::detectLandmarks68 ( Span< const Image > images, Span< Span< const Detection > > detections ) const

pure virtualnoexcept

Detects landmarks68 on multiple images.

Parameters

[in]	images	span of source images.
[in]	detections	span of detection coordinates in corresponding source images space from the previous frames. It is a two dimensional Span. There is one Span of Detections for each image.

Returns

ResultValue with error code and a IFaceLandmarksBatch object.

See also

Ref, Span, Image, Detection, Landmarks68, IFaceLandmarksBatch, ResultValue 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.

detectLandmarksAsync()

virtual FaceLandmarksBatchFuture fsdk::IFaceLandmarksDetector::detectLandmarksAsync ( Span< const Image > images, Span< Span< const Detection > > detections, DetectionType detectionType ) const

pure virtual

Asynchronously detects landmarks5 and/or landmarks68 on multiple images.

Parameters

[in]	images	source images.
[in]	detections	input detections.
[in]	detectionType	type[s] of landmarks to detect, any of {DT_LANDMARKS5, DT_LANDMARKS68, DT_LANDMARKS5 | DT_LANDMARKS68}

Returns

Future with IFaceLandmarksBatch object.

See also

Ref, Span, Image, Detection, Landmarks5, Landmarks68, IFaceLandmarksBatch, and vlc::future 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.

this method is not marked as noexcept and may throw an exception.

validate() [1/3]

virtual Result< FSDKError > fsdk::IFaceLandmarksDetector::validate ( const Image & images, Span< const Detection > detections, Span< Result< FSDKError > > errors ) const

pure virtualnoexcept

Validates input of frame and detections in a single function call.

Parameters

[in]	images	source image.
[in]	detections	span of detection
[out]	errors	output span of errors.

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.

validate() [2/3]

virtual Result< FSDKError > fsdk::IFaceLandmarksDetector::validate ( Span< const Image > images, Span< Span< const Detection > > detections, DetectionType detectionType, Span< Span< Result< FSDKError > > > errors ) const

pure virtualnoexcept

Validates frames, detections, detectionType in a single function call.

Parameters

[in]	images	source image.
[in]	detections	span of detection
[in]	detectionType	type[s] of landmarks to detect, any of {DT_LANDMARKS5, DT_LANDMARKS68, DT_LANDMARKS5 | DT_LANDMARKS68}
[out]	errors	output span of errors.

Returns

Result with error code.

See also

Span, Image, Detection, DetectionType, 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.

validate() [3/3]

virtual Result< FSDKError > fsdk::IFaceLandmarksDetector::validate ( Span< const Image > images, Span< Span< const Detection > > detections, Span< Span< Result< FSDKError > > > errors ) const

pure virtualnoexcept

Validates input of multiple frames in a single function call.

Parameters

[in]	images	span of source images.
[in]	detections	span of detection coordinates in corresponding source images space from the previous frames. It is a two dimensional Span. There is one Span of Detections for each image.
[out]	errors	output span of errors for each image. It is a two dimensional Span. There is one Span of the errors for each image.

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:

• fsdk.framework/Headers/IFaceLandmarksDetector.h