| ►NIDRSNET | |
| ►NExperimental | |
| CCDataExtraction | CDataExtraction is the main class used for data extraction feature: |
| CCDateSearchContext | Context class for date searches |
| CCDocumentProcessing | Encapsulates a workflow of page analysis, OCR and output to different formats. It is designed to use an optimal threading strategy, using inter-page (instead of intra-page) multithreading of the OCR engine, as well as an optimal memory usage, where each page is automatically discarded once it has been processed, and the number of pages in-flight as any one time is limited |
| CCDocumentProcessingResult | Represents the result of a document processing operation |
| CCIDRSExt | Represent special instances of CIDRS objects that contain a thread pool with a fixed number of threads. Objects taking advantage of CIDRSExt will use that thread pool to perform asynchronous operations. The threads remain alive for the whole lifetime of the object |
| CCNumberSearchContext | Context class for number searches |
| CCRegexSearchContext | Context class for regex searches |
| CCSearchContext | Base class for data search contexts |
| CCSearchMatch | Represents a potential match for a given search |
| CCSearchResult | CDataExtractionResult contains the results of a data extraction run |
| CCTextSearchContext | Context class for regex searches |
| CCAttachment | CAttachment represent an attachment to add to an output PDF |
| CCBarcode | CBarcode contains the data associated with a barcode result. Instances of this class are usually created during the barcode detection process |
| CCBarcodeAdvancedParameters | Public Class that manages advanced barcode recognition parameters. It let the integrator specify advanced parameters for a specific barcode type: |
| CCBarcodeContext | Manages a barcode recognition context.A barcode recognition context is a set of parameters used by the barcode engine to process images. When more than one barcode type is enable and a barcode may be recognized by different algorithms (with possible different solutions), the barcode is rejected except when: |
| CCBarcodeDetection | CBarcodeDetection is the main class used for barcode detection feature This class allows the following operations |
| CCBarcodeEngineConfig | CBarcodeEngineConfig contains the configuration for a barcode engine. This class allows the barcode engines to define the following characteristics: |
| CCBarcodeEngineManager | CBarcodeEngineManager class contains the registry for all barcode engines available in iDRS SDK. The class allows easy integration of 3rd party barcode engines The class provides static methods for dealing with the barcode registration registration. It is not expected to be instantiated. The class will maintain a list with references to the available barcode engines |
| CCBarcodeEnginePreprocessDitherRemoval | CBarcodeEnginePreprocessDitherRemoval represents the an implementation of IBarcodeEnginePreprocess that offers dither removal |
| CCBarcodeEnginePreprocessWhitePixelsRemoval | CBarcodeEnginePreprocessWhitePixelRemoval represents the an implementation of IBarcodeEnginePreprocess that offers white pixels removal This preprocessing operation will use the same operations as CAdvancedDespeckle |
| CCBarcodePageParams | CBarcodePageParams contains the configuration for full page barcode detection. This class allows setting the following barcode detection options: |
| CCBarcodeParams | CBarcodeParams represents the base class for the barcode parameters containing the configuration for barcode detection. This class allows setting the following barcode detection options: |
| CCBarcodeSpecificOptions | CBarcodeSpecificOptions contains some specific options for some specific barcode types |
| CCBarcodeSpecificOptionsCode128 | CBarcodeSpecificOptions contains some specific options for code128 barcode type the specific options are: control code mode and mapping |
| CCBarcodeValidationCriteria | CBarcodeValidationCriteria contains detailed parametes for barcode validation This class allows setting the following barcode validation options: |
| CCBarcodeZonalParams | CBarcodeZonalParams contains the configuration for zonal barcode detection. This class allows setting the zonal configuration for barcode detection |
| CCBarcodeZonalSettings | CBarcodeZonalSettings contains the configuration for a set of zones where barcode detection will be executed with the same CBarcodeContext This class allows setting following options fo the zonal configuration for barcode detection: |
| CCBinarize | Offers image binarization featuresBinarization is the first stage in image recognition. It convert the input image into a black & white image for faster processing. The CBinarize class offers the following image binarization algorithms: |
| CCBlankImageDetection | Offers blank image detection featuresIt contains an implementation of blank image detection algorithm that is able to detect whether a image contains any useful information. The algorithm can work with images obtained from various paper sources, like glaring white, yellow old paper or gray recycled paper |
| CCBookmarksOptions | CBookmarksOptions class defines all bookmarks options |
| CCConsoleLogger | IDRS implementation of the ILogger interface. It exposes a default iDRS Logger that can be used to log messages during an operation. This class will print log messages in console. Log entries are expressed by this class as per the following pattern: YYYY-MM-DD hh:mm:ss [severity level] [message] |
| CCDarkBordersRemoval | Dark borders removal capabilities.It features an algorithm for automatic dark border detection and removal in all types of images: monochrome, grayscale or color. The integrator can also specify threshold under which the border pixels are considered "dark" by the dark border removal algorithm. If not, the algorithm will use the following predefined values for the definition of "dark" borders: |
| CCDefaultPageCollection | CDefaultPageCollection is the default implementation for the IPageCollection interface. This default implementation will store pages in memory until a given memory treshold is reached, after which pages will be stored on disk as temporary files. This behavior can be configured via the StorageOptions property. This means that this default implementation is able to automatically: |
| CCDeskew | Offers deskew image correction.Deskew image correction is normally used for images that were scanned misaligned or photographed from a low angle Deskew/Skew angles are calculated counter-clockwise |
| CCDespeckle | Image noise reduction features via an image despeckle filterIt works only with black and white images |
| CCDigitalCertificate | CDigitalCertificate manages the digital certificate content |
| CCDigitalSignature | CDigitalSignature container class that manages all signature aspects (digital certificate, UI content and page index) |
| CCDitherRemoval | CDitherRemoval attempts to perform the reversal of image dithering, which is a common technique for printing with inkjet printers. Dithering is analogous to the halftone technique used in printing. Due to the fact that during the dithering process a part of the image information is lost, the resulting image after the dithering removal will not be the same as the original. However, the resulting image would improve the recognition rate of iDRS recognition engines (both OCR and barcode) |
| CCDocument | CDocument class represents a document composed of a set of CPage elements |
| CCDocumentMetadata | CDocumentMetadata class represents the set of metadata defined at the document level |
| CCDocumentSeparationOptions | CDocumentSeparationOptions class is used to specify the document separation rules The class allows splitting documents based on rules defined in iDRS. The separation can be either done by size or user defined by means of a custom callback |
| CCDocumentWriter | Exports iDRS structures to external file formats |
| CCDocxOutputParams | CDocxOutputParams class manages the parameters to create a docx file |
| CCEncryptionOptions | CEncryptionOptions manages the PDF Security parameters |
| CCEpubOutputParams | CEpubOutputParams class manages the parameters to create an Epub file |
| CCFileLogger | IDRS implementation of the ILogger interface. It exposes a default iDRS Logger that can be used to log messages during an operation. This class will write log messages to a file on disk. Note that each instance of CFileLogger must use a unique file. Having several loggers using the same file results in undefined behavior. Log entries are expressed by this class as per the following pattern: YYYY-MM-DD hh:mm:ss [severity level] [message] |
| CCFormAction | Class CFormAction represents the base class for all types of interactive form actions available in iDRS SDK |
| CCFormCheckboxField | Class CFormPasswordField represents a checkbox form field |
| CCFormCombedTextField | Class CFormTextField represents a text input form field |
| CCFormDropdownField | Class that represents a Dropdown form field with an optional text input (Combo-box mode) |
| CCFormField | Class CFormField represents the base class for all types of form fields available in iDRS SDK |
| CCFormFieldGroup | Class CFormRadioButtonGroup represents a group of related radio button fields |
| CCFormFieldOptionItem | CFormFieldValueData represents the value of an item of a choice form field |
| CCFormFieldStyle | Class CFormFieldStyle represents the styling information applying to a group or a single form field (CFormField) |
| CCFormJavaScriptAction | Class CFormAction represents the base class for all types of interactive form actions available in iDRS SDK |
| CCFormListBoxField | Class that represents a list box form field |
| CCFormPasswordField | Class CFormPasswordField represents a password input form field |
| CCFormRadioButtonField | Class CFormRadioButtonGroup represents a group of related radio button fields |
| CCFormRadioButtonItem | Class CFormRadioButtonField represents a radio button form field |
| CCFormTextField | Class CFormTextField represents a text input form field |
| CCGreyscale | Offers image greyscale conversionThis class contains an algorithm for converting color images to greyscale |
| CCHtmlOutputParams | CHtmlOutputParams class manages the parameters to create a Html file |
| CCIDRSColor | Public Class defines a color with Red, Green and Blue components |
| CCIDRSException | To be replaced with actual description in the future |
| CCIDRSLicense | Stores the licensing information for a module in iDRS SDKThe class stores the following information: |
| CCIDRSObj | Abstract Class to represent CIDRSObj |
| CCIDRSObjArray | Templated Class for managing array of CIDRSObj It represents a collection of elements that can be individually accessed by index |
| CCIDRSPoint | Public Class defines the coordinates of a point in iDRS |
| CCIDRSRect | Public Class that defines the upper-left and lower-right corners of a rectangle |
| CCIDRSSetup | Manages the iDRS SDK licensing informationThe class is responsible with the following tasks: |
| CCImage | Manages images for iDRS.An image is a buffer of pixels and some characteristics such as width, height, resolution. The class CImage offers a set of convenient methods for loading, saving and manipulating image pixels. Internally the class stores the data in uncompressed format. ColorMode for color modes |
| CCImageIO | Manages loading and saving of images for the iDRS. An image is a buffer of pixels and some characteristics such as width, height, resolution. The class CImageIO offers a set of convenient methods for loading and saving images |
| CCImageLimits | CImageLimits class contains helper methods useful when working with images |
| CCImageLoadOptions | The CImageLoadOptions is the base class to hold the options for loading an image file |
| CCImageLoadOptionsPdf | CImageLoadOptionsPdf contains the options for loading image to pdf file format |
| CCImageOperation | Base class for the image operations related classes in iDRS SDK.IDRSNET.Module.Prepro |
| CCImageOperationUtils | Offers image operation utilities.IDRSNET.Module.Prepro |
| CCImagePixels | Handles the pixels of an image.The class offers pixel level access for an image |
| CCImagePluginCapabilities | Capabilities implemented in a image plugin.The class acts as a storage for CImagePluginCapability objects and also provides useful methods for detecting if a certain image can be saved or loaded using various parameteres |
| CCImagePluginCapability | The CImagePluginCapability represents a image capability implemented in the image plugin it belongs to.The class contains the fine-grained settings that define a image plugin capability: |
| CCImagePluginManager | Registry for the user defined pluginsThe class provides static methods for dealing with the plugin registration. It is not supposed to be instantiated. The class will maintain a list with references to the image plugin objects supplied. Besides this list, CImagePluginManager contains a reference to an image plugin implemented in iDRS SDK that expose all the imaging functionality in iDRS SDK |
| CCImageSaveOptions | The CImageSaveOptions is the base class to hold the options for an image file |
| CCImageSaveOptionsJpeg | Various options to deal with JPEG images.CImage.Load |
| CCImageSaveOptionsJpeg2000 | Various options to deal with JPEG 2000 image compression algorithm |
| CCImageSaveOptionsPdf | CImageSaveOptionsPdf contains the options for saving image to pdf file format |
| CCImageSaveOptionsPng | Various options to deal with PNG images |
| CCImageSaveOptionsTiff | Various options to deal with TIFF images |
| CCImageSource | Offers method to identify the source of an image. The images can be captured by many different devices, including document scanner and cameras. In order to improve the character recognition accuracy, it can be interesting to apply specific image preprocessing features. The CImageSource class helps identifying the source of an image so the correct preprocessing is done |
| CCJpegCompressionOptions | CJpegCompressionOptions class specifies the jpeg compression options |
| CCLanguageCandidate | Public Class containing the language candidates that are found during page analysis |
| CCLineRemoval | Line removal capabilities.The class contains algorithms for removing vertical and horizontal lines in an image |
| CCLngUtils | Some helper methods to manage the iDRS languages. The class exposes functions for: |
| CCMarginInfo | ! Public Class containing the margins for a page element |
| CCMemoryBuffer | CMemoryBuffer class manages a memory buffer |
| CCMetadataInfo | CMetadataInfo class is used to contain a document metadata The properties in this class are written to the output document if they are available for the given format, in other words each format has a specific set of supported metadata as shown in the table below: |
| CCNegative | Offers negative image transformation.The class contains a image transformation algorithm that performs negative image transformation on an image or a part of an image |
| CCOcrContext | Manages a recognition context for the OCR engine. A recognition context consists in a recognition environment, one or multiple decision environments, a character set and a set of parameters the OCR engine will use to analyze/recognize pages. An OCR context has a unique recognition environment and one ore more decision environments. Decision environments are related to a specific language; recognition is related to the alphabets. The recognition environment is not immediately loaded at the time the integrator sets one or more languages in the OCR context. The number of languages an OCR context can manage at a time is specified in the define IDRS_LNG_COUNT_LIMIT. In addition to specifying the language, the integrator can limit the OCR context's character set. When the integrator set the languages for the OCR context, iDRS computes the characters used by the languages to limit the OCR character set to these characters |
| CCOcrPageParams | COcrPageParams contains the configuration for the full page OCR text recognition. This class allows setting the following text recognition options: |
| CCOcrParams | Base class for OCR parameters. The class offers the most common OCR parameters like threading model to use and the amount of work to spend while in the OCR process |
| CCOcrThreadingConfig | Defines how many threads OCR operations should use for processing |
| CCOcrZonalParams | The class COcrZonalParams contains the ocr parameters for zonal recognition |
| CCOcrZonalSettings | The class COcrZonalSettings contains the configuration for a set of zones where text recognition will be executed with the same COcrContext This class allows setting following options fo the zonal configuration for text recognition: |
| CCOcrZoneDescription | The class COcrZoneDescription contains the configuration for a single zone where text recognition will be executed. This class allows setting following options fo the zonal configuration for text recognition: |
| CCOdtOutputParams | COdtOutputParams class manages the parameters to create an Odt file |
| CCOutputParams | COutputParams class is the base class for different output classes |
| CCOutputThreadingConfig | Defines how many threads output operations should use for processing |
| CCPaddingInfo | ! Public Class containing the padding information for a page |
| CCPage | Manages a page in the IDRS.A page contains the following entities: |
| CCPageAnalysis | CPageAnalysis is the main class used for page analysis feature: |
| CCPageAnalysisParams | CPageAnalysisParams contains the configuration for page analysis. This class allows setting the following page analysis options: |
| CCPageAnalysisResult | CPageAnalysisResult contains the results of page analysis. See CPageAnalysis |
| CCPageAnalysisThreadingConfig | Internal structure defining threading configuration parameters. Defaults each member to 1. Used internally to control per-operation thread usage |
| CCPageBookmark | CPageBookmark represents a bookmark on a page |
| CCPageCollectionStorageOptions | CPageCollectionStorageOptions class represents the set of options for an IPageCollection |
| CCPageColumn | CPageColumn represents a column in a page section |
| CCPageContent | CPageContent represents the results content of CPage. The content is editable, meaning that an integrator can easily update any part of the page content |
| CCPageCustomData | CPageCustomData allows to store inside iDRS page content some integrator-provided data |
| CCPageFont | CPageFont represents a font in iDRS SDK A font contains the following data: |
| CCPageGraphicShape | CPageGraphicShape represents the base class for graphic shapes that can be represented in iDRS SDK This class is a base class, so integrators are not expected to instantiate objects of this type |
| CCPageGraphicShapeLine | CPageGraphicShapeLine represents a line graphic shape |
| CCPageInteractiveForm | Class CPageInteractiveForm represents the interactive form gathering all page's form fields |
| CCPageMetadata | CPageMetadata represents the metadata content of a page |
| CCPageParagraph | CPageParagraph represents a text paragraph The class contains the following info: |
| CCPageParagraphsGroup | CPageParagraphsGroup represents a group of text paragraphs |
| CCPageProcessing | CPageProcessing exposes all recognition features of iDRS SDK: page analysis, text recognition and barcode detection Each of these features can be enabled/disabled. The order in which the features are executed is: |
| CCPageSection | CPageSection represents a section in a page A section class contains the following elements: |
| CCPageSizeOptions | CPageSizeOptions class specifies the page size options |
| CCPageStyle | Sets the page style associated to a page Usually when a page has a style object associated, it is considered that it is containing enough information to generate a document (pdf, docx, etc) |
| CCPageStyleFont | CPageStyleFont represents a style used for a specific font This class contains: |
| CCPageStyleParagraph | CPageStyleParagraph represents the text paragraph style data. This class contains the following info related to a text paragraph |
| CCPageStyleParagraphList | CPageStyleParagraphList represents a list style associated to a text paragraph A list can contain one or more paragraphs. This class contains the info that describe the style of the list which should be applied to the text paragraph: |
| CCPageStyleTableCell | CPageStyleTableCell contains the style information associated to a table cell. The class holds the following information: |
| CCPageStyleTabulation | CPageStyleTabulation represents the style for a text tabulation |
| CCPageStyleTextElement | CPageStyleTextElement represents the style associated to a text element IDRSNET.CPageTextElement |
| CCPageStyleWord | CPageStyleWord represents a text word style |
| CCPageTableCell | CPageTableCell represents a table cell. It contains the following information: |
| CCPageTextElement | CPageTextElement represents a text element in iDRS. A text element can be a single character or a sequence of characters. This class contains the following info: |
| CCPageTextElementAlternative | CPageTextElementAlternative represents a text element alternative Text alternatives are usually generated by the ocr engine with text solutions close to the actual solution. Each text alternative has it's own text solution and confidence level |
| CCPageTextLine | CPageTextLine represents a line of text |
| CCPageWord | CPageWord represents a text word |
| CCPageZone | Class CPageZone represents the base class for all zones available in iDRS SDK A zone contains the following entities: |
| CCPageZoneGraphic | CPageZoneGraphic represents a graphic zone The graphic zone can represent one of the following: |
| CCPageZoneGraphicExternalImage | CPageZoneGraphicExternalImage represents a zone that is loaded from an external source By default the image zones in iDRS SDK represent parts of the source image for a document. The class CPageZoneGraphicExternalImage allows integrators to specify image zones that have the source in other images. This allows greater flexibility when creating output documents |
| CCPageZoneTable | CPageZoneTable represents a table zone in iDRS SDK |
| CCPageZoneText | CPageZoneText represents a text zone in a page In contains a list with groups of paragraphs |
| CCPdfCompressionOptions | CPdfCompressionOptions class specifies the pdf compression options |
| CCPdfCustomMetadata | CPdfCustomMetadata is the root container gathering all PDF metadata resources |
| CCPdfCustomMetadataContainer | CPdfCustomMetadataContainer represents a PDF metadata bag A container can contain |
| CCPdfCustomMetadataProperty | CPdfCustomMetadataProperty represents a PDF metadata property composed of a name/value pair |
| CCPdfCustomMetadataPropertyList | CPdfCustomMetadataPropertyList represents a list of custom metadata properties |
| CCPdfCustomMetadataResource | CPdfCustomMetadataResource is the base class for a PDF metadata element. A metadata resource can be a either a list of properties or a container |
| CCPdfOperation | CPdfOperation exposes features which can be used on PDF documents |
| CCPdfOutputParams | CPdfOutputParams class manages the parameters to create a Pdf file |
| CCPdfUpdateParams | Manages the parameters for PDF update operations |
| CCPerspective | Offers perspective correction of document images captured by a camera. Perspective distortions are a frequent phenomenon when it comes to camera-based document images and their correction is highly recommended as it increases significantly the recognition accuracy. The CPerspective class can be used for all types of document images (document images containing barcodes, printed or handwritten text).IMPORTANT |
| CCPerspectiveCorners | The PerspectiveCorners structure contains the four corners of a quadrilateral that represent the area of the document that has been photographed |
| CCPolygon | Handles polygons for iDRS.iDRS SDK uses polygons to describe zones in images. In iDRS, a polygon is defined by a list of points |
| CCPolygonUtils | Implements utilities to get information regarding polygons. It offers operations like: |
| CCPptxOutputParams | CPptxOutputParams class manages the parameters to create a pptx file |
| CCPunchHoleRemoval | Part of iDRS advanced preprocessing module. It provides punch hole removal capabilities |
| CCQualityAssessment | Offers a set of methods to estimate the OCR quality of a provided image |
| CCResize | Offers image resizing.The class contains an algorithm for image resizing using all types of images: |
| CCRotate | Offers image rotation features.The class contains an algorithm for image rotation using all types of images: |
| CCRtfOutputParams | CRtfOutputParams class manages the parameters to create an Rtf file |
| CCSerialization | Manages loading and saving of page content for the iDRS |
| CCSignatureContent | CSignatureContent contains the UI elements for displaying a signature on a PDF document The class is a light weight version of CPageContent2, allowing the integrators to define custom zones, paragraphs, lines, words and text elements having custom styles and fonts |
| CCSkewInfo | Fine representation of a skew angle |
| CCStdLineReader | Standard implementation for a line reader class that reads the lines in a memory buffer.The class is providing a quick and convenient way of accessing a memory buffer that stores the pixels of image or some other data. ILineReader |
| CCTextOutputParams | CTextOutputParams class manages the parameters to create a text file |
| CCTextRecognition | CTextRecognition contains the text recognition features of iDRS SDK This class allows the following operations: |
| CCXlsxOutputParams | CXlsxOutputParams class manages the parameters to create an xlsx file |
| CCXmlOutputParams | CXmlOutputParams class manages the parameters to create an XML file |
| CIBarcodeEngine | IBarcodeEngine defines the interface representing a barcode engine used by iDRS SDK This class needs to be extended when creating a new barcode engine that would be used with iDRS SDK. A typical barcode engine is expected to have: |
| CIBarcodeEnginePostprocess | IBarcodeEnginePostprocess defines the interface required to provide a custom post-processing on barcode results. The purpose of barcode results post-processing is to allow modification of barcode results returned by an engine before it is actually mixed with the results obtained from other barcode engines |
| CIBarcodeEnginePreprocess | IBarcodeEnginePreprocess defines the interface required to provide a custom image preprocessing for a barcode engine. The purpose of image preprocessing options is to enhance the image before it will be processed by the barcode recognition engine |
| CIBaseImagePlugin | IBaseImagePlugin defines the interface required to provide custom image loading/saving capabilities.An image plugin is a class that is able to load and/or save a specific type of image. Each plugin needs to announce it's internal capabilities through CImagePluginCapabilities. Each plugin needs to support all options from the used CImageSaveOptionsXXX class. iDRS SDK will invoke function CanLoadFile whenever a file needs to be loaded. The plugin's responsibility is to detect whether the supplied file can be loaded using it's own code |
| CIBinarizeCallback | IBinarizeCallback defines the interface required to provide a custom algorithm for image binarization |
| CIDespeckleCallback | IBinarizeCallback defines the interface required to provide a custom algorithm for speckle removing |
| CIDocumentSeparationCallback | IDocumentSeparationCallback defines the interface required to provide a custom document separation logic |
| CIFontDataProviderCallback | IFontDataProviderCallback defines the interface required to supply the fonts to be used by the document output engine |
| CILineReader | The ILineReader defines the interface required to provide a custom line reader.A line reader object is used to provide image buffers inside iDRS. A common usage for this class is to provide the image raw data for image file format that iDRS SDK is not currently supported or for custom image file formats CStdLineReader contains a default implementation of this interface working with memory buffers |
| CILogger | The ILogger abstract class describes an interface which can be used by a custom class to provide a global logging system The global logging system can be used to provide to an IDRS SDK integrator information and feedback about meaningfuls event The interface contains information about the level of severity of the events that are going to be logged |
| CIPageCollection | IPageCollection defines the interface for a page collection. The page collection interface is used by the CDocument class to store the pages of a document. Additionally that interface is used internally by the CDocumentWriter to access the document's pages and generate the output. The collections that implement that interface must be thread-safe |
| CIProgressDocumentWriting | IProgressDocumentWriting defines the interface required to monitor document writing progress |
| CIProgressPageProcessing | CProgressTextRecognition defines the interface required to monitor page processing progress |
| CIStreamFactory | IStreamFactory represents an interface used for output stream creation This interface can be used to create new streams for the output documents. Currently it is used for document split feature Currently the sequence of calls is always CreateStream then CloseStream. However, integrators code should not reply on this assumption. There might be several CreateStream called before CloseStream |
1.9.8 