Skip to main content

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

Release files for s3a 0.7.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for s3a 0.7.0
File Size Uploaded
s3a-0.7.0.tar.gz 255.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for s3a 0.7.0
File Interpreter ABI Platform
s3a-0.7.0-py3-none-any.whl Python 3 none any Details

Total release size: 523.1 kB

Release files / s3a-0.7.0.tar.gz

Download URL s3a-0.7.0.tar.gz
Size 255.5 kB
Tags Source
SHA-256 checksum
How to use checksums
ab5ad8a7e3b5152271c3d6d37cdfd3396c83b77793d2c637d2ff4d2e775a6b5e
BLAKE2b-256 checksum
How to use checksums
38e222fbf3f2ef5f86c1d634232e38555e71e937cab61db0116eb37f6fffed01
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.12

Release files / s3a-0.7.0-py3-none-any.whl

Download URL s3a-0.7.0-py3-none-any.whl
Size 267.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
056c9a76bf4c64cb84c30911bbcb16e2aacefc01f252fdf9bc95b6c59d9af7df
BLAKE2b-256 checksum
How to use checksums
adc84df088cea24e6a7b13d5c47ea4eaa2e540a3393b822c18def0c01ba7dd03
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/4.0.1 CPython/3.9.12

Release history Release notifications | RSS feed

This release

0.7.0 This release

2 release files

0.6.2

2 release files

0.6.1

2 release files

0.5.6

2 release files

0.5.5

2 release files

0.5.4

2 release files

0.5.3

2 release files

0.5.2

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.15

2 release files

0.4.11

2 release files

0.4.10

2 release files

0.4.9

2 release files

0.4.8

2 release files

0.4.7

2 release files

0.4.6

2 release files

0.4.5

2 release files

0.4.4

2 release files

0.4.3

2 release files

0.4.2

2 release files

0.4.1

2 release files

0.4.0

2 release files

0.3.7

2 release files

0.3.6

2 release files

0.3.5

2 release files

0.3.4

2 release files

0.3.3

2 release files

0.3.2

2 release files

0.3.1

2 release files

0.2.18

2 release files

0.2.17

2 release files

0.2.16

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page