Multi-Projector
All Classes Functions Pages
Multi-Projector.ImageIO.ImageIO Class Reference

This class is in charge of image input and output. More...

Public Member Functions

 __init__ (self, shared_data)
 Initializator for whole method.
 
 load_image (self, path)
 Function for loading image.
 
 write_image (self, img, fileName="image.png")
 Function to manipulate the image.
 
 show_image (self, img, title="Image Title", canvas=None)
 Function to print image through the projector.
 

Public Attributes

 shared_data = shared_data
 

Detailed Description

This class is in charge of image input and output.

Constructor & Destructor Documentation

◆ __init__()

Multi-Projector.ImageIO.ImageIO.__init__ ( self,
shared_data )

Initializator for whole method.

Get parsed config file data from the class 'SharedData'

Parameters
shared_daraparsed config file
Returns
None
Warning
This method will not check config data is valid or not

Member Function Documentation

◆ load_image()

Multi-Projector.ImageIO.ImageIO.load_image ( self,
path )

Function for loading image.

Parameters
pathPath of the image
Returns
numpy array, image
Warning
This method does not check the file format or image content

◆ show_image()

Multi-Projector.ImageIO.ImageIO.show_image ( self,
img,
title = "Image Title",
canvas = None )

Function to print image through the projector.

Parameters
imgNumpy array, loaded image
titleTitle of the window. 'Image Title' will be the default value if there is no input. @paran Canvas parameter needed for library 'Tinker Canvas'. None is default value.
Returns
None

◆ write_image()

Multi-Projector.ImageIO.ImageIO.write_image ( self,
img,
fileName = "image.png" )

Function to manipulate the image.

Parameters
imgLoaded image, numpy matrix
fileNameName of the image. "image.png" will be the default vale if there are no input
Returns
None

The documentation for this class was generated from the following file: