Source code for image_transformer.pixels_processors.generic_pixels_processor

"""
This module contains the definition of the GenericPixelsProcessor abstract base class, 
which provides an interface for processing pixel data to extract RGB color information.
"""

from typing import Tuple
from abc import ABC, abstractmethod

import numpy as np



class GenericPixelsProcessor(ABC):
    """
    An abstract base class for processing pixel data to extract RGB color information.
    """



    @abstractmethod
    def get_rgb_color_from_pixels(self: 'GenericPixelsProcessor', pixels: np.ndarray) -> Tuple[int, int, int]:
        """
        Extracts the RGB color from the given pixel data.

        Parameters:
            pixels (np.ndarray): A numpy array representing the pixel data.

        Returns:
            Tuple[int, int, int]: A tuple containing the RGB color values.
        """