Implement getDatabaseFilterLabel.

lsst · Oct 27, 2020 · 2ee1984 · 2ee1984
1 parent f9cb88b
commit 2ee1984
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 3 deletions.
diff --git a/include/lsst/afw/image/FilterLabel.h b/include/lsst/afw/image/FilterLabel.h
@@ -146,6 +146,13 @@ class FilterLabel final : public table::io::PersistableFacade<FilterLabel>, publ
     static Factory factory;
 };
 
+/**
+ * Remap special characters, etc. to "_" for database fields.
+ *
+ * @return The filter label in database-sanitized format.
+ */
+std::string getDatabaseFilterLabel(std::string const &filterLabel);
+
 }  // namespace image
 }  // namespace afw
 }  // namespace lsst

diff --git a/python/lsst/afw/image/filterLabel.cc b/python/lsst/afw/image/filterLabel.cc
@@ -64,7 +64,7 @@ PyFilterLabel declare(py::module& mod) {
     return PyFilterLabel(mod, "FilterLabel", initDoc);
 }
 
-void define(PyFilterLabel& cls) {
+void define(py::module& mod, PyFilterLabel& cls) {
     table::io::python::addPersistableMethods(cls);
 
     cls.def_static("fromBandPhysical", &FilterLabel::fromBandPhysical, "band"_a, "physical"_a);
@@ -112,6 +112,10 @@ void define(PyFilterLabel& cls) {
     // Neither __copy__ nor __deepcopy__ default to each other
     cls.def("__copy__", [](const FilterLabel& obj) { return obj.cloneStorable(); });
     cls.def("__deepcopy__", [](const FilterLabel& obj, py::dict& memo) { return obj.cloneStorable(); });
+
+    // Free functions
+
+    mod.def("getDatabaseFilterLabel", &getDatabaseFilterLabel, "filterLabel"_a);
 }
 
 PYBIND11_MODULE(filterLabel, mod) {
@@ -122,7 +126,7 @@ PYBIND11_MODULE(filterLabel, mod) {
     // then import dependencies used in method signatures
     // none
     // and now we can safely define methods and other attributes
-    define(cls);
+    define(mod, cls);
 }
 
 }  // namespace

diff --git a/src/image/FilterLabel.cc b/src/image/FilterLabel.cc
@@ -22,6 +22,7 @@
  */
 
 #include <memory>
+#include <regex>
 
 #include "lsst/utils/hashCombine.h"
 #include "lsst/pex/exceptions.h"
@@ -41,6 +42,11 @@ namespace lsst {
 namespace afw {
 namespace image {
 
+std::string getDatabaseFilterLabel(std::string const &filterLabel) {
+    static std::regex const unsafeCharacters("\\W"s);
+    return std::regex_replace(filterLabel, unsafeCharacters, "_"s);
+}
+
 namespace impl {
 // Hack to allow unit tests to test states that, while legal, are
 // not produced by (and should not be required of) standard factories.

diff --git a/tests/test_filterLabel.py b/tests/test_filterLabel.py
@@ -24,7 +24,7 @@
 
 import lsst.utils.tests
 
-from lsst.afw.image import FilterLabel
+from lsst.afw.image import FilterLabel, getDatabaseFilterLabel
 
 
 class FilterLabelTestCase(lsst.utils.tests.TestCase):
@@ -140,6 +140,13 @@ def testCopy(self):
             copy2 = copy.deepcopy(label)
             self._checkCopy(copy2, label)
 
+    def testDatabaseLabel(self):
+        self.assertEqual(getDatabaseFilterLabel("k"), "k")
+        self.assertEqual(getDatabaseFilterLabel("k-0234"), "k_0234")
+        self.assertEqual(getDatabaseFilterLabel("g decam 0101"), "g_decam_0101")
+        self.assertEqual(getDatabaseFilterLabel("speci@l band"), "speci_l_band")
+        self.assertEqual(getDatabaseFilterLabel("\"hacky, (42);"), "_hacky___42__")
+
 
 class TestMemory(lsst.utils.tests.MemoryTestCase):
     pass