All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pdftron::PDF::OCRModule Class Reference

#include <OCRModule.h>

Static Public Member Functions

static bool IsModuleAvailable ()
 
static void ImageToPDF (PDFDoc dst, const UString &src, OCROptions *options)
 
static void ProcessPDF (PDFDoc dst, OCROptions *options)
 
static UString GetOCRJsonFromImage (PDFDoc dst, const UString &src, OCROptions *options)
 
static UString GetOCRJsonFromPDF (PDFDoc src, OCROptions *options)
 
static void ApplyOCRJsonToPDF (PDFDoc dst, const UString &json)
 
static UString GetOCRXmlFromImage (PDFDoc dst, const UString &src, OCROptions *options)
 
static UString GetOCRXmlFromPDF (PDFDoc src, OCROptions *options)
 
static void ApplyOCRXmlToPDF (PDFDoc dst, const UString &xml)
 

Detailed Description

The class OCRModule. static interface to PDFTron SDKs OCR functionality

Definition at line 24 of file OCRModule.h.

Member Function Documentation

static void pdftron::PDF::OCRModule::ApplyOCRJsonToPDF ( PDFDoc  dst,
const UString json 
)
static

Add hidden text layer to a PDF consisting of raster image(s).

Parameters
dst– The source and destination document.
json– JSON representing OCR results.
static void pdftron::PDF::OCRModule::ApplyOCRXmlToPDF ( PDFDoc  dst,
const UString xml 
)
static

Add hidden text layer to a PDF consisting of raster image(s).

Parameters
dst– The source and destination document.
xml– XML representing OCR results.
static UString pdftron::PDF::OCRModule::GetOCRJsonFromImage ( PDFDoc  dst,
const UString src,
OCROptions options 
)
static

Perform OCR on an image and return resulting JSON string. Side effect: source image is converted to PDF and stored in the destination document.

Parameters
dst– The destination document.
src– The path to the input image.
options– OCR options (optional).
Returns
JSON string represeting OCR results.
static UString pdftron::PDF::OCRModule::GetOCRJsonFromPDF ( PDFDoc  src,
OCROptions options 
)
static

Perform OCR on raster images within a PDF and return resulting JSON string.

Parameters
src– The source document.
options– OCR options (optional).
Returns
JSON string represeting OCR results.
static UString pdftron::PDF::OCRModule::GetOCRXmlFromImage ( PDFDoc  dst,
const UString src,
OCROptions options 
)
static

Perform OCR on an image and return resulting XML string. Side effect: source image is converted to PDF and stored in the destination document.

Parameters
dst– The destination document.
src– The path to the input image.
options– OCR options (optional).
Returns
XML string represeting OCR results.
static UString pdftron::PDF::OCRModule::GetOCRXmlFromPDF ( PDFDoc  src,
OCROptions options 
)
static

Perform OCR on raster images within a PDF and return resulting XML string.

Parameters
src– The source document.
options– OCR options (optional).
Returns
XML string represeting OCR results.
static void pdftron::PDF::OCRModule::ImageToPDF ( PDFDoc  dst,
const UString src,
OCROptions options 
)
static

Convert an image to a PDF with searchable text.

Parameters
dst– The destination document.
src– The path to the input image.
options– OCR options (optional).
static bool pdftron::PDF::OCRModule::IsModuleAvailable ( )
static

Find out whether the OCR module is available (and licensed).

Returns
returns true if OCR operations can be performed.
static void pdftron::PDF::OCRModule::ProcessPDF ( PDFDoc  dst,
OCROptions options 
)
static

Add searchable and selectable text to raster images within a PDF.

Parameters
dst– The source and destination document.
options– OCR options (optional).

The documentation for this class was generated from the following file: