formHTR

Contents

  • README
    • Installation
      • pip
    • Usage
      • Quickstart
      • Select ROIs
      • Annotate ROIs
      • Process logsheet
      • Credentials
      • Examples
        • CLI
        • Python API
    • Documentation
    • Developer Documentation
      • Setup
      • conda (dev)
      • Contributing
      • Testing
  • Changelog
    • [unreleased]
      • Added
      • Changed
    • [0.2.0] - 2026-04-09
      • Added
      • Changed
    • [0.1.1] - 2026-04-08
      • Changed
    • [0.1.0] - 2026-04-08
  • Documentation
    • CLI
    • Core API
    • Other API modules
    • Library internals (formhtr.libs)
      • Command-line interface
        • Positional Arguments
        • Named Arguments
        • Sub-commands
        • main()
      • Core API
        • Logsheet pipeline
        • ROI tools
      • Other API modules
        • ExportEntry
        • ExportConfig
        • export_logsheet_to_xlsx()
        • get_page_alignment_data()
        • build_alignment_payload()
        • align_page()
        • manual_align_pdf()
        • get_pdf_dimensions()
        • check_system_dependencies()
        • ensure_system_dependencies()
      • libs.extract_ROI
        • extract_framebox()
        • detect_rectangles()
        • find_residuals()
        • process_cli()
        • SelectROIsWidget
      • libs.annotate_ROI
        • AnnotateROIsWidget
        • process_cli()
        • is_approximately_square()
      • libs.processing
        • validate_corners()
        • compute_closest_point()
        • find_corners()
        • transform()
        • align_images()
        • format_point()
        • get_alignment_data()
        • extract_barcode()
        • read_barcode()
        • is_ticked()
        • is_a_number()
        • identify_number()
        • separate_to_lines()
        • get_max_dimensions()
        • align_pairwise()
        • majority_vote()
        • remove_non_ascii()
        • identify_words()
        • filter_exceeding_words()
        • process_lines()
        • align_lines()
        • general_text_area()
        • process_content()
        • order_results()
        • write_header()
        • store_image()
        • store_results()
        • store_results_csv()
      • libs.services
        • call_services()
        • extract_corners()
      • libs support modules
        • convert_pdf_to_image()
        • resize_image()
        • get_image_size()
        • LogsheetConfig
        • Region
        • Residual
        • ROI
        • Rectangle
        • compute_success_ratio()
        • load_font()
        • create_debug_dir()
        • annotate_pdfs()
        • visualise_regions()
formHTR
  • Overview: module code

All modules for which code is available

  • formhtr.auto_align
  • formhtr.cli
  • formhtr.deps
  • formhtr.export_logsheet
  • formhtr.libs.annotate_ROI.annotate_ROIs_widget
  • formhtr.libs.annotate_ROI.cli_inputs
  • formhtr.libs.annotate_ROI.utils
  • formhtr.libs.extract_ROI.autodect
  • formhtr.libs.extract_ROI.cli_inputs
  • formhtr.libs.extract_ROI.select_ROIs_widget
  • formhtr.libs.logsheet_config
  • formhtr.libs.pdf_to_image
  • formhtr.libs.processing.align_images
  • formhtr.libs.processing.barcode
  • formhtr.libs.processing.checkbox
  • formhtr.libs.processing.process_area
  • formhtr.libs.processing.read_content
  • formhtr.libs.processing.store_results
  • formhtr.libs.region
  • formhtr.libs.services.call_services
  • formhtr.libs.services.utils
  • formhtr.libs.statistics
  • formhtr.libs.visualise_regions
  • formhtr.logsheet
  • formhtr.manual_align
  • formhtr.pdf_utils
  • formhtr.roi_tools

© Copyright 2026, EMBL.

Built with Sphinx using a theme provided by Read the Docs.