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

FILTER : SliceTriangleGeometry & CreateAMScanPaths #984

Merged

Conversation

jmarquisbq
Copy link
Contributor

@jmarquisbq jmarquisbq commented May 31, 2024

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

@jmarquisbq jmarquisbq force-pushed the topic/create_scan_vectors branch 2 times, most recently from dac0d8e to d2b2944 Compare June 10, 2024 13:28
@jmarquisbq jmarquisbq self-assigned this Jun 13, 2024
@jmarquisbq jmarquisbq added Filter Adds a new filter bug Something isn't working labels Jun 13, 2024
@jmarquisbq jmarquisbq force-pushed the topic/create_scan_vectors branch from 8dbabe7 to f02eb4e Compare June 14, 2024 12:46
@imikejackson imikejackson force-pushed the topic/create_scan_vectors branch from f02eb4e to d242238 Compare June 20, 2024 15:10
@imikejackson
Copy link
Contributor

This needs #998 and #991

@imikejackson imikejackson force-pushed the topic/create_scan_vectors branch 4 times, most recently from 618e785 to 744dc32 Compare June 24, 2024 13:40
@imikejackson imikejackson force-pushed the topic/create_scan_vectors branch 2 times, most recently from 60f5101 to 3e08e5d Compare June 26, 2024 17:54
@imikejackson imikejackson force-pushed the topic/create_scan_vectors branch from 3e08e5d to fe467cf Compare June 26, 2024 19:41
Signed-off-by: Michael Jackson <[email protected]>
@imikejackson imikejackson merged commit 8f24174 into BlueQuartzSoftware:develop Jun 27, 2024
8 checks passed
@jmarquisbq jmarquisbq deleted the topic/create_scan_vectors branch July 25, 2024 19:55
imikejackson added a commit to imikejackson/simplnx that referenced this pull request Oct 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working Filter Adds a new filter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants