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.

Sign up for GitHub

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

Jump to bottom

Deprecate darkness in surf_plotting functions #3501

Closed
alexisthual opened this issue Feb 11, 2023 · 4 comments · Fixed by #3855
Closed

Deprecate darkness in surf_plotting functions #3501

alexisthual opened this issue Feb 11, 2023 · 4 comments · Fixed by #3855
Assignees
@alishakodibagkar
Labels
Code quality This issue tackles code quality (code refactoring, PEP8...). Effort: low The issue is likely to require a small amount of work (less than a few hours). Good first issue Good for newcomers. Equivalent to "very low" effort. Plotting The issue is related to plotting functionalities. Priority: medium The task is important but not urgent and should be addressed over the next few months.

Comments

@alexisthual
Copy link
Contributor

This is a follow-up issue from #3173.

We should start a deprecation cycle for darkness in all functions in plotting.surf_plotting.
Indeed, this parameter is currently used to set a maximum value to a scaled background map (ie whose values are in [0,1]): bg_map = darkness * bg_map.
In the future, background maps will no longer be scaled by nilearn, so it no longer makes sense to have a darkness parameter.
@alexisthual alexisthual added Plotting The issue is related to plotting functionalities. Good first issue Good for newcomers. Equivalent to "very low" effort. Code quality This issue tackles code quality (code refactoring, PEP8...). Effort: low The issue is likely to require a small amount of work (less than a few hours). Priority: medium The task is important but not urgent and should be addressed over the next few months. labels Feb 11, 2023
@alishakodibagkar
Copy link
Contributor

I can work on this!

@Remi-Gau
Copy link
Collaborator

@alishakodibagkar I assigned you to it.
Let me know if you need help

This was referenced Jul 19, 2023
Closed
Merged
@ymzayek
Copy link
Member

ymzayek commented Jul 20, 2023

@alexisthual any reason not to also deprecate it in html_surface._get_vertex_color ?

@alexisthual
Copy link
Contributor Author

I had a look at html_surface.py again and I think it should be deprecated there as well :)
I think you can deprecate it everywhere.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@alishakodibagkar alishakodibagkar

Labels
Code quality This issue tackles code quality (code refactoring, PEP8...). Effort: low The issue is likely to require a small amount of work (less than a few hours). Good first issue Good for newcomers. Equivalent to "very low" effort. Plotting The issue is related to plotting functionalities. Priority: medium The task is important but not urgent and should be addressed over the next few months.
Projects
No open projects
OHBM Brainhack 2023 - Nilearn Surface Support
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[MAINT] add warning to deprecate darkness alishakodibagkar/nilearn
4 participants
@Remi-Gau @alexisthual @alishakodibagkar @ymzayek