Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Z projection disabled tooltip #471

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

will-moore
Copy link
Member

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
Copy link

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

@will-moore will-moore requested a review from pwalczysko May 3, 2024 12:16
@pwalczysko
Copy link
Member

pwalczysko commented May 3, 2024

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

Copy link
Member

@pwalczysko pwalczysko left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please simplify&modify the content of the tooltip as per #471 (comment)

@will-moore
Copy link
Member Author

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:

  • Admin doesn't know if their omero.pixeldata.max_projection_bytes config has been taken into account when calculating the threshold or if a lower threshold might be in place from iviewer config, so we want to include that number in the tooltip.
  • User forgot that sizeC is taken into account in this calculation (NB: sizeT makes no difference)
  • Also, users may not know how many bytes per pixel for the current pixelType although I guess we can omit this.

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.

@will-moore
Copy link
Member Author

@pwalczysko - how about the suggested change in my previous comment?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants