Skip to main content

Semantic labeling made simple

Project description

Semi-Supervised Semantic Annotator (S3A)

pipeline status coverage report Total alerts Language grade: Python SonarCloud

Description

A highly adaptable tool for both visualizing and generating semantic annotations for generic images.

Most software solutions for semantic (pixel-level) labeling are designed for low-resolution (<10MB) images with fewer than 10 components of interest. Violating either constraint (e.g. using a high-res image or annotating ~1000 components) incur detrimental performance impacts. S3A is designed to combat both these deficiencies. With images up to 150 MB and 2000 components, the tool remains interactive.


A more detailed overview can be found in the project wiki here.


Installation

The easiest method for installing s3a is via pip after cloning the repository, or directly from pypi:

git clone https://gitlab.com/ficsresearch/s3a
pip install -e ./s3a

# Or from pypi using "pip install s3a"

Note that a version of OpenCV and Qt binding are required for S3A to work. These can be installed for you with the "full" option:

pip install -e ./s3a[full]
# Or "pip install s3a[full]"

Running the App

Running the app is as easy as calling s3a as a module or using a provided entry point:

python -m s3a

Or, equivalently:

s3a-gui

From here, projects can be created to host groups of related images, or images can be annotated in the default project. Both options are available through the File menu.

Detailed Feature List

More information about the capabilities of this tool are outlined in the project wiki.

Please Note

S3A's programmatic API is still largely under development. It still needs refinement to allow for consistent naming schemes, removing vestigial elements, confirming private vs. public-facing elements, and a few other line items. However, the graphical interface should be minimally affected by these alterations.

Thus, while the GUI entry point should be consistently useful, be aware of these developments when using the scripting portion of S3A in great detail.

License

This tool is free for personal and commercial use (except the limits imposed by the selected Qt binding). If you publish something based on results obtained through this app, please cite the following papers:

Jessurun, N., Paradis, O., Roberts, A., & Asadizanjani, N. (2020). Component Detection and Evaluation Framework (CDEF): A Semantic Annotation Tool. Microscopy and Microanalysis, 1-5. doi:10.1017/S1431927620018243

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

s3a-0.7.0.tar.gz (255.5 kB view details)

Uploaded Source

Built Distribution

s3a-0.7.0-py3-none-any.whl (267.6 kB view details)

Uploaded Python 3

File details

Details for the file s3a-0.7.0.tar.gz.

File metadata

  • Download URL: s3a-0.7.0.tar.gz
  • Upload date:
  • Size: 255.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for s3a-0.7.0.tar.gz
Algorithm Hash digest
SHA256 ab5ad8a7e3b5152271c3d6d37cdfd3396c83b77793d2c637d2ff4d2e775a6b5e
MD5 b2bb1e8c9e05712490ef65d45ad16ffe
BLAKE2b-256 38e222fbf3f2ef5f86c1d634232e38555e71e937cab61db0116eb37f6fffed01

See more details on using hashes here.

File details

Details for the file s3a-0.7.0-py3-none-any.whl.

File metadata

  • Download URL: s3a-0.7.0-py3-none-any.whl
  • Upload date:
  • Size: 267.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.1 CPython/3.9.12

File hashes

Hashes for s3a-0.7.0-py3-none-any.whl
Algorithm Hash digest
SHA256 056c9a76bf4c64cb84c30911bbcb16e2aacefc01f252fdf9bc95b6c59d9af7df
MD5 d797ab3e57b17427e0bbf17cdb758210
BLAKE2b-256 adc84df088cea24e6a7b13d5c47ea4eaa2e540a3393b822c18def0c01ba7dd03

See more details on using hashes here.

Supported by

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