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: pipeline conversion #779

Merged
merged 42 commits into from
Dec 18, 2023
Merged

ENH: pipeline conversion #779

merged 42 commits into from
Dec 18, 2023

Conversation

jmarquisbq
Copy link
Contributor

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 complex/docs/Code_Style_Guide.md for a more in depth explanation.

Filter Checklist

The help file complex/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 changed the title Feature/pipeline conversion ENH: pipeline conversion Nov 29, 2023
@jmarquisbq jmarquisbq force-pushed the feature/pipeline_conversion branch from dc4057d to 6d26458 Compare November 29, 2023 16:28
@jmarquisbq jmarquisbq force-pushed the feature/pipeline_conversion branch 2 times, most recently from b406777 to 2204f3d Compare December 1, 2023 15:10
@jmarquisbq jmarquisbq force-pushed the feature/pipeline_conversion branch from b35e179 to 7f4ce81 Compare December 5, 2023 15:05
Copy link
Contributor

@nyoungbq nyoungbq left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good for the most part a few changes. I appreciated the addition of the NX-Runner documentation.

@imikejackson imikejackson force-pushed the feature/pipeline_conversion branch from aef8aa9 to 590129e Compare December 10, 2023 21:58
JDuffeyBQ and others added 15 commits December 15, 2023 11:25
* CreateDataArray, CreateDataGroup, and CreateAttributeMatrix
have their conversion functions implemented

Signed-off-by: Jared Duffey <[email protected]>
* Removed unnecessary inline
* Added fallthrough annotation
* Added anonymous namespace

Signed-off-by: Jared Duffey <[email protected]>
* ArrayCreation to AttributeMatrixSelection & DataObjectName
* ArraySelection to ArraySelection
* ArraySelection to GeometrySelection
* LinkedPathCreation to DataObjectName
* AttributeMatrixSelection to AttributeMatrixSelection
* Float/Double FilterParameter to NumberParameter<float32/float64>
* Bool/LinkedBool FilterParameter to BoolParameter
mmarineBlueQuartz and others added 24 commits December 15, 2023 11:25
* Added Rescale Intensity Image
* Added ITK Legacy UUID Mapping
* Orientation Analysis
* Orientation Analysis
* ComplexCore
* Read CSV Filter was redesigned and json porting needs to be redone.
* Updated UseMask and MaskPath keys
* Update for develop rebase
Filters do not come with arguments if encountering an error during SIMPL pipeline conversion
* Add documentation for CMake generation.
* Improve description for each of the commands.
* Add examples for using each of the commands.

Fixes #731
@mmarineBlueQuartz mmarineBlueQuartz force-pushed the feature/pipeline_conversion branch from dc20f61 to a661f34 Compare December 15, 2023 18:44
@imikejackson imikejackson merged commit d11a7a8 into develop Dec 18, 2023
7 checks passed
@imikejackson imikejackson deleted the feature/pipeline_conversion branch December 18, 2023 18:30
imikejackson added a commit to imikejackson/simplnx that referenced this pull request Oct 20, 2024
* Added utility functions to Result.hpp
* Added IFilter::getDefaultArguments
* Added pipeline conversion functionality
* Added python script to generate SIMPL json conversion code
* Added convert option to nxrunner
* Use placeholder (null IFilter) and continue converting when SIMPL conversion fails to find filter
* Update NX Runner documentation
* Add text to filter conversion error hinting to use for further actions

---------

Signed-off-by: Jared Duffey <[email protected]>
Signed-off-by: Michael Jackson <[email protected]>
Co-authored-by: Jared Duffey <[email protected]>
Co-authored-by: Matthew Marine <[email protected]>
Co-authored-by: Michael Jackson <[email protected]>
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.

5 participants