Expose IDataArray/IDataStore resize_tuples method to Python. (#807)

Signed-off-by: Joey Kleingers <[email protected]> Signed-off-by: Michael Jackson <[email protected]> Co-authored-by: Michael Jackson <[email protected]>
BlueQuartzSoftware · Dec 28, 2023 · 4994adb · 4994adb
1 parent 26de993
commit 4994adb
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 7 deletions.
diff --git a/.gitignore b/.gitignore
@@ -28,3 +28,4 @@ CMakeLists.txt.*
 test_data/
 CMakeUserPresets.json
 Workspace
+/__pycache__/
diff --git a/conda/meta.yaml b/conda/meta.yaml
@@ -1,5 +1,5 @@
 {% set name = "simplnx" %}
-{% set version = "1.2.1" %}
+{% set version = "1.2.2" %}
 
 package:
   name: {{ name|lower }}

diff --git a/src/Plugins/SimplnxCore/wrapping/python/simplnxpy.cpp b/src/Plugins/SimplnxCore/wrapping/python/simplnxpy.cpp
@@ -161,6 +161,7 @@ auto BindDataStore(py::handle scope, const char* name)
       py::return_value_policy::reference_internal);
   dataStore.def("__getitem__", &DataStore<T>::at);
   dataStore.def("__len__", &DataStore<T>::getSize);
+  dataStore.def("resize_tuples", &DataStore<T>::resizeTuples, "Resize the tuples with the given shape");
   return dataStore;
 }
 
@@ -703,6 +704,7 @@ PYBIND11_MODULE(simplnx, mod)
   iDataArray.def_property_readonly("tdims", &IDataArray::getTupleShape);
   iDataArray.def_property_readonly("cdims", &IDataArray::getComponentShape);
   iDataArray.def_property_readonly("data_type", &IDataArray::getDataType);
+  iDataArray.def("resize_tuples", &IDataArray::resizeTuples, "Resize the tuples with the given shape");
 
   auto dataArrayInt8 = SIMPLNX_PY_BIND_DATA_ARRAY(mod, Int8Array);
   auto dataArrayUInt8 = SIMPLNX_PY_BIND_DATA_ARRAY(mod, UInt8Array);

diff --git a/wrapping/python/docs/source/DataObjects.rst b/wrapping/python/docs/source/DataObjects.rst
@@ -194,6 +194,16 @@ in the example.
    :ivar store: The DataStore object.
    :ivar dtype: The type of data stored in the DataArray
 
+
+   .. py:method:: resize_tuples
+
+      Resize the DataStore with the given shape array.
+
+      :ivar shape: List: The new dimensions of the DataStore in the order from slowest to fastest
+
+DataArray Example Usage
+^^^^^^^^^^^^^^^^^^^^^^^
+
 This code will create a DataArray called "2D Array" with tuple dimensions of [4,5], 
 3 components at each tuple, of type Float32 with every element initialized to "0.0"
 and then print the name, tuple_dimensions and component_dims of the created DatArray object
@@ -249,6 +259,15 @@ from a created DataArray_ by executing the :ref:`Create Data Array <CreateDataAr
 
       Get a value at a specified index. Use of the numpy view into the DataArray is preferred.
 
+   .. py:method:: resize_tuples
+
+      Resize the DataStore with the given shape array.
+
+      :ivar shape: List: The new dimensions of the DataStore in the order from slowest to fastest
+
+
+DataStore Example Usage
+^^^^^^^^^^^^^^^^^^^^^^^
 
 .. code:: python
 

diff --git a/wrapping/python/docs/source/Overview.rst b/wrapping/python/docs/source/Overview.rst
@@ -205,15 +205,15 @@ created.
 
    .. py:method:: execute()
 
-      :return: A simplnx.IFilter.Result object that contains any warnings or errors
-      that were encountered during the execution of the filter.
-      :rtype: simplnx.IFilter.Result
+      :return: A complex.IFilter.Result object that contains any warnings or errors that were encountered during the execution of the filter.
+
+      :rtype: complex.IFilter.Result
 
    .. py:method:: preflight()
 
-      :return: A simplnx.IFilter.Result object that contains any warnings or errors
-      that were encountered during the preflight of the filter.
-      :rtype: simplnx.IFilter.Result
+      :return: A complex.IFilter.Result object that contains any warnings or errors that were encountered during the preflight of the filter.
+
+      :rtype: complex.IFilter.Result
 
 .. code:: python