DocumentReader.readDocument Method¶
Module: DocumentReader
Definition¶
Reads all the fields in a document.
read_document(self, image: DocumentImage, document_name: str) -> TextFieldList
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
A list of all the text fields read in the document.
Exceptions
An error has occurred during Document Library execution.
TextFieldList readDocument(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
A list of all the text fields read in the document.
Exceptions
An error has occurred during Document Library execution.
public TextFieldList ReadDocument(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
A list of all the text fields read in the document.
Exceptions
An error has occurred during Document Library execution.
public TextFieldList readDocument(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
A list of all the text fields read in the document.
Exceptions
An error has occurred during Document Library execution.
public func readDocument(image: DocumentImage, documentName: String) throws -> TextFieldList
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
A list of all the text fields read in the document.
Exceptions
An error has occurred during Document Library execution.
int id3DocumentReader_ReadDocument (
ID3_DOCUMENT_READER hDocumentReader,
ID3_DOCUMENT_IMAGE hImage,
const char * documentName,
ID3_DOCUMENT_TEXT_FIELD_LIST hReadTexts)
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.hReadTextsID3_DOCUMENT_TEXT_FIELD_LISTout A list of all the text fields read in the document.
Returns