gtagora-workbook-py
Agora workbook utilities for Python
Pure, dependency-free (no numpy, no HTTP client) helpers for working with the JSON shape of an Agora Workbook - mask RLE encoding, default CMR contour/landmark button templates, and merging new masks/contour groups into an existing workbook session. No network code lives here; it's meant to be shared by anything that needs to build or read Workbook data, whether that's a REST client (see gtagora-connector-py, which depends on this package) or code with direct database access.
Installation
pip install gtagora-workbook-py
Usage
Mask encoding/decoding (workbook.mask)
Encode a (size_x * size_y) label array into the base64 RLE format used by a
Workbook mask's mSliceMask[i].mBase64Values, and decode it back:
from workbook.mask import encode_mask, decode_mask
encoded = encode_mask(labels) # labels: flat list of ints, one per pixel
decoded = decode_mask(encoded, len(labels))
assert decoded == labels
Decode a full Workbook mask dict (mSizeX/Y/Z/T plus one mSliceMask entry
per (z, t)) into a flat list and its (X, Y, Z, T) shape:
from workbook.mask import decode_full_mask
decoded = decode_full_mask(mask) # mask: one entry of workbook['mask']['mMasks']
print(decoded.shape) # (size_x, size_y, size_z, size_t)
Convert to a numpy array with a single call:
import numpy as np
array = np.array(decoded.data, dtype=np.uint8).reshape(decoded.shape)
Default CMR templates (workbook.templates)
from workbook.templates import default_cmr_contour_buttons, default_cmr_landmark_buttons, new_cmr_workbook_body
object_buttons = default_cmr_contour_buttons() + default_cmr_landmark_buttons()
body = new_cmr_workbook_body(dataset_id=158, name='CMR Workbook') # ready to POST to a Workbook endpoint
Merging into an existing workbook session (workbook.session)
from workbook.session import merge_contour_session, merge_mask_session, resolve_contour_buttons
# insert/replace `mask` (by its 'name') into an existing mask session
mask_session = merge_mask_session(workbook['mask'], workbook_id=workbook['id'], mask=mask)
# insert/replace contour groups (by 'name') and set the object buttons
contour_session = merge_contour_session(
workbook['contour'], workbook_id=workbook['id'],
contour_groups=contour_groups, object_buttons=object_buttons)
# a workbook's own contour buttons, or the default CMR set if it has none yet
object_buttons = resolve_contour_buttons(workbook.get('contour'))
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file gtagora_workbook_py-0.1.0.tar.gz.
File metadata
- Download URL: gtagora_workbook_py-0.1.0.tar.gz
- Upload date:
- Size: 10.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1ab7cdc047bd22960534662404df4feda3bb3de885c1bd6635edd10335a32526
|
|
| MD5 |
e20a01194041b150a9520bbe0fe87ef9
|
|
| BLAKE2b-256 |
04d53dcabeb3408165bb452f920451535bb4e421ba52ae7d452a9ff7b1a76e9a
|
Provenance
The following attestation bundles were made for gtagora_workbook_py-0.1.0.tar.gz:
Publisher:
python-publish.yml on GyroTools/gtagora-workbook-py
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gtagora_workbook_py-0.1.0.tar.gz -
Subject digest:
1ab7cdc047bd22960534662404df4feda3bb3de885c1bd6635edd10335a32526 - Sigstore transparency entry: 2527292658
- Sigstore integration time:
-
Permalink:
GyroTools/gtagora-workbook-py@142587d11f5d5f7b29be51da3e9647261cdedf44 -
Branch / Tag:
refs/tags/0.1.0 - Owner: https://github.com/GyroTools
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@142587d11f5d5f7b29be51da3e9647261cdedf44 -
Trigger Event:
release
-
Statement type:
File details
Details for the file gtagora_workbook_py-0.1.0-py3-none-any.whl.
File metadata
- Download URL: gtagora_workbook_py-0.1.0-py3-none-any.whl
- Upload date:
- Size: 9.7 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e7fc1e023049a1855cb34c365f64ee49e306d553f826a11f9b28731db54506b9
|
|
| MD5 |
33a853fc754add9d2fd5f7e8794a72f4
|
|
| BLAKE2b-256 |
bebb134cca61402eafc964a63c81205180d6896a566d933d667af650b8261767
|
Provenance
The following attestation bundles were made for gtagora_workbook_py-0.1.0-py3-none-any.whl:
Publisher:
python-publish.yml on GyroTools/gtagora-workbook-py
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
gtagora_workbook_py-0.1.0-py3-none-any.whl -
Subject digest:
e7fc1e023049a1855cb34c365f64ee49e306d553f826a11f9b28731db54506b9 - Sigstore transparency entry: 2527292726
- Sigstore integration time:
-
Permalink:
GyroTools/gtagora-workbook-py@142587d11f5d5f7b29be51da3e9647261cdedf44 -
Branch / Tag:
refs/tags/0.1.0 - Owner: https://github.com/GyroTools
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
python-publish.yml@142587d11f5d5f7b29be51da3e9647261cdedf44 -
Trigger Event:
release
-
Statement type:
