Interface for CTextRecognition wrapper.
More...
Go to the source code of this file.
|
| CTextRecognition | CTextRecognition_Create (const CIDRS argIdrs, idrs_exception *pargException) |
| | Creates a new instance of this class and associates the provided.
|
| |
| CTextRecognition | CTextRecognition_Create2 (const CIDRS argIdrs, const COcrParams argOcrParams, idrs_exception *pargException) |
| | Creates a new instance of this class and associates the provided.
|
| |
| COcrParams | CTextRecognition_GetOcrParams (const CTextRecognition argCTextRecognition, idrs_exception *pargException) |
| | Gets the parameters used for the ocr (language(s), full page/zonal recognition, etc)
|
| |
| void | CTextRecognition_SetOcrParams (CTextRecognition argCTextRecognition, const COcrParams argOcrParams, idrs_exception *pargException) |
| | Sets the parameters used for the ocr (language(s), full page/zonal recognition, etc)
|
| |
| IProgressPageProcessing | CTextRecognition_GetProgressCallback (const CTextRecognition argCTextRecognition, idrs_exception *pargException) |
| | Gets the callback used to notify about text recognition progress.
|
| |
| void | CTextRecognition_SetProgressCallback (CTextRecognition argCTextRecognition, IProgressPageProcessing argpProgressCallback, idrs_exception *pargException) |
| | Sets the callback used to notify about text recognition progress.
|
| |
| CPageContent | CTextRecognition_RecognizeText (const CTextRecognition argCTextRecognition, const CImage argImage, idrs_exception *pargException) |
| | Runs CProgressTextRecognition and returns the recognized text.
|
| |
| void | CTextRecognition_RecognizeText2 (const CTextRecognition argCTextRecognition, CPage argPage, idrs_exception *pargException) |
| | Runs CProgressTextRecognition and returns the recognized text.
|
| |
| void | CTextRecognition_Destroy (CTextRecognition argCTextRecognition, idrs_exception *pargException) |
| | Destroys a CTextRecognition handle.
|
| |
Interface for CTextRecognition wrapper.
◆ CTextRecognition_Create()
| CTextRecognition CTextRecognition_Create |
( |
const CIDRS |
argIdrs, |
|
|
idrs_exception * |
pargException |
|
) |
| |
Creates a new instance of this class and associates the provided.
- See also
- CIDRS handle to it.
- Parameters
-
| argIdrs | CIDRS instance |
| pargException | Pointer to exception structure that will be filled if an exception occurs |
◆ CTextRecognition_Create2()
Creates a new instance of this class and associates the provided.
- See also
- CIDRS handle and ocr parameters
- Parameters
-
| argIdrs | CIDRS instance |
| argOcrParams | Object containing the ocr parameters |
| pargException | Pointer to exception structure that will be filled if an exception occurs |
◆ CTextRecognition_Destroy()
| void CTextRecognition_Destroy |
( |
CTextRecognition |
argCTextRecognition, |
|
|
idrs_exception * |
pargException |
|
) |
| |
Destroys a CTextRecognition handle.
- Parameters
-
| argCTextRecognition | CTextRecognition handle to destroy |
| pargException | Pointer to exception structure that will be filled if an exception occurs |
◆ CTextRecognition_GetOcrParams()
Gets the parameters used for the ocr (language(s), full page/zonal recognition, etc)
By default, the ocr runs on full page with english language enabled
- Returns
- Parameters used for ocr.
- Parameters
-
| argCTextRecognition | CTextRecognition handle |
| pargException | Pointer to exception structure that will be filled if an exception occurs |
◆ CTextRecognition_GetProgressCallback()
Gets the callback used to notify about text recognition progress.
The callback mechanism also allows stopping the text recognition. See
- See also
- CProgressTextRecognition for more details
By default, there's no callback defined for text recognition, so the returned value will be NULL
- Returns
- Pointer to the current progress callback object.
- Parameters
-
| argCTextRecognition | CTextRecognition handle |
| pargException | Pointer to exception structure that will be filled if an exception occurs |
◆ CTextRecognition_RecognizeText()
Runs CProgressTextRecognition and returns the recognized text.
- Parameters
-
| argCTextRecognition | CTextRecognition handle |
| argImage | Image on which text recognition will be run |
| pargException | Pointer to exception structure that will be filled if an exception occurs |
- Returns
- CPageContent object contained the recognized text split in words, lines, paragraphs, etc
◆ CTextRecognition_RecognizeText2()
| void CTextRecognition_RecognizeText2 |
( |
const CTextRecognition |
argCTextRecognition, |
|
|
CPage |
argPage, |
|
|
idrs_exception * |
pargException |
|
) |
| |
Runs CProgressTextRecognition and returns the recognized text.
- Parameters
-
| argCTextRecognition | CTextRecognition handle |
| argPage | Page on which text recognition will be run. The page's content will be updated with the results of ocr |
| pargException | Pointer to exception structure that will be filled if an exception occurs |
◆ CTextRecognition_SetOcrParams()
| void CTextRecognition_SetOcrParams |
( |
CTextRecognition |
argCTextRecognition, |
|
|
const COcrParams |
argOcrParams, |
|
|
idrs_exception * |
pargException |
|
) |
| |
Sets the parameters used for the ocr (language(s), full page/zonal recognition, etc)
By default, the ocr runs on full page with english language enabled
- Parameters
-
| argCTextRecognition | CTextRecognition handle |
| argOcrParams | Parameters used for ocr. |
| pargException | Pointer to exception structure that will be filled if an exception occurs |
◆ CTextRecognition_SetProgressCallback()
Sets the callback used to notify about text recognition progress.
The callback mechanism also allows stopping the text recognition. See
- See also
- CProgressTextRecognition for more details
- Parameters
-
| argCTextRecognition | CTextRecognition handle |
| argpProgressCallback | Pointer to the progress callback object to set. |
| pargException | Pointer to exception structure that will be filled if an exception occurs |