Differences
This shows you the differences between two versions of the page.
| Both sides previous revision Previous revision Next revision | Previous revision | ||
|
en:face_api [2020/10/22 09:45] kkshin [FaceEx API] |
en:face_api [2025/02/18 11:36] (current) alex Update rawImageData description |
||
|---|---|---|---|
| Line 2: | Line 2: | ||
| This API allows to scan/verify the face template. | This API allows to scan/verify the face template. | ||
| - | * [[BS2_ScanFace]]: ''FaceStation2'' Scans the face from a device and extracts template and image data. | + | * [[BS2_ScanFace]]: ''IR Face based'' Scans the face from a device and extracts template and image data. |
| * [[BS2_GetAuthGroup]]: Retrieves selected authentication groups. | * [[BS2_GetAuthGroup]]: Retrieves selected authentication groups. | ||
| * [[BS2_GetAllAuthGroup]]: Retrieves all authentication groups. | * [[BS2_GetAllAuthGroup]]: Retrieves all authentication groups. | ||
| Line 10: | Line 10: | ||
| ====== FaceEx API ====== | ====== FaceEx API ====== | ||
| - | * [[BS2_ScanFaceEx]]: ''FaceStation F2'' Scans the face from a device and extracts template and image data. [+ 2.7.1] | + | * [[BS2_ScanFaceEx]]: ''Visual Face based'' Scans the face from a device and extracts template and image data. [+ 2.7.1] |
| - | * [[BS2_ExtraceTemplateFaceEx]]: ''FaceStation F2'' Extracts template data by the face image. [+ 2.7.1] | + | * [[BS2_ExtraceTemplateFaceEx]]: ''Visual Face based'' Extracts template data by the face image. [+ 2.7.1] |
| + | * [[BS2_GetNormalizedImageFaceEx]]: ''Visual Face based'' Create a WARP image with an un-warped (unprocessed) face image. [+ 2.8] | ||
| ===== Structure ===== | ===== Structure ===== | ||
| Line 35: | Line 35: | ||
| Number of face templates. \\ \\ | Number of face templates. \\ \\ | ||
| 3. //flag// \\ | 3. //flag// \\ | ||
| - | Not used. \\ \\ | + | This values is used inside the device based on FaceStation2 V1.4.0 and FaceLite V1.2.0. \\ |
| + | The flag value received from the device can be used, but if it is not known, it can be set to 0. \\ \\ | ||
| 4. //reserved// \\ | 4. //reserved// \\ | ||
| Reserved space. \\ \\ | Reserved space. \\ \\ | ||
| Line 72: | Line 73: | ||
| } BS2TemplateEx; | } BS2TemplateEx; | ||
| </code> | </code> | ||
| - | ''FaceStation F2'' \\ \\ | + | ''Visual Face based'' \\ \\ |
| 1. //data// \\ | 1. //data// \\ | ||
| IR or visual image template data \\ \\ | IR or visual image template data \\ \\ | ||
| Line 101: | Line 102: | ||
| uint8_t *rawImageData; | uint8_t *rawImageData; | ||
| + | |||
| + | BS2TemplateEx *onlyTemplateEx; | ||
| }; | }; | ||
| } BS2FaceEx; | } BS2FaceEx; | ||
| </code> | </code> | ||
| - | ''FaceStation F2'' \\ \\ | + | ''Visual Face based'' \\ \\ |
| 1. //faceIndex// \\ | 1. //faceIndex// \\ | ||
| Index of face \\ \\ | Index of face \\ \\ | ||
| Line 110: | Line 113: | ||
| The number of template including Visual, IR \\ \\ | The number of template including Visual, IR \\ \\ | ||
| 3. //flag// \\ | 3. //flag// \\ | ||
| - | Flag whether the image is a WARPed image. \\ | + | Flag whether the image is a WARPed image. \\ |
| WARP is a kind of generalization that extracts the face among the physical image which contains different body parts. \\ | WARP is a kind of generalization that extracts the face among the physical image which contains different body parts. \\ | ||
| When flag is set to 1, the device refers to 5 pieces of information defined by the struct in the union. \\ | When flag is set to 1, the device refers to 5 pieces of information defined by the struct in the union. \\ | ||
| Line 118: | Line 121: | ||
| When this happens, the device will automatically go through the WARP process with rawImageData and fill in the information in the struct. \\ | When this happens, the device will automatically go through the WARP process with rawImageData and fill in the information in the struct. \\ | ||
| Please note that rawImageData and struct are tied in an union. \\ | Please note that rawImageData and struct are tied in an union. \\ | ||
| + | [+ 2.9.6] An option BS2_FACE_EX_FLAG_TEMPLATE_ONLY(0x20) has been added to allow transmitting only the template excluding the facial image when sending facial data. \\ | ||
| + | This is particularly useful in environments where privacy protection is emphasized. \\ | ||
| + | When using this option, the onlyTemplateEx should be allocated with template data for each numOfTemplate. \\ | ||
| + | Additionally, unableToSaveImageOfVisualFace in [[configuration_api#BS2FaceConfig]] must be set to 1 (true). \\ | ||
| <WRAP group 50%> | <WRAP group 50%> | ||
| ^Value ^Description ^ | ^Value ^Description ^ | ||
| |BS2_FACE_EX_FLAG_NONE |0x00 | | |BS2_FACE_EX_FLAG_NONE |0x00 | | ||
| |BS2_FACE_EX_FLAG_WARPED |0x01 | | |BS2_FACE_EX_FLAG_WARPED |0x01 | | ||
| + | |BS2_FACE_EX_FLAG_TEMPLATE_ONLY |0x20 | | ||
| |BS2_FACE_EX_FLAG_ALL |0xFF | | |BS2_FACE_EX_FLAG_ALL |0xFF | | ||
| </WRAP> | </WRAP> | ||
| Line 133: | Line 141: | ||
| Unused space. (for packing) \\ \\ | Unused space. (for packing) \\ \\ | ||
| 8. //imageData// \\ | 8. //imageData// \\ | ||
| - | WARPed facial image data. This is made by rawImageData automatically. \\ \\ | + | WARPed facial image data. This is made by rawImageData automatically. \\ |
| + | <WRAP group 70%> | ||
| + | ^Device type ^Version ^FW version ^Image size ^Image type ^''rawImageData'' ^ | ||
| + | |FaceStation F2 |V1 |less than 2.0.0 |250 * 250 |JPG |JPG | | ||
| + | |FaceStation F2 |V2 |2.0.0 or later |112 * 112 |PNG |JPG, PNG | | ||
| + | |BioStation 3 |V1 |All version |112 * 112 |PNG |JPG, PNG | | ||
| + | </WRAP> | ||
| 9. //irImageData// \\ | 9. //irImageData// \\ | ||
| IR image data. IR image might not exist in the WARP process. \\ | IR image data. IR image might not exist in the WARP process. \\ | ||
| - | It is generated automatically when trying authentication. \\ | + | It is generated automatically when trying authentication. \\ \\ |
| 10. //templateEx// \\ | 10. //templateEx// \\ | ||
| Template data of Visual or IR image \\ \\ | Template data of Visual or IR image \\ \\ | ||
| 11. //rawImageData// \\ | 11. //rawImageData// \\ | ||
| - | Non-WARPed image data \\ \\ | + | Non-WARPed image data. See ''imageData'' \\ |
| + | The maximum resolution for an unwarped image is 4000 pixels in both width and height. However, a resolution of 1920 pixels or less is recommended. \\ | ||
| + | A clear and high-quality facial image is recommended. If the original image is blurred or distorted, Warped Image generation may fail.\\ | ||
| + | It is recommended to use an image where the total image width is at least 190% larger than the face width. \\ \\ | ||
| + | 12. //onlyTemplateEx// \\ | ||
| + | [+ 2.9.6] This represents contiguous memory information of BS2TemplateEx data, which is template information, and must be allocated as many as numOfTemplate. \\ | ||
| + | This is only used when the flag is BS2_FACE_EX_FLAG_TEMPLATE_ONLY. \\ \\ | ||