G21-2023

#!/usr/bin/env python3

#-*- coding: utf-8 -*-

import cv2

##

# @brief Responsible for the main display operations of images.

#

# This class handles reading, setting, and displaying images using OpenCV.

##

class MainDisplay:

    ##

    # @brief Initializes the MainDisplay object.

    #

    # This constructor initializes the result image to None.

    ##

    def __init__(self):

        self.result_image = None

    ##

    # @brief Reads an image from a given file path.

    #

    # @param image_path str: The file path of the image to be read.

    # @return The read image.

    ##

    def readImage(self, image_path):

        image = cv2.imread(image_path)

        return image

    ##

    # @brief Sets the image for display.

    #

    # @param image: The image to be displayed.

    # @return The set image.

    ##

    def setImage(self, image):

        self.result_image = image

        return self.result_image

    ##

    # @brief Displays the set image.

    #

    # Opens a window to display the set image. The window closes upon any key press.

    ##

    def saveImage(self):

        cv2.imshow(f"Displaying {self.result_image}", self.result_image)

        cv2.waitKey(0)

        cv2.destroyAllWindows()