Coverage for python/astro_metadata_translator/tests.py: 19%
105 statements
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-06 03:48 -0700
« prev ^ index » next coverage.py v7.4.4, created at 2024-04-06 03:48 -0700
1# This file is part of astro_metadata_translator.
2#
3# Developed for the LSST Data Management System.
4# This product includes software developed by the LSST Project
5# (http://www.lsst.org).
6# See the LICENSE file at the top-level directory of this distribution
7# for details of code ownership.
8#
9# Use of this source code is governed by a 3-clause BSD-style
10# license that can be found in the LICENSE file.
12from __future__ import annotations
14__all__ = ("read_test_file", "MetadataAssertHelper")
16import json
17import os
18import pickle
19import warnings
20from collections.abc import MutableMapping
21from typing import TYPE_CHECKING, Any, NoReturn
23import astropy.units as u
24import astropy.utils.exceptions
25import yaml
26from astropy.io.fits import Header
27from astropy.io.fits.verify import VerifyWarning
28from astropy.time import Time
30from astro_metadata_translator import ObservationInfo
32# PropertyList is optional
33try:
34 import lsst.daf.base as daf_base
35except ImportError:
36 daf_base = None
39# For YAML >= 5.1 need a different Loader for the constructor
40Loader: type[yaml.Loader] | type[yaml.FullLoader]
41try:
42 Loader = yaml.FullLoader
43except AttributeError:
44 Loader = yaml.Loader
47# Define a YAML loader for lsst.daf.base.PropertySet serializations that
48# we can use if daf_base is not available.
49def pl_constructor(loader: yaml.Loader, node: yaml.SequenceNode) -> Any:
50 """Construct an OrderedDict from a YAML file containing a PropertyList.
52 Parameters
53 ----------
54 loader : `yaml.Loader`
55 Instance used to load YAML file.
56 node : `yaml.SequenceNode`
57 Node to examine.
59 Yields
60 ------
61 pl : `dict`
62 Contents of PropertyList as a dict.
63 """
64 pl: dict[str, Any] = {}
65 yield pl
66 state = loader.construct_sequence(node, deep=True)
67 for key, dtype, value, comment in state:
68 if dtype == "Double":
69 pl[key] = float(value)
70 elif dtype == "Int":
71 pl[key] = int(value)
72 elif dtype == "Bool":
73 pl[key] = value
74 else:
75 pl[key] = value
78if daf_base is None: 78 ↛ 79line 78 didn't jump to line 79, because the condition on line 78 was never true
79 yaml.add_constructor("lsst.daf.base.PropertyList", pl_constructor, Loader=Loader) # type: ignore
82def read_test_file(filename: str, dir: str | None = None) -> MutableMapping[str, Any]:
83 """Read the named test file relative to the location of this helper.
85 Parameters
86 ----------
87 filename : `str`
88 Name of file in the data directory.
89 dir : `str`, optional
90 Directory from which to read file. Current directory used if none
91 specified.
93 Returns
94 -------
95 header : `dict`-like
96 Header read from file.
97 """
98 if dir is not None and not os.path.isabs(filename):
99 filename = os.path.join(dir, filename)
100 with open(filename) as fd:
101 if filename.endswith(".yaml"):
102 header = yaml.load(fd, Loader=Loader)
103 elif filename.endswith(".json"):
104 header = json.load(fd)
105 else:
106 raise RuntimeError(f"Unrecognized file format: {filename}")
108 # Cannot directly check for Mapping because PropertyList is not one
109 if not hasattr(header, "items"):
110 raise ValueError(f"Contents of YAML file {filename} are not a mapping, they are {type(header)}")
111 return header
114class MetadataAssertHelper:
115 """Class with helpful asserts that can be used for testing metadata
116 translations.
117 """
119 # This class is assumed to be combined with unittest.TestCase but mypy
120 # does not know this. We need to teach mypy about the APIs we are using.
121 if TYPE_CHECKING:
123 def assertAlmostEqual( # noqa: N802
124 self,
125 a: float,
126 b: float,
127 places: int | None = None,
128 msg: str | None = None,
129 delta: float | None = None,
130 ) -> None:
131 pass
133 def assertIsNotNone(self, a: Any, msg: str | None = None) -> None: # noqa: N802
134 pass
136 def assertEqual(self, a: Any, b: Any, msg: str | None = None) -> None: # noqa: N802
137 pass
139 def assertLess(self, a: Any, b: Any, msg: str | None = None) -> None: # noqa: N802
140 pass
142 def assertLessEqual(self, a: Any, b: Any, msg: str | None = None) -> None: # noqa: N802
143 pass
145 def fail(self, msg: str) -> NoReturn:
146 pass
148 def assertCoordinatesConsistent( # noqa: N802
149 self, obsinfo: ObservationInfo, max_sep: float = 1.0, amdelta: float = 0.01
150 ) -> None:
151 """Check that SkyCoord, AltAz, and airmass are self consistent.
153 Parameters
154 ----------
155 obsinfo : `ObservationInfo`
156 Object to check.
157 max_sep : `float`, optional
158 Maximum separation between AltAz derived from RA/Dec headers
159 and that found in the AltAz headers.
160 amdelta : `float`, optional
161 Max difference between header airmass and derived airmass.
163 Raises
164 ------
165 AssertionError
166 Inconsistencies found.
167 """
168 self.assertIsNotNone(obsinfo.tracking_radec, msg="Checking tracking_radec is defined")
169 self.assertIsNotNone(obsinfo.altaz_begin, msg="Checking AltAz is defined")
171 # Is airmass from header close to airmass from AltAz headers?
172 # In most cases there is uncertainty over whether the elevation
173 # and airmass in the header are for the start, end, or middle
174 # of the observation. Sometimes the AltAz is from the start
175 # but the airmass is from the middle so accuracy is not certain.
176 self.assertAlmostEqual(
177 obsinfo.altaz_begin.secz.to_value(),
178 obsinfo.boresight_airmass,
179 delta=amdelta,
180 msg="Checking airmass is consistent",
181 )
183 # Is AltAz from headers close to AltAz from RA/Dec headers?
184 # Can trigger warnings from Astropy if date is in future
185 with warnings.catch_warnings():
186 warnings.simplefilter("ignore", category=astropy.utils.exceptions.AstropyWarning)
187 sep = obsinfo.altaz_begin.separation(obsinfo.tracking_radec.altaz)
188 self.assertLess(sep.to_value(unit="arcmin"), max_sep, msg="AltAz inconsistent with RA/Dec")
190 def assertObservationInfoFromYaml( # noqa: N802
191 self,
192 file: str,
193 dir: str | None = None,
194 check_wcs: bool = True,
195 wcs_params: dict[str, Any] | None = None,
196 check_altaz: bool = False,
197 **kwargs: Any,
198 ) -> None:
199 """Check contents of an ObservationInfo.
201 Parameters
202 ----------
203 file : `str`
204 Path to YAML file representing the header.
205 dir : `str`, optional
206 Optional directory from which to read ``file``.
207 check_wcs : `bool`, optional
208 Check the consistency of the RA/Dec and AltAz values.
209 wcs_params : `dict`, optional
210 Parameters to pass to `assertCoordinatesConsistent`.
211 check_altaz : `bool`, optional
212 Check that an alt/az value has been calculated.
213 **kwargs : `dict`
214 Keys matching `ObservationInfo` properties with values
215 to be tested.
217 Raises
218 ------
219 AssertionError
220 A value in the ObservationInfo derived from the file is
221 inconsistent.
222 """
223 header = read_test_file(file, dir=dir)
225 # DM-30093: Astropy Header does not always behave dict-like
226 astropy_header = Header()
227 for key, val in header.items():
228 values = val if isinstance(val, list) else [val]
229 for v in values:
230 # Appending ensures *all* duplicated keys are also preserved.
231 # astropy.io.fits complains about long keywords rather than
232 # letting us say "thank you for using the standard to let
233 # us write this header" so we need to catch the warnings.
234 with warnings.catch_warnings():
235 warnings.simplefilter("ignore", category=VerifyWarning)
236 astropy_header.append((key, v))
238 for hdr in (header, astropy_header):
239 try:
240 self.assertObservationInfo(
241 header,
242 filename=file,
243 check_wcs=check_wcs,
244 wcs_params=wcs_params,
245 check_altaz=check_altaz,
246 **kwargs,
247 )
248 except AssertionError as e:
249 raise AssertionError(
250 f"ObservationInfo derived from {type(hdr)} type is inconsistent: {e}"
251 ) from e
253 def assertObservationInfo( # noqa: N802
254 self,
255 header: MutableMapping[str, Any],
256 filename: str | None = None,
257 check_wcs: bool = True,
258 wcs_params: dict[str, Any] | None = None,
259 check_altaz: bool = False,
260 **kwargs: Any,
261 ) -> None:
262 """Check contents of an ObservationInfo.
264 Parameters
265 ----------
266 header : `dict`-like
267 Header to be checked.
268 filename : `str`, optional
269 Name of the filename associated with this header if known.
270 check_wcs : `bool`, optional
271 Check the consistency of the RA/Dec and AltAz values. Checks
272 are automatically disabled if the translated header does
273 not appear to be "science".
274 wcs_params : `dict`, optional
275 Parameters to pass to `assertCoordinatesConsistent`.
276 check_altaz : `bool`, optional
277 Check that an alt/az value has been calculated.
278 **kwargs : `dict`
279 Keys matching `ObservationInfo` properties with values
280 to be tested.
282 Raises
283 ------
284 AssertionError
285 A value in the ObservationInfo derived from the file is
286 inconsistent.
287 """
288 # For testing we force pedantic mode since we are in charge
289 # of all the translations
290 obsinfo = ObservationInfo(header, pedantic=True, filename=filename)
291 translator = obsinfo.translator_class_name
293 # Check that we can pickle and get back the same properties
294 newinfo = pickle.loads(pickle.dumps(obsinfo))
295 self.assertEqual(obsinfo, newinfo)
297 # Check the properties
298 for property, expected in kwargs.items():
299 calculated = getattr(obsinfo, property)
300 msg = f"Comparing property {property} using translator {translator}"
301 if isinstance(expected, u.Quantity) and calculated is not None:
302 calculated = calculated.to_value(unit=expected.unit)
303 expected = expected.to_value()
304 self.assertAlmostEqual(calculated, expected, msg=msg)
305 elif isinstance(calculated, u.Quantity):
306 # Only happens if the test is not a quantity when it should be
307 self.fail(f"Expected {expected!r} but got Quantity '{calculated}': {msg}")
308 elif isinstance(expected, float) and calculated is not None:
309 self.assertAlmostEqual(calculated, expected, msg=msg)
310 else:
311 self.assertEqual(calculated, expected, msg=msg)
313 # Date comparison error reports will benefit by specifying ISO
314 # format. Generate a new Time object at fixed precision
315 # to work around the fact that (as of astropy 3.1) adding 0.0 seconds
316 # to a Time results in a new Time object that is a few picoseconds in
317 # the past.
318 def _format_date_for_testing(date: Time | None) -> Time | None:
319 if date is not None:
320 date.format = "isot"
321 date.precision = 9
322 date = Time(str(date), scale=date.scale, format="isot")
323 return date
325 datetime_begin = _format_date_for_testing(obsinfo.datetime_begin)
326 datetime_end = _format_date_for_testing(obsinfo.datetime_end)
328 # Check that dates are defined and end is the same or after beginning
329 self.assertLessEqual(datetime_begin, datetime_end)
331 # Check that exposure time is not outside datetime_end
332 self.assertLessEqual(obsinfo.datetime_begin + obsinfo.exposure_time, obsinfo.datetime_end)
334 # Do we expect an AltAz value or not.
335 if check_altaz:
336 self.assertIsNotNone(obsinfo.altaz_begin, "altaz_begin is None but should have a value")
338 # Check the WCS consistency
339 if check_wcs and obsinfo.observation_type == "science":
340 if wcs_params is None:
341 wcs_params = {}
342 self.assertCoordinatesConsistent(obsinfo, **wcs_params)