Merge pull request #145 from transientskp/make_cli_backwards_compatible

Use back-size-x/y if set, fall back to grid parameter from config.

Author: HannoSpreeuw

sourcefinder/config.py

@@ -158,16 +158,16 @@ class ImgConf(_Validate):
     allow_multiprocessing: bool = True     # Allow multiprocessing for Gaussian fitting in parallel.
     margin: int = 0                        # Margin in pixels to ignore around the edge of the image.
     radius: float = 0.0                    # Radius in pixels around sources to include in analysis.
-    back_size_x: int = 32                  # Background estimation box size (X direction).
-    back_size_y: int = 32                  # Background estimation box size (Y direction).
+    back_size_x: int | None = 32           # Background estimation box size (X direction).
+    back_size_y: int | None = 32           # Background estimation box size (Y direction).
     eps_ra: float = 0.0                    # RA matching tolerance in arcseconds.
     eps_dec: float = 0.0                   # Dec matching tolerance in arcseconds.
     detection: float = 10.0                # Detection threshold.
     analysis: float = 3.0                  # Analysis threshold.
     fdr: bool = False                      # Use False Detection Rate (FDR) algorithm.
     alpha: float = 1e-2                    # FDR alpha value (significance level).
     deblend_thresholds: int = 0            # Number of deblending subthresholds; 0 to disable.
-    grid: int = 64                         # Background grid segment size.
+    grid: int | None = None                # Background grid segment size used as fallback for back-size-x and back-size-y.
     bmaj: float | None = None              # Set beam: Major axis of beam (degrees).
     bmin: float | None = None              # Set beam: Minor axis of beam (degrees).
     bpa: float | None = None               # Set beam: Beam position angle (degrees).

sourcefinder/image.py

@@ -223,14 +223,22 @@ def __grids(self):
         useful_chunk = ndimage.find_objects(np.where(self.data.mask, 0, 1))
         assert (len(useful_chunk) == 1)
         x_dim, y_dim  = self.data[useful_chunk[0]].shape
+        # Use 'back-size-x' and 'back-size-y' if available, fall back to 'grid'.
+        back_size_x = self.conf.image.back_size_x or self.conf.image.grid
+        if back_size_x is None:
+            raise ValueError("Expected either back-size-x or grid to be set in the config object")
+        back_size_y = self.conf.image.back_size_y or self.conf.image.grid
+        if back_size_y is None:
+            raise ValueError("Expected either back-size-y or grid to be set in the config object")
         # We should divide up the image into subimages such that each grid
         # node is centered on a subimage. This is only possible if
         # self.back_size_x and self.back_size_y are divisors of xdim and ydim,
         # respectively. If not, we need to select a frame within useful_chunk
         # that does have the appropriate dimensions. At the same time, it should
         # be as large as possible and centered within useful_chunk.
-        rem_row = np.mod(x_dim, self.conf.image.back_size_x)
-        rem_col = np.mod(y_dim, self.conf.image.back_size_y)
+        rem_row = np.mod(x_dim, back_size_x)
+        rem_col = np.mod(y_dim, back_size_y)
+
         start_offset_row, rem_rem_row = divmod(rem_row, 2)
         start_offset_col, rem_rem_col = divmod(rem_col, 2)
         end_offset_row = start_offset_row + rem_rem_row
@@ -245,8 +253,8 @@ def __grids(self):
 
         # Before proceeding, check that our data has the size of at least
         # one subimage, for both dimensions.
-        if (centred_inds[1] - centred_inds[0] > self.conf.image.back_size_x and
-            centred_inds[3] - centred_inds[2] > self.conf.image.back_size_y):
+        if (centred_inds[1] - centred_inds[0] > back_size_x and
+            centred_inds[3] - centred_inds[2] > back_size_y):
 
             subimages, number_of_elements_for_each_subimage = \
                 utils.make_subimages(self.data.data[centred_inds[0]:
@@ -257,7 +265,7 @@ def __grids(self):
                                                     centred_inds[1],
                                                     centred_inds[2]:
                                                     centred_inds[3]],
-                                     self.conf.image.back_size_x, self.conf.image.back_size_y)
+                                     back_size_x, back_size_y)
 
             mean_grid = np.zeros(number_of_elements_for_each_subimage.shape,
                                  dtype=np.float32)