BUG: Fix parameter key for Import HDF5 Parameter (#953)

- This will break any current Python codes that use this filter. Signed-off-by: Michael Jackson <mike.jackson@bluequartz.net>
BlueQuartzSoftware · May 8, 2024 · cee8ef7 · cee8ef7
1 parent db204c3
commit cee8ef7
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 3 deletions.
diff --git a/src/Plugins/SimplnxCore/src/SimplnxCore/Filters/ReadHDF5DatasetFilter.hpp b/src/Plugins/SimplnxCore/src/SimplnxCore/Filters/ReadHDF5DatasetFilter.hpp
@@ -26,7 +26,7 @@ class SIMPLNXCORE_EXPORT ReadHDF5DatasetFilter : public IFilter
   ReadHDF5DatasetFilter& operator=(ReadHDF5DatasetFilter&&) noexcept = delete;
 
   // Parameter Keys
-  static inline constexpr StringLiteral k_ImportHDF5File_Key = "import_hd_f5_file";
+  static inline constexpr StringLiteral k_ImportHDF5File_Key = "import_hdf5_object";
 
   /**
    * @brief Reads SIMPL json and converts it simplnx Arguments.

diff --git a/wrapping/python/docs/source/User_API.rst b/wrapping/python/docs/source/User_API.rst
@@ -548,7 +548,7 @@ General Parameters
       import_hdf5_param.datasets = [dataset1, dataset2]
       # import_hdf5_param.parent = nx.DataPath(["Imported Data"])
       result = nx.ReadHDF5DatasetFilter.execute(data_structure=data_structure,
-                                          import_hd_f5_file=import_hdf5_param
+                                          import_hdf5_object=import_hdf5_param
                                           )
 
 

diff --git a/wrapping/python/examples/scripts/import_hdf5.py b/wrapping/python/examples/scripts/import_hdf5.py
@@ -85,7 +85,7 @@
 # import_hdf5_param.parent = nx.DataPath(["Imported Data"])
 
 result = nx.ReadHDF5DatasetFilter.execute(data_structure=data_structure,
-                                      import_hd_f5_file=import_hdf5_param
+                                          import_hdf5_object=import_hdf5_param
                                       )
 nxtest.check_filter_result(nx.ReadHDF5DatasetFilter, result)