✨ Activate stellar aberration correctionb

Author: barentsen

README.rst

@@ -58,20 +58,26 @@ Obtaining pixel coordinates for a specific celestial coordinate:
     >>> from astropy.coordinates import SkyCoord
     >>> crd = SkyCoord(ra=60, dec=70, unit='deg')
     >>> locate(crd)
-    List of 1 coordinates
-    ↳[TessCoord(sector=19, camera=2, ccd=2, column=355.3, row=1045.9, time=None)]
+    List of 4 coordinates
+    ↳[TessCoord(sector=19, camera=2, ccd=2, column=355.3, row=1045.9, time=None)
+      TessCoord(sector=25, camera=4, ccd=4, column=1107.0, row=285.9, time=None)
+      TessCoord(sector=26, camera=4, ccd=3, column=317.7, row=395.9, time=None)
+      TessCoord(sector=52, camera=4, ccd=4, column=603.5, row=240.2, time=None)]
 
 
 You can access the properties of `TessCoord` objects using standard list and attribute syntax:
 
 .. code-block:: python
 
     >>> crdlist = locate("Alpha Cen")
-    >>> crdlist[0].sector, crdlist[0].camera, crdlist[0].ccd, crdlist[0].column, crdlist[0].row
-    (11, 2, 2, 1699.0540739785683, 1860.2510951146114)
+    >>> crdlist[0].sector, crdlist[0].camera, crdlist[0].ccd
+    (11, 2, 2)
+    >>> crdlist[0].column, crdlist[0].row
+    (1699.0540739785683, 1860.2510951146114)
 
 
-When you have obtained a `TessCoord` object, you can use it to obtain a list of the TESS Full Frame Images (FFIs) which covered the position:
+When you have obtained a `TessCoord` object, you can use it to obtain a list of the TESS Full Frame Images (FFIs) which covered the position.
+The objects returned are provided by the `tess-cloud <https://github.com/SSDataLab/tess-cloud>`_ package.
 
 .. code-block:: python
 

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "tess-locator"
-version = "0.5.0"
+version = "0.6.dev"
 description = "Fast offline queries of TESS FFI positions and filenames."
 license = "MIT"
 authors = ["Geert Barentsen <[email protected]>",
@@ -37,10 +37,11 @@ line-profiler = "^3.1.0"
 jupyterlab = "^2.2.9"
 pytest-xdist = "^2.1.0"
 pre-commit = "^2.8.2"
+Pygments = "^2.9.0"
 mkdocs = "^1.1.2"
 mkdocs-material = "^7.1.4"
-Pygments = "^2.9.0"
 mkdocstrings = "^0.15.0"
+pytkdocs = {version = "^0.11.1", extras = ["numpy-style"]}
 #tess-cloud = {path = "../tess-cloud", develop = true}
 
 [build-system]

src/tess_locator/__init__.py

@@ -2,7 +2,7 @@
 from pathlib import Path
 import tess_stars2px  # provided by the `tess-point` package
 
-__version__ = "0.5.0"
+__version__ = "0.6.dev"
 
 # Where does this package store its embedded data?
 PACKAGEDIR: Path = Path(__file__).parent.absolute()

src/tess_locator/locate.py

@@ -14,7 +14,9 @@ def locate(
     target: Union[SkyCoord, str],
     time: Union[Time, str, List[str]] = None,
     sector: Union[int, List[int]] = None,
+    aberrate: bool = True
 ) -> TessCoordList:
+    """Locate a target in the TESS FFI data set."""
     # Allow the target coordinate to be instantiated from a string
     if isinstance(target, str):
         target = SkyCoord.from_name(target)
@@ -53,7 +55,7 @@ def locate(
             out_row,
             scinfo,
         ) = tess_stars2px_function_entry(
-            0, ra[idx], dec[idx], trySector=sectors_to_search[idx]
+            0, ra[idx], dec[idx], trySector=sectors_to_search[idx], aberrate=aberrate
         )
 
         for idx_out in range(len(out_sector)):

src/tess_locator/tesscoord.py

@@ -1,3 +1,4 @@
+"""Defines the TessCoord and TessCoordList classes."""
 from collections import UserList
 from typing import Union, Optional
 
@@ -22,6 +23,17 @@ def _optional_time_converter(time) -> Time:
 
 @attr.s(slots=True)
 class TessCoord:
+    """Class representing a position in a single TESS Full Frame Image.
+
+    Args:
+        msg (str): Human readable string describing the exception.
+        code (:obj:`int`, optional): Error code.
+
+    Attributes:
+        msg (str): Human readable string describing the exception.
+        code (int): Exception error code.
+
+    """
     sector: int = attr.ib()
     camera: int = attr.ib(validator=attr.validators.in_([1, 2, 3, 4]))
     ccd: int = attr.ib(validator=attr.validators.in_([1, 2, 3, 4]))

tests/test_locate.py

@@ -14,13 +14,12 @@
 from tess_locator import locate, SECTORS
 
 
-@pytest.mark.xfail  # Frequent failures during ingest of reprocessed data into MAST
+@pytest.mark.xfail  # TessCut currently claims Pi Men was in Sector 35 (whereas it was just off edge)
 def test_pi_men():
     """Tests `locate()` against `astroquery.mast.Tesscut.get_sectors()`"""
     # Query using Tesscut
     crd = SkyCoord(ra=84.291188, dec=-80.46911982, unit="deg")
     mast_result = Tesscut.get_sectors(crd)
-    mast_result = mast_result[mast_result["sector"] <= SECTORS]
     # Query using our tool
     our_result = locate(crd)
     # Do the sector, camera, and ccd numbers all match?
@@ -104,7 +103,7 @@ def test_locate_time():
 def test_locate_roundtrip():
     """Is the conversion SkyCoord -> TessCoord -> SkyCoord consistent?"""
     crd1 = SkyCoord.from_name("Proxima Cen")
-    crd2 = locate(crd1)[0].to_skycoord()
+    crd2 = locate(crd1, aberrate=False)[0].to_skycoord()
     assert approx(crd1.ra.degree) == crd2.ra.degree
     assert approx(crd1.dec.degree) == crd2.dec.degree