Define table specifications

[tcompa]

Close #529 Close #587 Close #588

Checklist before merging

• [x] I added an appropriate entry to CHANGELOG.md

[github-actions[bot]]

Coverage report

The coverage rate went from 90.47% to 90.48% :arrow_up: The branch rate is 84%.

None of the new lines are part of the tested code. Therefore, there is no coverage data about them.

[tcompa]

@jluethi a first draft of the new docs page is taking form.

Any high-level feedback on the layout and contents is already welcome, while I'd suggest that for a more detailed review you can directly work on the source code in this branch.

Here are examples of how to serve the documentation locally, to have the new page visible at http://localhost:8001/roi_tables:

git checkout 529-write-docs-page-for-fractal-tasks-core-rois-v1

# With poetry
poetry install --with docs --all-extras
poetry run mkdocs serve --config-file mkdocs.yml --dev-addr localhost:8001

# Without poetry
python -m venv myenv
source myenv/bin/activate
pip install -r docs/doc-requirements.txt
mkdocs serve --config-file mkdocs.yml --dev-addr localhost:8001

[jluethi]

Outlook: Axis generalization

[jluethi]

Link to PR for fusing FOVs to single well: https://github.com/ome/ngff/pull/137

Nomenclature: Tiled (instead of stitched or fused)

[jluethi]

TODO: Mention masked loading functionality

[jluethi]

Fractal core Tables (subset of proposed table spec)

3 tables: ROI tables Advanced ROI tables (=> naming TBD) Feature tables (=> should in future potentially add additional metadata, as done in #333 )

[tcompa]

Thanks for the review. I addressed all comments but one via https://github.com/fractal-analytics-platform/fractal-tasks-core/pull/582/commits/43a622e7afd52d3849a9fa7809208a0b7d390526, feel free to double-check.