Merge pull request #170 from sot/fetch-obs-ocat

Move yoshi into sparkles and add some OCAT convenience

pytest.ini

@@ -0,0 +1,5 @@
+[pytest]
+filterwarnings =
+    ignore:'soft_unicode' has been renamed to 'soft_str'
+    ignore:`np.object` is a deprecated alias for the builtin `object`
+

sparkles/core.py

@@ -34,6 +34,7 @@
 
 from .roll_optimize import RollOptimizeMixin
 
+
 CACHE = {}
 FILEDIR = Path(__file__).parent
 
@@ -1300,3 +1301,30 @@ def check_fid_count(self):
         if self.n_fid != typical_n_fid:
             msg = f'{obs_type} requested {self.n_fid} fids but {typical_n_fid} is typical'
             self.add_message('caution', msg)
+
+    @classmethod
+    def from_ocat(cls, obsid, t_ccd=-5, man_angle=5, date=None, roll=None, **kwargs):
+        """Return an AcaReviewTable object using OCAT to specify key information.
+
+        :param obsid: obsid
+        :param t_ccd: ACA CCD temperature (degrees C)
+        :param man_angle: maneuver angle (degrees)
+        :param date: observation date (for proper motion and ACA offset projection)
+        :param roll: roll angle (degrees)
+        :param **kwargs: additional keyword args to update or override params from
+            yoshi for call to get_aca_catalog()
+
+        :returns: AcaReviewTable object
+        """
+        from proseco import get_aca_catalog
+        from .yoshi import get_yoshi_params_from_ocat, convert_yoshi_to_proseco_params
+
+        params_yoshi = get_yoshi_params_from_ocat(obsid, obs_date=date)
+        if roll is not None:
+            params_yoshi['roll_targ'] = roll
+        params_proseco = convert_yoshi_to_proseco_params(
+            **params_yoshi, obsid=obsid, man_angle=man_angle, t_ccd=t_ccd)
+        params_proseco.update(kwargs)
+        aca = get_aca_catalog(**params_proseco)
+        acar = cls(aca)
+        return acar

sparkles/tests/test_yoshi.py

@@ -0,0 +1,146 @@
+import numpy as np
+import agasc
+import pytest
+from Quaternion import Quat
+from mica.archive.tests.test_cda import HAS_WEB_SERVICES
+from sparkles.core import ACAReviewTable
+
+from sparkles.yoshi import (
+    get_yoshi_params_from_ocat,
+    run_one_yoshi,
+    convert_yoshi_to_proseco_params,
+)
+
+
+@pytest.fixture(autouse=True)
+def do_not_use_agasc_supplement(monkeypatch):
+    """Do not use AGASC supplement in any test"""
+    monkeypatch.setenv(agasc.SUPPLEMENT_ENABLED_ENV, "False")
+
+
+@pytest.mark.skipif(not HAS_WEB_SERVICES, reason="No web services available")
+def test_run_one_yoshi():
+    """Regression test a single run for a real obsid"""
+    request = {
+        "obsid": 20562,
+        "chip_id": 3,
+        "chipx": 970.0,
+        "chipy": 975.0,
+        "dec_targ": 66.35,
+        "detector": "ACIS-I",
+        "dither_y": 8,
+        "dither_z": 8,
+        "focus_offset": 0,
+        "man_angle": 175.0,
+        "obs_date": "2019:174:00:32:23.789",
+        "offset_y": -2.3,
+        "offset_z": 3.0,
+        "ra_targ": 239.06125,
+        "roll_targ": 197.12,
+        "sim_offset": 0,
+        "t_ccd": -9.1,
+    }
+
+    expected = {
+        "ra_aca": 238.96459762180638,
+        "dec_aca": 66.400811774068146,
+        "roll_aca": 197.20855489084187,
+        "n_critical": 2,
+        "n_warning": 1,
+        "n_caution": 0,
+        "n_info": 1,
+        "P2": 1.801521445484349,
+        "guide_count": 3.8577301426624357,
+    }
+
+    actual = run_one_yoshi(**request, dyn_bgd_n_faint=0)
+
+    for key in expected:
+        val = expected[key]
+        val2 = actual[key]
+        if isinstance(val, float):
+            assert np.isclose(val, val2, atol=1e-3)
+        else:
+            assert val == val2
+
+
+@pytest.mark.skipif(not HAS_WEB_SERVICES, reason="No web services available")
+def test_get_params():
+    params = get_yoshi_params_from_ocat(obsid=8008, obs_date="2022:001")
+    exp = {
+        "chip_id": 3,
+        "chipx": 970.0,
+        "chipy": 975.0,
+        "dec_targ": 2.3085194444444443,
+        "detector": "ACIS-I",
+        "dither_y": 8,
+        "dither_z": 8,
+        "focus_offset": 0,
+        "obs_date": "2022:001:00:00:00.000",
+        "offset_y": 0.0,
+        "offset_z": np.ma.masked,
+        "ra_targ": 149.91616666666664,
+        "roll_targ": 62.01050867568485,
+        "sim_offset": 0,
+    }
+    assert_dict_equal(params, exp)
+
+    params_proseco = convert_yoshi_to_proseco_params(
+        **params, obsid=8008, t_ccd=-10, man_angle=5.0
+    )
+    exp_proseco = {
+        "att": Quat([0.15017923, 0.49292814, 0.83025727, 0.21246392]),
+        "date": "2022:001:00:00:00.000",
+        "detector": "ACIS-I",
+        "dither": (8, 8),
+        "focus_offset": 0,
+        "man_angle": 5.0,
+        "n_acq": 8,
+        "n_fid": 3,
+        "n_guide": 5,
+        "obsid": 8008,
+        "sim_offset": 0,
+        "t_ccd": -10,
+    }
+    assert_dict_equal(params_proseco, exp_proseco)
+
+
+def assert_dict_equal(dict1, dict2):
+    assert dict2.keys() == dict1.keys()
+    for key in dict2:
+        val = dict1[key]
+        val_exp = dict2[key]
+        if isinstance(val, float):
+            assert np.isclose(val, val_exp, atol=1e-8)
+        elif val_exp is np.ma.masked:
+            assert val is np.ma.masked
+        elif isinstance(val_exp, Quat):
+            assert str(val) == str(val_exp)
+        else:
+            assert val == val_exp
+
+
+@pytest.mark.skipif(not HAS_WEB_SERVICES, reason="No web services available")
+def test_acar_from_ocat(monkeypatch):
+    """Get an AcaReviewTable with minimal information filling in rest from OCAT"""
+    monkeypatch.setenv(agasc.SUPPLEMENT_ENABLED_ENV, "False")
+
+    acar = ACAReviewTable.from_ocat(obsid=8008, date="2022:001", t_ccd=-10, n_acq=6)
+    assert acar.obsid == 8008
+    assert acar.date == "2022:001:00:00:00.000"
+    assert len(acar.acqs) == 6
+    exp = [
+        "idx slot    id    type  mag    yang    zang   row    col  ",
+        "--- ---- -------- ---- ----- ------- ------- ------ ------",
+        "  1    0        1  FID  7.00   919.8  -844.2 -178.7 -164.1",
+        "  2    1        5  FID  7.00 -1828.2  1053.8  374.1  216.2",
+        "  3    2        6  FID  7.00   385.8  1697.8  -70.8  346.0",
+        "  4    3 31983336  BOT  8.64   878.2 -1622.7 -171.0 -320.8",
+        "  5    4 31075368  BOT  9.13    50.8   737.3   -3.8  152.6",
+        "  6    5 32374896  BOT  9.17  2007.9 -2050.0 -400.2 -408.3",
+        "  7    6 31075128  BOT  9.35  -317.2  1185.7   70.1  242.6",
+        "  8    7 31463496  BOT  9.46  2028.6  1371.5 -402.1  281.9",
+        "  9    0 31076560  ACQ  9.70  -939.8  -368.7  194.3  -69.3",
+    ]
+    cols = ("idx", "slot", "id", "type", "mag", "yang", "zang")
+    assert acar[cols].pformat_all() == exp