settings.ROOT_COLOR changes 2D plots in addition to 3D brainrender plots #33
Conversation
This file contains 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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #33 +/- ##
=====================================
Coverage 0.00% 0.00%
=====================================
Files 5 5
Lines 285 285
=====================================
Misses 285 285 ☔ View full report in Codecov by Sentry. |
alessandrofelder
approved these changes
Apr 4, 2024
There was a problem hiding this comment.
Thanks @samclothier. I think for now no updates to the docs are needed, given that there's quite a bit yet to be documented here. And this actually, as you say, makes things more self-consistent - which is great.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
What is this PR
Usability improvement
Why is this PR needed?
I found myself wanting to change the root colour for the 2D matplotlib plots. This was especially useful when using a Greys (B-W) colourmap, as the grey background can make some regions invisible.
What does this PR do?
Currently the root region setting appears to only control the root region colour in the 3D brainrender plots. To me it would be intuitive to have the 2D matplotlib plots also read this value so that it only need be set once at the top of the file.
How has this PR been tested?
Externally, I am now able to do something like
bgh.heatmaps.settings.ROOT_COLOR = whiteand have this produce the 2D brain image with a white background.Does this PR require an update to the documentation?
Unsure.
Checklist: