ocrmypdf
Introduction
Release notes
Installing OCRmyPDF
Installing additional language packs
Installing the JBIG2 encoder
Usage
Cookbook
PDF optimization
OCRmyPDF Docker image
Advanced features
Batch processing
Online deployments
Performance
PDF security issues
Common error messages
Developers
Using the OCRmyPDF API
Plugins
API reference
Design notes
Contributing guidelines
Maintainer notes
ocrmypdf
Index
Edit on GitHub
Index
_
|
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
L
|
M
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
X
|
Y
_
__call__() (ocrmypdf.pluginspec.Executor method)
__enter__() (ocrmypdf.pluginspec.ProgressBar method)
__exit__() (ocrmypdf.pluginspec.ProgressBar method)
__init__() (ocrmypdf.pluginspec.ProgressBar method)
__str__() (ocrmypdf.pluginspec.OcrEngine method)
A
add_options() (in module ocrmypdf.pluginspec)
already_done_ocr (ocrmypdf.exceptions.ExitCode attribute)
angle (ocrmypdf.pluginspec.OrientationConfidence attribute)
B
bad_args (ocrmypdf.exceptions.ExitCode attribute)
BadArgsError
baseline() (ocrmypdf.hocrtransform.HocrTransform class method)
C
check_external_program() (in module ocrmypdf.subprocess)
check_options() (in module ocrmypdf.pluginspec)
child_process_error (ocrmypdf.exceptions.ExitCode attribute)
ColorConversionNeededError
confidence (ocrmypdf.pluginspec.OrientationConfidence attribute)
configure_logging() (in module ocrmypdf)
creator_tag() (ocrmypdf.pluginspec.OcrEngine static method)
ctrl_c (ocrmypdf.exceptions.ExitCode attribute)
D
debug (ocrmypdf.Verbosity attribute)
debug_all (ocrmypdf.Verbosity attribute)
default (ocrmypdf.Verbosity attribute)
DigitalSignatureError
DpiError
E
element_coordinates() (ocrmypdf.hocrtransform.HocrTransform class method)
encrypted_pdf (ocrmypdf.exceptions.ExitCode attribute)
EncryptedPdfError
environment variable
OMP_THREAD_LIMIT
TESSDATA_PREFIX
Executor (class in ocrmypdf.pluginspec)
exit_code (ocrmypdf.exceptions.BadArgsError attribute)
(ocrmypdf.exceptions.DpiError attribute)
(ocrmypdf.exceptions.EncryptedPdfError attribute)
(ocrmypdf.exceptions.ExitCodeException attribute)
(ocrmypdf.exceptions.InputFileError attribute)
(ocrmypdf.exceptions.MissingDependencyError attribute)
(ocrmypdf.exceptions.OutputFileAccessError attribute)
(ocrmypdf.exceptions.PriorOcrFoundError attribute)
(ocrmypdf.exceptions.SubprocessOutputError attribute)
(ocrmypdf.exceptions.TesseractConfigError attribute)
(ocrmypdf.exceptions.UnsupportedImageFormatError attribute)
ExitCode (class in ocrmypdf.exceptions)
ExitCodeException
F
file_access_error (ocrmypdf.exceptions.ExitCode attribute)
file_claims_pdfa() (in module ocrmypdf.pdfa)
filter_ocr_image() (in module ocrmypdf.pluginspec)
filter_page_image() (in module ocrmypdf.pluginspec)
filter_pdf_page() (in module ocrmypdf.pluginspec)
G
generate_hocr() (ocrmypdf.pluginspec.OcrEngine static method)
generate_pdf() (ocrmypdf.pluginspec.OcrEngine static method)
generate_pdfa() (in module ocrmypdf.pluginspec)
generate_pdfa_ps() (in module ocrmypdf.pdfa)
get_deskew() (ocrmypdf.pluginspec.OcrEngine static method)
get_executor() (in module ocrmypdf.pluginspec)
get_logging_console() (in module ocrmypdf.pluginspec)
get_ocr_engine() (in module ocrmypdf.pluginspec)
get_orientation() (ocrmypdf.pluginspec.OcrEngine static method)
get_page_context_args() (ocrmypdf.PdfContext method)
get_page_contexts() (ocrmypdf.PdfContext method)
get_path() (ocrmypdf.PageContext method)
(ocrmypdf.PdfContext method)
get_progressbar_class() (in module ocrmypdf.pluginspec)
get_version() (in module ocrmypdf.subprocess)
H
HocrTransform (class in ocrmypdf.hocrtransform)
HocrTransformError
I
initialize() (in module ocrmypdf.pluginspec)
input_file (ocrmypdf.exceptions.ExitCode attribute)
InputFileError
invalid_config (ocrmypdf.exceptions.ExitCode attribute)
invalid_output_pdf (ocrmypdf.exceptions.ExitCode attribute)
is_optimization_enabled() (in module ocrmypdf.pluginspec)
L
languages() (ocrmypdf.pluginspec.OcrEngine static method)
M
measure_words_matched() (ocrmypdf.quality.OcrQualityDictionary method)
message (ocrmypdf.exceptions.ColorConversionNeededError attribute)
(ocrmypdf.exceptions.DigitalSignatureError attribute)
(ocrmypdf.exceptions.EncryptedPdfError attribute)
(ocrmypdf.exceptions.ExitCodeException attribute)
(ocrmypdf.exceptions.TaggedPDFError attribute)
(ocrmypdf.exceptions.TesseractConfigError attribute)
missing_dependency (ocrmypdf.exceptions.ExitCode attribute)
MissingDependencyError
module
ocrmypdf.exceptions
ocrmypdf.hocrtransform
ocrmypdf.pdfa
ocrmypdf.quality
ocrmypdf.subprocess
O
ocr() (in module ocrmypdf)
OcrEngine (class in ocrmypdf.pluginspec)
ocrmypdf.exceptions
module
ocrmypdf.hocrtransform
module
ocrmypdf.pdfa
module
ocrmypdf.quality
module
ocrmypdf.subprocess
module
OcrQualityDictionary (class in ocrmypdf.quality)
ok (ocrmypdf.exceptions.ExitCode attribute)
optimize_pdf() (in module ocrmypdf.pluginspec)
options (ocrmypdf.PageContext attribute)
(ocrmypdf.PdfContext attribute)
OrientationConfidence (class in ocrmypdf.pluginspec)
origin (ocrmypdf.PageContext attribute)
(ocrmypdf.PdfContext attribute)
other_error (ocrmypdf.exceptions.ExitCode attribute)
OutputFileAccessError
P
PageContext (class in ocrmypdf)
pageinfo (ocrmypdf.PageContext attribute)
pageno (ocrmypdf.PageContext attribute)
pbar_class (ocrmypdf.pluginspec.Executor attribute)
pdfa_conversion_failed (ocrmypdf.exceptions.ExitCode attribute)
PdfContext (class in ocrmypdf)
pdfinfo (ocrmypdf.PdfContext attribute)
plugin_manager (ocrmypdf.PageContext attribute)
(ocrmypdf.PdfContext attribute)
polyval() (ocrmypdf.hocrtransform.HocrTransform class method)
PriorOcrFoundError
ProgressBar (class in ocrmypdf.pluginspec)
pt_from_pixel() (ocrmypdf.hocrtransform.HocrTransform method)
Q
quiet (ocrmypdf.Verbosity attribute)
R
rasterize_pdf_page() (in module ocrmypdf.pluginspec)
Rect (class in ocrmypdf.hocrtransform)
replace_unsupported_chars() (ocrmypdf.hocrtransform.HocrTransform class method)
run() (in module ocrmypdf.subprocess)
run_polling_stderr() (in module ocrmypdf.subprocess)
S
SubprocessOutputError
T
TaggedPDFError
TesseractConfigError
to_pdf() (ocrmypdf.hocrtransform.HocrTransform method)
U
UnsupportedImageFormatError
update() (ocrmypdf.pluginspec.ProgressBar method)
V
validate() (in module ocrmypdf.pluginspec)
Verbosity (class in ocrmypdf)
version() (ocrmypdf.pluginspec.OcrEngine static method)
X
x1 (ocrmypdf.hocrtransform.Rect attribute)
x2 (ocrmypdf.hocrtransform.Rect attribute)
Y
y1 (ocrmypdf.hocrtransform.Rect attribute)
y2 (ocrmypdf.hocrtransform.Rect attribute)
Read the Docs
v: latest
Versions
latest
stable
v15.4.2
v15.4.1
v15.4.0
v15.3.1
v15.3.0
v15.2.0
v15.1.0
v15.0.2
v15.0.1
v15.0.0.post1
v14.4.0
v14.3.0
v14.2.1
v14.2.0
v14.1.0
v14.0.4
v14.0.3
v14.0.2
v14.0.1
v14.0.0
v13.7.0
v13.6.2
v13.6.1
v13.6.0
v13.5.0
v13.4.7
v13.4.6
v13.4.5
v13.4.4
v13.4.3
v13.4.2
v13.4.1
v13.4.0
v13.3.0
v13.2.0
v13.1.1
v13.1.0
v13.0.0
v12.7.2
v12.7.1
v12.7.0
v12.6.0
v12.5.0
v12.4.0
v12.3.3
v12.3.2
v12.3.1
v12.3.0
v12.2.0
v12.1.0
v12.0.3
v12.0.2
v12.0.1
v12.0.0
v11.7.3
v11.7.2
v11.7.1
v11.7.0
v11.6.2
v11.6.1
v11.6.0
v11.5.0
v11.4.5
v11.4.4
v11.4.3
v11.4.2
v11.4.1
v11.4.0
v11.3.4
v11.3.3
v11.3.2
v11.3.1
v11.3.0
v11.2.1
v11.2.0
v11.1.2
v11.1.1
v11.1.0
v11.0.2
v11.0.1
v11.0.0
v10.3.3
v10.3.2
v10.3.1
v10.3.0
v10.2.1
v10.2.0
v10.1.0
v10.0.1
v10.0.0
v9.8.2
v9.8.1
v9.8.0
v9.7.2
v9.7.1
v9.7.0
v9.6.1
v9.6.0
v9.5.0
v9.4.0
v9.3.0
v9.2.0
v9.1.1
v9.1.0
v9.0.5
v9.0.4
v9.0.3
v9.0.2
v9.0.1
v9.0.0
v8.3.2
v8.3.1
v8.3.0
v8.2.4
v8.2.3
v8.2.2
v8.2.0
v8.1.0
v8.0.1
v8.0.0
v7.4.0
v6.2.5
Downloads
pdf
On Read the Docs
Project Home
Builds