Minor Comment and Other Cleanup

Author: den-sq

python/ouroboros/helpers/slice.py

@@ -201,27 +201,37 @@ def backproject_box(bounding_box: BoundingBox, slice_rects: np.ndarray, slices:
         # No slices, just return
         return np.empty((0), dtype=np.uint32), np.empty(0, dtype=np.float32), np.empty(0, dtype=np.float32)
 
+    # Plot the backprojected X/Y/Z coordinates for each of the slice rects in this chunk.
+    grid_call = partial(coordinate_grid, shape=slices[0].shape, floor=bounding_box.get_min(), flip=True)
+    precise_points = np.concatenate(list(map(grid_call, slice_rects)))
+
+    # Flatten values to 1-Dimension Array for Efficient Allocation.
+    # Use ZYX domain rather than XYZ as the former is what is written to disk.
     values = slices.flatten()
     zyx_shape = np.flip(bounding_box.get_shape())
     flat_shape = np.prod(zyx_shape)
 
-    grid_call = partial(coordinate_grid, shape=slices[0].shape, floor=bounding_box.get_min(), flip=True)
-    precise_points = np.concatenate(list(map(grid_call, slice_rects)))
+    # Determine minimum dtype for index of flattened shape.
+    squish_type = np.min_scalar_type(flat_shape)
 
+    # Allocate the flattened data volume.
     volume = np.zeros((2, flat_shape), dtype=np.float32)
-    squish_type = np.min_scalar_type(flat_shape)
 
+    # Get the top corner (integer) points and full weight matrix.
     points, weights = _points_and_weights(precise_points.reshape(-1, 3).T, zyx_shape, squish_type)
 
+    # Sequentially allocate the points and weights for each corner to the flattened array.
     for corner in np.array(list(np.ndindex(2, 2, 2))):
         w_values, c_weights = _apply_weights(values, weights, corner)
         point_inc = np.ravel_multi_index(corner, zyx_shape).astype(squish_type)
 
         np.add.at(volume[0], points + point_inc, w_values)
         np.add.at(volume[1], points + point_inc, c_weights)
 
+    # Get indicies of the flattened Z-Y-X backprojected domain that have values.
     nz_vol = np.flatnonzero(volume[0])
 
+    # Return indicies and only the volume region with values.
     return nz_vol, volume[0, nz_vol].squeeze(), volume[1, nz_vol].squeeze()
 
 

python/ouroboros/helpers/volume_cache.py

@@ -252,22 +252,22 @@ def update_writable_rects(processed: np.ndarray, slice_rects: np.ndarray, min_di
 
     Parameters:
     -----------
-        processed (np.ndarray): Marker of which chunks are processed, 
-        						 by their (Z, Y, X) indicies.
+        processed (np.ndarray): Marker of which chunks are processed,
+                                 by their (Z, Y, X) indicies.
         slice_rects: All full-size slice rects from the straightened volume.
         min_dim (int): Minimum (z) dimension of the full object.
         writeable (np.ndarray): Tracker of writable Z-stacks (index 0 = z min_dim).
-								Values: 0 (not writeable), 1 (writable), 2 (dispatched to writer).
+                                Values: 0 (not writeable), 1 (writable), 2 (dispatched to writer).
         chunk_size (int): Size of 3D chunk in (z) dimension.
 
     Return:
     -------
         np.ndarray: Sorted values in the given dimension that ready to be written to.
 
     """
-    # Each chunk covers part of chunk_size slice_rects in z (straightened) dimension, 
-	#  except last may be shorter (so capped to length of slice_rects).
-	# A full slice_rect is ready if all (y, x) chunks for it are processed.
+    # Each chunk covers part of chunk_size slice_rects in z (straightened) dimension,
+    #  except last may be shorter (so capped to length of slice_rects).
+    # A full slice_rect is ready if all (y, x) chunks for it are processed.
     processed_slices = np.repeat(np.all(processed, axis=(1, 2)), chunk_size)[:len(slice_rects)]
     if np.all(processed_slices):
         # All slice_rects processed, remaining z (backprojected) slices are to be written.

python/ouroboros/pipeline/backproject_pipeline.py

@@ -274,8 +274,8 @@ def note_written(write_future):
         pipeline_input.backprojected_folder_path = folder_path
 
         self.add_timing("export", time.perf_counter() - start)
-        
-        if config.make_single_file:        
+
+        if config.make_single_file:
             shutil.rmtree(folder_path)
 
         return None