Skip to content

VV: Require Minimum Number of Neighbors fully V&V'ed - #1694

Open
JDuffeyBQ wants to merge 5 commits into
developfrom
vv/RequireMinNumNeighborsFilter
Open

VV: Require Minimum Number of Neighbors fully V&V'ed#1694
JDuffeyBQ wants to merge 5 commits into
developfrom
vv/RequireMinNumNeighborsFilter

Conversation

@JDuffeyBQ

Copy link
Copy Markdown
Collaborator

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: Jared Duffey <jared.duffey@bluequartz.net>
Signed-off-by: Jared Duffey <jared.duffey@bluequartz.net>
Signed-off-by: Jared Duffey <jared.duffey@bluequartz.net>
Signed-off-by: Jared Duffey <jared.duffey@bluequartz.net>
Summary:
- Confirmed no bugs (Minor changes port)
- Documented 0 deviations from DREAM3D 6.5.171
- Retired 0 tests
- Augmented existing tests with 6 new test cases including a
templated Class 1 (Analytical) + Class 4 (Invariant) oracle
- Added V&V source-tree deliverables (report, deviations)
- Added several new error checks
- Removed some unused code

Signed-off-by: Jared Duffey <jared.duffey@bluequartz.net>
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.

1 participant