ome / omero-iviewer

An OMERO.web app allowing to view images
https://www.openmicroscopy.org/omero/iviewer/
Other
18 stars 29 forks source link

Z projection disabled tooltip #471

Open will-moore opened 3 months ago

will-moore commented 3 months ago

See https://forum.image.sc/t/z-projections-disabled/95042/7

Discussion above shows that we don't give any feedback about why projection is disabled. Users can't tell if the max projection bytes config is being taken into account or if projection is disabled for some other reason.

This adds a useful tooltip to provide info on why projection is disabled (movie is playing or image is tiled or image bytes greater than projection:

Screenshot 2024-04-18 at 12 22 11

imagesc-bot commented 3 months ago

This pull request has been mentioned on Image.sc Forum. There might be relevant details there:

https://forum.image.sc/t/z-projections-disabled/95042/11

pwalczysko commented 2 months ago

The tooltip works on merge-ci and imho is useful.

Nevertheless, could you please explain what does the message in the tooltip attempt to say ? I genuinely understand only that "some" parameter is bigger than the cutoff for the projection showing. RFE for the tooltip:

  1. Use much simpler wording - what are bytes ? Maybe get rid of this bytes explanation ?
  2. Do not use brackets
  3. Do not use x size X x sizeY... - very hard to read and understand on a small font on a tooltip - the x in first case means "times", in second case it is the sizeX - very unfriendly, hard to read and understand
  4. Can a small paragraph be made in the tooltip so that the equation is not over two lines ? (but also see ad 1. above, is the complex equation necessary ?)
  5. In my case, I have only 1 byte, but it still says bytes. I understand that this is because of a technical problem of implementing the difference between singular and plural in the text ? But still, it further complicates the reading&understanding of the tooltip

Thank you

will-moore commented 2 months ago

This PR aims to address issues on the forum discussion (see description link above). It's mostly meant for a sysadmin to setup their system but it would also be useful for a user who wants to ask their sysadmin to update their config to enable projection for a particular image:

It's tricky to explain to regular users what bytes are or to remove them from the tooltip completely since that's what the message is all about.

How about:

Projection Disabled: Image size XYZ and Channels exceeds the max_projection_bytes limit of 268,435,456.