Add Instrument interface and minimal implementation.

python/lsst/daf/butler/instrument.py

@@ -0,0 +1,70 @@
+# This file is part of daf_butler.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (http://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+
+__all__ = ("Instrument", )
+
+
+class Instrument:
+    """A template method class that can register itself with a
+    `Registry.
+
+    This class should be subclassed by various implementations.
+
+    Attributes
+    ----------
+    camera : `str`
+        Name of the camera.
+    physicalFilters : `list`
+        List of PhysicalFilter entries (each entry being a dict).
+    sensors : `list`
+        List of Sensor entries (each entry being a dict).
+    """
+    @property
+    def camera(self):
+        raise NotImplementedError('Must be specified by derived class')
+
+    physicalFilters = []
+    sensors = []
+
+    def register(self, registry):
+        """Register an instance of this `Instrument` with a `Registry`.
+
+        Creates all relevant `DataUnit` entries.
+        """
+        self._addCamera(registry)
+        self._addPhysicalFilters(registry)
+        self._addSensors(registry)
+
+    def _addCamera(self, registry):
+        registry.addDataUnitEntry('Camera', {'camera': self.camera})
+
+    def _addPhysicalFilters(self, registry):
+        for entry in self.physicalFilters:
+            if 'camera' not in entry:
+                entry['camera'] = self.camera
+            registry.addDataUnitEntry('PhysicalFilter', entry)
+
+    def _addSensors(self, registry):
+        for entry in self.sensors:
+            if 'camera' not in entry:
+                entry['camera'] = self.camera
+            registry.addDataUnitEntry('Sensor', entry)

tests/test_instrument.py

@@ -0,0 +1,69 @@
+# This file is part of daf_butler.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (http://www.lsst.org).
+# See the COPYRIGHT file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# This program is free software: you can redistribute it and/or modify
+# it under the terms of the GNU General Public License as published by
+# the Free Software Foundation, either version 3 of the License, or
+# (at your option) any later version.
+#
+# This program is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with this program.  If not, see <http://www.gnu.org/licenses/>.
+
+import os
+import unittest
+
+import lsst.utils.tests
+
+from lsst.daf.butler.core import Registry
+
+from lsst.daf.butler.instrument import Instrument
+
+"""Tests for Instrument.
+"""
+
+
+class DummyCam(Instrument):
+    camera = 'DummyCam'
+
+    physicalFilters = [{'physical_filter': 'dummy_g'},
+                       {'physical_filter': 'dummy_u'}]
+
+    sensors = [{'sensor': 'one'},
+               {'sensor': 'two'}]
+
+
+class InstrumentTestCase(lsst.utils.tests.TestCase):
+    """Test for Instrument.
+    """
+
+    def setUp(self):
+        self.testDir = os.path.dirname(__file__)
+        self.configFile = os.path.join(self.testDir, "config/basic/butler.yaml")
+
+    def testRegister(self):
+        registry = Registry.fromConfig(self.configFile)
+        dummyCam = DummyCam()
+        dummyCam.register(registry)
+
+
+class MemoryTester(lsst.utils.tests.MemoryTestCase):
+    pass
+
+
+def setup_module(module):
+    lsst.utils.tests.init()
+
+
+if __name__ == "__main__":
+    lsst.utils.tests.init()
+    unittest.main()