tobac icon indicating copy to clipboard operation
tobac copied to clipboard

Documentation update addressing why not all features have segmented areas

Open JuliaKukulies opened this issue 2 years ago • 1 comments

This PR resolves #52 which has been a long existing issue reporting that not all feature IDs can be found in the segmentation mask output and that some features result in ncells=0 in the dataframe output from the segmentation (see also #25 ). After discussing this in #52 with @freemansw1 and @zxdawn, we concluded that this is not a bug, but that there are simply some situations where the segmentation cannot create a segmented area even though everything is working as expected.

I have tested and verified this and updated the documentation page to visualize cases identified by @freemansw1. Note also that I have added a short section describing the segmentation output.

Here you can have a look at the documentation page looks like: https://tobac--195.org.readthedocs.build/en/195/

We can also wait until v1.5 but given that this is only documentation and that several users may encounter this issue, we may as well squeeze it into v1.4?

  • [x] Have you followed our guidelines in CONTRIBUTING.md?
  • [x] Have you self-reviewed your code and corrected any misspellings?
  • [x] Have you written documentation that is easy to understand?
  • [x] Have you written descriptive commit messages?
  • [ ] Have you added NumPy docstrings for newly added functions?
  • [ ] Have you formatted your code using black?
  • [ ] If you have introduced a new functionality, have you added adequate unit tests?
  • [x] Have all tests passed in your local clone?
  • [ ] If you have introduced a new functionality, have you added an example notebook?
  • [x] Have you kept your pull request small and limited so that it is easy to review?
  • [x] Have the newest changes from this branch been merged?

JuliaKukulies avatar Oct 24 '22 20:10 JuliaKukulies

Codecov Report

Base: 36.20% // Head: 36.22% // Increases project coverage by +0.02% :tada:

Coverage data is based on head (934c3ef) compared to base (29e5598). Patch has no changes to coverable lines.

Additional details and impacted files
@@              Coverage Diff              @@
##           RC_v1.4.0     #195      +/-   ##
=============================================
+ Coverage      36.20%   36.22%   +0.02%     
=============================================
  Files             10       10              
  Lines           2116     2120       +4     
=============================================
+ Hits             766      768       +2     
- Misses          1350     1352       +2     
Flag Coverage Δ
unittests 36.22% <ø> (+0.02%) :arrow_up:

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

Impacted Files Coverage Δ
tobac/__init__.py 92.00% <0.00%> (-8.00%) :arrow_down:

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

:umbrella: View full report at Codecov.
:loudspeaker: Do you have feedback about the report comment? Let us know in this issue.

codecov[bot] avatar Oct 24 '22 20:10 codecov[bot]

Thanks for your reviews @snilsn and @freemansw1! I made some minor changes according to your points and I am ready to merge.

JuliaKukulies avatar Oct 26 '22 19:10 JuliaKukulies

I'm happy with your changes and happy for you to merge once @snilsn has a chance to look things over.

freemansw1 avatar Oct 26 '22 21:10 freemansw1