Face SDK  1.13.0 Mozart release
Face Recognition Software Development Kit
face.h
1 
4 #pragma once
5 
6 #include <face_sdk_base/export.h>
7 
8 #include <c_interface/common/face_sdk_class.h>
10 #include <c_interface/face_sdk_base/image.h>
11 
12 FACE_SDK_EXTERN_C_BEGIN
13 
19 const float FACE_SDK__UNKNOWN_CONFIDENCE = .0f;
20 const uint32_t FACE_SDK__UNKNOWN_VERSION = 0;
21 
27 DECLARE_FACE_SDK_CLASS(face)
28 
29 
30 
37 bool FACE_SDK_C_EXPORT face_sdk__face__get_confidence(const face_sdk__face_t *face, float *value);
38 
46 bool FACE_SDK_C_EXPORT face_sdk__face__get_x(const face_sdk__face_t *face, int32_t *value);
47 
55 bool FACE_SDK_C_EXPORT face_sdk__face__get_y(const face_sdk__face_t *face, int32_t *value);
56 
64 bool FACE_SDK_C_EXPORT face_sdk__face__get_width(const face_sdk__face_t *face, int32_t *value);
65 
73 bool FACE_SDK_C_EXPORT face_sdk__face__get_height(const face_sdk__face_t *face, int32_t *value);
74 
82 bool FACE_SDK_C_EXPORT face_sdk__face__get_img(const face_sdk__face_t *face, face_sdk__image_t **image);
83 
91 bool FACE_SDK_C_EXPORT face_sdk__face__get_cropped_image(const face_sdk__face_t *face, face_sdk__image_t **image);
92 
100 bool FACE_SDK_C_EXPORT face_sdk__face__has_landmarks(const face_sdk__face_t *face, bool *value);
101 
109 bool FACE_SDK_C_EXPORT face_sdk__face__get_landmarks(const face_sdk__face_t *face, face_sdk__landmark_set_t **landmarks);
110 
118 bool FACE_SDK_C_EXPORT face_sdk__face__is_out_of_bounds_set(const face_sdk__face_t *face, bool *value);
119 
127 bool FACE_SDK_C_EXPORT face_sdk__face__out_of_bounds(const face_sdk__face_t *face, bool *value);
128 
136 bool FACE_SDK_C_EXPORT face_sdk__face__get_version(const face_sdk__face_t *face, uint32_t *value);
137 
145 bool FACE_SDK_C_EXPORT face_sdk__make_face(const face_sdk__image_t *img, face_sdk__face_t **face);
146 
155 bool FACE_SDK_C_EXPORT face_sdk__make_face_1(const face_sdk__image_t *img, uint32_t version, face_sdk__face_t **face);
156 
166 bool FACE_SDK_C_EXPORT face_sdk__make_face_2(const face_sdk__image_t *img,
167  bool out_of_bounds,
168  uint32_t version,
169  face_sdk__face_t **face);
170 
183 bool FACE_SDK_C_EXPORT face_sdk__make_face_3(const face_sdk__image_t *img,
184  int32_t x, int32_t y, int32_t width, int32_t height,
185  float confidence, face_sdk__face_t **face);
186 
200 bool FACE_SDK_C_EXPORT face_sdk__make_face_4(const face_sdk__image_t *img,
201  int32_t x, int32_t y, int32_t width, int32_t height,
202  float confidence,
203  uint32_t version, face_sdk__face_t **face);
204 
219 bool FACE_SDK_C_EXPORT face_sdk__make_face_5(const face_sdk__image_t *img,
220  int32_t x, int32_t y, int32_t width, int32_t height,
221  float confidence,
222  bool out_of_bounds,
223  uint32_t version, face_sdk__face_t **face);
224 
238 bool FACE_SDK_C_EXPORT face_sdk__make_face_6(const face_sdk__image_t *img,
239  int32_t x, int32_t y, int32_t width, int32_t height,
240  float confidence,
241  const face_sdk__landmark_set_t *landmark_set,
242  face_sdk__face_t **face);
243 
258 bool FACE_SDK_C_EXPORT face_sdk__make_face_7(const face_sdk__image_t *img,
259  int32_t x, int32_t y, int32_t width, int32_t height,
260  float confidence,
261  const face_sdk__landmark_set_t *landmark_set,
262  uint32_t version, face_sdk__face_t **face);
263 
279 bool FACE_SDK_C_EXPORT face_sdk__make_face_8(const face_sdk__image_t *img,
280  int32_t x, int32_t y, int32_t width, int32_t height,
281  float confidence,
282  const face_sdk__landmark_set_t *landmark_set,
283  bool out_of_bounds,
284  uint32_t version, face_sdk__face_t **face);
285 
300 bool FACE_SDK_C_EXPORT face_sdk__make_face_9(const face_sdk__image_t *img,
301  int32_t x, int32_t y, int32_t width, int32_t height,
302  float confidence,
303  const face_sdk__landmark_set_t *landmark_set,
304  const face_sdk__image_t *cropped_image, face_sdk__face_t **face);
305 
321 bool FACE_SDK_C_EXPORT face_sdk__make_face_10(const face_sdk__image_t *img,
322  int32_t x, int32_t y, int32_t width, int32_t height,
323  float confidence,
324  const face_sdk__landmark_set_t *landmark_set,
325  const face_sdk__image_t *cropped_image,
326  uint32_t version, face_sdk__face_t **face);
327 
343 bool FACE_SDK_C_EXPORT face_sdk__make_face_11(const face_sdk__image_t *img,
344  int32_t x, int32_t y, int32_t width, int32_t height,
345  float confidence,
346  const face_sdk__landmark_set_t *landmark_set,
347  const face_sdk__image_t *cropped_image,
348  bool out_of_bounds,
349  uint32_t version, face_sdk__face_t **face);
350 
356 void FACE_SDK_C_EXPORT face_sdk__face_free(face_sdk__face_t *face);
357 
360 FACE_SDK_EXTERN_C_END
bool face_sdk__face__get_version(const face_sdk__face_t *face, uint32_t *value)
Retrieves face object version.
bool face_sdk__make_face_8(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, bool out_of_bounds, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence, landmarks, out_of_bounds flag and version.
bool face_sdk__make_face_2(const face_sdk__image_t *img, bool out_of_bounds, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified out of bound flag and version. Bounding box size is set equal to...
bool face_sdk__face__has_landmarks(const face_sdk__face_t *face, bool *value)
Retrieves face landmarks availability.
bool face_sdk__make_face_3(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box and confidence.
bool face_sdk__face__get_img(const face_sdk__face_t *face, face_sdk__image_t **image)
Retrieves original image.
bool face_sdk__face__out_of_bounds(const face_sdk__face_t *face, bool *value)
Retrieves out of bounds state.
bool face_sdk__face__get_x(const face_sdk__face_t *face, int32_t *value)
Retrieves x coordinate of face bounding box in pixels.
bool face_sdk__face__get_confidence(const face_sdk__face_t *face, float *value)
Retrieves face confidence. Range is from 0.0f to 1.0f where 1.0f is definitely a face.
bool face_sdk__make_face_4(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence and version.
bool face_sdk__make_face_10(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, const face_sdk__image_t *cropped_image, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence, landmarks, cropped_image version.
bool face_sdk__face__is_out_of_bounds_set(const face_sdk__face_t *face, bool *value)
Retrieves out of bounds feature availability.
bool face_sdk__make_face(const face_sdk__image_t *img, face_sdk__face_t **face)
Makes the face object. Bounding box size is set equal to the original image size. ...
bool face_sdk__face__get_y(const face_sdk__face_t *face, int32_t *value)
Retrieves y coordinate of face bounding box in pixels.
bool face_sdk__make_face_9(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, const face_sdk__image_t *cropped_image, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence, landmarks and cropped i...
bool face_sdk__face__get_landmarks(const face_sdk__face_t *face, face_sdk__landmark_set_t **landmarks)
Retrieves set of 10 predicted landmarks.
bool face_sdk__make_face_6(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence and landmarks.
An image keeps bitmap data in 24bpp RBG format.
Definition: image.h:23
bool face_sdk__face__get_width(const face_sdk__face_t *face, int32_t *value)
Retrieves width of face bounding box in pixels.
Set of face landmarks.
Definition: landmark_set.h:20
bool face_sdk__face__get_cropped_image(const face_sdk__face_t *face, face_sdk__image_t **image)
The cropped image (Not all detector versions support this method. If supported function will return f...
bool face_sdk__make_face_11(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, const face_sdk__image_t *cropped_image, bool out_of_bounds, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, landmarks, cropped_image, out_of_bounds flag and version.
bool face_sdk__make_face_1(const face_sdk__image_t *img, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified version. Bounding box size is set equal to the original image si...
The face object. Face object contains information about face bounding box on the image and the origin...
Definition: face.h:27
bool face_sdk__make_face_5(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, bool out_of_bounds, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence, out_of_bounds flag and ...
bool face_sdk__face__get_height(const face_sdk__face_t *face, int32_t *value)
Retrieves height of face bounding box in pixels.
bool face_sdk__make_face_7(const face_sdk__image_t *img, int32_t x, int32_t y, int32_t width, int32_t height, float confidence, const face_sdk__landmark_set_t *landmark_set, uint32_t version, face_sdk__face_t **face)
Makes the face object with specified coordinates of bounding box, confidence, landmarks and version...
void face_sdk__face_free(face_sdk__face_t *face)
Destroys face_sdk__face object.