iDRS™ SDK 16
Loading...
Searching...
No Matches
CPageProcessing_interface.h
Go to the documentation of this file.
1
7#ifndef CPAGEPROCESSING_INTERFACE_H
8
9#define CPAGEPROCESSING_INTERFACE_H
10
11#include "CObjPtr_interface.h"
12#include "CPageAnalysisParams_interface.h"
13#include "CBarcodeParams_interface.h"
14#include "COcrParams_interface.h"
15#include "IProgressPageProcessing_interface.h"
16
17#include "idrs_common.h"
18
19#ifdef __cplusplus
20extern "C" {
21#endif
22
31CPageProcessing CPageProcessing_Create(CIDRS argIdrs, idrs_exception *pargException);
32
42CPageAnalysisParams CPageProcessing_GetPageAnalysisParams(const CPageProcessing argCPageProcessing, idrs_exception *pargException);
43
55void CPageProcessing_SetPageAnalysisParams(CPageProcessing argCPageProcessing, const CPageAnalysisParams argPageAnalysisParams, idrs_exception *pargException);
56
64IDRS_BOOL CPageProcessing_GetRunPageAnalysis(const CPageProcessing argCPageProcessing, idrs_exception *pargException);
65
73void CPageProcessing_SetRunPageAnalysis(CPageProcessing argCPageProcessing, IDRS_BOOL const bAnalysePage, idrs_exception *pargException);
74
82IDRS_BOOL CPageProcessing_GetRunBarcodeDetection(const CPageProcessing argCPageProcessing, idrs_exception *pargException);
83
91void CPageProcessing_SetRunBarcodeDetection(CPageProcessing argCPageProcessing, IDRS_BOOL const bDetectBarcodes, idrs_exception *pargException);
92
100IDRS_BOOL CPageProcessing_GetRunTextRecognition(const CPageProcessing argCPageProcessing, idrs_exception *pargException);
101
109void CPageProcessing_SetRunTextRecognition(CPageProcessing argCPageProcessing, IDRS_BOOL const bRecognizeText, idrs_exception *pargException);
110
120CBarcodeParams CPageProcessing_GetBarcodeParams(const CPageProcessing argCPageProcessing, idrs_exception *pargException);
121
131void CPageProcessing_SetBarcodeParams(CPageProcessing argCPageProcessing, const CBarcodeParams argBarcodeParams, idrs_exception *pargException);
132
142COcrParams CPageProcessing_GetOcrParams(const CPageProcessing argCPageProcessing, idrs_exception *pargException);
143
158void CPageProcessing_SetOcrParams(CPageProcessing argCPageProcessing, const COcrParams argOcrParams, idrs_exception *pargException);
159
171IProgressPageProcessing CPageProcessing_GetProgressCallback(const CPageProcessing argCPageProcessing, idrs_exception *pargException);
172
184void CPageProcessing_SetProgressCallback(CPageProcessing argCPageProcessing, IProgressPageProcessing pProgressCallback, idrs_exception *pargException);
185
197void CPageProcessing_ProcessPage(CPageProcessing argCPageProcessing, CPage argPage, idrs_exception *pargException);
198
206void CPageProcessing_Destroy(CPageProcessing argCPageProcessing, idrs_exception *pargException);
207
208#ifdef __cplusplus
209}
210#endif /* __cplusplus */
211
212#endif /* CPAGEPROCESSING_INTERFACE_H */
CBarcodeParams_interface.h
Interface for CBarcodeParams wrapper.
CObjPtr_interface.h
Interface for CObjPtr wrapper.
COcrParams_interface.h
Interface for COcrParams wrapper.
CPageAnalysisParams_interface.h
Interface for CPageAnalysisParams wrapper.
CPageProcessing_GetPageAnalysisParams
CPageAnalysisParams CPageProcessing_GetPageAnalysisParams(const CPageProcessing argCPageProcessing, idrs_exception *pargException)
Gets the parameters used for the page analysis (language detection, orientation detection,...
CPageProcessing_GetRunPageAnalysis
IDRS_BOOL CPageProcessing_GetRunPageAnalysis(const CPageProcessing argCPageProcessing, idrs_exception *pargException)
Gets the boolean flag that enables/disables the page analysis.
CPageProcessing_GetRunTextRecognition
IDRS_BOOL CPageProcessing_GetRunTextRecognition(const CPageProcessing argCPageProcessing, idrs_exception *pargException)
Gets the boolean flag that enables/disables the text recognition.
CPageProcessing_GetProgressCallback
IProgressPageProcessing CPageProcessing_GetProgressCallback(const CPageProcessing argCPageProcessing, idrs_exception *pargException)
Gets the callback used to notify about page processing progress.
CPageProcessing_SetPageAnalysisParams
void CPageProcessing_SetPageAnalysisParams(CPageProcessing argCPageProcessing, const CPageAnalysisParams argPageAnalysisParams, idrs_exception *pargException)
Gets the parameters used for the page analysis (language detection, orientation detection,...
CPageProcessing_Create
CPageProcessing CPageProcessing_Create(CIDRS argIdrs, idrs_exception *pargException)
Creates a new instance of this class and associates the provided.
CPageProcessing_SetOcrParams
void CPageProcessing_SetOcrParams(CPageProcessing argCPageProcessing, const COcrParams argOcrParams, idrs_exception *pargException)
Sets the parameters used for the ocr (language(s), full page/zonal recognition, etc).
CPageProcessing_SetRunBarcodeDetection
void CPageProcessing_SetRunBarcodeDetection(CPageProcessing argCPageProcessing, IDRS_BOOL const bDetectBarcodes, idrs_exception *pargException)
Sets the boolean flag that enables/disables the barcode detection.
CPageProcessing_Destroy
void CPageProcessing_Destroy(CPageProcessing argCPageProcessing, idrs_exception *pargException)
Destroys a CPageProcessing handle.
CPageProcessing_GetRunBarcodeDetection
IDRS_BOOL CPageProcessing_GetRunBarcodeDetection(const CPageProcessing argCPageProcessing, idrs_exception *pargException)
Gets the boolean flag that enables/disables the barcode detection.
CPageProcessing_ProcessPage
void CPageProcessing_ProcessPage(CPageProcessing argCPageProcessing, CPage argPage, idrs_exception *pargException)
Runs the page processing. This method is executing the following operations (if enabled),...
CPageProcessing_SetRunPageAnalysis
void CPageProcessing_SetRunPageAnalysis(CPageProcessing argCPageProcessing, IDRS_BOOL const bAnalysePage, idrs_exception *pargException)
Sets the boolean flag that enables/disables the page analysis.
CPageProcessing_SetRunTextRecognition
void CPageProcessing_SetRunTextRecognition(CPageProcessing argCPageProcessing, IDRS_BOOL const bRecognizeText, idrs_exception *pargException)
Sets the boolean flag that enables/disables the text recognition.
CPageProcessing_SetProgressCallback
void CPageProcessing_SetProgressCallback(CPageProcessing argCPageProcessing, IProgressPageProcessing pProgressCallback, idrs_exception *pargException)
Sets the callback used to notify about page processing progress.
CPageProcessing_SetBarcodeParams
void CPageProcessing_SetBarcodeParams(CPageProcessing argCPageProcessing, const CBarcodeParams argBarcodeParams, idrs_exception *pargException)
Sets the parameters used for barcode detection.
CPageProcessing_GetOcrParams
COcrParams CPageProcessing_GetOcrParams(const CPageProcessing argCPageProcessing, idrs_exception *pargException)
Gets the parameters used for the ocr (language(s), full page/zonal recognition, etc)
CPageProcessing_GetBarcodeParams
CBarcodeParams CPageProcessing_GetBarcodeParams(const CPageProcessing argCPageProcessing, idrs_exception *pargException)
Gets the parameters used for the detection (barcode type(s), full page/zonal recognition,...
IProgressPageProcessing_interface.h
Interface for IProgressPageProcessing wrapper.
CBarcodeParams
CBarcodeParams represents the base class for the barcode parameters containing the configuration for ...
COcrParams
Base class for OCR parameters.
CPageAnalysisParams
CPageAnalysisParams contains the configuration for page analysis.
CPage
The CPage class manages a page in the IDRS.
CPageProcessing
CPageProcessing exposes all recognition features of iDRS SDK: page analysis, text recognition and bar...
IProgressPageProcessing
CProgressTextRecognition defines the interface required to monitor page processing progress.
idrs_common.h
IDRS_BOOL
IDRS_INT IDRS_BOOL
A Boolean value.
Definition idrsstd_interface.h:37