teareduce 0.4.6__tar.gz → 0.4.7__tar.gz

{teareduce-0.4.6/src/teareduce.egg-info → teareduce-0.4.7}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: teareduce
-Version: 0.4.6
+Version: 0.4.7
 Summary: Utilities for astronomical data reduction
 Author-email: Nicolás Cardiel <cardiel@ucm.es>
 License: GPL-3.0-or-later

{teareduce-0.4.6 → teareduce-0.4.7}/src/teareduce/sliceregion.py

@@ -43,7 +43,7 @@ class SliceRegion1D:
         Check if slice 'other' is within the parent slice.
     """
 
-    def __init__(self, region, mode=None):
+    def __init__(self, region, mode=None, naxis1=None):
         """Initialize SliceRegion1D.
 
         Parameters
@@ -54,6 +54,9 @@ class SliceRegion1D:
         mode : str
             Convention mode employed to define the slice.
             The two possible modes are 'fits' and 'python'.
+        naxis1 : int
+            The axis 1 size (length) of the data being sliced.
+            If provided, it is used to validate the slice region.
         """
         if isinstance(region, str):
             pattern = r'^\s*\[\s*\d+\s*:\s*\d+\s*\]\s*$'
@@ -93,6 +96,12 @@ class SliceRegion1D:
         else:
             raise ValueError(errmsg)
 
+        if naxis1 is not None:
+            if not (1 <= self.fits.start <= naxis1):
+                raise ValueError(f'Invalid start={self.fits.start} for naxis1={naxis1}')
+            if not (1 <= self.fits.stop <= naxis1+1):
+                raise ValueError(f'Invalid stop={self.fits.stop} for naxis1={naxis1}')
+
         s = self.fits
         self.fits_section = f'[{s.start}:{s.stop}]'
 
@@ -137,6 +146,10 @@ class SliceRegion1D:
         result = True
         return result
 
+    def length(self):
+        """Return the length of the slice."""
+        return self.python.stop - self.python.start
+
 
 class SliceRegion2D:
     """Store indices for slicing of 2D regions.
@@ -163,7 +176,7 @@ class SliceRegion2D:
     within(other)
         Check if slice 'other' is within the parent slice."""
 
-    def __init__(self, region, mode=None):
+    def __init__(self, region, mode=None, naxis1=None, naxis2=None):
         """Initialize SliceRegion2D.
 
         Parameters
@@ -175,6 +188,14 @@ class SliceRegion2D:
         mode : str
             Convention mode employed to define the slice.
             The two possible modes are 'fits' and 'python'.
+        naxis1 : int
+            The axis 1 size (length) of the data being sliced,
+            assuming the FITS convention.
+            If provided, it is used to validate the slice region.
+        naxis2 : int
+            The axis 2 size (length) of the data being sliced,
+            assuming the FITS convention.
+            If provided, it is used to validate the slice region.
         """
         if isinstance(region, str):
             pattern = r'^\s*\[\s*\d+\s*:\s*\d+\s*,\s*\d+\s*:\s*\d+\s*\]\s*$'
@@ -224,6 +245,17 @@ class SliceRegion2D:
         s1, s2 = self.fits
         self.fits_section = f'[{s1.start}:{s1.stop},{s2.start}:{s2.stop}]'
 
+        if naxis1 is not None:
+            if not (1 <= s1.start <= naxis1):
+                raise ValueError(f'Invalid start={s1.start} for naxis1={naxis1}')
+            if not (1 <= s1.stop <= naxis1):
+                raise ValueError(f'Invalid stop={s1.stop} for naxis1={naxis1}')
+        if naxis2 is not None:
+            if not (1 <= s2.start <= naxis2):
+                raise ValueError(f'Invalid start={s2.start} for naxis2={naxis2}')
+            if not (1 <= s2.stop <= naxis2):
+                raise ValueError(f'Invalid stop={s2.stop} for naxis2={naxis2}')
+
     def __eq__(self, other):
         return self.fits == other.fits and self.python == other.python
 
@@ -269,6 +301,11 @@ class SliceRegion2D:
         result = True
         return result
 
+    def area(self):
+        """Return the area of the slice."""
+        s1, s2 = self.python
+        return (s1.stop - s1.start) * (s2.stop - s2.start)
+
 
 class SliceRegion3D:
     """Store indices for slicing of 3D regions.
@@ -295,7 +332,7 @@ class SliceRegion3D:
     within(other)
         Check if slice 'other' is within the parent slice."""
 
-    def __init__(self, region, mode=None):
+    def __init__(self, region, mode=None, naxis1=None, naxis2=None, naxis3=None):
         """Initialize SliceRegion3D.
 
         Parameters
@@ -307,6 +344,18 @@ class SliceRegion3D:
         mode : str
             Convention mode employed to define the slice.
             The two possible modes are 'fits' and 'python'.
+        naxis1 : int
+            The axis 1 size (length) of the data being sliced,
+            assuming the FITS convention.
+            If provided, it is used to validate the slice region.
+        naxis2 : int
+            The axis 2 size (length) of the data being sliced,
+            assuming the FITS convention.
+            If provided, it is used to validate the slice region.
+        naxis3 : int
+            The axis 3 size (length) of the data being sliced,
+            assuming the FITS convention.
+            If provided, it is used to validate the slice region.
         """
         if isinstance(region, str):
             pattern = r'^\s*\[\s*\d+\s*:\s*\d+\s*,\s*\d+\s*:\s*\d+\s*,\s*\d+\s*:\s*\d+\s*\]\s*$'
@@ -360,6 +409,22 @@ class SliceRegion3D:
         s1, s2, s3 = self.fits
         self.fits_section = f'[{s1.start}:{s1.stop},{s2.start}:{s2.stop},{s3.start}:{s3.stop}]'
 
+        if naxis1 is not None:
+            if not (1 <= s1.start <= naxis1):
+                raise ValueError(f'Invalid start={s1.start} for naxis1={naxis1}')
+            if not (1 <= s1.stop <= naxis1):
+                raise ValueError(f'Invalid stop={s1.stop} for naxis1={naxis1}')
+        if naxis2 is not None:
+            if not (1 <= s2.start <= naxis2):
+                raise ValueError(f'Invalid start={s2.start} for naxis2={naxis2}')
+            if not (1 <= s2.stop <= naxis2):
+                raise ValueError(f'Invalid stop={s2.stop} for naxis2={naxis2}')
+        if naxis3 is not None:
+            if not (1 <= s3.start <= naxis3):
+                raise ValueError(f'Invalid start={s3.start} for naxis3={naxis3}')
+            if not (1 <= s3.stop <= naxis3):
+                raise ValueError(f'Invalid stop={s3.stop} for naxis3={naxis3}')
+
     def __eq__(self, other):
         return self.fits == other.fits and self.python == other.python
 
@@ -408,3 +473,8 @@ class SliceRegion3D:
             return result
         result = True
         return result
+
+    def volume(self):
+        """Return the volume of the slice."""
+        s1, s2, s3 = self.python
+        return (s1.stop - s1.start) * (s2.stop - s2.start) * (s3.stop - s3.start)

teareduce-0.4.7/src/teareduce/tests/test_sliceregion.py

@@ -0,0 +1,116 @@
+# -*- coding: utf-8 -*-
+#
+# Copyright 2025 Universidad Complutense de Madrid
+#
+# This file is part of teareduce
+#
+# SPDX-License-Identifier: GPL-3.0-or-later
+# License-Filename: LICENSE.txt
+#
+"""Tests for the SliceRegion class."""
+
+import numpy as np
+
+from ..sliceregion import SliceRegion1D, SliceRegion2D, SliceRegion3D
+
+
+def test_slice_region_creation():
+    """Test the creation of a SliceRegion."""
+
+    region1d = SliceRegion1D(np.s_[1:10], mode='python')
+    assert region1d.fits == slice(2, 10, None)
+    assert region1d.python == slice(1, 10, None)
+    assert region1d.fits_section == '[2:10]'
+
+    region2d = SliceRegion2D(np.s_[1:10, 2:20], mode='python')
+    assert region2d.fits == (slice(3, 20, None), slice(2, 10, None))
+    assert region2d.python == (slice(1, 10, None), slice(2, 20, None))
+    assert region2d.fits_section == '[3:20,2:10]'
+
+    region3d = SliceRegion3D(np.s_[1:10, 2:20, 3:30], mode='python')
+    assert region3d.fits == (slice(4, 30, None), slice(3, 20, None), slice(2, 10, None))
+    assert region3d.python == (slice(1, 10, None), slice(2, 20, None), slice(3, 30, None))
+    assert region3d.fits_section == '[4:30,3:20,2:10]'
+
+
+def test_slice_values():
+    """Test the values of the slices in different modes."""
+
+    array1d = np.arange(10)
+
+    region1d = SliceRegion1D(np.s_[1:3], mode='python')
+    assert np.all(array1d[region1d.python] == np.array([1, 2]))
+
+    array2d = np.arange(12).reshape(3, 4)
+    region2d = SliceRegion2D(np.s_[1:3, 2:3], mode='python')
+    assert np.all(array2d[region2d.python] == np.array([[6], [10]]))
+
+    array3d = np.arange(24).reshape(3, 4, 2)
+    region3d = SliceRegion3D(np.s_[1:3, 2:4, 1:2], mode='python')
+    assert np.all(array3d[region3d.python] == np.array([[[13], [15]], [[21], [23]]]))
+
+
+def test_wrong_number_of_dimensions():
+    """Test the creation of a SliceRegion with wrong slices."""
+
+    try:
+        SliceRegion1D(np.s_[1:3, 2:4], mode='python')
+        assert False, "Expected ValueError for 1D slice with 2D input"
+    except ValueError:
+        pass
+
+    try:
+        SliceRegion2D(np.s_[1:3], mode='python')
+        assert False, "Expected ValueError for 2D slice with 1D input"
+    except ValueError:
+        pass
+
+    try:
+        SliceRegion3D(np.s_[1:3, 2:4], mode='python')
+        assert False, "Expected ValueError for 3D slice with 2D input"
+    except ValueError:
+        pass
+
+
+def test_wrong_limits_order():
+    """Test the creation of a SliceRegion with wrong limits."""
+
+    try:
+        SliceRegion1D(np.s_[10:5], mode='python')
+        assert False, "Expected ValueError for 1D slice with start > stop"
+    except ValueError:
+        pass
+
+    try:
+        SliceRegion2D(np.s_[1:3, 5:2], mode='python')
+        assert False, "Expected ValueError for 2D slice with start > stop in second dimension"
+    except ValueError:
+        pass
+
+    try:
+        SliceRegion3D(np.s_[1:3, 2:4, 6:1], mode='python')
+        assert False, "Expected ValueError for 3D slice with start > stop in third dimension"
+    except ValueError:
+        pass
+
+
+def test_limits_out_of_range():
+    """Test the creation of a SliceRegion with limits out of range."""
+
+    try:
+        SliceRegion1D(np.s_[-1:5], mode='python', naxis1=10)
+        assert False, "Expected ValueError for 1D slice with negative start"
+    except ValueError:
+        pass
+
+    try:
+        SliceRegion2D(np.s_[1:3, 2:25], mode='python', naxis1=10, naxis2=20)
+        assert False, "Expected ValueError for 2D slice with stop > naxis in second dimension"
+    except ValueError:
+        pass
+
+    try:
+        SliceRegion3D(np.s_[1:3, 2:4, 3:35], mode='python', naxis1=10, naxis2=20, naxis3=30)
+        assert False, "Expected ValueError for 3D slice with stop > naxis in third dimension"
+    except ValueError:
+        pass

{teareduce-0.4.6 → teareduce-0.4.7}/src/teareduce/version.py

@@ -9,7 +9,7 @@
 #
 """Module to define the version of the teareduce package."""
 
-VERSION = '0.4.6'
+VERSION = '0.4.7'
 
 
 def main():

{teareduce-0.4.6 → teareduce-0.4.7/src/teareduce.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: teareduce
-Version: 0.4.6
+Version: 0.4.7
 Summary: Utilities for astronomical data reduction
 Author-email: Nicolás Cardiel <cardiel@ucm.es>
 License: GPL-3.0-or-later

teareduce-0.4.6/src/teareduce/tests/test_sliceregion.py

@@ -1,49 +0,0 @@
-# -*- coding: utf-8 -*-
-#
-# Copyright 2025 Universidad Complutense de Madrid
-#
-# This file is part of teareduce
-#
-# SPDX-License-Identifier: GPL-3.0-or-later
-# License-Filename: LICENSE.txt
-#
-"""Tests for the SliceRegion class."""
-
-import numpy as np
-
-from ..sliceregion import SliceRegion1D, SliceRegion2D, SliceRegion3D
-
-
-def test_slice_region_creation():
-    """Test the creation of a SliceRegion."""
-
-    region1d = SliceRegion1D(np.s_[1:10], mode='python')
-    assert region1d.fits == slice(2, 10, None)
-    assert region1d.python == slice(1, 10, None)
-    assert region1d.fits_section == '[2:10]'
-
-    region2d = SliceRegion2D(np.s_[1:10, 2:20], mode='python')
-    assert region2d.fits == (slice(3, 20, None), slice(2, 10, None))
-    assert region2d.python == (slice(1, 10, None), slice(2, 20, None))
-    assert region2d.fits_section == '[3:20,2:10]'
-
-    region3d = SliceRegion3D(np.s_[1:10, 2:20, 3:30], mode='python')
-    assert region3d.fits == (slice(4, 30, None), slice(3, 20, None), slice(2, 10, None))
-    assert region3d.python == (slice(1, 10, None), slice(2, 20, None), slice(3, 30, None))
-    assert region3d.fits_section == '[4:30,3:20,2:10]'
-
-def test_slice_values():
-    """Test the values of the slices in different modes."""
-
-    array1d = np.arange(10)
-
-    region1d = SliceRegion1D(np.s_[1:3], mode='python')
-    assert np.all(array1d[region1d.python] == np.array([1, 2]))
-
-    array2d = np.arange(12).reshape(3, 4)
-    region2d = SliceRegion2D(np.s_[1:3, 2:3], mode='python')
-    assert np.all(array2d[region2d.python] == np.array([[6], [10]]))
-
-    array3d = np.arange(24).reshape(3, 4, 2)
-    region3d = SliceRegion3D(np.s_[1:3, 2:4, 1:2], mode='python')
-    assert np.all(array3d[region3d.python] == np.array([[[13], [15]], [[21], [23]]]))