Skip to main content

Text annotation utilities for computer vision pipelines.

Project description

Text Annotation Utilities

This project supports buildling datasets for downstream tasks using many open-source text-spotting datasets. It includes a number of classes and tools to quickly and easily build text spotting datasets with many annotation types, including

  • Dot
  • 2-point bounding boxes
  • Quadrilateral bounding boxes
  • Polygons
  • Bezier Curves

Additionally, this library makes converting between types extremely easy through an intuitive and extensible interface.

example

Setup

Use pip to install:

pip install textmark

TextAnnotation

TextAnnotation is a base class that can be easily extended to support other annotation formats. This library includes several formats already. Of particular note is that TextAnnotation includes a class level conversion registry. Subclasses can be registered like so:

# Add your subclass name:
TextAnnotation.register_name(name, "My_Class")
# Add any relevant conversions
# you only need to convert to the "closest" next annotation type
TextAnnotation.register_conversion(BoxAnnotation, QuadAnnotation, BoxAnnotation.to_quad)
TextAnnotation.register_conversion(QuadAnnotation, BoxAnnotation, QuadAnnotation.to_box)

Now, a user can easily convert between Box and Quad annotations through the use of

my_quad_annotation.to("Box")

If there are additional registries, such as Quad <--> Polygon, the user can convert all the way from a Box to a Polygon annotation (or vice versa) in a single command:

my_polygon_annotation.to("Box")

This system works by constructing a graph of all registered conversions. When a user calls the .to method, the graph is searched for the target class, and then applies all conversions on that path. This library implements the following simple conversions, which can be automatically chained together:

Polygon <--> Quad
Quad <--> Box
Box <--> Dot

Note that moving up through the chain is a lossy process!!

In addition, Bezier Curves can be converted to Polygons.

Visualizing

This library also includes an easy visualization system. See the example below:

from textmark import TextAnnotation, Visualizer

img_path = ...

my_annotation = TextAnnotation.factory(
    "Poly", scene_text, language, *list_of_points
)

my_second_annotation = TextAnnotation.factory(
    ...
)

# Can visualize an arbitrary number of annotations
vis = Visualizer(img_path, [my_annotation, my_second_annotation, ...])
visualization = vis.visualize()
visualize.show()  # uses PIL

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

textmark-0.3.7.tar.gz (12.9 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

textmark-0.3.7-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file textmark-0.3.7.tar.gz.

File metadata

  • Download URL: textmark-0.3.7.tar.gz
  • Upload date:
  • Size: 12.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for textmark-0.3.7.tar.gz
Algorithm Hash digest
SHA256 3755b9e03678f431d07384d7e029ffe908ef5f8f24906d1754a5cd4f3ddbf22d
MD5 214bc33d38eda1147a02fca4ecab6c8c
BLAKE2b-256 35d5aa6863f854290980591f9be4a111b8eb8ee5c705ec97a8b9c2c4cdf27849

See more details on using hashes here.

File details

Details for the file textmark-0.3.7-py3-none-any.whl.

File metadata

  • Download URL: textmark-0.3.7-py3-none-any.whl
  • Upload date:
  • Size: 12.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.18

File hashes

Hashes for textmark-0.3.7-py3-none-any.whl
Algorithm Hash digest
SHA256 915b1892a5fb39702c226858668ba456c343af2105fb147caa4127ff0209e518
MD5 27ad8d160ba5c34d12d95d5ebe4565cd
BLAKE2b-256 d9890e7ddc621920666f13345a943dea71b692617e1ab7dcddfbaa982542ca26

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page