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: ReadVtkStructuredPoints added to SimplnxCore #876

Conversation

imikejackson
Copy link
Contributor

Stub code and documentation generated.

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

@imikejackson imikejackson marked this pull request as draft March 1, 2024 19:55
@imikejackson imikejackson requested a review from nyoungbq March 1, 2024 19:55
@imikejackson imikejackson force-pushed the filter/read_vtk_structured_points branch 2 times, most recently from 2fc864f to 8083fbc Compare March 6, 2024 15:24
@imikejackson imikejackson force-pushed the filter/read_vtk_structured_points branch 4 times, most recently from fc93180 to 4b4a04a Compare March 19, 2024 19:41
@imikejackson imikejackson force-pushed the filter/read_vtk_structured_points branch 4 times, most recently from 4618f85 to 9529f6a Compare March 22, 2024 02:35
Stub code and documentation generated.

Signed-off-by: Michael Jackson <[email protected]>
Need to figure out how to return some proxy structure of the point and cell
data arrays.

Signed-off-by: Michael Jackson <[email protected]>
Substantially improved reading speed of text files.

Signed-off-by: Michael Jackson <[email protected]>
@imikejackson imikejackson force-pushed the filter/read_vtk_structured_points branch from 2c9a894 to ce4a66f Compare March 22, 2024 13:45
@imikejackson imikejackson force-pushed the filter/read_vtk_structured_points branch from c361ae0 to 79f6856 Compare March 22, 2024 19:29
@imikejackson imikejackson deleted the filter/read_vtk_structured_points branch April 2, 2024 19:07
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.

2 participants