ENH: Add DataStructure.exists() to the python bindings

Signed-off-by: Michael Jackson <[email protected]>
BlueQuartzSoftware · Apr 17, 2024 · a640bf2 · a640bf2
1 parent e7c7d8e
commit a640bf2
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 15 deletions.
diff --git a/src/Plugins/SimplnxCore/wrapping/python/simplnxpy.cpp b/src/Plugins/SimplnxCore/wrapping/python/simplnxpy.cpp
@@ -521,8 +521,7 @@ PYBIND11_MODULE(simplnx, mod)
   parameters.def("insert_linkable_parameter", &PyInsertLinkableParameter<ChoicesParameter>);
   parameters.def("link_parameters", [](Parameters& self, std::string groupKey, std::string childKey, BoolParameter::ValueType value) { self.linkParameters(groupKey, childKey, value); });
   parameters.def("link_parameters", [](Parameters& self, std::string groupKey, std::string childKey, ChoicesParameter::ValueType value) { self.linkParameters(groupKey, childKey, value); });
-  parameters.def(
-      "__getitem__", [](Parameters& self, std::string_view key) { return self.at(key).get(); }, py::return_value_policy::reference_internal);
+  parameters.def("__getitem__", [](Parameters& self, std::string_view key) { return self.at(key).get(); }, py::return_value_policy::reference_internal);
 
   py::class_<IArrayThreshold, std::shared_ptr<IArrayThreshold>> iArrayThreshold(mod, "IArrayThreshold");
 
@@ -631,16 +630,33 @@ PYBIND11_MODULE(simplnx, mod)
     }
     return self.removeData(pathConversionResult.value());
   });
+
+  dataStructure.def(
+      "exists",
+      [](DataStructure& self, const std::string& path) {
+        auto pathConversionResult = DataPath::FromString(path);
+        if(!pathConversionResult)
+        {
+          return false;
+        }
+        return (nullptr != self.getData(pathConversionResult.value()));
+      },
+      "Returns true if there is a DataStructure object at the given path");
+
+  dataStructure.def("exists", [](DataStructure& self, const DataPath& path) { return (nullptr != self.getData(path)); }, "Returns true if there is a DataStructure object at the given path");
   dataStructure.def("hierarchy_to_str", [](DataStructure& self) {
     std::stringstream ss;
     self.exportHierarchyAsText(ss);
     return ss.str();
   });
-  dataStructure.def("hierarchy_to_graphviz", [](DataStructure& self) {
-    std::stringstream ss;
-    self.exportHierarchyAsGraphViz(ss);
-    return ss.str();
-  });
+  dataStructure.def(
+      "hierarchy_to_graphviz",
+      [](DataStructure& self) {
+        std::stringstream ss;
+        self.exportHierarchyAsGraphViz(ss);
+        return ss.str();
+      },
+      "Returns the DataStructure hierarchy expressed in the 'dot' language. Use a GraphViz package to render.");
   dataStructure.def("get_children", [](DataStructure& self, nx::core::DataPath& parentPath) {
     if(parentPath.empty())
     {
@@ -1318,12 +1334,10 @@ PYBIND11_MODULE(simplnx, mod)
       },
       "name"_a, "path"_a);
   pipeline.def("execute", &ExecutePipeline);
-  pipeline.def(
-      "__getitem__", [](Pipeline& self, Pipeline::index_type index) { return self.at(index); }, py::return_value_policy::reference_internal);
+  pipeline.def("__getitem__", [](Pipeline& self, Pipeline::index_type index) { return self.at(index); }, py::return_value_policy::reference_internal);
   pipeline.def("__len__", &Pipeline::size);
   pipeline.def("size", &Pipeline::size);
-  pipeline.def(
-      "__iter__", [](Pipeline& self) { return py::make_iterator(self.begin(), self.end()); }, py::keep_alive<0, 1>());
+  pipeline.def("__iter__", [](Pipeline& self) { return py::make_iterator(self.begin(), self.end()); }, py::keep_alive<0, 1>());
   pipeline.def(
       "insert",
       [internals](Pipeline& self, Pipeline::index_type index, const IFilter& filter, const py::dict& args) {
@@ -1337,10 +1351,8 @@ PYBIND11_MODULE(simplnx, mod)
   pipeline.def("remove", &Pipeline::removeAt, "index"_a);
 
   pipelineFilter.def("get_args", [internals](PipelineFilter& self) { return ConvertArgsToDict(*internals, self.getParameters(), self.getArguments()); });
-  pipelineFilter.def(
-      "set_args", [internals](PipelineFilter& self, py::dict& args) { self.setArguments(ConvertDictToArgs(*internals, self.getParameters(), args)); }, "args"_a);
-  pipelineFilter.def(
-      "get_filter", [](PipelineFilter& self) { return self.getFilter(); }, py::return_value_policy::reference_internal);
+  pipelineFilter.def("set_args", [internals](PipelineFilter& self, py::dict& args) { self.setArguments(ConvertDictToArgs(*internals, self.getParameters(), args)); }, "args"_a);
+  pipelineFilter.def("get_filter", [](PipelineFilter& self) { return self.getFilter(); }, py::return_value_policy::reference_internal);
 
   py::class_<PyFilter, IFilter> pyFilter(mod, "PyFilter");
   pyFilter.def(py::init<>([](py::object object) { return std::make_unique<PyFilter>(std::move(object)); }));

diff --git a/wrapping/python/examples/scripts/basic_arrays.py b/wrapping/python/examples/scripts/basic_arrays.py
@@ -110,6 +110,15 @@
 nxtest.check_filter_result(nx.CreateDataGroup, result)
 
 
+#------------------------------------------------------------------------------
+# Check if that object exists in the DataStructure
+#------------------------------------------------------------------------------
+value = data_structure.exists("/Some/Path/To/Group")
+print(f'The path "/Some/Path/To/Group" exists: {value} ')
+
+value = data_structure.exists("/Some/Path/To/NonExistantGroup")
+print(f'The path "/Some/Path/To/NonExistantGroup" exists: {value} ')
+
 #------------------------------------------------------------------------------
 # Create 1D Array 
 #------------------------------------------------------------------------------