astro-metadata-translator 29.0.1__tar.gz → 29.2025.1700__tar.gz

{astro_metadata_translator-29.0.1/python/astro_metadata_translator.egg-info → astro_metadata_translator-29.2025.1700}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: astro-metadata-translator
-Version: 29.0.1
+Version: 29.2025.1700
 Summary: A translator for astronomical metadata.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License: BSD 3-Clause License

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700}/python/astro_metadata_translator/observationInfo.py

@@ -115,6 +115,7 @@ class ObservationInfo:
         datetime_end: astropy.time.Time
         exposure_group: str
         exposure_time: astropy.units.Quantity
+        exposure_time_requested: astropy.units.Quantity
         dark_time: astropy.units.Quantity
         boresight_airmass: float
         boresight_rotation_angle: astropy.units.Quantity
@@ -131,6 +132,7 @@ class ObservationInfo:
         relative_humidity: float
         tracking_radec: astropy.coordinates.SkyCoord
         altaz_begin: astropy.coordinates.AltAz
+        altaz_end: astropy.coordinates.AltAz | None
         science_program: str
         observation_counter: int
         observation_reason: str

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700}/python/astro_metadata_translator/properties.py

@@ -460,7 +460,14 @@ may not be.""",
         simple_to_datetime,
     ),
     "exposure_time": PropertyDefinition(
-        "Duration of the exposure with shutter open (seconds).",
+        "Actual duration of the exposure (seconds).",
+        "astropy.units.Quantity",
+        astropy.units.Quantity,
+        exptime_to_simple,
+        simple_to_exptime,
+    ),
+    "exposure_time_requested": PropertyDefinition(
+        "Requested duration of the exposure (seconds).",
         "astropy.units.Quantity",
         astropy.units.Quantity,
         exptime_to_simple,
@@ -550,6 +557,13 @@ may not be.""",
         altaz_to_simple,
         simple_to_altaz,
     ),
+    "altaz_end": PropertyDefinition(
+        "Telescope boresight azimuth and elevation at end of observation.",
+        "astropy.coordinates.AltAz",
+        astropy.coordinates.AltAz,
+        altaz_to_simple,
+        simple_to_altaz,
+    ),
     "science_program": PropertyDefinition("Observing program (survey or proposal) identifier.", "str", str),
     "observation_type": PropertyDefinition(
         "Type of observation (currently: science, dark, flat, bias, focus).",

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700}/python/astro_metadata_translator/translator.py

@@ -1042,6 +1042,34 @@ class MetadataTranslator:
             return "science"
         return "unknown"
 
+    @cache_translation
+    def to_exposure_time_requested(self) -> astropy.units.Quantity:
+        """Return the requested exposure time in seconds.
+
+        Base class implementations returns the same value as ``exposure_time``.
+        This information may not be available for all instruments.
+
+        Returns
+        -------
+        exptime : `astropy.units.Quantity`
+            The recorded exposure time in seconds.
+        """
+        return self.to_exposure_time()
+
+    @cache_translation
+    def to_altaz_end(self) -> astropy.coordinates.AltAz | None:
+        """Return the AltAz for the end of the observation.
+
+        Base class implementation returns `None`. Subclasses should override
+        if the value is known.
+
+        Returns
+        -------
+        altaz : `astropy.coordinates.AltAz` or `None`
+            The AltAz for the end of the observation.
+        """
+        return None
+
     @classmethod
     def observing_date_to_offset(cls, observing_date: astropy.time.Time) -> astropy.time.TimeDelta | None:
         """Calculate the observing day offset to apply for a given observation.

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700}/python/astro_metadata_translator/translators/decam.py

@@ -61,6 +61,7 @@ class DecamTranslator(FitsTranslator):
 
     _trivial_map: dict[str, str | list[str] | tuple[Any, ...]] = {
         "exposure_time": ("EXPTIME", {"unit": u.s}),
+        "exposure_time_requested": ("EXPREQ", {"unit": u.s}),
         "dark_time": ("DARKTIME", {"unit": u.s}),
         "boresight_airmass": ("AIRMASS", {"checker": is_non_science}),
         "observation_id": "OBSID",

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700}/python/astro_metadata_translator/translators/helpers.py

@@ -149,12 +149,16 @@ def altaz_from_degree_headers(
     altazpairs: tuple[tuple[str, str], ...],
     obstime: astropy.time.Time,
     is_zd: set[str] | None = None,
+    max_alt: float = 90.0,
+    min_alt: float = 0.0,
 ) -> AltAz:
     """Calculate the altitude/azimuth coordinates from lists of headers.
 
-    If the altitude is found but is greater than 90 deg, it will be returned
-    fixed at 90 deg.
-    If the altitude or azimuth are negative and this is a calibration
+    If the altitude is found but is greater than the maximum allowed value,
+    it will be returned fixed at that maximum value.
+    If the altitude is found but is less than the minimum allowed value, it
+    will be returned clipped to that minimum value.
+    If the azimuth is less than -360.0 and this is not a science
     observation, `None` will be returned.
 
     Parameters
@@ -167,6 +171,15 @@ def altaz_from_degree_headers(
     is_zd : `set`, optional
         Contains keywords that correspond to zenith distances rather than
         altitude.
+    max_alt : `float`, optional
+        Maximum allowed altitude in degrees. Will be clamped to this value if
+        out of range. This value will be forced to +90 if it exceeds +90
+        since `astropy.coordinates.AltAz` does not allow a value larger than
+        this even if that is caused by a telescope that can lean back at
+        Zenith.
+    min_alt : `float`, optional
+        Minimum allowed altitude in degrees. Will be clamped to this value if
+        out of range.
 
     Returns
     -------
@@ -181,6 +194,8 @@ def altaz_from_degree_headers(
         No AltAz keywords were found and this observation is a science
         observation.
     """
+    if max_alt > 90.0:
+        max_alt = 90.0
     for alt_key, az_key in altazpairs:
         if self.are_keys_ok([az_key, alt_key]):
             az = self._header[az_key]
@@ -190,13 +205,16 @@ def altaz_from_degree_headers(
             if is_zd and alt_key in is_zd:
                 alt = altitude_from_zenith_distance(alt * u.deg).value
 
-            if az < -360.0 or alt < 0.0:
+            if az < -360.0 or alt < -90.0:
                 # Break out of loop since we have found values but
-                # they are bad.
+                # they are not believable
                 break
-            if alt > 90.0:
-                log.warning("%s: Clipping altitude (%f) at 90 degrees", self._log_prefix, alt)
-                alt = 90.0
+            if alt > max_alt:
+                log.info("%s: Clipping altitude (%f) at %f degrees", self._log_prefix, alt, max_alt)
+                alt = max_alt
+            elif alt < min_alt:
+                log.info("%s: Clipping altitude (%f) at %f degrees", self._log_prefix, alt, min_alt)
+                alt = min_alt
 
             altaz = AltAz(az * u.deg, alt * u.deg, obstime=obstime, location=self.to_location())
             self._used_these_cards(az_key, alt_key)

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700}/python/astro_metadata_translator/translators/megaprime.py

@@ -64,6 +64,7 @@ class MegaPrimeTranslator(FitsTranslator):
         "physical_filter": "FILTER",
         "dark_time": ("DARKTIME", {"unit": u.s}),
         "exposure_time": ("EXPTIME", {"unit": u.s}),
+        "exposure_time_requested": ("EXPREQ", {"unit": u.s}),
         "observation_id": "OBSID",
         "object": "OBJECT",
         "science_program": "RUNID",

astro_metadata_translator-29.2025.1700/python/astro_metadata_translator/version.py

@@ -0,0 +1,2 @@
+__all__ = ["__version__"]
+__version__ = "29.2025.1700"

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700/python/astro_metadata_translator.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: astro-metadata-translator
-Version: 29.0.1
+Version: 29.2025.1700
 Summary: A translator for astronomical metadata.
 Author-email: Rubin Observatory Data Management <dm-admin@lists.lsst.org>
 License: BSD 3-Clause License

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700}/python/astro_metadata_translator.egg-info/SOURCES.txt

@@ -83,4 +83,5 @@ tests/test_sdss.py
 tests/test_shadowing.py
 tests/test_subaru.py
 tests/test_translate_header.py
-tests/test_translation.py
+tests/test_translation.py
+tests/test_translator_helpers.py

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700}/tests/test_cfht.py

@@ -44,6 +44,7 @@ class MegaPrimeTestCase(unittest.TestCase, MetadataAssertHelper):
                     exposure_id=1038843,
                     exposure_group="1038843",
                     exposure_time=615.037 * u.s,
+                    exposure_time_requested=615.0 * u.s,
                     focus_z=0.0 * u.mm,  # default value
                     group_counter_end=1038843,
                     group_counter_start=1038843,
@@ -79,6 +80,7 @@ class MegaPrimeTestCase(unittest.TestCase, MetadataAssertHelper):
                     exposure_id=849375,
                     exposure_group="849375",
                     exposure_time=300.202 * u.s,
+                    exposure_time_requested=300.0 * u.s,
                     focus_z=0.0 * u.mm,  # default value
                     group_counter_end=849375,
                     group_counter_start=849375,

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700}/tests/test_decam.py

@@ -43,6 +43,7 @@ class DecamTestCase(unittest.TestCase, MetadataAssertHelper):
                     exposure_id=229388,
                     exposure_group="229388",
                     exposure_time=200.0 * u.s,
+                    exposure_time_requested=200.0 * u.s,
                     focus_z=2497.32 * u.um,
                     group_counter_end=229388,
                     group_counter_start=229388,
@@ -79,6 +80,7 @@ class DecamTestCase(unittest.TestCase, MetadataAssertHelper):
                     exposure_id=160496,
                     exposure_group="160496",
                     exposure_time=0.0 * u.s,
+                    exposure_time_requested=0.0 * u.s,
                     focus_z=0.0 * u.um,
                     group_counter_end=160496,
                     group_counter_start=160496,
@@ -116,6 +118,7 @@ class DecamTestCase(unittest.TestCase, MetadataAssertHelper):
                     exposure_id=412037,
                     exposure_group="412037",
                     exposure_time=86.0 * u.s,
+                    exposure_time_requested=86.0 * u.s,
                     focus_z=2828.00 * u.um,
                     group_counter_end=412037,
                     group_counter_start=412037,
@@ -152,6 +155,7 @@ class DecamTestCase(unittest.TestCase, MetadataAssertHelper):
                     exposure_id=845291,
                     exposure_group="845291",
                     exposure_time=120.0 * u.s,
+                    exposure_time_requested=120.0 * u.s,
                     focus_z=2174.28 * u.um,
                     group_counter_end=845291,
                     group_counter_start=845291,
@@ -189,6 +193,7 @@ class DecamTestCase(unittest.TestCase, MetadataAssertHelper):
                     exposure_id=177764,
                     exposure_group="177764",
                     exposure_time=30.0 * u.s,
+                    exposure_time_requested=30.0 * u.s,
                     focus_z=2387.06 * u.um,
                     group_counter_end=177764,
                     group_counter_start=177764,

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700}/tests/test_sdss.py

@@ -42,6 +42,7 @@ class SdssTestCase(unittest.TestCase, MetadataAssertHelper):
                     exposure_id=6377,
                     exposure_group="6377",
                     exposure_time=53.907456 * u.s,
+                    exposure_time_requested=53.907456 * u.s,
                     group_counter_end=0,
                     group_counter_start=0,
                     has_simulated_content=False,

{astro_metadata_translator-29.0.1 → astro_metadata_translator-29.2025.1700}/tests/test_subaru.py

@@ -43,6 +43,7 @@ class HscTestCase(unittest.TestCase, MetadataAssertHelper):
                     exposure_id=904024,
                     exposure_group="904024",
                     exposure_time=30.0 * u.s,
+                    exposure_time_requested=30.0 * u.s,
                     focus_z=3.7 * u.mm,
                     group_counter_end=904024,
                     group_counter_start=904024,
@@ -77,6 +78,7 @@ class HscTestCase(unittest.TestCase, MetadataAssertHelper):
                     exposure_id=40900,
                     exposure_group="40900",
                     exposure_time=150.0 * u.s,
+                    exposure_time_requested=150.0 * u.s,
                     focus_z=3.83 * u.mm,
                     group_counter_end=40900,
                     group_counter_start=40900,
@@ -119,6 +121,7 @@ class HscTestCase(unittest.TestCase, MetadataAssertHelper):
                     exposure_id=53577,
                     exposure_group="53577",
                     exposure_time=200.0 * u.s,
+                    exposure_time_requested=200.0 * u.s,
                     group_counter_end=53577,
                     group_counter_start=53577,
                     has_simulated_content=False,

astro_metadata_translator-29.2025.1700/tests/test_translator_helpers.py

@@ -0,0 +1,99 @@
+# This file is part of astro_metadata_translator.
+#
+# Developed for the LSST Data Management System.
+# This product includes software developed by the LSST Project
+# (http://www.lsst.org).
+# See the LICENSE file at the top-level directory of this distribution
+# for details of code ownership.
+#
+# Use of this source code is governed by a 3-clause BSD-style
+# license that can be found in the LICENSE file.
+
+import unittest
+
+from astropy.coordinates import EarthLocation
+from astropy.time import Time
+
+from astro_metadata_translator import StubTranslator
+from astro_metadata_translator.translators.helpers import altaz_from_degree_headers
+
+
+class HelperTranslator(StubTranslator):
+    """Base class for testing shadowing."""
+
+    def to_instrument(self):
+        return "BaseInstrument"
+
+    def to_observation_type(self):
+        return "flat"
+
+    def to_observation_id(self):
+        return "OBSID"
+
+    def to_location(self):
+        return EarthLocation.from_geodetic(0.0, 0.0)
+
+
+class ScienceTranslator(HelperTranslator):
+    """Translator corresponding to science observation."""
+
+    def to_observation_type(self):
+        return "science"
+
+
+class HelperTestCase(unittest.TestCase):
+    """Test translator helpers."""
+
+    def assert_azel(self, azel, az, alt):
+        self.assertAlmostEqual(float(azel.az.to_value("deg")), az)
+        self.assertAlmostEqual(float(azel.alt.to_value("deg")), alt)
+
+    def test_altaz(self):
+        """Test altaz extraction."""
+        translator = HelperTranslator({})
+        now = Time.now()
+
+        value = altaz_from_degree_headers(translator, [("ELSTART", "AZSTART")], now)
+        self.assertIsNone(value)
+
+        translator._header["AZSTART"] = -400.0
+        translator._header["ELSTART"] = 45.0
+
+        value = altaz_from_degree_headers(translator, [("ELSTART", "AZSTART")], now)
+        self.assertIsNone(value)
+
+        for alt, az in ((80.0, 300.0), (-1.0, 200.0)):
+            translator._header["AZSTART"] = az
+            translator._header["ELSTART"] = alt
+            value = altaz_from_degree_headers(translator, [("ELSTART", "AZSTART")], now, min_alt=-5.0)
+            self.assert_azel(value, az, alt)
+
+        translator._header["AZSTART"] = 22.0
+        translator._header["ELSTART"] = 34.0
+        value = altaz_from_degree_headers(translator, [("AZ1", "EL1"), ("ELSTART", "AZSTART")], now)
+        self.assert_azel(value, 22.0, 34.0)
+
+        value = altaz_from_degree_headers(translator, [("ELSTART", "AZSTART")], now, is_zd={"ELSTART"})
+        self.assert_azel(value, 22.0, 56.0)
+
+        translator._header["ELSTART"] = -1.0
+        with self.assertLogs():
+            value = altaz_from_degree_headers(translator, [("ELSTART", "AZSTART")], now, min_alt=-0.5)
+        self.assert_azel(value, 22.0, -0.5)
+
+        translator._header["ELSTART"] = 90.2
+        with self.assertLogs():
+            value = altaz_from_degree_headers(translator, [("ELSTART", "AZSTART")], now, max_alt=95.0)
+        self.assert_azel(value, 22.0, 90.0)
+
+    def test_science_altaz(self):
+        """Test science altaz."""
+        translator = ScienceTranslator({})
+        now = Time.now()
+
+        with self.assertRaises(KeyError):
+            altaz_from_degree_headers(translator, [("ELSTART", "AZSTART")], now)
+
+
+if __name__ == "__main__":
+    unittest.main()

astro_metadata_translator-29.0.1/python/astro_metadata_translator/version.py

@@ -1,2 +0,0 @@
-__all__ = ["__version__"]
-__version__ = "29.0.1"