opsci-toolbox 0.0.6__py3-none-any.whl → 0.0.8__py3-none-any.whl

opsci_toolbox/helpers/cv.py

@@ -8,11 +8,11 @@ def open_image(image_path: str) -> Image:
     """
     Open and return an image.
 
-    Parameters:
-    - image_path (str): The path to the image file.
+    Args:
+        image_path (str): The path to the image file.
 
     Returns:
-    - Image object: The opened image.
+        Image object: The opened image.
     """
     try:
         # Open the image file
@@ -26,13 +26,13 @@ def save_image(image: Image, output_path: str, name: str) -> str:
     """
     Save an image to the local disk.
 
-    Parameters:
-    - image (Image object): The image to be saved.
-    - output_path (str): The path to save the image.
-    - name (str): The name of the saved image file.
+    Args:
+        image (Image object): The image to be saved.
+        output_path (str): The path to save the image.
+        name (str): The name of the saved image file.
 
     Returns:
-    - str: The file path where the image is saved, or an error message if saving fails.
+        str: The file path where the image is saved, or an error message if saving fails.
     """
     try:
         # Save the image to the specified path
@@ -47,14 +47,14 @@ def convert_image_format(input_path: str, output_path: str, output_filename: str
     """
     Convert an image to another image format (e.g., from PNG to JPEG).
 
-    Parameters:
-    - input_path (str): The path to the input image file.
-    - output_path (str): The path to save the converted image.
-    - output_filename (str): The name of the converted image file.
-    - output_format (str): The format to which the image should be converted. Default is "JPEG".
+    Args:
+        input_path (str): The path to the input image file.
+        output_path (str): The path to save the converted image.
+        output_filename (str): The name of the converted image file.
+        output_format (str): The format to which the image should be converted. Default is "JPEG".
 
     Returns:
-    - str: The file path where the converted image is saved, or an error message if conversion fails.
+        str: The file path where the converted image is saved, or an error message if conversion fails.
     """
     try:
         file_path = os.path.join(output_path, output_filename + "." + output_format)
@@ -73,13 +73,13 @@ def resize_image(image: Image, new_width: int, new_height: int) -> Image:
     """
     Resize an image to the specified width and height.
 
-    Parameters:
-    - image (PIL.Image.Image): The PIL image object to be resized.
-    - new_width (int): The desired width of the resized image.
-    - new_height (int): The desired height of the resized image.
+    Args:
+        image (PIL.Image.Image): The PIL image object to be resized.
+        new_width (int): The desired width of the resized image.
+        new_height (int): The desired height of the resized image.
 
     Returns:
-    - PIL.Image.Image: The resized image.
+        PIL.Image.Image: The resized image.
     """
     try:
         # Resize the image
@@ -93,15 +93,15 @@ def crop_image(image: Image, x: int, y: int, width: int, height: int) -> Image:
     """
     Crop an image based on the specified coordinates and dimensions.
 
-    Parameters:
-    - image (PIL.Image.Image): The PIL image object to be cropped.
-    - x (int): The x-coordinate of the top-left corner of the cropping region.
-    - y (int): The y-coordinate of the top-left corner of the cropping region.
-    - width (int): The width of the cropping region.
-    - height (int): The height of the cropping region.
+    Args:
+        image (PIL.Image.Image): The PIL image object to be cropped.
+        x (int): The x-coordinate of the top-left corner of the cropping region.
+        y (int): The y-coordinate of the top-left corner of the cropping region.
+        width (int): The width of the cropping region.
+        height (int): The height of the cropping region.
 
     Returns:
-    - PIL.Image.Image: The cropped image.
+        PIL.Image.Image: The cropped image.
     """
     try:
         # Crop the image
@@ -115,12 +115,12 @@ def flip_image(image: Image, direction: str = 'horizontal') -> Image:
     """
     Flip an image horizontally or vertically.
 
-    Parameters:
-    - image (PIL.Image.Image): The PIL image object to be flipped.
-    - direction (str): The direction of the flip ('horizontal' or 'vertical'). Default is 'horizontal'.
+    Args:
+        image (PIL.Image.Image): The PIL image object to be flipped.
+        direction (str): The direction of the flip ('horizontal' or 'vertical'). Default is 'horizontal'.
 
     Returns:
-    - PIL.Image.Image: The flipped image.
+        PIL.Image.Image: The flipped image.
     """
     try:
         # Flip the image
@@ -141,12 +141,12 @@ def rotate_image(image: Image, angle: float) -> Image:
     """
     Rotate an image by the given angle (in degrees).
 
-    Parameters:
-    - image (PIL.Image.Image): The PIL image object to be rotated.
-    - angle (float): The angle by which to rotate the image (in degrees).
+    Args:
+        image (PIL.Image.Image): The PIL image object to be rotated.
+        angle (float): The angle by which to rotate the image (in degrees).
 
     Returns:
-    - PIL.Image.Image: The rotated image.
+        PIL.Image.Image: The rotated image.
     """
     try:
         # Rotate the image
@@ -160,11 +160,11 @@ def convert_to_grayscale(image: Image) -> Image:
     """
     Convert a color image to grayscale.
 
-    Parameters:
-    - image (PIL.Image.Image): The PIL image object to be converted.
+    Args:
+        image (PIL.Image.Image): The PIL image object to be converted.
 
     Returns:
-    - PIL.Image.Image: The grayscale image.
+        PIL.Image.Image: The grayscale image.
     """
     try:
         # Convert the image to grayscale
@@ -178,11 +178,11 @@ def PIL_get_image_size(image: Image) -> tuple:
     """
     Get PILLOW image size.
 
-    Parameters:
-    - image (PIL.Image.Image): The PIL image object.
+    Args:
+        image (PIL.Image.Image): The PIL image object.
 
     Returns:
-    - tuple: A tuple containing the width and height of the image.
+        tuple: A tuple containing the width and height of the image.
     """
     width, height = image.size
     return width, height
@@ -191,11 +191,11 @@ def cv_get_image_size(image) -> tuple:
     """
     Get cv2 image size.
 
-    Parameters:
-    - image: The cv2 image array.
+    Args:
+        image: The cv2 image array.
 
     Returns:
-    - tuple: A tuple containing the width and height of the image.
+        tuple: A tuple containing the width and height of the image.
     """
     height, width, _ = image.shape
     return width, height
@@ -204,11 +204,11 @@ def convert_PIL_to_cv(image: Image) -> np.ndarray:
     """
     Convert an image from Pillow to CV2.
 
-    Parameters:
-    - image (PIL.Image.Image): The PIL image object.
+    Args:
+        image (PIL.Image.Image): The PIL image object.
 
     Returns:
-    - numpy.ndarray: The converted cv2 image array.
+        numpy.ndarray: The converted cv2 image array.
     """
     numpy_array = np.array(image)
     cv2_image = cv2.cvtColor(numpy_array, cv2.COLOR_RGB2BGR)
@@ -399,14 +399,14 @@ def apply_mask(image: np.ndarray, mask: np.ndarray, color_mask: list = [255, 255
     Apply a transparent color mask on an image.
 
     Args:
-        image (np.ndarray): The input image to which the mask will be applied.
-        mask (np.ndarray): The binary mask indicating where to apply the color mask.
+        image (numpy.ndarray): The input image to which the mask will be applied.
+        mask (numpy.ndarray): The binary mask indicating where to apply the color mask.
         color_mask (list, optional): The RGB color to use for the mask. Default is white [255, 255, 255].
         reverse (bool, optional): If True, apply the color mask where the mask is False; otherwise, apply where True. Default is True.
         transparency (float, optional): The transparency level of the color mask (0.0 to 1.0). Default is 1.0 (opaque).
 
     Returns:
-        np.ndarray: The image with the color mask applied.
+        numpy.ndarray: The image with the color mask applied.
     """
     # Validate transparency value
     transparency = max(0.0, min(1.0, transparency))
@@ -606,14 +606,4 @@ def sv_annotate_image_label(
     # Annotate the image with the labels
     annotated_image = label_annotator.annotate(scene=image, detections=detections, labels=labels)
 
-    return annotated_image
-
-
-
-    
-
-    
-
-
-
-
+    return annotated_image