Loading imgutils/preprocess/pillow.py +324 −2 Original line number Diff line number Diff line """ This module provides utilities for image processing using the PIL library, allowing for transformations such as resizing, cropping, converting to tensor, normalization, and more. It supports both basic and composite transformations, which can be registered and parsed dynamically. The module also offers functionality to convert images to tensors and normalize them, making it suitable for preprocessing tasks in machine learning applications. Transforms can be applied individually or composed into sequences using the PillowCompose class, which applies a list of transforms sequentially to an image. Each transformation can be registered with decorators to facilitate dynamic creation and parsing based on configuration dictionaries or lists, supporting flexible and configurable preprocessing pipelines. """ import copy import io from functools import wraps Loading Loading @@ -35,6 +46,16 @@ _PILLOW_TO_STR = { def _get_pillow_resample(value: Union[int, str]) -> int: """ Converts a resampling filter name or code to a Pillow resampling filter. :param value: The resampling filter name (str) or code (int). :type value: Union[int, str] :return: The corresponding Pillow resampling filter. :rtype: int :raises ValueError: If the provided value is not a recognized resampling filter. :raises TypeError: If the type of `value` is neither int nor str. """ if isinstance(value, int): if value not in _INT_TO_PILLOW: raise ValueError(f'Invalid interpolation value - {value!r}.') Loading @@ -52,6 +73,13 @@ _PTRANS_CREATORS = {} def register_pillow_transform(name: str): """ Decorator to register a function as a creator for a specific type of Pillow transform. :param name: The name of the transform. :type name: str """ def _fn(func): _PTRANS_CREATORS[name] = func return func Loading @@ -63,6 +91,13 @@ _PTRANS_PARSERS = {} def register_pillow_parse(name: str): """ Decorator to register a function as a parser for a specific type of Pillow transform. :param name: The name of the transform. :type name: str """ def _fn(func): @wraps(func) def _new_func(*args, **kwargs): Loading @@ -78,6 +113,22 @@ def register_pillow_parse(name: str): class PillowResize: """ A class to resize an image to a specified size using Pillow. :param size: Target size. If an int, the smallest side is matched to this number maintaining aspect ratio. If a tuple or list of two ints, size is matched to these dimensions (width, height). :type size: Union[int, List[int], Tuple[int, ...]] :param interpolation: Resampling filter for resizing. :type interpolation: int :param max_size: If provided, resizes the image such that the maximum size does not exceed this value. :type max_size: Optional[int] :param antialias: Whether to apply an anti-aliasing filter. :type antialias: bool :raises TypeError: If `size` is not int, list, or tuple. :raises ValueError: If `size` is a list or tuple but does not contain 1 or 2 elements. """ # noinspection PyUnresolvedReferences def __init__( self, Loading @@ -93,13 +144,21 @@ class PillowResize: if max_size is not None and isinstance(size, (list, tuple)) and len(size) != 1: raise ValueError("max_size is only supported for single int size or sequence of length 1") # noinspection PyTypeChecker self.size = size self.interpolation = interpolation # noinspection PyTypeChecker self.max_size = max_size self.antialias = antialias def _get_resize_size(self, img: Image.Image) -> Tuple[int, int]: """ Calculate the target resize dimensions for the image. :param img: The image to resize. :type img: Image.Image :return: The calculated dimensions to resize to. :rtype: Tuple[int, int] """ w, h = img.size if isinstance(self.size, int) or (isinstance(self.size, (list, tuple)) and len(self.size) == 1): size = self.size if isinstance(self.size, int) else self.size[0] Loading @@ -112,11 +171,14 @@ class PillowResize: if self.max_size is not None: max_size = self.max_size # noinspection PyTypeChecker if max(oh, ow) > max_size: if oh > ow: # noinspection PyTypeChecker ow = int(max_size * ow / oh) oh = max_size else: # noinspection PyTypeChecker oh = int(max_size * oh / ow) ow = max_size Loading @@ -126,6 +188,15 @@ class PillowResize: return self.size[1], self.size[0] def __call__(self, img: Image.Image) -> Image.Image: """ Resize the image according to the specified parameters. :param img: The image to resize. :type img: Image.Image :return: The resized image. :rtype: Image.Image :raises TypeError: If the input is not an image. """ if not isinstance(img, Image.Image): raise TypeError('Input must be a PIL Image') Loading @@ -141,6 +212,12 @@ class PillowResize: return img def __repr__(self) -> str: """ Represent the PillowResize instance as a string. :return: String representation of the instance. :rtype: str """ interpolate_str = _PILLOW_TO_STR[self.interpolation] detail = f"(size={self.size}, interpolation={interpolate_str}, max_size={self.max_size}, antialias={self.antialias})" return f"{self.__class__.__name__}{detail}" Loading @@ -148,6 +225,21 @@ class PillowResize: @register_pillow_transform('resize') def _create_resize(size, interpolation='bilinear', max_size=None, antialias=True): """ Create a PillowResize transformation. :param size: Target size for resizing, either an int or a tuple/list of two ints. :type size: Union[int, Tuple[int, int], List[int]] :param interpolation: The interpolation method to use. :type interpolation: str :param max_size: Optional maximum size to ensure the image does not exceed. :type max_size: Optional[int] :param antialias: Whether to apply anti-aliasing. :type antialias: bool :return: An instance of PillowResize. :rtype: PillowResize """ # noinspection PyTypeChecker return PillowResize( size=size, interpolation=_get_pillow_resample(interpolation), Loading @@ -158,6 +250,15 @@ def _create_resize(size, interpolation='bilinear', max_size=None, antialias=True @register_pillow_parse('resize') def _parse_resize(obj: PillowResize): """ Parse a PillowResize object to a dictionary representing its configuration. :param obj: The PillowResize object to parse. :type obj: PillowResize :return: A dictionary containing the configuration of the PillowResize object. :rtype: dict :raises NotParseTarget: If the object is not an instance of PillowResize. """ if not isinstance(obj, PillowResize): raise NotParseTarget Loading @@ -170,23 +271,58 @@ def _parse_resize(obj: PillowResize): class PillowCenterCrop: """ A class for center cropping an image using Pillow. :param size: Desired output size of the crop. If an int is provided, the crop will be a square of that size. If a tuple or list of two ints is provided, it specifies the size as (height, width). :type size: Union[int, Tuple[int, int], List[int]] :raises ValueError: If `size` is neither an int nor a tuple/list of two ints. """ def __init__(self, size): """ Initialize the PillowCenterCrop instance. :param size: The target size for cropping. :type size: Union[int, Tuple[int, int], List[int]] """ if isinstance(size, int): # noinspection PyTypeChecker self.size = (size, size) elif isinstance(size, (tuple, list)) and len(size) == 1: # noinspection PyTypeChecker self.size = (size[0], size[0]) elif isinstance(size, (tuple, list)) and len(size) == 2: # noinspection PyTypeChecker self.size = (size[0], size[1]) else: raise ValueError("Please provide only two dimensions (h, w) for size.") def __call__(self, img): """ Apply a center crop to the image. :param img: The image to crop. :type img: Image.Image :return: The cropped image. :rtype: Image.Image :raises TypeError: If the input is not an image. """ if not isinstance(img, Image.Image): raise TypeError('img should be PIL Image') return self._center_crop(img) def _center_crop(self, img): """ Perform the actual center cropping operation on the image. :param img: The image to crop. :type img: Image.Image :return: The cropped image. :rtype: Image.Image """ width, height = img.size crop_height, crop_width = self.size Loading @@ -213,11 +349,25 @@ class PillowCenterCrop: return img.crop((left, top, right, bottom)) def __repr__(self) -> str: """ Represent the PillowCenterCrop instance as a string. :return: String representation of the instance. :rtype: str """ return f"{self.__class__.__name__}(size={self.size})" @register_pillow_transform('center_crop') def _create_center_crop(size): """ Create a PillowCenterCrop transformation. :param size: Target size for cropping, either an int or a tuple/list of two ints. :type size: Union[int, Tuple[int, int], List[int]] :return: An instance of PillowCenterCrop. :rtype: PillowCenterCrop """ return PillowCenterCrop( size=size ) Loading @@ -225,6 +375,15 @@ def _create_center_crop(size): @register_pillow_parse('center_crop') def _parse_center_crop(obj: PillowCenterCrop): """ Parse a PillowCenterCrop object to a dictionary representing its configuration. :param obj: The PillowCenterCrop object to parse. :type obj: PillowCenterCrop :return: A dictionary containing the configuration of the PillowCenterCrop object. :rtype: dict :raises NotParseTarget: If the object is not an instance of PillowCenterCrop. """ if not isinstance(obj, PillowCenterCrop): raise NotParseTarget Loading @@ -234,7 +393,21 @@ def _parse_center_crop(obj: PillowCenterCrop): class PillowToTensor: """ A class to convert a PIL Image to a tensor, handling different image modes appropriately. """ def __call__(self, pic): """ Convert a PIL Image to a tensor. :param pic: The picture to convert. :type pic: Image.Image :return: The picture as a numpy array with dimensions depending on the image mode. :rtype: np.ndarray :raises TypeError: If the input is not a PIL Image. :raises ValueError: If the image mode is not supported. """ if not isinstance(pic, Image.Image): raise TypeError('pic should be PIL Image. Got {}'.format(type(pic))) Loading Loading @@ -274,16 +447,37 @@ class PillowToTensor: raise ValueError(f"Unsupported PIL image mode: {pic.mode}") # pragma: no cover def __repr__(self) -> str: """ Represent the PillowToTensor instance as a string. :return: String representation of the instance. :rtype: str """ return f"{self.__class__.__name__}()" @register_pillow_transform('to_tensor') def _create_to_tensor(): """ Create a PillowToTensor transformation. :return: An instance of PillowToTensor. :rtype: PillowToTensor """ return PillowToTensor() @register_pillow_parse('to_tensor') def _parse_to_tensor(obj: PillowToTensor): """ Parse a PillowToTensor object to a dictionary representing its configuration. :param obj: The PillowToTensor object to parse. :type obj: PillowToTensor :return: A dictionary representing the configuration of the PillowToTensor object. :rtype: dict :raises NotParseTarget: If the object is not an instance of PillowToTensor. """ if not isinstance(obj, PillowToTensor): raise NotParseTarget Loading @@ -291,23 +485,56 @@ def _parse_to_tensor(obj: PillowToTensor): class PillowMaybeToTensor: """ A class to conditionally convert an image or numpy array to a tensor. """ def __call__(self, image): """ Convert an image to a tensor if it is not already a numpy array. :param image: The image to potentially convert. :type image: Union[Image.Image, np.ndarray] :return: The image as a numpy array. :rtype: np.ndarray """ if isinstance(image, np.ndarray): return image else: return PillowToTensor()(image) def __repr__(self): """ Represent the PillowMaybeToTensor instance as a string. :return: String representation of the instance. :rtype: str """ return f'{type(self).__name__}()' @register_pillow_transform('maybe_to_tensor') def _create_maybe_to_tensor(): """ Create a PillowMaybeToTensor transformation. :return: An instance of PillowMaybeToTensor. :rtype: PillowMaybeToTensor """ return PillowMaybeToTensor() @register_pillow_parse('maybe_to_tensor') def _parse_maybe_to_tensor(obj: PillowMaybeToTensor): """ Parse a PillowMaybeToTensor object to a dictionary representing its configuration. :param obj: The PillowMaybeToTensor object to parse. :type obj: PillowMaybeToTensor :return: A dictionary representing the configuration of the PillowMaybeToTensor object. :rtype: dict :raises NotParseTarget: If the object is not an instance of PillowMaybeToTensor. """ if not isinstance(obj, PillowMaybeToTensor): raise NotParseTarget Loading @@ -315,7 +542,18 @@ def _parse_maybe_to_tensor(obj: PillowMaybeToTensor): class PillowNormalize: def __init__(self, mean, std, inplace=False): """ Normalizes an image by subtracting the mean and dividing by the standard deviation. :param mean: The mean value(s) for normalization. :type mean: np.ndarray :param std: The standard deviation value(s) for normalization. :type std: np.ndarray :param inplace: If True, perform normalization in-place. :type inplace: bool """ def __init__(self, mean, std, inplace: bool = False): if isinstance(mean, (list, tuple)): self.mean = np.array(mean, dtype=np.float32) else: Loading @@ -327,6 +565,16 @@ class PillowNormalize: self.inplace = inplace def __call__(self, array): """ Apply normalization to the input array. :param array: The input image array. :type array: np.ndarray :return: The normalized image array. :rtype: np.ndarray :raises TypeError: If the input is not a numpy.ndarray or is not a float array. :raises ValueError: If the input array does not have the expected dimensions. """ if not isinstance(array, np.ndarray): raise TypeError('Input should be a numpy.ndarray') if not np.issubdtype(array.dtype, np.floating): Loading @@ -341,6 +589,14 @@ class PillowNormalize: return self._normalize_multi(array) def _normalize_multi(self, array): """ Helper function to normalize each channel of the image. :param array: The input image array. :type array: np.ndarray :return: The normalized image array. :rtype: np.ndarray """ mean = self.mean.reshape(-1, 1, 1) std = self.std.reshape(-1, 1, 1) array -= mean Loading @@ -348,11 +604,29 @@ class PillowNormalize: return array def __repr__(self) -> str: """ String representation of the PillowNormalize instance. :return: String representation. :rtype: str """ return f"{self.__class__.__name__}(mean={self.mean}, std={self.std})" @register_pillow_transform('normalize') def _create_normalize(mean, std, inplace=False): """ Factory function to create a PillowNormalize instance. :param mean: Mean value(s) for normalization. :type mean: np.ndarray :param std: Standard deviation value(s) for normalization. :type std: np.ndarray :param inplace: Perform normalization in-place. :type inplace: bool :return: An instance of PillowNormalize. :rtype: PillowNormalize """ return PillowNormalize( mean=mean, std=std, Loading @@ -362,6 +636,15 @@ def _create_normalize(mean, std, inplace=False): @register_pillow_parse('normalize') def _parse_normalize(obj: PillowNormalize): """ Parse a PillowNormalize instance into a serializable dictionary. :param obj: The PillowNormalize instance to parse. :type obj: PillowNormalize :return: A dictionary with mean and std values. :rtype: dict :raises NotParseTarget: If the object is not a PillowNormalize instance. """ if not isinstance(obj, PillowNormalize): raise NotParseTarget Loading @@ -372,16 +655,37 @@ def _parse_normalize(obj: PillowNormalize): class PillowCompose: """ Composes several transforms together into a single transform. :param transforms: A list of transformations to compose. :type transforms: list """ def __init__(self, transforms): self.transforms = transforms def __call__(self, image): """ Apply the composed transformations to an image. :param image: The input image. :type image: Any :return: The transformed image. :rtype: Any """ x = image for trans in self.transforms: x = trans(x) return x def __repr__(self): """ String representation of the PillowCompose instance. :return: String representation. :rtype: str """ with io.StringIO() as sf: print(f'{type(self).__name__}(', file=sf) for trans in self.transforms: Loading @@ -391,6 +695,15 @@ class PillowCompose: def create_pillow_transforms(tvalue: Union[list, dict]): """ Create a transformation or a composition of transformations based on the input value. :param tvalue: A list or dictionary describing the transformation(s). :type tvalue: Union[list, dict] :return: A transformation or a composition of transformations. :rtype: Union[PillowCompose, Any] :raises TypeError: If the input value is not a list or dictionary. """ if isinstance(tvalue, list): return PillowCompose([create_pillow_transforms(titem) for titem in tvalue]) elif isinstance(tvalue, dict): Loading @@ -402,6 +715,15 @@ def create_pillow_transforms(tvalue: Union[list, dict]): def parse_pillow_transforms(value): """ Parse transformations into a serializable format. :param value: The transformation or composition to parse. :type value: Union[PillowCompose, Any] :return: A serializable representation of the transformation. :rtype: Union[list, dict] :raises TypeError: If the transformation cannot be parsed. """ if isinstance(value, PillowCompose): return [parse_pillow_transforms(trans) for trans in value.transforms] else: Loading Loading
imgutils/preprocess/pillow.py +324 −2 Original line number Diff line number Diff line """ This module provides utilities for image processing using the PIL library, allowing for transformations such as resizing, cropping, converting to tensor, normalization, and more. It supports both basic and composite transformations, which can be registered and parsed dynamically. The module also offers functionality to convert images to tensors and normalize them, making it suitable for preprocessing tasks in machine learning applications. Transforms can be applied individually or composed into sequences using the PillowCompose class, which applies a list of transforms sequentially to an image. Each transformation can be registered with decorators to facilitate dynamic creation and parsing based on configuration dictionaries or lists, supporting flexible and configurable preprocessing pipelines. """ import copy import io from functools import wraps Loading Loading @@ -35,6 +46,16 @@ _PILLOW_TO_STR = { def _get_pillow_resample(value: Union[int, str]) -> int: """ Converts a resampling filter name or code to a Pillow resampling filter. :param value: The resampling filter name (str) or code (int). :type value: Union[int, str] :return: The corresponding Pillow resampling filter. :rtype: int :raises ValueError: If the provided value is not a recognized resampling filter. :raises TypeError: If the type of `value` is neither int nor str. """ if isinstance(value, int): if value not in _INT_TO_PILLOW: raise ValueError(f'Invalid interpolation value - {value!r}.') Loading @@ -52,6 +73,13 @@ _PTRANS_CREATORS = {} def register_pillow_transform(name: str): """ Decorator to register a function as a creator for a specific type of Pillow transform. :param name: The name of the transform. :type name: str """ def _fn(func): _PTRANS_CREATORS[name] = func return func Loading @@ -63,6 +91,13 @@ _PTRANS_PARSERS = {} def register_pillow_parse(name: str): """ Decorator to register a function as a parser for a specific type of Pillow transform. :param name: The name of the transform. :type name: str """ def _fn(func): @wraps(func) def _new_func(*args, **kwargs): Loading @@ -78,6 +113,22 @@ def register_pillow_parse(name: str): class PillowResize: """ A class to resize an image to a specified size using Pillow. :param size: Target size. If an int, the smallest side is matched to this number maintaining aspect ratio. If a tuple or list of two ints, size is matched to these dimensions (width, height). :type size: Union[int, List[int], Tuple[int, ...]] :param interpolation: Resampling filter for resizing. :type interpolation: int :param max_size: If provided, resizes the image such that the maximum size does not exceed this value. :type max_size: Optional[int] :param antialias: Whether to apply an anti-aliasing filter. :type antialias: bool :raises TypeError: If `size` is not int, list, or tuple. :raises ValueError: If `size` is a list or tuple but does not contain 1 or 2 elements. """ # noinspection PyUnresolvedReferences def __init__( self, Loading @@ -93,13 +144,21 @@ class PillowResize: if max_size is not None and isinstance(size, (list, tuple)) and len(size) != 1: raise ValueError("max_size is only supported for single int size or sequence of length 1") # noinspection PyTypeChecker self.size = size self.interpolation = interpolation # noinspection PyTypeChecker self.max_size = max_size self.antialias = antialias def _get_resize_size(self, img: Image.Image) -> Tuple[int, int]: """ Calculate the target resize dimensions for the image. :param img: The image to resize. :type img: Image.Image :return: The calculated dimensions to resize to. :rtype: Tuple[int, int] """ w, h = img.size if isinstance(self.size, int) or (isinstance(self.size, (list, tuple)) and len(self.size) == 1): size = self.size if isinstance(self.size, int) else self.size[0] Loading @@ -112,11 +171,14 @@ class PillowResize: if self.max_size is not None: max_size = self.max_size # noinspection PyTypeChecker if max(oh, ow) > max_size: if oh > ow: # noinspection PyTypeChecker ow = int(max_size * ow / oh) oh = max_size else: # noinspection PyTypeChecker oh = int(max_size * oh / ow) ow = max_size Loading @@ -126,6 +188,15 @@ class PillowResize: return self.size[1], self.size[0] def __call__(self, img: Image.Image) -> Image.Image: """ Resize the image according to the specified parameters. :param img: The image to resize. :type img: Image.Image :return: The resized image. :rtype: Image.Image :raises TypeError: If the input is not an image. """ if not isinstance(img, Image.Image): raise TypeError('Input must be a PIL Image') Loading @@ -141,6 +212,12 @@ class PillowResize: return img def __repr__(self) -> str: """ Represent the PillowResize instance as a string. :return: String representation of the instance. :rtype: str """ interpolate_str = _PILLOW_TO_STR[self.interpolation] detail = f"(size={self.size}, interpolation={interpolate_str}, max_size={self.max_size}, antialias={self.antialias})" return f"{self.__class__.__name__}{detail}" Loading @@ -148,6 +225,21 @@ class PillowResize: @register_pillow_transform('resize') def _create_resize(size, interpolation='bilinear', max_size=None, antialias=True): """ Create a PillowResize transformation. :param size: Target size for resizing, either an int or a tuple/list of two ints. :type size: Union[int, Tuple[int, int], List[int]] :param interpolation: The interpolation method to use. :type interpolation: str :param max_size: Optional maximum size to ensure the image does not exceed. :type max_size: Optional[int] :param antialias: Whether to apply anti-aliasing. :type antialias: bool :return: An instance of PillowResize. :rtype: PillowResize """ # noinspection PyTypeChecker return PillowResize( size=size, interpolation=_get_pillow_resample(interpolation), Loading @@ -158,6 +250,15 @@ def _create_resize(size, interpolation='bilinear', max_size=None, antialias=True @register_pillow_parse('resize') def _parse_resize(obj: PillowResize): """ Parse a PillowResize object to a dictionary representing its configuration. :param obj: The PillowResize object to parse. :type obj: PillowResize :return: A dictionary containing the configuration of the PillowResize object. :rtype: dict :raises NotParseTarget: If the object is not an instance of PillowResize. """ if not isinstance(obj, PillowResize): raise NotParseTarget Loading @@ -170,23 +271,58 @@ def _parse_resize(obj: PillowResize): class PillowCenterCrop: """ A class for center cropping an image using Pillow. :param size: Desired output size of the crop. If an int is provided, the crop will be a square of that size. If a tuple or list of two ints is provided, it specifies the size as (height, width). :type size: Union[int, Tuple[int, int], List[int]] :raises ValueError: If `size` is neither an int nor a tuple/list of two ints. """ def __init__(self, size): """ Initialize the PillowCenterCrop instance. :param size: The target size for cropping. :type size: Union[int, Tuple[int, int], List[int]] """ if isinstance(size, int): # noinspection PyTypeChecker self.size = (size, size) elif isinstance(size, (tuple, list)) and len(size) == 1: # noinspection PyTypeChecker self.size = (size[0], size[0]) elif isinstance(size, (tuple, list)) and len(size) == 2: # noinspection PyTypeChecker self.size = (size[0], size[1]) else: raise ValueError("Please provide only two dimensions (h, w) for size.") def __call__(self, img): """ Apply a center crop to the image. :param img: The image to crop. :type img: Image.Image :return: The cropped image. :rtype: Image.Image :raises TypeError: If the input is not an image. """ if not isinstance(img, Image.Image): raise TypeError('img should be PIL Image') return self._center_crop(img) def _center_crop(self, img): """ Perform the actual center cropping operation on the image. :param img: The image to crop. :type img: Image.Image :return: The cropped image. :rtype: Image.Image """ width, height = img.size crop_height, crop_width = self.size Loading @@ -213,11 +349,25 @@ class PillowCenterCrop: return img.crop((left, top, right, bottom)) def __repr__(self) -> str: """ Represent the PillowCenterCrop instance as a string. :return: String representation of the instance. :rtype: str """ return f"{self.__class__.__name__}(size={self.size})" @register_pillow_transform('center_crop') def _create_center_crop(size): """ Create a PillowCenterCrop transformation. :param size: Target size for cropping, either an int or a tuple/list of two ints. :type size: Union[int, Tuple[int, int], List[int]] :return: An instance of PillowCenterCrop. :rtype: PillowCenterCrop """ return PillowCenterCrop( size=size ) Loading @@ -225,6 +375,15 @@ def _create_center_crop(size): @register_pillow_parse('center_crop') def _parse_center_crop(obj: PillowCenterCrop): """ Parse a PillowCenterCrop object to a dictionary representing its configuration. :param obj: The PillowCenterCrop object to parse. :type obj: PillowCenterCrop :return: A dictionary containing the configuration of the PillowCenterCrop object. :rtype: dict :raises NotParseTarget: If the object is not an instance of PillowCenterCrop. """ if not isinstance(obj, PillowCenterCrop): raise NotParseTarget Loading @@ -234,7 +393,21 @@ def _parse_center_crop(obj: PillowCenterCrop): class PillowToTensor: """ A class to convert a PIL Image to a tensor, handling different image modes appropriately. """ def __call__(self, pic): """ Convert a PIL Image to a tensor. :param pic: The picture to convert. :type pic: Image.Image :return: The picture as a numpy array with dimensions depending on the image mode. :rtype: np.ndarray :raises TypeError: If the input is not a PIL Image. :raises ValueError: If the image mode is not supported. """ if not isinstance(pic, Image.Image): raise TypeError('pic should be PIL Image. Got {}'.format(type(pic))) Loading Loading @@ -274,16 +447,37 @@ class PillowToTensor: raise ValueError(f"Unsupported PIL image mode: {pic.mode}") # pragma: no cover def __repr__(self) -> str: """ Represent the PillowToTensor instance as a string. :return: String representation of the instance. :rtype: str """ return f"{self.__class__.__name__}()" @register_pillow_transform('to_tensor') def _create_to_tensor(): """ Create a PillowToTensor transformation. :return: An instance of PillowToTensor. :rtype: PillowToTensor """ return PillowToTensor() @register_pillow_parse('to_tensor') def _parse_to_tensor(obj: PillowToTensor): """ Parse a PillowToTensor object to a dictionary representing its configuration. :param obj: The PillowToTensor object to parse. :type obj: PillowToTensor :return: A dictionary representing the configuration of the PillowToTensor object. :rtype: dict :raises NotParseTarget: If the object is not an instance of PillowToTensor. """ if not isinstance(obj, PillowToTensor): raise NotParseTarget Loading @@ -291,23 +485,56 @@ def _parse_to_tensor(obj: PillowToTensor): class PillowMaybeToTensor: """ A class to conditionally convert an image or numpy array to a tensor. """ def __call__(self, image): """ Convert an image to a tensor if it is not already a numpy array. :param image: The image to potentially convert. :type image: Union[Image.Image, np.ndarray] :return: The image as a numpy array. :rtype: np.ndarray """ if isinstance(image, np.ndarray): return image else: return PillowToTensor()(image) def __repr__(self): """ Represent the PillowMaybeToTensor instance as a string. :return: String representation of the instance. :rtype: str """ return f'{type(self).__name__}()' @register_pillow_transform('maybe_to_tensor') def _create_maybe_to_tensor(): """ Create a PillowMaybeToTensor transformation. :return: An instance of PillowMaybeToTensor. :rtype: PillowMaybeToTensor """ return PillowMaybeToTensor() @register_pillow_parse('maybe_to_tensor') def _parse_maybe_to_tensor(obj: PillowMaybeToTensor): """ Parse a PillowMaybeToTensor object to a dictionary representing its configuration. :param obj: The PillowMaybeToTensor object to parse. :type obj: PillowMaybeToTensor :return: A dictionary representing the configuration of the PillowMaybeToTensor object. :rtype: dict :raises NotParseTarget: If the object is not an instance of PillowMaybeToTensor. """ if not isinstance(obj, PillowMaybeToTensor): raise NotParseTarget Loading @@ -315,7 +542,18 @@ def _parse_maybe_to_tensor(obj: PillowMaybeToTensor): class PillowNormalize: def __init__(self, mean, std, inplace=False): """ Normalizes an image by subtracting the mean and dividing by the standard deviation. :param mean: The mean value(s) for normalization. :type mean: np.ndarray :param std: The standard deviation value(s) for normalization. :type std: np.ndarray :param inplace: If True, perform normalization in-place. :type inplace: bool """ def __init__(self, mean, std, inplace: bool = False): if isinstance(mean, (list, tuple)): self.mean = np.array(mean, dtype=np.float32) else: Loading @@ -327,6 +565,16 @@ class PillowNormalize: self.inplace = inplace def __call__(self, array): """ Apply normalization to the input array. :param array: The input image array. :type array: np.ndarray :return: The normalized image array. :rtype: np.ndarray :raises TypeError: If the input is not a numpy.ndarray or is not a float array. :raises ValueError: If the input array does not have the expected dimensions. """ if not isinstance(array, np.ndarray): raise TypeError('Input should be a numpy.ndarray') if not np.issubdtype(array.dtype, np.floating): Loading @@ -341,6 +589,14 @@ class PillowNormalize: return self._normalize_multi(array) def _normalize_multi(self, array): """ Helper function to normalize each channel of the image. :param array: The input image array. :type array: np.ndarray :return: The normalized image array. :rtype: np.ndarray """ mean = self.mean.reshape(-1, 1, 1) std = self.std.reshape(-1, 1, 1) array -= mean Loading @@ -348,11 +604,29 @@ class PillowNormalize: return array def __repr__(self) -> str: """ String representation of the PillowNormalize instance. :return: String representation. :rtype: str """ return f"{self.__class__.__name__}(mean={self.mean}, std={self.std})" @register_pillow_transform('normalize') def _create_normalize(mean, std, inplace=False): """ Factory function to create a PillowNormalize instance. :param mean: Mean value(s) for normalization. :type mean: np.ndarray :param std: Standard deviation value(s) for normalization. :type std: np.ndarray :param inplace: Perform normalization in-place. :type inplace: bool :return: An instance of PillowNormalize. :rtype: PillowNormalize """ return PillowNormalize( mean=mean, std=std, Loading @@ -362,6 +636,15 @@ def _create_normalize(mean, std, inplace=False): @register_pillow_parse('normalize') def _parse_normalize(obj: PillowNormalize): """ Parse a PillowNormalize instance into a serializable dictionary. :param obj: The PillowNormalize instance to parse. :type obj: PillowNormalize :return: A dictionary with mean and std values. :rtype: dict :raises NotParseTarget: If the object is not a PillowNormalize instance. """ if not isinstance(obj, PillowNormalize): raise NotParseTarget Loading @@ -372,16 +655,37 @@ def _parse_normalize(obj: PillowNormalize): class PillowCompose: """ Composes several transforms together into a single transform. :param transforms: A list of transformations to compose. :type transforms: list """ def __init__(self, transforms): self.transforms = transforms def __call__(self, image): """ Apply the composed transformations to an image. :param image: The input image. :type image: Any :return: The transformed image. :rtype: Any """ x = image for trans in self.transforms: x = trans(x) return x def __repr__(self): """ String representation of the PillowCompose instance. :return: String representation. :rtype: str """ with io.StringIO() as sf: print(f'{type(self).__name__}(', file=sf) for trans in self.transforms: Loading @@ -391,6 +695,15 @@ class PillowCompose: def create_pillow_transforms(tvalue: Union[list, dict]): """ Create a transformation or a composition of transformations based on the input value. :param tvalue: A list or dictionary describing the transformation(s). :type tvalue: Union[list, dict] :return: A transformation or a composition of transformations. :rtype: Union[PillowCompose, Any] :raises TypeError: If the input value is not a list or dictionary. """ if isinstance(tvalue, list): return PillowCompose([create_pillow_transforms(titem) for titem in tvalue]) elif isinstance(tvalue, dict): Loading @@ -402,6 +715,15 @@ def create_pillow_transforms(tvalue: Union[list, dict]): def parse_pillow_transforms(value): """ Parse transformations into a serializable format. :param value: The transformation or composition to parse. :type value: Union[PillowCompose, Any] :return: A serializable representation of the transformation. :rtype: Union[list, dict] :raises TypeError: If the transformation cannot be parsed. """ if isinstance(value, PillowCompose): return [parse_pillow_transforms(trans) for trans in value.transforms] else: Loading
