Index

_

__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) add_pdfa_metadata() (in module ocrmypdf.pdfa) add_srgb_output_intent() (in module ocrmypdf.pdfa)

already_done_ocr (ocrmypdf.exceptions.ExitCode attribute) angle (ocrmypdf.pluginspec.OrientationConfidence attribute) available_cpu_count() (in module ocrmypdf.helpers)

B

bad_args (ocrmypdf.exceptions.ExitCode attribute) BadArgsError Baseline (class in ocrmypdf.hocrtransform) baseline (ocrmypdf.hocrtransform.OcrElement attribute)

bbox (ocrmypdf.hocrtransform.OcrElement attribute) bold (ocrmypdf.hocrtransform.FontInfo attribute) bottom (ocrmypdf.hocrtransform.BoundingBox attribute) BoundingBox (class in ocrmypdf.hocrtransform)

C

check_external_program() (in module ocrmypdf.subprocess) check_options() (in module ocrmypdf.api) (in module ocrmypdf.pluginspec) check_pdf() (in module ocrmypdf.helpers) child_process_error (ocrmypdf.exceptions.ExitCode attribute) children (ocrmypdf.hocrtransform.OcrElement attribute) clamp() (in module ocrmypdf.helpers)

ColorConversionNeededError confidence (ocrmypdf.hocrtransform.OcrElement attribute) (ocrmypdf.pluginspec.OrientationConfidence attribute) configure_logging() (in module ocrmypdf.api) create_options() (in module ocrmypdf.api) creator_tag() (ocrmypdf.pluginspec.OcrEngine static method) ctrl_c (ocrmypdf.exceptions.ExitCode attribute)

D

debug (ocrmypdf.api.Verbosity attribute) debug_all (ocrmypdf.api.Verbosity attribute) default (ocrmypdf.api.Verbosity attribute)

DigitalSignatureError direction (ocrmypdf.hocrtransform.OcrElement attribute) dpi (ocrmypdf.hocrtransform.OcrElement attribute) DpiError

E

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() (ocrmypdf.api.PageNumberFilter method) filter_ocr_image() (in module ocrmypdf.pluginspec) filter_page_image() (in module ocrmypdf.pluginspec)

filter_pdf_page() (in module ocrmypdf.pluginspec) find_by_class() (ocrmypdf.hocrtransform.OcrElement method) flip_axis() (ocrmypdf.helpers.Resolution method) font (ocrmypdf.hocrtransform.OcrElement attribute) FontInfo (class in ocrmypdf.hocrtransform) force_ocr (ocrmypdf._options.OcrOptions property)

G

generate_hocr() (ocrmypdf.pluginspec.OcrEngine static method) generate_ocr() (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_parser() (in module ocrmypdf.api) get_progressbar_class() (in module ocrmypdf.pluginspec) get_text_recursive() (ocrmypdf.hocrtransform.OcrElement method) get_version() (in module ocrmypdf.subprocess)

H

handle_special_cases() (ocrmypdf._options.OcrOptions class method) height (ocrmypdf.hocrtransform.BoundingBox property)

HocrParseError HocrParser (class in ocrmypdf.hocrtransform)

I

initialize() (in module ocrmypdf.pluginspec) input_file (ocrmypdf.exceptions.ExitCode attribute) InputFileError intercept (ocrmypdf.hocrtransform.Baseline attribute) invalid_config (ocrmypdf.exceptions.ExitCode attribute) invalid_output_pdf (ocrmypdf.exceptions.ExitCode attribute)

is_file_writable() (in module ocrmypdf.helpers) is_finite (ocrmypdf.helpers.Resolution property) is_iterable_notstr() (in module ocrmypdf.helpers) is_optimization_enabled() (in module ocrmypdf.pluginspec) is_square (ocrmypdf.helpers.Resolution property) italic (ocrmypdf.hocrtransform.FontInfo attribute) iter_by_class() (ocrmypdf.hocrtransform.OcrElement method)

J

jpeg_quality (ocrmypdf._options.OcrOptions property)

L

language (ocrmypdf.hocrtransform.OcrElement attribute) languages() (ocrmypdf.pluginspec.OcrEngine static method) left (ocrmypdf.hocrtransform.BoundingBox attribute)

lines (ocrmypdf.hocrtransform.OcrElement property) logical_page_number (ocrmypdf.hocrtransform.OcrElement attribute) lossless_reconstruction (ocrmypdf._options.OcrOptions property)

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 model_config (ocrmypdf._options.OcrOptions attribute) model_dump_json_safe() (ocrmypdf._options.OcrOptions method)

model_validate_json_safe() (ocrmypdf._options.OcrOptions class method) module ocrmypdf._options ocrmypdf.api ocrmypdf.exceptions ocrmypdf.helpers ocrmypdf.hocrtransform ocrmypdf.pdfa ocrmypdf.quality ocrmypdf.subprocess monospace (ocrmypdf.hocrtransform.FontInfo attribute) monotonic() (in module ocrmypdf.helpers)

N

name (ocrmypdf.hocrtransform.FontInfo attribute)

O

ocr() (in module ocrmypdf.api) ocr_class (ocrmypdf.hocrtransform.OcrElement attribute) OcrClass (class in ocrmypdf.hocrtransform) OcrElement (class in ocrmypdf.hocrtransform) OcrEngine (class in ocrmypdf.pluginspec) ocrmypdf._options module ocrmypdf.api module ocrmypdf.exceptions module ocrmypdf.helpers module ocrmypdf.hocrtransform module

ocrmypdf.pdfa module ocrmypdf.quality module ocrmypdf.subprocess module OcrOptions (class in ocrmypdf._options) OcrQualityDictionary (class in ocrmypdf.quality) ok (ocrmypdf.exceptions.ExitCode attribute) optimize_pdf() (in module ocrmypdf.pluginspec) OrientationConfidence (class in ocrmypdf.pluginspec) other_error (ocrmypdf.exceptions.ExitCode attribute) OutputFileAccessError

P

page_number (ocrmypdf.hocrtransform.OcrElement attribute) page_number() (in module ocrmypdf.helpers) PageNumberFilter (class in ocrmypdf.api) paragraphs (ocrmypdf.hocrtransform.OcrElement property) parse() (ocrmypdf.hocrtransform.HocrParser method)

pbar_class (ocrmypdf.pluginspec.Executor attribute) pdfa_conversion_failed (ocrmypdf.exceptions.ExitCode attribute) pikepdf_enable_mmap() (in module ocrmypdf.helpers) poly (ocrmypdf.hocrtransform.OcrElement attribute) PriorOcrFoundError ProgressBar (class in ocrmypdf.pluginspec)

Q

quiet (ocrmypdf.api.Verbosity attribute)

R

rasterize_pdf_page() (in module ocrmypdf.pluginspec) redo_ocr (ocrmypdf._options.OcrOptions property) register_options() (in module ocrmypdf.pluginspec) register_plugin_models() (ocrmypdf._options.OcrOptions class method) remove_all_log_handlers() (in module ocrmypdf.helpers) Resolution (class in ocrmypdf.helpers) right (ocrmypdf.hocrtransform.BoundingBox attribute)

round() (ocrmypdf.helpers.Resolution method) run() (in module ocrmypdf.subprocess) run_pipeline() (in module ocrmypdf.api) run_pipeline_cli() (in module ocrmypdf.api) run_polling_stderr() (in module ocrmypdf.subprocess) running_in_docker() (in module ocrmypdf.helpers) running_in_snap() (in module ocrmypdf.helpers)

S

safe_symlink() (in module ocrmypdf.helpers) samefile() (in module ocrmypdf.helpers) serif (ocrmypdf.hocrtransform.FontInfo attribute) setup_plugin_infrastructure() (in module ocrmypdf.api) size (ocrmypdf.hocrtransform.FontInfo attribute)

skip_text (ocrmypdf._options.OcrOptions property) slope (ocrmypdf.hocrtransform.Baseline attribute) smallcaps (ocrmypdf.hocrtransform.FontInfo attribute) speculative_pdfa_conversion() (in module ocrmypdf.pdfa) SubprocessOutputError supports_generate_ocr() (ocrmypdf.pluginspec.OcrEngine static method)

T

TaggedPDFError take_max() (ocrmypdf.helpers.Resolution method) take_min() (ocrmypdf.helpers.Resolution method) TesseractConfigError

text (ocrmypdf.hocrtransform.OcrElement attribute) textangle (ocrmypdf.hocrtransform.OcrElement attribute) to_int() (ocrmypdf.helpers.Resolution method) to_scalar() (ocrmypdf.helpers.Resolution method) top (ocrmypdf.hocrtransform.BoundingBox attribute)

U

underline (ocrmypdf.hocrtransform.FontInfo attribute)

UnsupportedImageFormatError update() (ocrmypdf.pluginspec.ProgressBar method)

V

validate() (in module ocrmypdf.pluginspec) validate_clean_final() (ocrmypdf._options.OcrOptions class method) validate_jobs() (ocrmypdf._options.OcrOptions class method) validate_languages() (ocrmypdf._options.OcrOptions class method) validate_max_image_mpixels() (ocrmypdf._options.OcrOptions class method) validate_metadata_unicode() (ocrmypdf._options.OcrOptions class method) validate_output_type() (ocrmypdf._options.OcrOptions class method) validate_output_type_compatibility() (ocrmypdf._options.OcrOptions method) validate_oversample() (ocrmypdf._options.OcrOptions class method)

validate_pages_format() (ocrmypdf._options.OcrOptions class method) validate_pdf_renderer() (ocrmypdf._options.OcrOptions class method) validate_rasterizer() (ocrmypdf._options.OcrOptions class method) validate_redo_ocr_options() (ocrmypdf._options.OcrOptions method) validate_rotate_pages_threshold() (ocrmypdf._options.OcrOptions class method) validate_unpaper_args() (ocrmypdf._options.OcrOptions class method) validate_verbose() (ocrmypdf._options.OcrOptions class method) Verbosity (class in ocrmypdf.api) version() (ocrmypdf.pluginspec.OcrEngine static method)

W

width (ocrmypdf.hocrtransform.BoundingBox property)

words (ocrmypdf.hocrtransform.OcrElement property)