LSSTApplications  19.0.0-14-gb0260a2+72efe9b372,20.0.0+7927753e06,20.0.0+8829bf0056,20.0.0+995114c5d2,20.0.0+b6f4b2abd1,20.0.0+bddc4f4cbe,20.0.0-1-g253301a+8829bf0056,20.0.0-1-g2b7511a+0d71a2d77f,20.0.0-1-g5b95a8c+7461dd0434,20.0.0-12-g321c96ea+23efe4bbff,20.0.0-16-gfab17e72e+fdf35455f6,20.0.0-2-g0070d88+ba3ffc8f0b,20.0.0-2-g4dae9ad+ee58a624b3,20.0.0-2-g61b8584+5d3db074ba,20.0.0-2-gb780d76+d529cf1a41,20.0.0-2-ged6426c+226a441f5f,20.0.0-2-gf072044+8829bf0056,20.0.0-2-gf1f7952+ee58a624b3,20.0.0-20-geae50cf+e37fec0aee,20.0.0-25-g3dcad98+544a109665,20.0.0-25-g5eafb0f+ee58a624b3,20.0.0-27-g64178ef+f1f297b00a,20.0.0-3-g4cc78c6+e0676b0dc8,20.0.0-3-g8f21e14+4fd2c12c9a,20.0.0-3-gbd60e8c+187b78b4b8,20.0.0-3-gbecbe05+48431fa087,20.0.0-38-ge4adf513+a12e1f8e37,20.0.0-4-g97dc21a+544a109665,20.0.0-4-gb4befbc+087873070b,20.0.0-4-gf910f65+5d3db074ba,20.0.0-5-gdfe0fee+199202a608,20.0.0-5-gfbfe500+d529cf1a41,20.0.0-6-g64f541c+d529cf1a41,20.0.0-6-g9a5b7a1+a1cd37312e,20.0.0-68-ga3f3dda+5fca18c6a4,20.0.0-9-g4aef684+e18322736b,w.2020.45
LSSTDataManagementBasePackage
instrument_tests.py
Go to the documentation of this file.
1 # This file is part of obs_base.
2 #
3 # Developed for the LSST Data Management System.
4 # This product includes software developed by the LSST Project
5 # (https://www.lsst.org).
6 # See the COPYRIGHT file at the top-level directory of this distribution
7 # for details of code ownership.
8 #
9 # This program is free software: you can redistribute it and/or modify
10 # it under the terms of the GNU General Public License as published by
11 # the Free Software Foundation, either version 3 of the License, or
12 # (at your option) any later version.
13 #
14 # This program is distributed in the hope that it will be useful,
15 # but WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
18 #
19 # You should have received a copy of the GNU General Public License
20 # along with this program. If not, see <http://www.gnu.org/licenses/>.
21 
22 """Helpers for writing tests against subclassses of Instrument.
23 
24 These are not tests themselves, but can be subclassed (plus unittest.TestCase)
25 to get a functional test of an Instrument.
26 """
27 
28 import abc
29 import dataclasses
30 
31 from lsst.obs.base import Instrument
32 from lsst.obs.base.gen2to3 import TranslatorFactory
33 from lsst.daf.butler import Registry
34 from lsst.daf.butler import RegistryConfig
35 
36 
37 @dataclasses.dataclass
39  """Values to test against in sublcasses of `InstrumentTests`.
40  """
41 
42  name: str
43  """The name of the Camera this instrument describes."""
44 
45  nDetectors: int
46  """The number of detectors in the Camera."""
47 
48  firstDetectorName: str
49  """The name of the first detector in the Camera."""
50 
51  physical_filters: {str}
52  """A subset of the physical filters should be registered."""
53 
54 
55 class InstrumentTests(metaclass=abc.ABCMeta):
56  """Tests of sublcasses of Instrument.
57 
58  TestCase subclasses must derive from this, then `TestCase`, and override
59  ``data`` and ``instrument``.
60  """
61 
62  data = None
63  """`InstrumentTestData` containing the values to test against."""
64 
65  instrument = None
66  """The `~lsst.obs.base.Instrument` to be tested."""
67 
68  def test_name(self):
69  self.assertEqual(self.instrument.getName(), self.data.name)
70 
71  def test_getCamera(self):
72  """Test that getCamera() returns a reasonable Camera definition.
73  """
74  camera = self.instrument.getCamera()
75  self.assertEqual(camera.getName(), self.instrument.getName())
76  self.assertEqual(len(camera), self.data.nDetectors)
77  self.assertEqual(next(iter(camera)).getName(), self.data.firstDetectorName)
78 
79  def test_register(self):
80  """Test that register() sets appropriate Dimensions.
81  """
82  registryConfig = RegistryConfig()
83  registryConfig["db"] = "sqlite://"
84  registry = Registry.createFromConfig(registryConfig)
85  # check that the registry starts out empty
86  self.assertFalse(registry.queryDataIds(["instrument"]).toSequence())
87  self.assertFalse(registry.queryDataIds(["detector"]).toSequence())
88  self.assertFalse(registry.queryDataIds(["physical_filter"]).toSequence())
89 
90  # register the instrument and check that certain dimensions appear
91  self.instrument.register(registry)
92  instrumentDataIds = registry.queryDataIds(["instrument"]).toSequence()
93  self.assertEqual(len(instrumentDataIds), 1)
94  instrumentNames = {dataId["instrument"] for dataId in instrumentDataIds}
95  self.assertEqual(instrumentNames, {self.data.name})
96  detectorDataIds = registry.queryDataIds(["detector"]).expanded().toSequence()
97  self.assertEqual(len(detectorDataIds), self.data.nDetectors)
98  detectorNames = {dataId.records["detector"].full_name for dataId in detectorDataIds}
99  self.assertIn(self.data.firstDetectorName, detectorNames)
100  physicalFilterDataIds = registry.queryDataIds(["physical_filter"]).toSequence()
101  filterNames = {dataId['physical_filter'] for dataId in physicalFilterDataIds}
102  self.assertGreaterEqual(filterNames, self.data.physical_filters)
103 
104  # Check that the instrument class can be retrieved
105  registeredInstrument = Instrument.fromName(self.instrument.getName(), registry)
106  self.assertEqual(type(registeredInstrument), type(self.instrument))
107 
108  # Check that re-registration is not an error.
109  self.instrument.register(registry)
110 
112  factory = self.instrument.makeDataIdTranslatorFactory()
113  self.assertIsInstance(factory, TranslatorFactory)
114  str(factory) # just make sure this doesn't raise.
astshim.fitsChanContinued.next
def next(self)
Definition: fitsChanContinued.py:105
lsst.obs.base.instrument_tests.InstrumentTests.test_name
def test_name(self)
Definition: instrument_tests.py:68
lsst.obs.base.gen2to3
Definition: __init__.py:1
lsst.obs.base.instrument_tests.InstrumentTests
Definition: instrument_tests.py:55
lsst.obs.base.instrument_tests.InstrumentTests.data
data
Definition: instrument_tests.py:62
lsst.obs.base.instrument_tests.InstrumentTests.testMakeTranslatorFactory
def testMakeTranslatorFactory(self)
Definition: instrument_tests.py:111
lsst.obs.base.instrument_tests.InstrumentTests.test_register
def test_register(self)
Definition: instrument_tests.py:79
lsst.gdb.ip.diffim.printers.register
def register(obj)
Definition: printers.py:20
type
table::Key< int > type
Definition: Detector.cc:163
lsst.obs.base.instrument_tests.InstrumentTests.instrument
instrument
Definition: instrument_tests.py:65
lsst.obs.base.instrument_tests.InstrumentTests.test_getCamera
def test_getCamera(self)
Definition: instrument_tests.py:71
astshim.fitsChanContinued.iter
def iter(self)
Definition: fitsChanContinued.py:88
lsst.obs.base
Definition: __init__.py:1
lsst.obs.base.instrument_tests.InstrumentTestData
Definition: instrument_tests.py:38