dkist-processing-math 2.2.2__py3-none-any.whl → 2.2.3__py3-none-any.whl

dkist_processing_math/arithmetic.py

@@ -1,5 +1,6 @@
 """Arithmetic."""
 
+from datetime import datetime
 from typing import Generator
 from typing import Iterable
 from typing import Union
@@ -124,3 +125,21 @@ def divide_fits_access_by_array(
     for obj in access_objs:
         obj.data = next(divide_arrays_by_array(obj.data, array_to_divide_by))
         yield obj
+
+
+def closest_datetime(
+    target_datetime: str | datetime, datetimes: list[str | datetime] | str | datetime
+) -> str | datetime:
+    """Find the closest datetime to a target datetime. Return type is of the same type as the datetimes list."""
+    if isinstance(target_datetime, str):
+        target_datetime = datetime.fromisoformat(target_datetime)
+    if isinstance(datetimes, str) or isinstance(datetimes, datetime):
+        datetimes = [datetimes]
+    converted_datetimes = [
+        datetime.fromisoformat(d) if isinstance(d, str) else d for d in datetimes
+    ]
+    closest_index, _ = min(
+        enumerate(converted_datetimes),
+        key=lambda dt: abs(dt[1] - target_datetime),
+    )
+    return datetimes[closest_index]

dkist_processing_math/tests/test_arithmetic.py

@@ -1,3 +1,4 @@
+from datetime import datetime
 from typing import Generator
 
 import numpy as np
@@ -5,6 +6,7 @@ import pytest
 from astropy.io import fits
 from dkist_processing_common.models.fits_access import FitsAccessBase
 
+from dkist_processing_math.arithmetic import closest_datetime
 from dkist_processing_math.arithmetic import divide_arrays_by_array
 from dkist_processing_math.arithmetic import divide_fits_access_by_array
 from dkist_processing_math.arithmetic import subtract_array_from_arrays
@@ -18,7 +20,7 @@ def multiple_test_fits_access(request, numpy_arrays):
     for i, array in enumerate(numpy_arrays):
         hdu = fits.PrimaryHDU(data=array)
         hdu.header["TEST"] = i
-        access_list.append(FitsAccessBase(hdu=hdu))
+        access_list.append(FitsAccessBase(header=hdu.header, data=array))
     if request.param == "multiple":
         return access_list
     return access_list[0]
@@ -126,3 +128,54 @@ def test_divide_arrays_by_array_wrong_shape(numpy_arrays_wrong_shape, numpy_arra
     """
     with pytest.raises(ValueError):
         list(divide_arrays_by_array(numpy_arrays_wrong_shape, numpy_array))
+
+
+@pytest.mark.parametrize(
+    "datetimes, expected_result",
+    [
+        pytest.param(
+            ["2025-12-31T00:00:00", "2026-01-07T00:00:00"],
+            "2025-12-31T00:00:00",
+            id="multiple solar gain ops",
+        ),
+        pytest.param("2025-12-31T00:00:00", "2025-12-31T00:00:00", id="single solar gain op"),
+    ],
+)
+def test_closest_datetime_with_strings(datetimes, expected_result):
+    """
+    Given: a target datetime and a list of string datetimes
+    When: running the closest_datetime method
+    Then: the closest datetime from the list of datetimes is returned
+    """
+    result = closest_datetime(
+        target_datetime="2026-01-01T00:00:00",
+        datetimes=datetimes,
+    )
+    assert result == expected_result
+
+
+@pytest.mark.parametrize(
+    "datetimes, expected_result",
+    [
+        pytest.param(
+            [
+                datetime(2025, 12, 31),
+                datetime(2026, 1, 7),
+            ],
+            datetime(2025, 12, 31),
+            id="multiple solar gain ops",
+        ),
+        pytest.param(datetime(2025, 12, 31), datetime(2025, 12, 31), id="single solar gain op"),
+    ],
+)
+def test_closest_datetime_with_datetimes(datetimes, expected_result):
+    """
+    Given: a target datetime and a list of datetimes
+    When: running the closest_datetime method
+    Then: the closest datetime from the list of datetimes is returned
+    """
+    result = closest_datetime(
+        target_datetime=datetime(2026, 1, 1),
+        datetimes=datetimes,
+    )
+    assert result == expected_result

{dkist_processing_math-2.2.2.dist-info → dkist_processing_math-2.2.3.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: dkist-processing-math
-Version: 2.2.2
+Version: 2.2.3
 Summary: Common math functionality used in the DKIST calibrations suite
 Author-email: NSO / AURA <dkistdc@nso.edu>
 License: BSD-3-Clause

{dkist_processing_math-2.2.2.dist-info → dkist_processing_math-2.2.3.dist-info}/RECORD

@@ -1,12 +1,12 @@
 changelog/.gitempty,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dkist_processing_math/__init__.py,sha256=z2HXBhrQyX-yBiLTWnPUgVevMA7QI_3ZdJKn3ev1F8I,252
-dkist_processing_math/arithmetic.py,sha256=WgO3lQI4GIVVOiXb_F7tQCZ5XQKzm_kF_zcy_3IL964,3695
+dkist_processing_math/arithmetic.py,sha256=-kLO64IT2RxyykH1jlthvC0pegkhyJpIj9oa_9rdAdY,4457
 dkist_processing_math/feature.py,sha256=xdhPkkoOX9aO50BeMjU_2vKwAOG1AUBA3TvfHzZuP6A,2004
 dkist_processing_math/linear_algebra.py,sha256=yCA6ZuNORFnAyXywj73QMmGCpv9ZC2FSoMEPc8wToQY,4180
 dkist_processing_math/statistics.py,sha256=KkZTy8wdslPSQ5qP4z_We60Vizaxqna7rmMwxkoj36U,3178
 dkist_processing_math/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 dkist_processing_math/tests/conftest.py,sha256=TV0o-R2lU1MvZleme0w-akcgO5wOTlFNKhjSlmDwkqg,1593
-dkist_processing_math/tests/test_arithmetic.py,sha256=18YI4Fr_m0KU0dYR8_ef7CMmnOlb-Zc4I8ERgoYdxdA,5658
+dkist_processing_math/tests/test_arithmetic.py,sha256=IzNm6u1ER5w_zlasOgTXlXSZjmpXnXpUmRb20XPx4DM,7320
 dkist_processing_math/tests/test_feature.py,sha256=ZB8r_IUrAyTAlKbxEXwr8Q2zS7KPmlJhaU1l0guK0Xc,2311
 dkist_processing_math/tests/test_linear_algebra.py,sha256=k-XqIIBPsenNMKqo2nQnDkkN-6T1nvVT8BrJnupAIFU,6495
 dkist_processing_math/tests/test_statistics.py,sha256=N0S8C9Bwhd1VgCAkm6RqIZF_Ulwrcet9wqfbndw8KZs,2998
@@ -24,7 +24,7 @@ docs/landing_page.rst,sha256=JCyR9SRhYS6zeEUlonIzko1kQ0tAFDIfi7pCoQanZeA,251
 docs/make.bat,sha256=mBAhtURwhQ7yc95pqwJzlhqBSvRknr1aqZ5s8NKvdKs,4513
 docs/requirements.txt,sha256=Kbl_X4c7RQZw035YTeNB63We6I7pvXFU4T0Uflp2yDY,29
 licenses/LICENSE.rst,sha256=piZaQplkzOMmH1NXg6QIdo9wwo9pPCoHkvm2-DmH76E,1462
-dkist_processing_math-2.2.2.dist-info/METADATA,sha256=lHuOull8f05fjgkr_N7NwKMLiojK04JPN0WX3u4f0dw,4467
-dkist_processing_math-2.2.2.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-dkist_processing_math-2.2.2.dist-info/top_level.txt,sha256=7NeFrOlR4xhZ3LMT4jN99LQugukjr6l9u3w_s6b-uO4,46
-dkist_processing_math-2.2.2.dist-info/RECORD,,
+dkist_processing_math-2.2.3.dist-info/METADATA,sha256=rDz6CyzGJ7lTuHHw4-ul1VtpZ7Mozss5SMdWFh8YTEU,4467
+dkist_processing_math-2.2.3.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+dkist_processing_math-2.2.3.dist-info/top_level.txt,sha256=7NeFrOlR4xhZ3LMT4jN99LQugukjr6l9u3w_s6b-uO4,46
+dkist_processing_math-2.2.3.dist-info/RECORD,,