Uh oh!
There was an error while loading.Please reload this page.
- Notifications
You must be signed in to change notification settings - Fork7.9k
Update to docs with regards to colorbar and colorizer#30112
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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Uh oh!
There was an error while loading.Please reload this page.
Conversation
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
A `~.Figure.colorbar` needs a "mappable" (`matplotlib.colorizer.ColorizingArtist`) | ||
object (typically, an image) which contains a colorizer | ||
(`matplotlib.colorizer.Colorizer`) that holds the data-to-color pipeline (norm and | ||
colormap). In order to create a colorbar without an attached image, one can instead | ||
use a `.ColorizingArtist` with no associated data. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
I think you can be more straightforward. ColorizingArtist is the base class for everything that "can be colormapped". Directly instruct to create the base class and pass it to colorbar. This the detour "typically subclasses with data, like image, but you can create without data" is not needed for the context of creating a standalone colorbar.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Thank you for the feedback, does the following read more easily:
"""A `~.Figure.colorbar` requires a `matplotlib.colorizer.ColorizingArtist` whichcontains a `matplotlib.colorizer.Colorizer` that holds the data-to-color pipeline(norm and colormap). To create a colorbar without an attached plot one canuse a `.ColorizingArtist` with no associated data."""
(and should we remove the last sentence?)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
This is okish. Maybe an improvement would be to switch the last sentence for
To create a colorbar without an attached plot one can directly instantiate the
base class.ColorizingArtist
, which has no associated data.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others.Learn more.
Done :)
Thank you@timhoffm, all the suggestions should be addressed now :) |
d56d471
to150165b
Compareb09a0c7
intomatplotlib:mainUh oh!
There was an error while loading.Please reload this page.
Uh oh!
There was an error while loading.Please reload this page.
PR summary
This PR updateshttps://matplotlib.org/stable/gallery/images_contours_and_fields/multi_image.html andhttps://matplotlib.org/stable/users/explain/colors/colorbar_only.html in light of the interoduction of
colorizer.Colorizer
andcolorizer.ColorizingArtist
(#28658).It also updates the docs of
colorbar.Colorbar
to referencecolorizer.ColorizingArtist
instead ofcm.ScalarMappable
See#30008 for a related discussion.
PR checklist