spyrit.misc.disp.blue_box

spyrit.misc.disp.blue_box(f: ndarray, amp_max: int = 0, box_color: Tuple[int, int, int] = (0, 0, 255)) → ndarray

Add a colored box overlay to an image for visualization purposes.

Args:

f: Input grayscale or RGB image. amp_max: Offset from image borders for the box. box_color: RGB color for the box (default: blue).

Returns:

RGB image with colored box overlay.

Raises:

ValueError: If amp_max is too large for the image size.