import os
from typing import Optional, Tuple, Union
import cv2
import numpy as np
from simba.utils.checks import (check_file_exist_and_readable,
check_if_valid_img, check_if_valid_rgb_tuple,
check_int, check_str, check_valid_boolean)
from simba.utils.enums import Options
from simba.utils.errors import InvalidFileTypeError
from simba.utils.read_write import (get_fn_ext, get_video_meta_data,
read_frm_of_video, read_img)
from simba.utils.warnings import CropWarning
[docs]class ROISelector(object):
"""
A class for selecting and reflecting Regions of Interest (ROI) in an image.
The selected region variables are stored in self: top_left, bottom_right, width, height etc.
.. video:: _static/img/roi_selector.webm
:width: 600
:autoplay:
:loop:
:muted:
:align: center
:param Union[str, os.PathLike] path: Path to the image or video file. Can also be an image represented as a numpy array.
:param int thickness: Thickness of the rectangle border for visualizing the ROI.
:param Tuple[int, int, int] clr: BGR color tuple for visualizing the ROI. Default: deep pink.
:param Optional[str] title: Title of the drawing window. If None, then `Draw ROI - Press ESC when drawn`.
:param bool destroy: If True, destroy drawing window when completed. Default: True.
:example:
>>> img_selector = ROISelector(path='/Users/simon/Desktop/compute_overlap.png', clr=(0, 255, 0), thickness=2)
>>> img_selector.run()
"""
def __init__(self,
path: Union[str, os.PathLike, np.ndarray],
thickness: int = 10,
clr: Tuple[int, int, int] = (147, 20, 255),
title: Optional[str] = None,
destroy: bool = True,
greyscale: bool = False,
clahe: bool = False) -> None:
check_if_valid_rgb_tuple(data=clr)
check_int(name="Thickness", value=thickness, min_value=1, raise_error=True)
if title is not None: check_str(name=f"{self.__class__.__name__} title", value=title)
check_valid_boolean(value=destroy, source=f'{self.__class__.__name__} destroy', raise_error=True)
check_valid_boolean(value=greyscale, source=f'{self.__class__.__name__} greyscale', raise_error=True)
check_valid_boolean(value=clahe, source=f'{self.__class__.__name__} clahe', raise_error=True)
self.roi_start = None
self.roi_end = None
self.selecting_roi = False
self.clr = clr
self.complete = False
self.terminate = False
self.thickness = int(thickness)
self.destroy = destroy
if isinstance(path, np.ndarray):
self.image = path
check_if_valid_img(data=self.image, source=self.__class__.__name__, raise_error=True)
else:
check_file_exist_and_readable(file_path=path)
_, filename, ext = get_fn_ext(filepath=path)
if ext in Options.ALL_VIDEO_FORMAT_OPTIONS.value:
self.image = read_frm_of_video(video_path=path, frame_index=0, greyscale=greyscale, clahe=clahe, use_ffmpeg=False, raise_error=True)
elif ext in Options.ALL_IMAGE_FORMAT_OPTIONS.value:
self.image = read_img(img_path=path, greyscale=greyscale, clahe=clahe)
#self.image = cv2.imread(path).astype(np.uint8)
else:
raise InvalidFileTypeError(msg=f"Cannot crop a {ext} file.", source=self.__class__.__name__)
if title is None:
title = f"Draw ROI video {filename} - Press ESC when drawn"
self.img_cpy = self.image.copy()
self.w, self.h = self.image.shape[1], self.image.shape[0]
if title is None:
self.title = "Draw ROI - Press ESC when drawn"
else:
self.title = title
def mouse_callback(self, event, x, y, flags, param):
if event == cv2.EVENT_LBUTTONDOWN:
self.roi_start = (x, y)
self.roi_end = (x, y)
self.selecting_roi = True
elif event == cv2.EVENT_LBUTTONUP:
self.roi_end = (x, y)
self.selecting_roi = False
elif event == cv2.EVENT_MOUSEMOVE and self.selecting_roi:
self.roi_end = (x, y)
self.img_cpy = self.image.copy()
cv2.rectangle(self.img_cpy, self.roi_start, self.roi_end, self.clr, self.thickness)
def run(self):
cv2.namedWindow(self.title, cv2.WINDOW_NORMAL)
cv2.resizeWindow(self.title, self.w, self.h)
cv2.setMouseCallback(self.title, self.mouse_callback)
while not self.terminate:
if self.selecting_roi or self.img_cpy is None:
self.img_cpy = self.image.copy()
if self.roi_start is not None and self.roi_end is not None:
cv2.rectangle(self.img_cpy, self.roi_start, self.roi_end, self.clr, self.thickness)
cv2.imshow(self.title, self.img_cpy)
key = cv2.waitKey(1) & 0xFF
if (key == ord("c") and self.roi_start is not None and self.roi_end is not None):
selected_roi = self.image[self.roi_start[1] : self.roi_end[1], self.roi_start[0] : self.roi_end[0]].copy()
reflected_roi = cv2.flip(selected_roi, 1)
self.image[self.roi_start[1] : self.roi_end[1], self.roi_start[0] : self.roi_end[0]] = reflected_roi
self.roi_start = None
self.roi_end = None
elif key == 27:
if self.run_checks():
if self.destroy:
cv2.destroyAllWindows()
cv2.waitKey(1)
self.terminate = True
break
if cv2.getWindowProperty(self.title, cv2.WND_PROP_VISIBLE) < 1:
if self.destroy:
cv2.destroyAllWindows()
self.terminate = True
break
if self.terminate:
self.run_checks()
def run_checks(self):
self.top_left = min(self.roi_start[0], self.roi_end[0]), min(self.roi_start[1], self.roi_end[1])
self.bottom_right = max(self.roi_start[0], self.roi_end[0]), max(self.roi_start[1], self.roi_end[1])
if self.top_left[0] < 0:
self.top_left = (0, self.top_left[1])
if self.top_left[1] < 0:
self.top_left = (self.top_left[0], 0)
if self.bottom_right[0] < 0:
self.bottom_right = (0, self.bottom_right[1])
if self.bottom_right[1] < 0:
self.bottom_right = (self.bottom_right[0], 0)
if self.bottom_right[0] > self.w:
self.bottom_right = (self.w, self.bottom_right[1])
if self.bottom_right[1] > self.h:
self.bottom_right = (self.bottom_right[0], self.h)
self.width = self.bottom_right[0] - self.top_left[0]
self.height = self.bottom_right[1] - self.top_left[1]
self.center = (int(self.top_left[0] + (self.width / 2)), int(self.top_left[1] + (self.height / 2)))
self.bottom_right_tag = (int(self.top_left[0] + self.width), int(self.top_left[1] + self.height))
self.top_right_tag = (int(self.top_left[0] + self.width), int(self.top_left[1]))
self.bottom_left_tag = (int(self.top_left[0]), int(self.top_left[1] + self.height))
self.top_tag = (int(self.top_left[0] + self.width / 2), int(self.top_left[1]))
self.right_tag = (int(self.top_left[0] + self.width), int(self.top_left[1] + self.height / 2))
self.left_tag = (int(self.top_left[0]), int(self.top_left[1] + self.height / 2))
self.bottom_tag = (int(self.top_left[0] + self.width / 2), int(self.top_left[1] + self.height))
self.complete = True
if (self.width == 0 and self.height == 0) or (self.width + self.height + self.top_left[0] + self.top_left[1] == 0):
CropWarning(msg="CROP WARNING: ROI height and width are both 0. Please try again.", source=self.__class__.__name__)
return False
else:
return True
# img_selector = ROISelector(path=r"D:\weights\2025-04-17_17-17-14\cropped_slowed_output.mp4", clr=(0, 255, 0), thickness=2, destroy=False)
# img_selector.run()
# print(img_selector.top_right_tag, img_selector.width, img_selector.height)