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

ENH: Merge Twins Rework and Segment Features Cleanup #955

Merged

Conversation

nyoungbq
Copy link
Contributor

  • Refactored and modernized all the merge twins code
  • Removed the Non-Contiguous NeighborList option from MergeTwins filter
  • Updated MergeTwins documentation (In-Progress still)
  • Removed GroupFeatures Superclass
  • Speed up Segment features by removing unnecessary check
  • Reworked all the Feature IDs randomizer methods in order to simplify, speed up, and modernize the call

Naming Conventions

Naming of variables should descriptive where needed. Loop Control Variables can use i if warranted. Most of these conventions are enforced through the clang-tidy and clang-format configuration files. See the file simplnx/docs/Code_Style_Guide.md for a more in depth explanation.

Filter Checklist

The help file simplnx/docs/Porting_Filters.md has documentation to help you port or write new filters. At the top is a nice checklist of items that should be noted when porting a filter.

Unit Testing

The idea of unit testing is to test the filter for proper execution and error handling. How many variations on a unit test each filter needs is entirely dependent on what the filter is doing. Generally, the variations can fall into a few categories:

  • 1 Unit test to test output from the filter against known exemplar set of data
  • 1 Unit test to test invalid input code paths that are specific to a filter. Don't test that a DataPath does not exist since that test is already performed as part of the SelectDataArrayAction.

Code Cleanup

  • No commented out code (rare exceptions to this is allowed..)
  • No API changes were made (or the changes have been approved)
  • No major design changes were made (or the changes have been approved)
  • Added test (or behavior not changed)
  • Updated API documentation (or API not changed)
  • Added license to new files (if any)
  • Added example pipelines that use the filter
  • Classes and methods are properly documented

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
@imikejackson imikejackson merged commit 0c003a4 into BlueQuartzSoftware:develop May 14, 2024
8 checks passed
@imikejackson imikejackson deleted the enh/merge_twins_cleanup branch May 14, 2024 11:50
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.

None yet

2 participants