tobac icon indicating copy to clipboard operation
tobac copied to clipboard

Feature: Identify object "families" using segmentation data

Open freemansw1 opened this issue 1 year ago • 3 comments

This is a long-promised feature to identify object families/systems by identifying where segmented objects touch.

I think this could probably use some more documentation beyond the docstring, but I wanted to get the feature in PR form first.

  • [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?
  • [x] Have you added NumPy docstrings for newly added functions?
  • [x] Have you formatted your code using black?
  • [x] 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?

freemansw1 avatar Jan 17 '24 19:01 freemansw1

Linting results by Pylint:

Your code has been rated at 8.72/10 (previous run: 8.72/10, +0.00) The linting score is an indicator that reflects how well your code version follows Pylint’s coding standards and quality metrics with respect to the RC_v1.5.x branch. A decrease usually indicates your new code does not fully meet style guidelines or has potential errors.

github-actions[bot] avatar Jan 17 '24 19:01 github-actions[bot]

Codecov Report

Attention: 2 lines in your changes are missing coverage. Please review.

Comparison is base (2e4c9d0) 56.91% compared to head (95063e7) 57.18%.

Files Patch % Lines
tobac/utils/general.py 92.30% 2 Missing :warning:
Additional details and impacted files
@@              Coverage Diff              @@
##           RC_v1.5.x     #398      +/-   ##
=============================================
+ Coverage      56.91%   57.18%   +0.26%     
=============================================
  Files             20       20              
  Lines           3440     3466      +26     
=============================================
+ Hits            1958     1982      +24     
- Misses          1482     1484       +2     
Flag Coverage Δ
unittests 57.18% <92.30%> (+0.26%) :arrow_up:

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

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

codecov[bot] avatar Jan 17 '24 19:01 codecov[bot]

Naming suggestion: "cluster" for a collection of features at one time step

w-k-jones avatar Mar 07 '24 17:03 w-k-jones