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

expose useful _plot_img_with_bg kwargs explicitly in plotting.plot_img #2154

Closed
jeromedockes opened this issue Oct 7, 2019 · 2 comments · Fixed by #2157
Closed

expose useful _plot_img_with_bg kwargs explicitly in plotting.plot_img #2154

jeromedockes opened this issue Oct 7, 2019 · 2 comments · Fixed by #2157

Comments

@jeromedockes
Copy link
Member

plotting.plot_img helpfully forwards kwargs, and in particular bg_img, to
plotting.img_plotting._plot_img_with_bg.

However the docstring says kwargs are passed to pyplot.imshow.

I would suggest exposing important arguments such as vmin, vmax and bg_img
explicitly in the function signature.

note that this example:

http://nilearn.github.io/auto_examples/02_decoding/plot_haxby_searchlight.html#sphx-glr-auto-examples-02-decoding-plot-haxby-searchlight-py

uses the bg_img kwarg

@bthirion
Copy link
Member

bthirion commented Oct 7, 2019

+1

@jeromedockes
Copy link
Member Author

jeromedockes commented Oct 7, 2019 via email

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 a pull request may close this issue.

2 participants