Skip to content

ENH: Refresh stale filter arguments in example pipelines#1677

Open
imikejackson wants to merge 1 commit into
BlueQuartzSoftware:developfrom
imikejackson:topic/fix_stale_parameters_in_pipelines
Open

ENH: Refresh stale filter arguments in example pipelines#1677
imikejackson wants to merge 1 commit into
BlueQuartzSoftware:developfrom
imikejackson:topic/fix_stale_parameters_in_pipelines

Conversation

@imikejackson

Copy link
Copy Markdown
Contributor

Summary

Refreshes 44 example .d3dpipeline files whose filter arguments had gone stale as filters gained or renamed parameters, eliminating the -5432/-5433 "Parameter key not found" warnings DREAM3D-NX shows when loading them.

  • Each stale pipeline was round-tripped through Pipeline::FromFiletoJson (via the python bindings) so every filter now serializes its current full parameter key set, defaults, and parameters_version — identical to what DREAM3D-NX would save today.
  • Three renamed keys were migrated value-preserving instead of falling back to defaults:
    • surface_mesh_face_ipf_colors_array_namefirst_face_ipf_colors_array_name (following the filter's own SIMPL-converter precedent; the second color array keeps its default name)
    • surface_mesh_face_misorientation_colors_array_namemisorientation_array_name
    • z_value_choicez_value_choice_index
  • GUI-level top-level fields (pipeline_uuid, workflowParams, pinnedParams) and all filter comments are preserved; core Pipeline::toJson does not emit the GUI fields, so they were re-applied from the original files.
  • V&V comparison pipelines under vv/ are deliberately untouched (provenance artifacts).

Test Plan

  • Preflight sweep of all 68 example pipelines with nxrunner shows zero missing/obsolete parameter-key warnings (only the intentionally excluded vv/ pipeline still warns).
  • Line-level diff audit confirms no argument values were lost — only added keys with defaults, version bumps, and the three value-preserving renames.
  • Import_CSV_File.d3dpipeline executes end-to-end cleanly via nxrunner.

Note: ExtractFeatureBoundaries2D.d3dpipeline contains a pre-existing hard-coded absolute input path from another machine and cannot execute portably; left for a separate fix.

* Round-trips 44 example pipelines through Pipeline::FromFile/toJson so
  every filter carries its current full parameter key set and version,
  eliminating the -5432/-5433 load warnings DREAM3D-NX shows
* Value-preserving key renames: surface_mesh_face_ipf_colors_array_name
  -> first_face_ipf_colors_array_name, surface_mesh_face_misorientation_
  colors_array_name -> misorientation_array_name, z_value_choice ->
  z_value_choice_index
* GUI-level top-level fields (pipeline_uuid, workflowParams,
  pinnedParams) and all filter comments preserved
* V&V comparison pipelines left untouched (provenance artifacts)

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