stouputils 1.14.0__py3-none-any.whl → 1.14.2__py3-none-any.whl

stouputils/data_science/data_processing/image/noise.py

@@ -1,59 +1,59 @@
-
-# Imports
-from .common import Any, NDArray, check_image, np
-
-
-# Functions
-def noise_image(image: NDArray[Any], amount: float, ignore_dtype: bool = False) -> NDArray[Any]:
-	""" Add Gaussian noise to an image.
-
-	Args:
-		image         (NDArray[Any]):  Image to add noise to
-		amount        (float):       Amount of noise to add (between 0 and 1)
-		ignore_dtype  (bool):        Ignore the dtype check
-	Returns:
-		NDArray[Any]: Noisy image
-
-	>>> ## Basic tests
-	>>> image = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]])
-	>>> noisy = noise_image(image.astype(np.uint8), 0.5)
-	>>> noisy.shape == image.shape
-	True
-	>>> bool(np.all(noisy >= 0) and np.all(noisy <= 255))
-	True
-
-	>>> np.random.seed(0)
-	>>> image = np.array([[128] * 3] * 3)
-	>>> noise_image(image.astype(np.uint8), 0.1).tolist()
-	[[172, 138, 152], [185, 175, 104], [152, 125, 126]]
-
-	>>> rgb = np.full((3,3,3), 128, dtype=np.uint8)
-	>>> noisy_rgb = noise_image(rgb, 0.1)
-	>>> noisy_rgb.shape == (3,3,3)
-	True
-
-	>>> ## Test invalid inputs
-	>>> noise_image("not an image", 0.5)
-	Traceback (most recent call last):
-		...
-	AssertionError: Image must be a numpy array
-
-	>>> noise_image(image.astype(np.uint8), "0.5")
-	Traceback (most recent call last):
-		...
-	AssertionError: amount must be a number, got <class 'str'>
-
-	>>> noise_image(image.astype(np.uint8), 1.5)
-	Traceback (most recent call last):
-		...
-	AssertionError: amount must be between 0 and 1, got 1.5
-	"""
-	# Check input data
-	check_image(image, ignore_dtype=ignore_dtype)
-	assert isinstance(amount, float | int), f"amount must be a number, got {type(amount)}"
-	assert 0 <= amount <= 1, f"amount must be between 0 and 1, got {amount}"
-
-	# Generate noise
-	noise: NDArray[Any] = np.random.normal(0, amount * 255, image.shape).astype(np.int16)
-	return np.clip(image.astype(np.int16) + noise, 0, 255).astype(image.dtype) # pyright: ignore [reportUnknownMemberType]
-
+
+# Imports
+from .common import Any, NDArray, check_image, np
+
+
+# Functions
+def noise_image(image: NDArray[Any], amount: float, ignore_dtype: bool = False) -> NDArray[Any]:
+	""" Add Gaussian noise to an image.
+
+	Args:
+		image         (NDArray[Any]):  Image to add noise to
+		amount        (float):       Amount of noise to add (between 0 and 1)
+		ignore_dtype  (bool):        Ignore the dtype check
+	Returns:
+		NDArray[Any]: Noisy image
+
+	>>> ## Basic tests
+	>>> image = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]])
+	>>> noisy = noise_image(image.astype(np.uint8), 0.5)
+	>>> noisy.shape == image.shape
+	True
+	>>> bool(np.all(noisy >= 0) and np.all(noisy <= 255))
+	True
+
+	>>> np.random.seed(0)
+	>>> image = np.array([[128] * 3] * 3)
+	>>> noise_image(image.astype(np.uint8), 0.1).tolist()
+	[[172, 138, 152], [185, 175, 104], [152, 125, 126]]
+
+	>>> rgb = np.full((3,3,3), 128, dtype=np.uint8)
+	>>> noisy_rgb = noise_image(rgb, 0.1)
+	>>> noisy_rgb.shape == (3,3,3)
+	True
+
+	>>> ## Test invalid inputs
+	>>> noise_image("not an image", 0.5)
+	Traceback (most recent call last):
+		...
+	AssertionError: Image must be a numpy array
+
+	>>> noise_image(image.astype(np.uint8), "0.5")
+	Traceback (most recent call last):
+		...
+	AssertionError: amount must be a number, got <class 'str'>
+
+	>>> noise_image(image.astype(np.uint8), 1.5)
+	Traceback (most recent call last):
+		...
+	AssertionError: amount must be between 0 and 1, got 1.5
+	"""
+	# Check input data
+	check_image(image, ignore_dtype=ignore_dtype)
+	assert isinstance(amount, float | int), f"amount must be a number, got {type(amount)}"
+	assert 0 <= amount <= 1, f"amount must be between 0 and 1, got {amount}"
+
+	# Generate noise
+	noise: NDArray[Any] = np.random.normal(0, amount * 255, image.shape).astype(np.int16)
+	return np.clip(image.astype(np.int16) + noise, 0, 255).astype(image.dtype) # pyright: ignore [reportUnknownMemberType]
+

stouputils/data_science/data_processing/image/normalize.py

@@ -1,65 +1,65 @@
-
-# pyright: reportUnknownVariableType=false
-# pyright: reportUnusedImport=false
-# pyright: reportArgumentType=false
-# pyright: reportCallIssue=false
-
-# Imports
-from .common import Any, NDArray, check_image, cv2, np  # noqa: F401
-
-
-# Functions
-def normalize_image(
-	image: NDArray[Any],
-	a: float | int = 0,
-	b: float | int = 255,
-	method: int = cv2.NORM_MINMAX,
-	ignore_dtype: bool = False,
-) -> NDArray[Any]:
-	""" Normalize an image to the range 0-255.
-
-	Args:
-		image         (NDArray[Any]):  Image to normalize
-		a             (float | int): Minimum value (default: 0)
-		b             (float | int): Maximum value (default: 255)
-		method        (int):         Normalization method (default: cv2.NORM_MINMAX)
-		ignore_dtype  (bool):        Ignore the dtype check
-	Returns:
-		NDArray[Any]: Normalized image
-
-	>>> ## Basic tests
-	>>> image = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]], dtype=np.uint8)
-	>>> normalized = normalize_image(image)
-	>>> normalized.tolist()
-	[[0, 32, 64], [96, 128, 159], [191, 223, 255]]
-	>>> normalized.shape == image.shape
-	True
-	>>> normalized.dtype == image.dtype
-	True
-
-	>>> ## Test invalid inputs
-	>>> normalize_image("not an image")
-	Traceback (most recent call last):
-		...
-	AssertionError: Image must be a numpy array
-
-	>>> normalize_image(image, a="not an integer")
-	Traceback (most recent call last):
-		...
-	AssertionError: a must be a float or an integer
-
-	>>> normalize_image(image, b="not an integer")
-	Traceback (most recent call last):
-		...
-	AssertionError: b must be a float or an integer
-	"""
-	# Check input data
-	check_image(image, ignore_dtype=ignore_dtype)
-	assert isinstance(a, float | int), "a must be a float or an integer"
-	assert isinstance(b, float | int), "b must be a float or an integer"
-	assert isinstance(method, int), "method must be an integer"
-	assert a < b, "a must be less than b"
-
-	# Normalize image
-	return cv2.normalize(image, None, a, b, method)
-
+
+# pyright: reportUnknownVariableType=false
+# pyright: reportUnusedImport=false
+# pyright: reportArgumentType=false
+# pyright: reportCallIssue=false
+
+# Imports
+from .common import Any, NDArray, check_image, cv2, np  # noqa: F401
+
+
+# Functions
+def normalize_image(
+	image: NDArray[Any],
+	a: float | int = 0,
+	b: float | int = 255,
+	method: int = cv2.NORM_MINMAX,
+	ignore_dtype: bool = False,
+) -> NDArray[Any]:
+	""" Normalize an image to the range 0-255.
+
+	Args:
+		image         (NDArray[Any]):  Image to normalize
+		a             (float | int): Minimum value (default: 0)
+		b             (float | int): Maximum value (default: 255)
+		method        (int):         Normalization method (default: cv2.NORM_MINMAX)
+		ignore_dtype  (bool):        Ignore the dtype check
+	Returns:
+		NDArray[Any]: Normalized image
+
+	>>> ## Basic tests
+	>>> image = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]], dtype=np.uint8)
+	>>> normalized = normalize_image(image)
+	>>> normalized.tolist()
+	[[0, 32, 64], [96, 128, 159], [191, 223, 255]]
+	>>> normalized.shape == image.shape
+	True
+	>>> normalized.dtype == image.dtype
+	True
+
+	>>> ## Test invalid inputs
+	>>> normalize_image("not an image")
+	Traceback (most recent call last):
+		...
+	AssertionError: Image must be a numpy array
+
+	>>> normalize_image(image, a="not an integer")
+	Traceback (most recent call last):
+		...
+	AssertionError: a must be a float or an integer
+
+	>>> normalize_image(image, b="not an integer")
+	Traceback (most recent call last):
+		...
+	AssertionError: b must be a float or an integer
+	"""
+	# Check input data
+	check_image(image, ignore_dtype=ignore_dtype)
+	assert isinstance(a, float | int), "a must be a float or an integer"
+	assert isinstance(b, float | int), "b must be a float or an integer"
+	assert isinstance(method, int), "method must be an integer"
+	assert a < b, "a must be less than b"
+
+	# Normalize image
+	return cv2.normalize(image, None, a, b, method)
+

stouputils/data_science/data_processing/image/random_erase.py

@@ -1,66 +1,66 @@
-
-# pyright: reportUnknownMemberType=false
-
-# Imports
-from .common import Any, NDArray, check_image, np
-
-
-# Functions
-def random_erase_image(image: NDArray[Any], erase_factor: float, ignore_dtype: bool = False) -> NDArray[Any]:
-	""" Randomly erase a rectangle in the image.
-
-	Args:
-		image         (NDArray[Any]):  Image to apply random erase
-		erase_factor  (float):       Factor determining the size of the rectangle to erase
-		ignore_dtype  (bool):        Ignore the dtype check
-	Returns:
-		NDArray[Any]: Image with random erasing applied
-
-	>>> ## Basic tests
-	>>> image = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]])
-	>>> erased = random_erase_image(image.astype(np.uint8), 0.5)
-	>>> erased.shape == image.shape
-	True
-
-	>>> np.random.seed(42)
-	>>> img = np.ones((5,5), dtype=np.uint8) * 255
-	>>> erased = random_erase_image(img, 0.4)
-	>>> bool(np.any(erased == 0))  # Should have some erased pixels
-	True
-
-	>>> rgb = np.full((3,3,3), 128, dtype=np.uint8)
-	>>> erased_rgb = random_erase_image(rgb, 0.3)
-	>>> erased_rgb.shape == (3,3,3)
-	True
-
-	>>> ## Test invalid inputs
-	>>> random_erase_image("not an image", 0.5)
-	Traceback (most recent call last):
-		...
-	AssertionError: Image must be a numpy array
-
-	>>> random_erase_image(image.astype(np.uint8), "0.5")
-	Traceback (most recent call last):
-		...
-	AssertionError: erase_factor must be a number, got <class 'str'>
-	"""
-	# Check input data
-	check_image(image, ignore_dtype=ignore_dtype)
-	assert isinstance(erase_factor, float | int), f"erase_factor must be a number, got {type(erase_factor)}"
-
-	# Get image dimensions
-	height, width = image.shape[:2]
-
-	# Determine size of the rectangle to erase
-	erase_height: int = int(height * erase_factor)
-	erase_width: int = int(width * erase_factor)
-
-	# Randomly choose the top-left corner of the rectangle
-	top_left_x: int = np.random.randint(0, width - erase_width)
-	top_left_y: int = np.random.randint(0, height - erase_height)
-
-	# Apply random erasing
-	erased_image: NDArray[Any] = image.copy()
-	erased_image[top_left_y:top_left_y + erase_height, top_left_x:top_left_x + erase_width] = 0
-	return erased_image
-
+
+# pyright: reportUnknownMemberType=false
+
+# Imports
+from .common import Any, NDArray, check_image, np
+
+
+# Functions
+def random_erase_image(image: NDArray[Any], erase_factor: float, ignore_dtype: bool = False) -> NDArray[Any]:
+	""" Randomly erase a rectangle in the image.
+
+	Args:
+		image         (NDArray[Any]):  Image to apply random erase
+		erase_factor  (float):       Factor determining the size of the rectangle to erase
+		ignore_dtype  (bool):        Ignore the dtype check
+	Returns:
+		NDArray[Any]: Image with random erasing applied
+
+	>>> ## Basic tests
+	>>> image = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]])
+	>>> erased = random_erase_image(image.astype(np.uint8), 0.5)
+	>>> erased.shape == image.shape
+	True
+
+	>>> np.random.seed(42)
+	>>> img = np.ones((5,5), dtype=np.uint8) * 255
+	>>> erased = random_erase_image(img, 0.4)
+	>>> bool(np.any(erased == 0))  # Should have some erased pixels
+	True
+
+	>>> rgb = np.full((3,3,3), 128, dtype=np.uint8)
+	>>> erased_rgb = random_erase_image(rgb, 0.3)
+	>>> erased_rgb.shape == (3,3,3)
+	True
+
+	>>> ## Test invalid inputs
+	>>> random_erase_image("not an image", 0.5)
+	Traceback (most recent call last):
+		...
+	AssertionError: Image must be a numpy array
+
+	>>> random_erase_image(image.astype(np.uint8), "0.5")
+	Traceback (most recent call last):
+		...
+	AssertionError: erase_factor must be a number, got <class 'str'>
+	"""
+	# Check input data
+	check_image(image, ignore_dtype=ignore_dtype)
+	assert isinstance(erase_factor, float | int), f"erase_factor must be a number, got {type(erase_factor)}"
+
+	# Get image dimensions
+	height, width = image.shape[:2]
+
+	# Determine size of the rectangle to erase
+	erase_height: int = int(height * erase_factor)
+	erase_width: int = int(width * erase_factor)
+
+	# Randomly choose the top-left corner of the rectangle
+	top_left_x: int = np.random.randint(0, width - erase_width)
+	top_left_y: int = np.random.randint(0, height - erase_height)
+
+	# Apply random erasing
+	erased_image: NDArray[Any] = image.copy()
+	erased_image[top_left_y:top_left_y + erase_height, top_left_x:top_left_x + erase_width] = 0
+	return erased_image
+

stouputils/data_science/data_processing/image/resize.py

@@ -1,69 +1,69 @@
-
-# Imports
-from PIL import Image
-
-from .common import Any, NDArray, check_image, np
-
-
-# Functions
-def resize_image(
-	image: NDArray[Any],
-	width: int,
-	height: int,
-	resample: Image.Resampling | int = Image.Resampling.LANCZOS,
-	ignore_dtype: bool = False
-) -> NDArray[Any]:
-	""" Resize an image to a new width and height.
-
-	Args:
-		image         (NDArray[Any]):              Image to resize
-		width         (int):                     New width
-		height        (int):                     New height
-		resample      (Image.Resampling | int):  Resampling method
-		ignore_dtype  (bool):                    Ignore the dtype check
-	Returns:
-		NDArray[Any]: Image with resized dimensions
-
-	>>> ## Basic tests
-	>>> image = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]])
-	>>> resized = resize_image(image.astype(np.uint8), 6, 6)
-	>>> resized.shape
-	(6, 6)
-
-	>>> img = np.ones((5, 5), dtype=np.uint8) * 255
-	>>> resized = resize_image(img, 10, 10)
-	>>> resized.shape
-	(10, 10)
-
-	>>> rgb = np.full((3, 3, 3), 128, dtype=np.uint8)
-	>>> resized_rgb = resize_image(rgb, 6, 6)
-	>>> resized_rgb.shape
-	(6, 6, 3)
-
-	>>> ## Test invalid inputs
-	>>> resize_image("not an image", 10, 10)
-	Traceback (most recent call last):
-		...
-	AssertionError: Image must be a numpy array
-
-	>>> resize_image(image.astype(np.uint8), "10", 10)
-	Traceback (most recent call last):
-		...
-	AssertionError: width must be integer, got <class 'str'>
-
-	>>> resize_image(image.astype(np.uint8), 10, "10")
-	Traceback (most recent call last):
-		...
-	AssertionError: height must be integer, got <class 'str'>
-	"""
-	# Check input data
-	check_image(image, ignore_dtype=ignore_dtype)
-	assert isinstance(width, int), f"width must be integer, got {type(width)}"
-	assert isinstance(height, int), f"height must be integer, got {type(height)}"
-	assert isinstance(resample, Image.Resampling | int), f"resample must be Image.Resampling, got {type(resample)}"
-
-	# Resize image
-	new_image: Image.Image = Image.fromarray(image)
-	new_image = new_image.resize((width, height), resample=resample)
-	return np.array(new_image)
-
+
+# Imports
+from PIL import Image
+
+from .common import Any, NDArray, check_image, np
+
+
+# Functions
+def resize_image(
+	image: NDArray[Any],
+	width: int,
+	height: int,
+	resample: Image.Resampling | int = Image.Resampling.LANCZOS,
+	ignore_dtype: bool = False
+) -> NDArray[Any]:
+	""" Resize an image to a new width and height.
+
+	Args:
+		image         (NDArray[Any]):              Image to resize
+		width         (int):                     New width
+		height        (int):                     New height
+		resample      (Image.Resampling | int):  Resampling method
+		ignore_dtype  (bool):                    Ignore the dtype check
+	Returns:
+		NDArray[Any]: Image with resized dimensions
+
+	>>> ## Basic tests
+	>>> image = np.array([[1, 2, 3], [4, 5, 6], [7, 8, 9]])
+	>>> resized = resize_image(image.astype(np.uint8), 6, 6)
+	>>> resized.shape
+	(6, 6)
+
+	>>> img = np.ones((5, 5), dtype=np.uint8) * 255
+	>>> resized = resize_image(img, 10, 10)
+	>>> resized.shape
+	(10, 10)
+
+	>>> rgb = np.full((3, 3, 3), 128, dtype=np.uint8)
+	>>> resized_rgb = resize_image(rgb, 6, 6)
+	>>> resized_rgb.shape
+	(6, 6, 3)
+
+	>>> ## Test invalid inputs
+	>>> resize_image("not an image", 10, 10)
+	Traceback (most recent call last):
+		...
+	AssertionError: Image must be a numpy array
+
+	>>> resize_image(image.astype(np.uint8), "10", 10)
+	Traceback (most recent call last):
+		...
+	AssertionError: width must be integer, got <class 'str'>
+
+	>>> resize_image(image.astype(np.uint8), 10, "10")
+	Traceback (most recent call last):
+		...
+	AssertionError: height must be integer, got <class 'str'>
+	"""
+	# Check input data
+	check_image(image, ignore_dtype=ignore_dtype)
+	assert isinstance(width, int), f"width must be integer, got {type(width)}"
+	assert isinstance(height, int), f"height must be integer, got {type(height)}"
+	assert isinstance(resample, Image.Resampling | int), f"resample must be Image.Resampling, got {type(resample)}"
+
+	# Resize image
+	new_image: Image.Image = Image.fromarray(image)
+	new_image = new_image.resize((width, height), resample=resample)
+	return np.array(new_image)
+