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: Map Point Cloud to Regular Grid Filter Modernization #1109

Merged

Conversation

nyoungbq
Copy link
Contributor

@nyoungbq nyoungbq commented Oct 18, 2024

Fixes: #1091

Miscellaneous Bug Fix:

  • patched out 3 incorrect inline in ITK source file

Map Point Cloud to Regular Grid Filter:

  • added options for silent, warning, error
  • added ability to set custom out of bounds value to
  • updated mask array to accept bool or uint8
  • stripped unneeded data
  • changed progress reporting to one second schema
  • extensive typing update
  • very verbose feedback messages
  • updated documentation

Image of Out-of-Bounds Handling Error on First Instance:
image

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 October 18, 2024 14:13
@nyoungbq nyoungbq force-pushed the enh/pt_to_reg_grid_ofb_value branch from ae156ab to 16ff00b Compare October 18, 2024 19:23
@nyoungbq nyoungbq enabled auto-merge (squash) October 18, 2024 21:07
@nyoungbq nyoungbq force-pushed the enh/pt_to_reg_grid_ofb_value branch from 16ff00b to dd1d883 Compare October 22, 2024 11:11
@imikejackson imikejackson force-pushed the enh/pt_to_reg_grid_ofb_value branch from dd1d883 to d54ffba Compare October 22, 2024 18:21
@imikejackson imikejackson disabled auto-merge October 22, 2024 18:21
@imikejackson imikejackson merged commit 5cf455d into BlueQuartzSoftware:develop Oct 22, 2024
7 checks passed
@imikejackson imikejackson deleted the enh/pt_to_reg_grid_ofb_value branch October 22, 2024 18:23
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.

Map Point Cloud To Regular Grid Filter Updates
2 participants