scalableminds / webknossos-libs

Python API and CLI tools for working with WEBKNOSSOS datasets, annotations and server interactions. Includes converter to OME-Zarr.
https://docs.webknossos.org/webknossos-py/index.html
22 stars 12 forks source link

Access Metadata of Segments & Trees in Annotations #1195

Open fm3 opened 4 weeks ago

fm3 commented 4 weeks ago

https://github.com/scalableminds/webknossos/pull/7875 introduces metadata for segments and trees and extends the NML format to include it. The libs should allow accessing it. We should discuss what the interface should look like.

kabilar commented 5 days ago

Hi @fm3, is there a way to use get_volume_layer_segments() to get the segment_id/name mapping without downloading the volume annotation NML file? Thank you.

kabilar commented 5 days ago

cc @jingjingwu1225 @balbasty @aaronkanzer

fm3 commented 5 days ago

As I understand it, the python libs currently access the contents of annotations via the downloaded NML file. So I’m afraid the download step is not optional. Eventually, we may build APIs to interact with individual elements of annotations without the download step, but as far as I know that is not on the short-term agenda. Tackling this issue concerning the new segment metadata will also be based on NML as an exchange format.

kabilar commented 5 days ago

Thanks for the quick response, @fm3. That sounds good.