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

Update references and documentation on threshold use #365

Merged

Conversation

JuliaKukulies
Copy link
Member

@JuliaKukulies JuliaKukulies commented Nov 12, 2023

Addresses #346 and #347.

Note that for #346, I have only changed the documentation now, but could also update the segmentation function with an optional input parameter to make the threshold inclusive. Thoughts?

Also, happy to get help on recent publications that I have missed. @freemansw1 maybe you are aware of additional ones for INCUS or from any CSU students that I could not find :)

  • Have you followed our guidelines in CONTRIBUTING.md?
  • Have you self-reviewed your code and corrected any misspellings?
  • Have you written documentation that is easy to understand?
  • Have you written descriptive commit messages?
  • Have you formatted your code using black?
  • Have all tests passed in your local clone?
  • Have you kept your pull request small and limited so that it is easy to review?
  • Have the newest changes from this branch been merged?

@JuliaKukulies JuliaKukulies added the documentation Updates and improvements to documentation and examples label Nov 12, 2023
Copy link

codecov bot commented Nov 12, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (5f096e3) 56.68% compared to head (c6deec9) 56.70%.
Report is 13 commits behind head on RC_v1.5.x.

Additional details and impacted files
@@              Coverage Diff              @@
##           RC_v1.5.x     #365      +/-   ##
=============================================
+ Coverage      56.68%   56.70%   +0.02%     
=============================================
  Files             19       19              
  Lines           3426     3428       +2     
=============================================
+ Hits            1942     1944       +2     
  Misses          1484     1484              
Flag Coverage Δ
unittests 56.70% <ø> (+0.02%) ⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@snilsn snilsn left a comment

Choose a reason for hiding this comment

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

Looks good, @JuliaKukulies, just one minor thought

tobac/segmentation.py Outdated Show resolved Hide resolved
tobac/feature_detection.py Outdated Show resolved Hide resolved
@freemansw1 freemansw1 added this to the Version 1.5.2 milestone Nov 13, 2023
Copy link
Collaborator

@snilsn snilsn left a comment

Choose a reason for hiding this comment

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

Ok great, approving this now @JuliaKukulies.

If we wanted to include the option to be inclusive with the threshold for segmentation, would we also include the option to be exclusive for feature detection? Might otherwise cause confusion if an option isn't available in both functions.

Copy link
Collaborator

@harrietgilmour harrietgilmour left a comment

Choose a reason for hiding this comment

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

All looks good to me - documentation on thresholds is now much clearer :)

@JuliaKukulies
Copy link
Member Author

Ok great, approving this now @JuliaKukulies.

If we wanted to include the option to be inclusive with the threshold for segmentation, would we also include the option to be exclusive for feature detection? Might otherwise cause confusion if an option isn't available in both functions.

Hm yes, good point. However, I find it also confusing when the options exist for both but in different directions. I feel that this needs some further discussion so I will not include it in this PR/release. Are you OK with that @freemansw1 @w-k-jones ?

@JuliaKukulies
Copy link
Member Author

Thanks for reviewing this @snilsn and @harrietgilmour !

Copy link
Member

@freemansw1 freemansw1 left a comment

Choose a reason for hiding this comment

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

I have a few minor comments, but am overall very happy! Thanks for doing this!

doc/index.rst Outdated Show resolved Hide resolved
doc/publications.rst Outdated Show resolved Hide resolved
doc/segmentation_parameters.rst Show resolved Hide resolved
doc/threshold_detection_parameters.rst Outdated Show resolved Hide resolved
@JuliaKukulies
Copy link
Member Author

I am merging this now and creating an issue for the future implementation of optional treatment of threshold values.

@JuliaKukulies JuliaKukulies merged commit d92d1ba into tobac-project:RC_v1.5.x Nov 21, 2023
19 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Updates and improvements to documentation and examples
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants