ENH: Refactor the Parameter Keys to make them consistent and easy to learn

CMakeLists.txt

@@ -78,7 +78,7 @@ endif()
 file(TO_CMAKE_PATH "${CMAKE_COMMAND}" CMAKE_COMMAND_NORM)
 
 project(simplnx
-  VERSION 1.2.7
+  VERSION 1.3.0
   DESCRIPTION "SIMPL Redesign"
   HOMEPAGE_URL "https://github.com/bluequartzsoftware/simplnx"
   LANGUAGES CXX

conda/meta.yaml

@@ -1,5 +1,5 @@
 {% set name = "simplnx" %}
-{% set version = "1.2.7" %}
+{% set version = "1.3.0" %}
 
 package:
   name: {{ name|lower }}

conda/recipe.yaml

@@ -1,5 +1,5 @@
 context:
-  version: "1.2.7"
+  version: "1.3.0"
   name: simplnx
 
 package:

pipelines/Combo-EBSD-osc_r0c0.d3dpipeline

@@ -7,7 +7,7 @@
       "args": {
         "cell_attribute_matrix_name": "CellData",
         "cell_ensemble_attribute_matrix_name": "CellEnsembleData",
-        "data_container_name": "DataContainer",
+        "output_image_geometry_path": "DataContainer",
         "input_file": "Data/OrientationAnalysis/Combo-EBSD-120130.osc_r0c0.ang"
       },
       "comments": "",
@@ -19,7 +19,7 @@
     },
     {
       "args": {
-        "created_image_geometry": "",
+        "output_image_geometry_path": "",
         "remove_original_geometry": true,
         "rotate_slice_by_slice": false,
         "rotation_axis": [
@@ -55,7 +55,7 @@
           ]
         ],
         "rotation_representation": 0,
-        "selected_image_geometry": "DataContainer"
+        "input_image_geometry_path": "DataContainer"
       },
       "comments": "",
       "filter": {
@@ -83,7 +83,7 @@
     },
     {
       "args": {
-        "array_thresholds": {
+        "array_thresholds_object": {
           "inverted": false,
           "thresholds": [
             {
@@ -98,7 +98,7 @@
           "type": "collection",
           "union": 0
         },
-        "created_data_path": "Mask"
+        "output_data_array_name": "Mask"
       },
       "comments": "",
       "filter": {
@@ -132,7 +132,7 @@
       "args": {
         "file_name": "Data/Output/Examples/Combo-EBSD-osc_r0c0.png",
         "image_array_path": "DataContainer/CellData/IPFColors",
-        "image_geom_path": "DataContainer",
+        "input_image_geometry_path": "DataContainer",
         "index_offset": 0,
         "plane": 0
       },
@@ -165,7 +165,7 @@
         "crystal_structures_array_path": "DataContainer/CellEnsembleData/CrystalStructures",
         "feature_ids_array_name": "FeatureIds",
         "mask_array_path": "DataContainer/CellData/Mask",
-        "image_geometry_path": "DataContainer",
+        "input_image_geometry_path": "DataContainer",
         "misorientation_tolerance": 5.0,
         "quats_array_path": "DataContainer/CellData/Quats",
         "randomize_feature_ids": true,
@@ -181,7 +181,7 @@
     {
       "args": {
         "avg_c_axes_array_path": "AvgCAxes",
-        "cell_feature_attribute_matrix": "DataContainer/CellFeatureData",
+        "cell_feature_attribute_matrix_path": "DataContainer/CellFeatureData",
         "cell_phases_array_path": "DataContainer/CellData/Phases",
         "crystal_structures_array_path": "DataContainer/CellEnsembleData/CrystalStructures",
         "feature_ids_array_path": "DataContainer/CellData/FeatureIds",
@@ -203,7 +203,7 @@
         "feature_ids_array_path": "DataContainer/CellData/FeatureIds",
         "feature_reference_c_axis_misorientations_array_name": "FeatureRefCAxisMisorientation",
         "feature_stdev_c_axis_misorientations_array_name": "StdevCAxisMisorientation",
-        "image_geometry_path": "DataContainer",
+        "input_image_geometry_path": "DataContainer",
         "quats_array_path": "DataContainer/CellData/Quats"
       },
       "comments": "",
@@ -230,7 +230,7 @@
     {
       "args": {
         "output_rgb_array_name": "Feature Ids (Color)",
-        "selected_data_array_path": "DataContainer/CellData/FeatureIds",
+        "input_data_array_path": "DataContainer/CellData/FeatureIds",
         "selected_preset": "hsv",
         "use_mask": false
       },
@@ -243,7 +243,7 @@
     },
     {
       "args": {
-        "array_thresholds": {
+        "array_thresholds_object": {
           "inverted": false,
           "thresholds": [
             {
@@ -258,7 +258,7 @@
           "type": "collection",
           "union": 0
         },
-        "created_data_path": "Mask Inverse"
+        "output_data_array_name": "Mask Inverse"
       },
       "comments": "",
       "filter": {
@@ -287,7 +287,7 @@
       "args": {
         "file_name": "Data/Output/Examples/Combo-EBSD-osc_r0c0._feature_ids.png",
         "image_array_path": "DataContainer/CellData/Feature Ids (Color)",
-        "image_geom_path": "DataContainer",
+        "input_image_geometry_path": "DataContainer",
         "index_offset": 0,
         "plane": 0
       },
@@ -314,9 +314,9 @@
     },
     {
       "args": {
-        "avg_euler_angles_array_path": "AvgEulerAngles",
-        "avg_quats_array_path": "AvgQuats",
-        "cell_feature_attribute_matrix": "DataContainer/CellFeatureData",
+        "avg_euler_angles_array_name": "AvgEulerAngles",
+        "avg_quats_array_name": "AvgQuats",
+        "cell_feature_attribute_matrix_path": "DataContainer/CellFeatureData",
         "cell_feature_ids_array_path": "DataContainer/CellData/FeatureIds",
         "cell_phases_array_path": "DataContainer/CellData/Phases",
         "cell_quats_array_path": "DataContainer/CellData/Quats",
@@ -331,16 +331,16 @@
     },
     {
       "args": {
-        "boundary_cells": "BoundaryCells",
-        "cell_feature_arrays": "DataContainer/CellFeatureData",
-        "feature_ids": "DataContainer/CellData/FeatureIds",
-        "image_geometry": "DataContainer",
-        "neighbor_list": "NeighborList",
-        "number_of_neighbors": "NumNeighbors",
-        "shared_surface_area_list": "SharedSurfaceAreaList",
+        "boundary_cells_name": "BoundaryCells",
+        "cell_feature_array_path": "DataContainer/CellFeatureData",
+        "feature_ids_path": "DataContainer/CellData/FeatureIds",
+        "input_image_geometry_path": "DataContainer",
+        "neighbor_list_name": "NeighborList",
+        "number_of_neighbors_name": "NumNeighbors",
+        "shared_surface_area_list_name": "SharedSurfaceAreaList",
         "store_boundary_cells": false,
         "store_surface_features": false,
-        "surface_features": "SurfaceFeatures"
+        "surface_features_name": "SurfaceFeatures"
       },
       "comments": "",
       "filter": {

pipelines/PorosityAnalysis.d3dpipeline

@@ -7,9 +7,9 @@
       "args": {
         "cell_attribute_matrix_name": "Optical Data",
         "image_data_array_name": "ImageData",
-        "image_geometry_path": "RoboMet.3D Image Stack",
+        "output_image_geometry_path": "RoboMet.3D Image Stack",
         "image_transform_choice": 0,
-        "input_file_list_info": {
+        "input_file_list_object": {
           "end_index": 174,
           "file_extension": ".tif",
           "file_prefix": "slice_",
@@ -40,7 +40,7 @@
     },
     {
       "args": {
-        "array_thresholds": {
+        "array_thresholds_object": {
           "inverted": false,
           "thresholds": [
             {
@@ -55,7 +55,7 @@
           "type": "collection",
           "union": 0
         },
-        "created_data_path": "Mask"
+        "output_data_array_name": "Mask"
       },
       "comments": "",
       "filter": {
@@ -66,10 +66,10 @@
     },
     {
       "args": {
-        "active_array_path": "Active",
-        "cell_feature_group_path": "Pore Data",
+        "active_array_name": "Active",
+        "cell_feature_group_name": "Pore Data",
         "feature_ids_path": "FeatureIds",
-        "grid_geometry_path": "RoboMet.3D Image Stack",
+        "input_image_geometry_path": "RoboMet.3D Image Stack",
         "input_array_path": "RoboMet.3D Image Stack/Optical Data/ImageData",
         "mask_path": "RoboMet.3D Image Stack/Optical Data/Mask",
         "randomize_features": true,
@@ -85,13 +85,13 @@
     },
     {
       "args": {
-        "equivalent_diameters_path": "EquivalentDiameters",
-        "feature_attribute_matrix": "RoboMet.3D Image Stack/Pore Data",
+        "equivalent_diameters_name": "EquivalentDiameters",
+        "feature_attribute_matrix_path": "RoboMet.3D Image Stack/Pore Data",
         "feature_ids_path": "RoboMet.3D Image Stack/Optical Data/FeatureIds",
-        "geometry_path": "RoboMet.3D Image Stack",
-        "num_elements_path": "NumElements",
+        "input_image_geometry_path": "RoboMet.3D Image Stack",
+        "num_elements_name": "NumElements",
         "save_element_sizes": false,
-        "volumes_path": "Volumes"
+        "volumes_name": "Volumes"
       },
       "comments": "",
       "filter": {
@@ -104,7 +104,7 @@
       "args": {
         "created_array_suffix": "",
         "feature_ids_path": "RoboMet.3D Image Stack/Optical Data/FeatureIds",
-        "selected_feature_array_path": ["RoboMet.3D Image Stack/Pore Data/EquivalentDiameters"]
+        "selected_feature_array_paths": ["RoboMet.3D Image Stack/Pore Data/EquivalentDiameters"]
       },
       "comments": "",
       "filter": {
@@ -115,12 +115,12 @@
     },
     {
       "args": {
-        "advanced_options": false,
+        "set_tuple_dimensions": false,
         "component_count": 1,
         "data_format": "",
-        "initialization_value": "1",
+        "initialization_value_str": "1",
         "numeric_type": 4,
-        "output_data_array": "RoboMet.3D Image Stack/Optical Data/Phases",
+        "output_array_path": "RoboMet.3D Image Stack/Optical Data/Phases",
         "tuple_dimensions": [
           [
             0.0
@@ -165,10 +165,10 @@
     },
     {
       "args": {
-        "centroids_array_path": "Centroids",
-        "feature_attribute_matrix": "RoboMet.3D Image Stack/Pore Data",
+        "centroids_array_name": "Centroids",
+        "feature_attribute_matrix_path": "RoboMet.3D Image Stack/Pore Data",
         "feature_ids_path": "RoboMet.3D Image Stack/Optical Data/FeatureIds",
-        "selected_image_geometry": "RoboMet.3D Image Stack"
+        "input_image_geometry_path": "RoboMet.3D Image Stack"
       },
       "comments": "",
       "filter": {
@@ -231,7 +231,7 @@
         "rdf_array_name": "RDF",
         "remove_biased_features": false,
         "seed_value": 5489,
-        "selected_image_geometry": "RoboMet.3D Image Stack",
+        "input_image_geometry_path": "RoboMet.3D Image Stack",
         "set_random_seed": false
       },
       "comments": "",

src/Plugins/ITKImageProcessing/pipelines/(02) Image Segmentation.d3dpipeline

@@ -7,9 +7,9 @@
       "args": {
         "cell_attribute_matrix_name": "Cell Data",
         "image_data_array_name": "ImageData",
-        "image_geometry_path": "ImageDataContainer",
+        "output_image_geometry_path": "ImageDataContainer",
         "image_transform_choice": 0,
-        "input_file_list_info": {
+        "input_file_list_object": {
           "end_index": 174,
           "file_extension": ".tif",
           "file_prefix": "slice_",
@@ -40,7 +40,7 @@
     },
     {
       "args": {
-        "array_thresholds": {
+        "array_thresholds_object": {
           "inverted": false,
           "thresholds": [
             {
@@ -55,7 +55,7 @@
           "type": "collection",
           "union": 0
         },
-        "created_data_path": "Mask"
+        "output_data_array_name": "Mask"
       },
       "comments": "",
       "filter": {
@@ -66,10 +66,10 @@
     },
     {
       "args": {
-        "active_array_path": "Active",
-        "cell_feature_group_path": "CellFeatureData",
-        "feature_ids_path": "FeatureIds",
-        "grid_geometry_path": "ImageDataContainer",
+        "active_array_name": "Active",
+        "cell_feature_group_name": "CellFeatureData",
+        "feature_ids_name": "FeatureIds",
+        "input_image_geometry_path": "ImageDataContainer",
         "input_array_path": "ImageDataContainer/Cell Data/ImageData",
         "mask_path": "ImageDataContainer/Cell Data/Mask",
         "randomize_features": true,
@@ -85,13 +85,13 @@
     },
     {
       "args": {
-        "equivalent_diameters_path": "EquivalentDiameters",
-        "feature_attribute_matrix": "ImageDataContainer/CellFeatureData",
+        "equivalent_diameters_name": "EquivalentDiameters",
+        "feature_attribute_matrix_path": "ImageDataContainer/CellFeatureData",
         "feature_ids_path": "ImageDataContainer/Cell Data/FeatureIds",
-        "geometry_path": "ImageDataContainer",
-        "num_elements_path": "NumElements",
+        "input_image_geometry_path": "ImageDataContainer",
+        "num_elements_name": "NumElements",
         "save_element_sizes": false,
-        "volumes_path": "Volumes"
+        "volumes_name": "Volumes"
       },
       "comments": "",
       "filter": {
@@ -104,7 +104,7 @@
       "args": {
         "created_array_suffix": "",
         "feature_ids_path": "ImageDataContainer/Cell Data/FeatureIds",
-        "selected_feature_array_path": ["ImageDataContainer/CellFeatureData/EquivalentDiameters"]
+        "selected_feature_array_paths": ["ImageDataContainer/CellFeatureData/EquivalentDiameters"]
       },
       "comments": "",
       "filter": {
@@ -115,12 +115,12 @@
     },
     {
       "args": {
-        "advanced_options": false,
+        "set_tuple_dimensions": false,
         "component_count": 1,
         "data_format": "",
-        "initialization_value": "1",
+        "initialization_value_str": "1",
         "numeric_type": 4,
-        "output_data_array": "ImageDataContainer/Cell Data/Phases",
+        "output_array_path": "ImageDataContainer/Cell Data/Phases",
         "tuple_dimensions": [
           [
             164.0,
@@ -167,10 +167,10 @@
     },
     {
       "args": {
-        "centroids_array_path": "Centroids",
-        "feature_attribute_matrix": "ImageDataContainer/CellFeatureData",
+        "centroids_array_name": "Centroids",
+        "feature_attribute_matrix_path": "ImageDataContainer/CellFeatureData",
         "feature_ids_path": "ImageDataContainer/Cell Data/FeatureIds",
-        "selected_image_geometry": "ImageDataContainer"
+        "input_image_geometry_path": "ImageDataContainer"
       },
       "comments": "",
       "filter": {