Refactor grid initialization in at_focused_bowl_3D example

- Updated the grid creation to use the new `from_domain` method for improved clarity and efficiency.
- Adjusted sensor mask and data reshaping to utilize properties from the kWaveGrid instance.
- Enhanced consistency in grid property usage throughout the example for better readability and maintainability.

Author: waltsims

examples/at_focused_bowl_3D/at_focused_bowl_3D.py

@@ -57,18 +57,9 @@
 # --------------------
 
 # calculate the grid spacing based on the PPW and F0
-dx: float = c0 / (ppw * source_f0)  # [m]
-
-# compute the size of the grid
-Nx: int = round_even(axial_size / dx) + source_x_offset
-Ny: int = round_even(lateral_size / dx)
-Nz: int = Ny
-
-grid_size_points = Vector([Nx, Ny, Nz])
-grid_spacing_meters = Vector([dx, dx, dx])
-
-# create the k-space grid
-kgrid = kWaveGrid(grid_size_points, grid_spacing_meters)
+kgrid = kWaveGrid.from_domain(
+    dimensions=[axial_size, lateral_size, lateral_size], frequency=source_f0, sound_speed_min=c0, points_per_wavelength=ppw
+)
 
 # compute points per temporal period
 ppp: int = round(ppw / cfl)
@@ -124,8 +115,8 @@
 sensor = kSensor()
 
 # set sensor mask to record central plane, not including the source point
-sensor.mask = np.zeros((Nx, Ny, Nz), dtype=bool)
-sensor.mask[(source_x_offset + 1) : -1, :, Nz // 2] = True
+sensor.mask = np.zeros(kgrid.N, dtype=bool)
+sensor.mask[(source_x_offset + 1) : -1, :, kgrid.Nz // 2] = True
 
 # record the pressure
 sensor.record = ["p"]
@@ -155,10 +146,10 @@
 amp, _, _ = extract_amp_phase(sensor_data["p"].T, 1.0 / kgrid.dt, source_f0, dim=1, fft_padding=1, window="Rectangular")
 
 # reshape data
-amp = np.reshape(amp, (Nx - (source_x_offset + 2), Ny), order="F")
+amp = np.reshape(amp, (kgrid.Nx - (source_x_offset + 2), kgrid.Ny), order="F")
 
 # extract pressure on axis
-amp_on_axis = amp[:, Ny // 2]
+amp_on_axis = amp[:, kgrid.Ny // 2]
 
 # define axis vectors for plotting
 x_vec = kgrid.x_vec[(source_x_offset + 1) : -1, :] - kgrid.x_vec[source_x_offset]
@@ -172,7 +163,7 @@
 knumber = 2.0 * np.pi * source_f0 / c0
 
 # define axis
-x_max = Nx * dx
+x_max = kgrid.x_max
 delta_x = x_max / 10000.0
 x_ref = np.arange(0.0, x_max + delta_x, delta_x)
 
@@ -210,14 +201,14 @@
 ax2a.pcolormesh(
     1e3 * np.squeeze(kgrid.y_vec),
     1e3 * np.squeeze(kgrid.x_vec),
-    np.flip(source.p_mask[:, :, Nz // 2], axis=0),
+    np.flip(source.p_mask[:, :, kgrid.Nz // 2], axis=0),
     shading="nearest",
 )
 ax2a.set(xlabel="y [mm]", ylabel="x [mm]", title="Source Mask")
 ax2b.pcolormesh(
     1e3 * np.squeeze(kgrid.y_vec),
     1e3 * np.squeeze(kgrid.x_vec),
-    np.flip(grid_weights[:, :, Nz // 2], axis=0),
+    np.flip(grid_weights[:, :, kgrid.Nz // 2], axis=0),
     shading="nearest",
 )
 ax2b.set(xlabel="y [mm]", ylabel="x [mm]", title="Off-Grid Source Weights")

kwave/kgrid.py

@@ -703,12 +703,12 @@ def k_dtt(self, dtt_type):  # Not tested for correctness!
             return k, M
 
     @classmethod
-    def from_geometry(cls, domain_size, min_element_width, points_per_wavelength=10, cfl=None):
+    def from_geometry(cls, dimensions, min_element_width, points_per_wavelength=10):
         """
         Create a kWaveGrid based on domain dimensions and the smallest resolvable geometry element.
 
         Args:
-            domain_size: List or array of physical domain sizes [m]
+            dimensions: List or array of physical domain sizes [m]
             min_element_width: Width of the smallest resolvable geometry element [m]
             points_per_wavelength: Number of points per wavelength (default=10)
             cfl: CFL number (default=cls.CFL_DEFAULT)
@@ -717,8 +717,8 @@ def from_geometry(cls, domain_size, min_element_width, points_per_wavelength=10,
             kWaveGrid instance with appropriate grid size and spacing
         """
         # Validate input parameters
-        domain_size = np.atleast_1d(domain_size)
-        if not np.all(domain_size > 0):
+        dimensions = np.atleast_1d(dimensions)
+        if not np.all(dimensions > 0):
             raise ValueError("Domain dimensions must be positive")
         if not min_element_width > 0:
             raise ValueError("Minimum element width must be positive")
@@ -728,10 +728,10 @@ def from_geometry(cls, domain_size, min_element_width, points_per_wavelength=10,
         grid_spacing = min_element_width / points_per_wavelength
 
         # Create a list of grid spacings with the same length as domain_size
-        grid_spacing_list = [grid_spacing] * domain_size.size
+        grid_spacing_list = [grid_spacing] * dimensions.size
 
         # Calculate grid size
-        N = np.ceil(domain_size / grid_spacing).astype(int)
+        N = np.ceil(dimensions / grid_spacing).astype(int)
 
         # Create grid instance
         grid = cls(N=N, spacing=grid_spacing_list)
@@ -785,3 +785,15 @@ def from_domain(cls, dimensions, frequency, sound_speed_min, sound_speed_max=Non
         grid = cls(N=N, spacing=grid_spacing)
 
         return grid
+
+    @property
+    def x_max(self):
+        return self.x_vec[-1] - self.x_vec[0]
+
+    @property
+    def y_max(self):
+        return self.y_vec[-1] - self.y_vec[0]
+
+    @property
+    def z_max(self):
+        return self.z_vec[-1] - self.z_vec[0]