Move OMERO pyramid specification to model documentation #55
Conversation
docs/sphinx/omero-pyramid/index.rst
Outdated
| Each pyramid contains 5 resolutions for each image plane, with each resolution stored in descending order from largest to smallest XY size. | ||
| Each resolution is half the width and height of the previous resolution. | ||
|
|
||
| OMERO handles pyramid generation automatically for files that do not already have a stored pyramid, use a supported pixel type, |
There was a problem hiding this comment.
This last paragraph is unrelated to the Pyramid format. Ideally should be in the OMERO documentation since it's also unrelated to Bio-Formats. Could it be dropped?
docs/sphinx/omero-pyramid/index.rst
Outdated
| Internal OMERO pyramid format v1.0.0 | ||
| ==================================== | ||
|
|
||
| For files that contain very large images and are not in a format that supports pyramids, OMERO will generate its own |
There was a problem hiding this comment.
This first paragraph is largely unrelated to the format description. Could it be replaced with a more appropriate introduction to the pyramid format or moved elsewhere?
docs/sphinx/omero-pyramid/index.rst
Outdated
| Z sections, and/or timepoints. | ||
|
|
||
| Each pyramid contains 5 resolutions for each image plane, with each resolution stored in descending order from largest to smallest XY size. | ||
| Each resolution is half the width and height of the previous resolution. |
There was a problem hiding this comment.
It might be worth mentioning explicitly that these 5 resolutions are separate IFDs.
Also, it made me wonder what the purpose of the JPEG-2000 decompression levels is, if we store and use the separate IFDs and don't actually use the decompression levels in the full-resolution IFD?
docs/sphinx/omero-pyramid/index.rst
Outdated
| @@ -0,0 +1,22 @@ | |||
| Internal OMERO pyramid format v1.0.0 | |||
There was a problem hiding this comment.
For consistency with the rest of the manual, could this be entitled "The OMERO Pyramid format" and move the version to the main text?
docs/sphinx/index.rst
Outdated
| @@ -73,6 +73,16 @@ OME-XML | |||
| ome-tiff/tools | |||
| ome-xml/java-library | |||
|
|
|||
| ************** | |||
| OMERO Pyramids | |||
There was a problem hiding this comment.
Maybe make singular "Pyramid" for consistency with the other things in the index.
|
All comments so far should be addressed with the latest 4 commits. |
|
Thanks, looks good to merge to me. |
docs/sphinx/omero-pyramid/index.rst
Outdated
| ======================== | ||
|
|
||
| The OMERO pyramid format is a way of storing very large images for easier visualization. | ||
| Currently only v1.0.0 is currently defined. |
There was a problem hiding this comment.
Just one little nitpick, you've got currently twice in this sentence, you only need the first one.
There was a problem hiding this comment.
Should be fixed with ee55320
|
N.B. made https://trello.com/c/LAmAnmOc/591-cross-reference-new-pyramid-doc-in-omero-docs to reference this in the OMERO docs once this is published. |
|
👍 |
See https://trello.com/c/XGsjTdcc/5-omero-pyramid-specification
docs/sphinx/omero-pyramid/index.rstshould be effectively the same as https://github.com/openmicroscopy/bioformats/blob/develop/docs/sphinx/developers/wsi.rst#internal-omero-pyramid-format-v100 - the only difference is thebf_doclinks.