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: Label Triangle Geometry and Remove Flagged Triangles Filters #842

Merged

Conversation

nyoungbq
Copy link
Contributor

@nyoungbq nyoungbq commented Jan 31, 2024

  • Added Filters
  • Added Test Cases
  • Added Documentation

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

@nyoungbq nyoungbq requested a review from imikejackson January 31, 2024 21:51
@imikejackson
Copy link
Contributor

Very quick glance at the code I think the Dynamic List array is going to have issues when Out-of-Core comes around. We cross that bridge when we get there.

@nyoungbq
Copy link
Contributor Author

nyoungbq commented Feb 1, 2024

Very quick glance at the code I think the Dynamic List array is going to have issues when Out-of-Core comes around. We cross that bridge when we get there.

Yea the problem is that it's embedded throughout the geometry APIs, so if we want to remove it. It should really be a separate PR rather than be integrated into this one.

@nyoungbq nyoungbq force-pushed the filter/label_triangle_geom branch from 2431de3 to c98c094 Compare February 1, 2024 12:09
@imikejackson imikejackson force-pushed the filter/label_triangle_geom branch from c98c094 to 9aa3b33 Compare February 2, 2024 14:48
@nyoungbq nyoungbq force-pushed the filter/label_triangle_geom branch from 9aa3b33 to 2da3f07 Compare February 2, 2024 15:48
@nyoungbq nyoungbq force-pushed the filter/label_triangle_geom branch from 2da3f07 to eef4306 Compare February 2, 2024 19:48
@imikejackson imikejackson enabled auto-merge (squash) February 2, 2024 20:19
@imikejackson
Copy link
Contributor

Added an example pipeline, updated the STL_Models archive which broke the combine_stl_models test. Other branches/PRs are going to break during testing until this gets merged.

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
@imikejackson imikejackson force-pushed the filter/label_triangle_geom branch from b772c4a to 21f084a Compare February 2, 2024 22:11
@imikejackson imikejackson merged commit d512fa2 into BlueQuartzSoftware:develop Feb 2, 2024
7 checks passed
@nyoungbq nyoungbq deleted the filter/label_triangle_geom branch February 6, 2024 12:34
imikejackson added a commit to imikejackson/simplnx that referenced this pull request Oct 20, 2024
…lueQuartzSoftware#842)

Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
Co-authored-by: Matthew Marine <matthew.marine@bluequartz.net>
Co-authored-by: Michael Jackson <mike.jackson@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.

3 participants