Add troubleshooting page #533
Conversation
github-actions
bot
added
the
documentation
|
Wowza this is great!! |
|
Eep, the circleCI fail is on main too now. napari/napari runs seem fine |
docs/troubleshooting.md
Outdated
|
|
||
| ### My image renders as all black/all white | ||
|
|
||
| This can happen when the contrast limits are not set correctly. You can reset the contrast limits by right-clicking "contras limits", then clicking the "Reset" button in the dialog shown. |
There was a problem hiding this comment.
| This can happen when the contrast limits are not set correctly. You can reset the contrast limits by right-clicking "contras limits", then clicking the "Reset" button in the dialog shown. | |
| This can happen when the contrast limits are not set correctly. You can reset the contrast limits by right-clicking "contrast limits", then clicking the "Reset" button in the dialog shown. |
But I think the advice should be more extensive here:
The contrast limits are the minimum and maximum values displayed by the layer. Any value under the smaller contrast limit will appear as black, while any value above the larger limit will appear as white. Additionally, when all the values are near the bottom of the range, the image can still appear black even if there are some very dark but not quite black pixels there.
You can reset the contrast limits by clicking the Auto-Contrast: "Once" button, or, if that fails, right clicking on the contrast limits to do manual adjustment, including directly editing the numbers shown. When in doubt, you can hover over the canvas with your image layer selected, and check the status message as you move the mouse around. That will give you an idea of the range and variability of the data in your layer, helping you set meaningful contrast limits.
This maybe points to writing a more extensive contrast limits and colormaps tutorial that we can link to from here, but otherwise I think it's worth doing a couple of paragraphs to help people understand what they are reading. (Screenshots would also be good here I think.)
There was a problem hiding this comment.
Maybe this is content for the viewer tutorial? Or do you think we need a dedicated page for this?
There was a problem hiding this comment.
There was a problem hiding this comment.
Yeah, I think we need better documentation for contrast limits and then we can keep this part brief. see also #535
There was a problem hiding this comment.
Ok - I created #542 and updated this PR to link to that doc (when it's live).
References and relevant issues
Closes #40, #493
Description
Adds a troubleshooting page under Usage. Not complete by any means, but a starting point. It has two sections, one for known issues and another for an FAQ.