G21-2024

> h2. [[Wiki]] | [[Team Members]] | [[Meeting Documentation]] | [[Our Project]] | [[Project Setup Guide]] | [[User Manual]] | [[Functional & Non-Functional Requirements]] | [[Math Document]] | [[Test Report]] | [[Results]]

h1. UML Diagrams

!class_diagram_final.png!

h2. 1. Main Class

* Acts as the central control of the application

* Depends on "Image" and "ImageConfiguration" for functionality

h2. 2. Image Class

* Manages image data and performs operations on the image

> * *data: NDArray* -> Holds the image data as a Numpy array for manipulation

> * *__init__(imageFilePath : String)* -> Initializes the image object by loading the image from a specified file path

> * *mask()* -> Applies the mask to the image based on the given parameters of side (left or right), projection width (of the image), distance between projectors, and a gamma value

> * *displayImage()* -> Displays the image

h2. 3. Imageconfiguration Class

* Handles the configuration information for given images

> * *__init__(configFilePath : String) : void* -> Initializes the configuration object by loading in settings from the specified configuration file

> * *getImageFilePath()* -> Returns the image file path 

> * *getSide()* -> Retrieves the parameter of "side" (either left or right)

> * *getDistanceBetweenProjectorCm()* -> Returns the distance between the two given projectors

> * *getProjectionWidthCm()* -> gets the projection width of the image in centimeters

> * *getGammaValue()* -> Returns the gamma correction value

h2. 4. Configuration File

* The external file that contains the information of various parameters

* Within the configuration file, information of image file path, side (left or right), projection width in centimeters, distance between projectors in centimeters, and gamma value are defined in the file that is later used for handling configuration information (ImageConfiguration Class) and image manipulation for masking (Image Class)