Merge branch 'cleanup-comments'

* Branch commit log:
  src/embed.py: remove comment, convolutional codes add key randomization
  src/extract.py: remove outdated todo / debug comments
  tests/gen-tests-mk: remove comment about lengthy rescaling
  tests/Makefile: remove old todo comments

Signed-off-by: Tim Janik <timj@gnu.org>

Author: tim-janik

src/embed.py

@@ -122,7 +122,6 @@ def command_add (input_img, output_img, message_hex, strength, args):
   Ldim = m_enc.shape[0]
   assert Ldim * Ldim == Lm
   dprint ("m (needs encoding):", "size=%d" % Lm, m_enc.shape, m_enc.min(), '...', m_enc.max());
-  # TODO: Key-Randomize message bit positions in watermark
 
   # generate random matrix `r` (bp_r)
   Lr, bp_r = common.make_wm_pattern (config.DEFAULT_KEY)

src/extract.py

@@ -48,7 +48,6 @@ def estimate_watermark (face_J, orig_J, strength, window):
     J_delta = face_J - J_mean                             # J´ = J - µ
   else:
     J_delta = face_J - orig_J
-  # TODO: ensure J_delta always != 0
   dprint ("J_delta:", J_delta.shape, J_delta.min(), '...', J_delta.max())
   if config.will_plot ('MSCN'): # MSCN = Mean Substracted Contrast Normalization
     show (J=face_J, J_mean=J_mean, J_var=J_var, J_delta=J_delta)
@@ -115,7 +114,7 @@ def find_peaks (S2_uni, S2j, window):
   S2M_mean = common.local_mean (S2M_uni, window)  # µ_S´ = local mean of S´
   dprint ("S2M_mean:", S2M_mean.shape, S2M_mean.min(), '...', S2M_mean.max())
   S2M_std = np.std (S2M_uni)                      # standard deviation of S´ - "σ²_S´"
-  dprint ("S2M_std:", S2M_std.shape, S2M_std.min(), '...', S2M_std.max()) # TODO: useless
+  dprint ("S2M_std:", S2M_std.shape, S2M_std.min(), '...', S2M_std.max())
   S2M_var = S2M_std ** 2                          # global variance of S´ - "σ²_S´"
   # S2M_var = common.local_variance (S2M_uni, S2M_uni.shape) # global variance of S´ - "σ²_S´"
   # dprint ("S2M_var:", S2M_var.shape, S2M_var.min(), '...', S2M_var.max())
@@ -507,7 +506,7 @@ def watermark_from_grid (grid, uz, LR, Ldim, Lwu, face_J, orig_J, wmasked_up, W_
   # skip decoding step if minimum ws_score is not reached
   wmi = None
   if ws_score >= min_ws_score:
-    wmi = pixels_to_watermark (ws_Y, ws_score, conv_decoder, args) # TODO: when this becomes too expensive, run once per grid list
+    wmi = pixels_to_watermark (ws_Y, ws_score, conv_decoder, args)
     # add statistics
     wmi['regularity'] = grid.features['regularity']
     wmi['coverage'] = coverage
@@ -836,7 +835,6 @@ def watermark_from_grid_lists (grid_lists, face_J, orig_J, W_est, wmasked, S2_xp
   wmi_time = args.startup_time
 
   # Detect lists of grids with decreasing regularity
-  # TODO: for testing we use either peaks2grid or cornersync, but for the final version we should use both
   for grid_list in grid_lists:
     # peaks2grid can send us empty grid lists?
     if len (grid_list) < 1:
@@ -876,6 +874,3 @@ def watermark_from_grid_lists (grid_lists, face_J, orig_J, W_est, wmasked, S2_xp
 
   done = best_jsd > jsd_window_threshold or done_expecting
   return wmi_list, done
-  # TODO: Xsum = Bsum ^ m_enc
-  # TODO: dprint ("Xsum:", Xsum.shape, Xsum.min(), '...', Xsum.max())
-  # TODO:   show (title = "Summarized Top 8", Ysum=Ysum, Bsum=Bsum, m=m_enc, xor=Xsum)

tests/Makefile

@@ -182,8 +182,3 @@ clean-reports:
 	rm -f *.tmp *.svg $(RESULT_REPORTS) report.md
 clean: clean-attack clean-extract clean-reports
 	rm -rf ../tests/wmarked/ ../tests/inputs/
-
-# TODO: json: prefix imagewmark get results with image file name
-# TODO: json: add filename field
-# TODO: json: add single 'watermark' and 'confidence' field
-# TODO: add timings, PSNR

tests/gen-tests-mk

@@ -176,7 +176,6 @@ def main():
     dstname = os.path.join (inputsdir, imgname)
     rw, rh = resolutions2d[imgidx]
     target_sizes.append ((imgname, f"{rw}x{rh}"))
-    # TODO: rescale if image is beyond 2k, for now always link
     if symlink (src_image_path, dstname):
       eprint ("  SYMLINK", dstname, "->", src_image_path, f"(target size: {rw}x{rh})")
     else: