sot · jeanconn · Dec 17, 2023 · Oct 13, 2023 · Oct 17, 2023 · Oct 29, 2023
diff --git a/analysis/backstop_offsets.ipynb b/analysis/backstop_offsets.ipynb
diff --git a/analysis/reselect_fid_offset.ipynb b/analysis/reselect_fid_offset.ipynb
diff --git a/docs/index.rst b/docs/index.rst
@@ -317,7 +317,13 @@ The following environment variables are used by proseco:
   "4", "6", or "8".
 - ``PROSECO_PRINT_OBC_CAT``: if set then create and print a debug catalog while doing
   catalog merging.
-- ``SKA``: root directory for Ska3 runtime environment
+- ``PROSECO_ENABLE_FID_OFFSET``: controls application of time and temperature dependent fid
+  light position offsets (from the ACA drift model) in :ref:`~proseco.fid.get_fid_positions`:
+  - Not set: apply offsets if time and temperature are provided (as is done in ``proseco`` fid 
+    selection since version 5.12.0)
+  - ``"True"``: require that time and temperature be provided and apply offsets.
+  - ``"False"``: do not apply offsets (typically used in regression testing not production).
+- ``SKA``: root directory that contains 'data' directory
 
 API docs
 --------

diff --git a/proseco/core.py b/proseco/core.py
@@ -1487,7 +1487,8 @@ def add_fake_stars_from_fid(
                 detector=detector,
                 sim_offset=sim_offset,
                 focus_offset=0,
-                t_ccd=-10.0,
+                t_ccd_guide=-10.0,
+                t_ccd_acq=-10.0,
                 date="2018:001",
                 dither=8.0,
             )

diff --git a/proseco/fid.py b/proseco/fid.py
@@ -5,10 +5,13 @@
 Get a catalog of fid lights.
 """
 
+import os
 import weakref
 
 import numpy as np
+from chandra_aca.drift import get_fid_offset
 from chandra_aca.transform import yagzag_to_pixels
+from cxotime import CxoTime, CxoTimeLike
 
 from . import characteristics as ACA
 from . import characteristics_acq as ACQ
@@ -94,6 +97,7 @@ class FidTable(ACACatalogTable):
         "detector",
         "sim_offset",
         "focus_offset",
+        "t_ccd_acq",
         "t_ccd_guide",
         "date",
         "dither_acq",
@@ -122,7 +126,7 @@ def acqs(self, val):
 
     @property
     def t_ccd(self):
-        # For fids use the guide CCD temperature
+        # For fids use the guide CCD temperature to scale the dark map
         return self.t_ccd_guide
 
     @t_ccd.setter
@@ -316,7 +320,11 @@ def get_fid_candidates(self):
         Result is updating self.cand_fids.
         """
         yang, zang = get_fid_positions(
-            self.detector, self.focus_offset, self.sim_offset
+            self.detector,
+            self.focus_offset,
+            self.sim_offset,
+            t_ccd=self.t_ccd_acq,
+            date=self.date,
         )
         row, col = yagzag_to_pixels(yang, zang, allow_bad=True)
         ids = np.arange(len(yang), dtype=np.int64) + 1  # E.g. 1 to 6 for ACIS
@@ -472,7 +480,13 @@ def set_spoilers_score(self, fid):
                 )
 
 
-def get_fid_positions(detector, focus_offset, sim_offset):
+def get_fid_positions(
+    detector: str,
+    focus_offset: float,
+    sim_offset: float,
+    t_ccd: float | None = None,
+    date: CxoTimeLike | None = None,
+) -> tuple:
     """Calculate the fid light positions for all fids for ``detector``.
 
     This is adapted from the Matlab
@@ -492,9 +506,14 @@ def get_fid_positions(detector, focus_offset, sim_offset):
       yfid=-SIfield.fidpos(:,1)/(SIfield.focallength-xshift);
       zfid=-zshift/(SIfield.focallength-xshift);
 
+    This function also applies a temperature-dependent fid offset if ``t_ccd`` and ``date``
+    are supplied and the ``PROSECO_ENABLE_FID_OFFSET`` env var is ``"True"`` or not set.
+
     :param detector: 'ACIS-S' | 'ACIS-I' | 'HRC-S' | 'HRC-I'
     :param focus_offset: SIM focus offset [steps]
     :param sim_offset: SIM translation offset from nominal [steps]
+    :param t_ccd: CCD temperature (C)
+    :param date: date (CxoTime compatible)
 
     :returns: yang, zang where each is a np.array of angles [arcsec]
     """
@@ -518,4 +537,23 @@ def get_fid_positions(detector, focus_offset, sim_offset):
 
     yang, zang = np.degrees(yfid) * 3600, np.degrees(zfid) * 3600
 
+    enable_fid_offset_env = os.environ.get("PROSECO_ENABLE_FID_OFFSET")
+    if enable_fid_offset_env not in ("True", "False", None):
+        raise ValueError(
+            f'PROSECO_ENABLE_FID_OFFSET env var must be either "True", "False", or not set, '
+            f"got {enable_fid_offset_env}"
+        )
+
+    has_tccd_and_date = t_ccd is not None and date is not None
+
+    if enable_fid_offset_env == "True" and not has_tccd_and_date:
+        raise ValueError(
+            "t_ccd_acq and date must be provided if PROSECO_ENABLE_FID_OFFSET is 'True'"
+        )
+
+    if has_tccd_and_date and enable_fid_offset_env != "False":
+        dy, dz = get_fid_offset(date, t_ccd)
+        yang += dy
+        zang += dz
+
     return yang, zang
diff --git a/proseco/tests/conftest.py b/proseco/tests/conftest.py
@@ -1,4 +1,5 @@
 import pytest
+import agasc
 from agasc import get_agasc_filename
 
 
@@ -7,6 +8,11 @@ def use_fixed_chandra_models(monkeypatch):
     monkeypatch.setenv("CHANDRA_MODELS_DEFAULT_VERSION", "3.48")
 
 
+@pytest.fixture(autouse=True)
+def disable_agasc_supplement(monkeypatch):
+    monkeypatch.setenv(agasc.SUPPLEMENT_ENABLED_ENV, "False")
+
+
 # By default test with the latest AGASC version available including release candidates
 @pytest.fixture(autouse=True)
 def proseco_agasc_rc(monkeypatch):

diff --git a/proseco/tests/test_acq.py b/proseco/tests/test_acq.py
@@ -34,9 +34,6 @@
 CACHE = {}  # Cache stuff for speed
 TEST_COLS = ("idx", "slot", "id", "yang", "zang", "halfw")
 
-# Do not use the AGASC supplement in testing by default since mags can change
-os.environ[agasc.SUPPLEMENT_ENABLED_ENV] = "False"
-
 
 def calc_p_brightest(acq, box_size, stars, dark, man_err=0, dither=20, bgd=0):
     """
@@ -846,11 +843,16 @@ def get_dark_stars_simple(box_size_thresh, dither):
     return dark, stars
 
 
-def test_acq_fid_catalog_probs_low_level():
+def test_acq_fid_catalog_probs_low_level(monkeypatch):
     """
     Low-level tests of machinery to handle different fid light sets within
     acquisition probabilities.
     """
+
+    # Disable fid offsets for this specific test which has been set up to spoil
+    # fids at not-offset-corrected positions
+    monkeypatch.setenv("PROSECO_ENABLE_FID_OFFSET", "False")
+
     # Put an acq star at an offset from fid light id=2 such that for a search
     # box size larger than box_size_thresh, that star will be spoiled.  This
     # uses the equation in FidTable.spoils().

diff --git a/proseco/tests/test_catalog.py b/proseco/tests/test_catalog.py
@@ -24,9 +24,6 @@
 HAS_SC_ARCHIVE = Path(mica.starcheck.starcheck.FILES["data_root"]).exists()
 TEST_COLS = "slot idx id type sz yang zang dim res halfw".split()
 
-# Do not use the AGASC supplement in testing by default since mags can change
-os.environ[agasc.SUPPLEMENT_ENABLED_ENV] = "False"
-
 HAS_MAG_SUPPLEMENT = len(agasc.get_supplement_table("mags")) > 0
 
 
@@ -100,12 +97,13 @@ def test_get_aca_catalog_20603(proseco_agasc_1p7):
         img_size_guide=6,
         raise_exc=True,
     )
+
     # Expected 2 fids, 4 guide, 7 acq
     exp = [
         "slot idx     id    type  sz   yang     zang   dim res halfw",
         "---- --- --------- ---- --- -------- -------- --- --- -----",
-        "   0   1         4  FID 8x8  2140.23   166.63   1   1    25",
-        "   1   2         5  FID 8x8 -1826.28   160.17   1   1    25",
+        "   0   1         4  FID 8x8  2136.87   163.42   1   1    25",
+        "   1   2         5  FID 8x8 -1829.63   156.96   1   1    25",
         "   2   3 116791824  BOT 6x6   622.00  -953.60  28   1   160",
         "   3   4  40114416  BOT 6x6   394.22  1204.43  24   1   140",
         "   4   5  40112304  BOT 6x6 -1644.35  2032.47  12   1    80",
@@ -145,9 +143,9 @@ def test_get_aca_catalog_20259(proseco_agasc_1p7):
     exp = [
         "slot idx     id    type  sz   yang     zang   dim res halfw",
         "---- --- --------- ---- --- -------- -------- --- --- -----",
-        "   0   1         1  FID 8x8 -1175.03  -468.23   1   1    25",
-        "   1   2         2  FID 8x8  1224.70  -460.93   1   1    25",
-        "   2   3         3  FID 8x8 -1177.69   561.30   1   1    25",
+        "   0   1         1  FID 8x8 -1176.88  -470.85   1   1    25",
+        "   1   2         2  FID 8x8  1222.86  -463.55   1   1    25",
+        "   2   3         3  FID 8x8 -1179.54   558.68   1   1    25",
         "   3   4 896009152  BOT 6x6  1693.39   217.92  16   1   100",
         "   4   5 897712576  BOT 6x6 -1099.95  2140.23  12   1    80",
         "   5   6 897717296  BOT 6x6   932.58  1227.48  12   1    80",
@@ -568,7 +566,8 @@ def test_call_args_attr():
         "obsid": 0,
         "optimize": False,
         "sim_offset": 0,
-        "t_ccd": -11,
+        "t_ccd_acq": -11,
+        "t_ccd_guide": -11,
     }
 
 
@@ -734,8 +733,8 @@ def offset(id, drow, dcol, dmag, rmult=1):
 
 def test_dark_property():
     """
-    Test that in the case of a common t_ccd, all the dark current maps are
-    actually the same object.
+    Test that appropriate temperatures are applied to acq, fid, guide
+    dark maps.
 
     :return: None
     """
@@ -744,7 +743,6 @@ def test_dark_property():
         assert aca.dark is getattr(aca, attr).dark
 
     kwargs = STD_INFO.copy()
-    del kwargs["t_ccd"]
     kwargs["t_ccd_acq"] = -12.5
     kwargs["t_ccd_guide"] = -11.5
     aca = get_aca_catalog(**kwargs)
@@ -766,9 +764,9 @@ def test_dense_star_field_regress(proseco_agasc_1p7):
     exp = [
         "slot idx     id     type  sz   yang     zang   dim res halfw  mag ",
         "---- --- ---------- ---- --- -------- -------- --- --- ----- -----",
-        "   0   1          3  FID 8x8    40.01 -1871.10   1   1    25  7.00",
-        "   1   2          4  FID 8x8  2140.23   166.63   1   1    25  7.00",
-        "   2   3          5  FID 8x8 -1826.28   160.17   1   1    25  7.00",
+        "   0   1          3  FID 8x8    35.52 -1874.72   1   1    25  7.00",
+        "   1   2          4  FID 8x8  2135.73   163.01   1   1    25  7.00",
+        "   2   3          5  FID 8x8 -1830.77   156.55   1   1    25  7.00",
         "   3   4 1130899056  BOT 8x8  2386.83 -1808.51  28   1   160  6.24",
         "   4   5 1130889232  BOT 8x8  -251.98 -1971.97  28   1   160  6.99",
         "   5   6 1130893664  BOT 8x8  1530.07 -2149.38  28   1   160  7.62",

diff --git a/proseco/tests/test_common.py b/proseco/tests/test_common.py
@@ -11,7 +11,8 @@
     date="2018:001",
     n_guide=5,
     n_fid=3,
-    t_ccd=-11,
+    t_ccd_acq=-11,
+    t_ccd_guide=-11,
     man_angle=90,
     dither=8.0,
 )

diff --git a/proseco/tests/test_fid.py b/proseco/tests/test_fid.py
@@ -10,12 +10,9 @@
 from ..fid import get_fid_catalog, get_fid_positions
 from .test_common import DARK40, OBS_INFO, STD_INFO, mod_std_info
 
-# Reference fid positions for spoiling tests
+# Reference fid positions for spoiling tests.
 FIDS = get_fid_catalog(stars=StarsTable.empty(), **STD_INFO)
 
-# Do not use the AGASC supplement in testing by default since mags can change
-os.environ[agasc.SUPPLEMENT_ENABLED_ENV] = "False"
-
 
 def test_get_fid_position():
     """
@@ -49,19 +46,71 @@ def test_get_fid_position():
     assert np.allclose(zang[fidset], [-468, -460, 561], rtol=0, atol=1.1)
 
 
+def test_get_fid_pos_with_offsets(monkeypatch):
+    # Confirm that if env var is set to 'False' then no offset is applied.
+    monkeypatch.setenv("PROSECO_ENABLE_FID_OFFSET", "False")
+    yang1, zang1 = get_fid_positions("ACIS-S", focus_offset=0.0, sim_offset=0.0)
+
+    # Confirm that if env var is set to 'True' and t_ccd and date are specified, then
+    # offset is applied.
+    monkeypatch.setenv("PROSECO_ENABLE_FID_OFFSET", "True")
+    yang2, zang2 = get_fid_positions(
+        "ACIS-S", focus_offset=0.0, sim_offset=0.0, date="2023:235", t_ccd=-13.65
+    )
+    assert np.allclose(yang1 - yang2, -32.47, rtol=0, atol=0.1)
+    assert np.allclose(zang1 - zang2, -9.63, rtol=0, atol=0.1)
+
+    # Confirm that if env var is not set and t_ccd and date are specified, then
+    # offset is applied.
+    monkeypatch.delenv("PROSECO_ENABLE_FID_OFFSET", raising=False)
+    yang3, zang3 = get_fid_positions(
+        "ACIS-S", focus_offset=0.0, sim_offset=0.0, date="2023:235", t_ccd=-13.65
+    )
+    assert np.all(yang2 == yang3)
+    assert np.all(zang2 == zang3)
+
+    # Confirm that if env var is not set and t_ccd and date not specified, then
+    # no offset is applied.
+    monkeypatch.delenv("PROSECO_ENABLE_FID_OFFSET", raising=False)
+    yang4, zang4 = get_fid_positions(
+        "ACIS-S",
+        focus_offset=0.0,
+        sim_offset=0.0,
+    )
+    assert np.all(yang1 == yang4)
+    assert np.all(zang1 == zang4)
+
+
+def test_get_fid_pos_errors(monkeypatch):
+    # Confirm if env var is set to 'True' and t_ccd and date not specified, then
+    # there's an error.
+    monkeypatch.setenv("PROSECO_ENABLE_FID_OFFSET", "True")
+    with pytest.raises(ValueError, match="t_ccd_acq and date must be provided"):
+        get_fid_positions("ACIS-S", focus_offset=0.0, sim_offset=0.0)
+
+    # Confirm an error if env var set to not-allowed value
+    monkeypatch.setenv("PROSECO_ENABLE_FID_OFFSET", "foo")
+    with pytest.raises(
+        ValueError, match='env var must be either "True", "False", or not set,'
+    ):
+        get_fid_positions(
+            "ACIS-S", focus_offset=0.0, sim_offset=0.0, t_ccd=-13.65, date="2023:235"
+        )
+
+
 def test_get_initial_catalog():
     """Test basic catalog with no stars in field using standard 2-4-5 config."""
     exp = [
         "<FidTable length=6>",
         "  id    yang     zang     row     col     mag   spoiler_score  idx   slot",
         "int64 float64  float64  float64 float64 float64     int64     int64 int64",
         "----- -------- -------- ------- ------- ------- ------------- ----- -----",
-        "    1   922.59 -1737.89 -180.05 -344.10    7.00             0     0   -99",
-        "    2  -773.20 -1742.03  160.79 -345.35    7.00             0     1     0",
-        "    3    40.01 -1871.10   -2.67 -371.00    7.00             0     2   -99",
-        "    4  2140.23   166.63 -424.51   39.13    7.00             0     3     1",
-        "    5 -1826.28   160.17  372.97   36.47    7.00             0     4     2",
-        "    6   388.59   803.75  -71.49  166.10    7.00             0     5   -99",
+        "    1   918.09 -1741.51 -179.15 -344.83    7.00             0     0   -99",
+        "    2  -777.70 -1745.65  161.69 -346.09    7.00             0     1     0",
+        "    3    35.52 -1874.72   -1.77 -371.73    7.00             0     2   -99",
+        "    4  2135.73   163.01 -423.60   38.40    7.00             0     3     1",
+        "    5 -1830.77   156.55  373.88   35.74    7.00             0     4     2",
+        "    6   384.10   800.13  -70.59  165.37    7.00             0     5   -99",
     ]
     assert repr(FIDS.cand_fids).splitlines() == exp
     assert np.all(FIDS["id"] == [2, 4, 5])
@@ -81,12 +130,12 @@ def test_get_initial_catalog():
         "  id    yang     zang     row     col     mag   spoiler_score  idx   slot",
         "int64 float64  float64  float64 float64 float64     int64     int64 int64",
         "----- -------- -------- ------- ------- ------- ------------- ----- -----",
-        "    1   922.59 -1737.89 -180.05 -344.10    7.00             4     0   -99",
-        "    2  -773.20 -1742.03  160.79 -345.35    7.00             4     1   -99",
-        "    3    40.01 -1871.10   -2.67 -371.00    7.00             0     2     0",
-        "    4  2140.23   166.63 -424.51   39.13    7.00             0     3     1",
-        "    5 -1826.28   160.17  372.97   36.47    7.00             0     4     2",
-        "    6   388.59   803.75  -71.49  166.10    7.00             0     5   -99",
+        "    1   918.09 -1741.51 -179.15 -344.83    7.00             4     0   -99",
+        "    2  -777.70 -1745.65  161.69 -346.09    7.00             4     1   -99",
+        "    3    35.52 -1874.72   -1.77 -371.73    7.00             0     2     0",
+        "    4  2135.73   163.01 -423.60   38.40    7.00             0     3     1",
+        "    5 -1830.77   156.55  373.88   35.74    7.00             0     4     2",
+        "    6   384.10   800.13  -70.59  165.37    7.00             0     5   -99",
     ]
     assert repr(fids2.cand_fids).splitlines() == exp
     assert np.all(fids2["id"] == [3, 4, 5])
@@ -148,12 +197,12 @@ def test_fid_spoiling_acq(dither_z):
         "  id    yang     zang     row     col     mag   spoiler_score  idx   slot",
         "int64 float64  float64  float64 float64 float64     int64     int64 int64",
         "----- -------- -------- ------- ------- ------- ------------- ----- -----",
-        "    1   922.59 -1737.89 -180.05 -344.10    7.00             0     0     0",
-        "    2  -773.20 -1742.03  160.79 -345.35    7.00             0     1   -99",
-        "    3    40.01 -1871.10   -2.67 -371.00    7.00             0     2   -99",
-        "    4  2140.23   166.63 -424.51   39.13    7.00             0     3   -99",
-        "    5 -1826.28   160.17  372.97   36.47    7.00             0     4     1",
-        "    6   388.59   803.75  -71.49  166.10    7.00             0     5     2",
+        "    1   918.09 -1741.51 -179.15 -344.83    7.00             0     0     0",
+        "    2  -777.70 -1745.65  161.69 -346.09    7.00             0     1   -99",
+        "    3    35.52 -1874.72   -1.77 -371.73    7.00             0     2   -99",
+        "    4  2135.73   163.01 -423.60   38.40    7.00             0     3   -99",
+        "    5 -1830.77   156.55  373.88   35.74    7.00             0     4     1",
+        "    6   384.10   800.13  -70.59  165.37    7.00             0     5     2",
     ]
 
     assert repr(fids5.cand_fids).splitlines() == exp

diff --git a/proseco/tests/test_guide.py b/proseco/tests/test_guide.py
@@ -30,9 +30,6 @@
 
 HAS_SC_ARCHIVE = Path(mica.starcheck.starcheck.FILES["data_root"]).exists()
 
-# Do not use the AGASC supplement in testing by default since mags can change
-os.environ[agasc.SUPPLEMENT_ENABLED_ENV] = "False"
-
 
 def test_select(proseco_agasc_1p7):
     """