JPEG: warn if quality is outside [0.25, 1.0]

melissalinkert commented 6 months ago

See https://github.com/ome/bio-formats-documentation/pull/369#pullrequestreview-1993596133.

This can wait for Bio-Formats 8.0.0, it was just faster to open a PR than it was to write up an issue for later.

melissalinkert commented 1 month ago

At this point, I'm inclined to either switch the level to DEBUG, or just close this. I don't have a great idea for how to both reduce the verbosity and catch all cases where the provided quality is out of bounds. Since the quality is automatically adjusted to be in bounds, I think the worst case is that the quality ends up being unexpectedly higher than intended.

melissalinkert commented 1 month ago

As discussed earlier with @joshmoore / @sbesson / @jburel, closing this without merging.

A few ideas were discussed, but rejected:

configure logging to collapse all messages with the same content
automatically adjust invalid quality settings in bfconvert
use a ThreadLocal within the codec so that the warning is printed once per thread

All are more work and higher impact than is warranted here, given that https://bio-formats.readthedocs.io/en/stable/users/comlinetools/conversion.html#cmdoption-bfconvert-quality documents the expected range of quality values.

ome / ome-codecs

JPEG: warn if quality is outside [0.25, 1.0] #37