DocumentReader.readField Method¶
Module: DocumentReader
Definition¶
Reads a single field in a document.
read_field(self, image: DocumentImage, document_name: str, field_name: str) -> TextField
Parameters
image
DocumentImagein The image that contains the document. Must be a realigned BGR image of the document.document_name
strin The name of the document to be searched. Must be a key loaded in DocumentLibrary.field_name
strin The name of the field to search.
Returns
Read Text in the specified field.
Exceptions
An error has occurred during Document Library execution.
TextField readField(DocumentImage image, String? documentName, String? fieldName)
Parameters
image
DocumentImagein The image that contains the document. Must be a realigned BGR image of the document.documentName
Stringin The name of the document to be searched. Must be a key loaded in DocumentLibrary.fieldName
Stringin The name of the field to search.
Returns
Read Text in the specified field.
Exceptions
An error has occurred during Document Library execution.
public TextField ReadField(DocumentImage image, string documentName, string fieldName)
Parameters
image
DocumentImagein The image that contains the document. Must be a realigned BGR image of the document.documentName
stringin The name of the document to be searched. Must be a key loaded in DocumentLibrary.fieldName
stringin The name of the field to search.
Returns
Read Text in the specified field.
Exceptions
An error has occurred during Document Library execution.
public TextField readField(DocumentImage image, String documentName, String fieldName) throws DocumentException
Parameters
image
DocumentImagein The image that contains the document. Must be a realigned BGR image of the document.documentName
Stringin The name of the document to be searched. Must be a key loaded in DocumentLibrary.fieldName
Stringin The name of the field to search.
Returns
Read Text in the specified field.
Exceptions
An error has occurred during Document Library execution.
public func readField(image: DocumentImage, documentName: String, fieldName: String) throws -> TextField
Parameters
image
DocumentImagein The image that contains the document. Must be a realigned BGR image of the document.documentName
Stringin The name of the document to be searched. Must be a key loaded in DocumentLibrary.fieldName
Stringin The name of the field to search.
Returns
Read Text in the specified field.
Exceptions
An error has occurred during Document Library execution.
int id3DocumentReader_ReadField (
ID3_DOCUMENT_READER hDocumentReader,
ID3_DOCUMENT_IMAGE hImage,
const char * documentName,
const char * fieldName,
ID3_DOCUMENT_TEXT_FIELD hReadText)
Parameters
hDocumentReader
ID3_DOCUMENT_READERin Handle to the DocumentReader object.hImage
ID3_DOCUMENT_IMAGEin The image that contains the document. Must be a realigned BGR image of the document.documentName
const char *in The name of the document to be searched. Must be a key loaded in DocumentLibrary.fieldName
const char *in The name of the field to search.hReadText
ID3_DOCUMENT_TEXT_FIELDout Read Text in the specified field.
Returns