Skip to content

VV: Write Image (ITK) fully V&V'ed - #1693

Open
JDuffeyBQ wants to merge 5 commits into
developfrom
vv/ITKImageWriterFilter
Open

VV: Write Image (ITK) fully V&V'ed#1693
JDuffeyBQ wants to merge 5 commits into
developfrom
vv/ITKImageWriterFilter

Conversation

@JDuffeyBQ

Copy link
Copy Markdown
Collaborator

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

Signed-off-by: Jared Duffey <jared.duffey@bluequartz.net>
Signed-off-by: Jared Duffey <jared.duffey@bluequartz.net>
Signed-off-by: Jared Duffey <jared.duffey@bluequartz.net>
Signed-off-by: Jared Duffey <jared.duffey@bluequartz.net>
Summary:
- Found and fixed 2 bugs (fill character validation and
uint32/uint64 wrong type in case)
- Documented 1 deviation from DREAM3D 6.5.171
(D1 default slice-index padding)
- Retired 0 tests (none)
- Augmented existing tests with 4 new test cases including a
templated Class 1 (Analytical) + Class 4 (Invariant) oracle
- Added V&V source-tree deliverables (report, deviations)
- Updated wording in docs

Signed-off-by: Jared Duffey <jared.duffey@bluequartz.net>
imikejackson added a commit to imikejackson/simplnx that referenced this pull request Jul 28, 2026
Both remaining MTR closure gaps were authored on 2026-07-28 (BlueQuartzSoftware#1694
RequireMinNumNeighbors, BlueQuartzSoftware#1693 ITKImageWriter), taking the closure to
29/29 across all branches while develop still reports 18/29.

* Record both PRs in section 1.1 with their oracle classes and state
* Add a required decision on ITK removal versus the submission tag:
  BlueQuartzSoftware#1693 verifies ITKImageWriterFilter in the plugin slated for removal,
  which is correct only if the submission tags before ITK is dropped
* Note that the BlueQuartzSoftware#1693 oracle fixture is format-agnostic and transfers to
  WriteImageFilter if the decision goes the other way
* Rewrite Phase 1 as review-bound rather than effort-bound; authoring is
  done, what remains is the ITK decision, the merge backlog, PR BlueQuartzSoftware#1640,
  and backfilling oracle attestations
* Promote the merge backlog to its own section: 13 of 39 reports exist
  only on unmerged branches and 11 of those are closure filters, so a
  release tag cut today would pin an incomplete evidence package
* Require vv_status.py to report against a named git ref defaulting to
  develop, so the all-branch versus develop gap cannot be hidden
* Refresh counts throughout: 39 reports authored, 26 on develop,
  MTR-adjacent 29 authored of 63

Signed-off-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.

1 participant