DocumentReader.extractFace Method¶
Module: DocumentReader
Definition¶
Extracts a crop of the face in a document.
extract_face(self, image: DocumentImage, document_name: str) -> DocumentImage
Parameters
imageDocumentImagein The image that contains the document. Must be a realigned BGR image of the document.document_namestrin The name of the document to be searched. Must be a key loaded in DocumentLibrary.
Returns
The cropped image of the face.
Exceptions
An error has occurred during Document Library execution.
DocumentImage extractFace(DocumentImage image, String? documentName)
Parameters
imageDocumentImagein The image that contains the document. Must be a realigned BGR image of the document.documentNameStringin The name of the document to be searched. Must be a key loaded in DocumentLibrary.
Returns
The cropped image of the face.
Exceptions
An error has occurred during Document Library execution.
public DocumentImage ExtractFace(DocumentImage image, string documentName)
Parameters
imageDocumentImagein The image that contains the document. Must be a realigned BGR image of the document.documentNamestringin The name of the document to be searched. Must be a key loaded in DocumentLibrary.
Returns
The cropped image of the face.
Exceptions
An error has occurred during Document Library execution.
public DocumentImage extractFace(DocumentImage image, String documentName) throws DocumentException
Parameters
imageDocumentImagein The image that contains the document. Must be a realigned BGR image of the document.documentNameStringin The name of the document to be searched. Must be a key loaded in DocumentLibrary.
Returns
The cropped image of the face.
Exceptions
An error has occurred during Document Library execution.
public func extractFace(image: DocumentImage, documentName: String) throws -> DocumentImage
Parameters
imageDocumentImagein The image that contains the document. Must be a realigned BGR image of the document.documentNameStringin The name of the document to be searched. Must be a key loaded in DocumentLibrary.
Returns
The cropped image of the face.
Exceptions
An error has occurred during Document Library execution.
int id3DocumentReader_ExtractFace (
ID3_DOCUMENT_READER hDocumentReader,
ID3_DOCUMENT_IMAGE hImage,
const char * documentName,
ID3_DOCUMENT_IMAGE hCroppedFace)
Parameters
hDocumentReaderID3_DOCUMENT_READERin Handle to the DocumentReader object.hImageID3_DOCUMENT_IMAGEin The image that contains the document. Must be a realigned BGR image of the document.documentNameconst char *in The name of the document to be searched. Must be a key loaded in DocumentLibrary.hCroppedFaceID3_DOCUMENT_IMAGEout The cropped image of the face.
Returns