teareduce 0.4.6__py3-none-any.whl → 0.4.7__py3-none-any.whl

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/tests/test_sliceregion.py

@@ -32,6 +32,7 @@ def test_slice_region_creation():
     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."""
 
@@ -47,3 +48,69 @@ def test_slice_values():
     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/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.dist-info → teareduce-0.4.7.dist-info}/METADATA

@@ -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.dist-info → teareduce-0.4.7.dist-info}/RECORD

@@ -14,18 +14,18 @@ teareduce/polfit.py,sha256=CGsrRsz_Du2aKxOcgXi36lpAZO04JyqCCUaxhC0C-Mk,14281
 teareduce/robust_std.py,sha256=dk1G3VgiplZzmSfL7qWniEZ-5c3novHnBpRPCM77u84,1084
 teareduce/sdistortion.py,sha256=5ZsZn4vD5Sw2aoqO8-NIOH7H89Zmh7ZDkow6YbAotHU,5916
 teareduce/simulateccdexposure.py,sha256=cdbpca6GVuM3d7R1LGzlIZZvjTq_jzrlkk_Cli7aouQ,24636
-teareduce/sliceregion.py,sha256=VFhIUqEF4dH5IhIBrdvmYjvgkxCKNWRxJR10oypVbBY,14973
+teareduce/sliceregion.py,sha256=AbkBqY7YaMYTvg-5BCdEoCB8NhIYsSMGcadXioCQfzo,18356
 teareduce/statsummary.py,sha256=VTNAnBV8z6suqiyB2Lhw3YjUUOjlmwUPX3enkOKRF54,5422
-teareduce/version.py,sha256=Pzgc2GKYwBL3pvjKHigKM9Jks22zwuhw5gwWxoxQO7Q,419
+teareduce/version.py,sha256=YfSDOnYOawt4dVMMDQzqFv1P8lf52tpIIDIBbNnrZW0,419
 teareduce/wavecal.py,sha256=2MewWz5Y3ms41c305UtWOM_LaLNdk1mugDXCtzf-fSw,68586
 teareduce/write_array_to_fits.py,sha256=kWDrEH9coJ1yIu56oQJpWtDqJL4c8HGmssE9jle4e94,617
 teareduce/zscale.py,sha256=SDgmcDD2N5GvDn46JADCgTQJPBF_N_jSKMHoeTz9Nsw,1152
 teareduce/tests/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-teareduce/tests/test_sliceregion.py,sha256=25dhS7yJ1z_3tgFLw21uOkNKuugyVA-8L1ehafSQjFg,1769
+teareduce/tests/test_sliceregion.py,sha256=S7Zoh2eEBFIEbfsXgWBEMCf7pottjw2oLhqlZJQkAwg,3785
 teareduce/tests/test_version.py,sha256=mKLnbXyvVNc1pATq5PxR8qeoFMPAFL_GilFV6IHLOi0,172
-teareduce-0.4.6.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
-teareduce-0.4.6.dist-info/METADATA,sha256=pyykAUteD0AIMJO3mfiokQAfypsYB6bnxd520_fOX5o,3017
-teareduce-0.4.6.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
-teareduce-0.4.6.dist-info/entry_points.txt,sha256=0ovOBIllSl9nN65mVOVVh--Gdd4AE2JebKuFk2YQ0wk,57
-teareduce-0.4.6.dist-info/top_level.txt,sha256=7OkwtX9zNRkGJ7ACgjk4ESgC74qUYcS5O2qcO0v-Si4,10
-teareduce-0.4.6.dist-info/RECORD,,
+teareduce-0.4.7.dist-info/licenses/LICENSE.txt,sha256=OXLcl0T2SZ8Pmy2_dmlvKuetivmyPd5m1q-Gyd-zaYY,35149
+teareduce-0.4.7.dist-info/METADATA,sha256=ylCxvLo5-wbLkWnlz1ve_c4THv-q6VHfB8RG2FUK1Ac,3017
+teareduce-0.4.7.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+teareduce-0.4.7.dist-info/entry_points.txt,sha256=0ovOBIllSl9nN65mVOVVh--Gdd4AE2JebKuFk2YQ0wk,57
+teareduce-0.4.7.dist-info/top_level.txt,sha256=7OkwtX9zNRkGJ7ACgjk4ESgC74qUYcS5O2qcO0v-Si4,10
+teareduce-0.4.7.dist-info/RECORD,,