docstrings and remove mask_unmasked

Author: Jammy2211

autoarray/mask/derive/zoom_2d.py

@@ -50,6 +50,17 @@ def __init__(self, mask: Union[np.ndarray, List]):
 
     @property
     def centre(self) -> Tuple[float, float]:
+        """
+        Returns the centre of the zoomed in region, which is the average of the maximum and minimum y and x pixel values
+        of the unmasked region.
+
+        The y and x pixel values are the pixel coordinates of the unmasked region, which are derived from the
+        `Mask2D` object. The pixel coordinates are in the same units as the pixel scales of the `Mask2D` object.
+
+        Returns
+        -------
+        The centre of the zoomed in region.
+        """
         from autoarray.structures.grids.uniform_2d import Grid2D
 
         grid = grid_2d_util.grid_2d_slim_via_mask_from(
@@ -73,6 +84,17 @@ def centre(self) -> Tuple[float, float]:
 
     @property
     def offset_pixels(self) -> Tuple[float, float]:
+        """
+        Returns the offset of the centred of the zoomed in region from the centre of the `Mask2D` object in pixel
+        units.
+
+        This is computed by subtracting the pixel coordinates of the `Mask2D` object from the pixel coordinates of
+        the zoomed in region.
+
+        Returns
+        -------
+        The offset of the zoomed in region from the centre of the `Mask2D` object in pixel units.
+        """
         if self.mask.pixel_scales is None:
             return self.mask.geometry.central_pixel_coordinates
 
@@ -83,6 +105,17 @@ def offset_pixels(self) -> Tuple[float, float]:
 
     @property
     def offset_scaled(self) -> Tuple[float, float]:
+        """
+        Returns the offset of the centred of the zoomed in region from the centre of the `Mask2D` object in scaled
+        units.
+
+        This is computed by subtracting the pixel coordinates of the `Mask2D` object from the pixel coordinates of
+        the zoomed in region.
+
+        Returns
+        -------
+        The offset of the zoomed in region from the centre of the `Mask2D` object in scaled units.
+        """
         return (
             -self.mask.pixel_scales[0] * self.offset_pixels[0],
             self.mask.pixel_scales[1] * self.offset_pixels[1],
@@ -91,10 +124,12 @@ def offset_scaled(self) -> Tuple[float, float]:
     @property
     def region(self) -> List[int]:
         """
-        The zoomed rectangular region corresponding to the square encompassing all unmasked values. This zoomed
-        extraction region is a squuare, even if the mask is rectangular.
+        The zoomed region corresponding to the square encompassing all unmasked values.
 
         This is used to zoom in on the region of an image that is used in an analysis for visualization.
+
+        This zoomed extraction region is a square, even if the mask is rectangular, so that extraction regions are
+        always squares which is important for ensuring visualization does not have aspect ratio issues.
         """
 
         where = np.array(np.where(np.invert(self.mask.astype("bool"))))
@@ -119,22 +154,14 @@ def region(self) -> List[int]:
 
     @property
     def shape_native(self) -> Tuple[int, int]:
-        region = self.region
-        return (region[1] - region[0], region[3] - region[2])
-
-    @property
-    def mask_unmasked(self) -> "Mask2D":
         """
-        The scaled-grid of (y,x) coordinates of every pixel.
+        The shape of the zoomed in region in pixels.
 
-        This is defined from the top-left corner, such that the first pixel at location [0, 0] will have a negative x
-        value y value in scaled units.
-        """
-
-        from autoarray.mask.mask_2d import Mask2D
+        This is computed by subtracting the minimum and maximum y and x pixel values of the unmasked region.
 
-        return Mask2D.all_false(
-            shape_native=self.shape_native,
-            pixel_scales=self.mask.pixel_scales,
-            origin=self.offset_scaled,
-        )
+        Returns
+        -------
+        The shape of the zoomed in region in pixels.
+        """
+        region = self.region
+        return (region[1] - region[0], region[3] - region[2])

test_autoarray/mask/derive/test_zoom_2d.py

@@ -109,41 +109,3 @@ def test__quantities():
 
     assert zoom.centre == (6, 2)
     assert zoom.offset_pixels == (3, 1)
-
-
-def test__mask_unmasked():
-    mask = aa.Mask2D(
-        mask=np.array(
-            [
-                [False, True, True, True],
-                [True, False, True, True],
-                [True, True, True, True],
-            ]
-        ),
-        pixel_scales=(1.0, 1.0),
-    )
-    zoom = aa.Zoom2D(mask=mask)
-    
-    mask_unmasked = zoom.mask_unmasked
-
-    assert (mask_unmasked == np.array([[False, False], [False, False]])).all()
-    assert mask_unmasked.origin == (0.5, -1.0)
-
-    mask = aa.Mask2D(
-        mask=np.array(
-            [
-                [False, True, True, True],
-                [True, False, True, True],
-                [True, False, True, True],
-            ]
-        ),
-        pixel_scales=(1.0, 2.0),
-    )
-    zoom = aa.Zoom2D(mask=mask)
-
-    mask_unmasked = zoom.mask_unmasked
-
-    assert (
-        mask_unmasked == np.array([[False, False], [False, False], [False, False]])
-    ).all()
-    assert mask_unmasked.origin == (0.0, -2.0)