Make ListedColormap.monochrome a property#29125
Merged
timhoffm merged 1 commit intomatplotlib:mainfrom Nov 13, 2024
Merged
Conversation
5827742 to
6b1ce2a
Compare
Member
Author
|
I get Note: Discussion moved to #29129. |
greglucas
approved these changes
Nov 12, 2024
Contributor
greglucas
left a comment
There was a problem hiding this comment.
👍 This is easier to follow.
jklymak
approved these changes
Nov 12, 2024
Member
jklymak
left a comment
There was a problem hiding this comment.
Feel free to self merge plus or minus @greglucas comment
The calculated property replaces the attribute *monochome*, which was manually set on `__init__`, but was not correctly set for all possible inputs. This property ensures consistency and simplifies initialization at the cost of some computation overhead to determine whether the colormap is monochrome. The computation cost is bearable (even without caching), because it's only used in `ContourSet._process_colors`. It's a separate discussion whether we need this property on colormaps at all (at least as public API). Usually, colormaps are not monochrome and monochrome colormaps are a very special edge case used in contours only. We may eventually deprecate it, but since it is currently public API, let's leave it for now. There's also a technical API incompatibility in that users cannot set the attribute anymore, but I'd argue that that has never been intended and there's no practical use-case, so I refrain from the extra hassle of allowing setting this property. Co-authored-by: Greg Lucas <greg.m.lucas@gmail.com>
5e48fd8 to
ce488f5
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The calculated property replaces the attribute monochome, which was manually set on
__init__, but was not correctly set for all possible inputs.This property ensures consistency and simplifies initialization at the cost of some computation overhead to determine whether the colormap is monochrome.
The computation cost is bearable (even without caching), because it's only used in
ContourSet._process_colors.It's a separate discussion whether we need this property on colormaps at all (at least as public API). Usually, colormaps are not monochrome and monochrome colormaps are a very special edge case used in contours only. We may eventually deprecate it, but since it is currently public API, let's leave it for now.
There's also a technical API incompatibility in that users cannot set the attribute anymore, but I'd argue that that has never been intended and there's no practical use-case, so I refrain from the extra hassle of allowing setting this property.