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

[DOC] update doc threshold image #3485

Merged
merged 6 commits into from Feb 7, 2023
Merged

[DOC] update doc threshold image #3485

merged 6 commits into from Feb 7, 2023

Conversation

Remi-Gau
Copy link
Collaborator

@Remi-Gau Remi-Gau commented Feb 6, 2023

Closes #2048

Changes proposed in this pull request:

  1. Clarify that voxels with values
  • inferior to threshold are set to 0
  • supeerior or equal to threshold are kept as is
  1. Explain how percentiles are computed.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2023

👋 @Remi-Gau Thanks for creating a PR!

Until this PR is ready for review, you can include the [WIP] tag in its title, or leave it as a github draft.

Please make sure it is compliant with our contributing guidelines. In particular, be sure it checks the boxes listed below.

  • PR has an interpretable title.
  • PR links to Github issue with mention "Closes #XXXX"
  • Code is PEP8-compliant.
  • Changelog or what's new entry in "doc/changes/latest.rst"
  • (Bug fixes) There is at least one test that would fail under the original bug conditions.
  • (New features) There is at least one unit test per new function / class.
  • (New features) The new feature is demoed in at least one relevant example.

We will review it as quick as possible, feel free to ping us with questions if needed.

@codecov
Copy link

codecov bot commented Feb 6, 2023

Codecov Report

Merging #3485 (127efc7) into main (b7e5efd) will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##             main    #3485   +/-   ##
=======================================
  Coverage   90.97%   90.97%           
=======================================
  Files         133      133           
  Lines       15346    15346           
  Branches     3030     3030           
=======================================
  Hits        13961    13961           
  Misses        818      818           
  Partials      567      567           
Impacted Files Coverage Δ
nilearn/image/image.py 95.73% <ø> (ø)

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

Copy link
Member

@ymzayek ymzayek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM @Remi-Gau! Just minor things. I'd also add a whatsnew entry.

nilearn/image/image.py Outdated Show resolved Hide resolved
nilearn/image/image.py Outdated Show resolved Hide resolved
Remi-Gau and others added 3 commits February 6, 2023 17:18
Co-authored-by: Yasmin <63292494+ymzayek@users.noreply.github.com>
@Remi-Gau
Copy link
Collaborator Author

Remi-Gau commented Feb 6, 2023

I'd also add a whatsnew entry.

added something in latest.rst.

doc/changes/latest.rst Outdated Show resolved Hide resolved
Copy link
Member

@ymzayek ymzayek left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM otherwise @Remi-Gau

Copy link
Member

@bthirion bthirion left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thx.

@ymzayek
Copy link
Member

ymzayek commented Feb 7, 2023

Merging

@ymzayek ymzayek merged commit 7df4729 into nilearn:main Feb 7, 2023
@Remi-Gau Remi-Gau deleted the doc_2048 branch February 20, 2023 17:55
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 this pull request may close these issues.

Documentation of threshold_img unclear
3 participants