Multi-Projector
Loading...
Searching...
No Matches
image_configuration.ImageConfiguration Class Reference

A class for managing image-related configuration settings stored in environment variables. More...

Inheritance diagram for image_configuration.ImageConfiguration:

Public Member Functions

 __init__ (self, configFilePath)
 Constructor to initialize the ImageConfiguration object.
 
str getImageFilePath (self)
 Retrieve the path of the image file from environment variables.
 
str getSide (self)
 Retrieve the 'SIDE' setting (e.g., "left" or "right").
 
int getDistanceBetweenProjectorCm (self)
 Retrieve the distance between projectors in centimeters.
 
int getProjectionWidthCm (self)
 Retrieve the projection width in centimeters.
 
float getGammaValue (self)
 Retrieve the gamma value for image display correction.
 

Public Attributes

 configFilePath = configFilePath
 

Detailed Description

A class for managing image-related configuration settings stored in environment variables.

This class is responsible for loading environment variables from a configuration file (using load_dotenv) and providing convenient getters for the necessary values.

Constructor & Destructor Documentation

◆ __init__()

image_configuration.ImageConfiguration.__init__ ( self,
configFilePath )

Constructor to initialize the ImageConfiguration object.

Parameters
configFilePathA string specifying the path to the dotenv configuration file.

The constructor loads environment variables from the specified file, making them available via the getter methods.

Member Function Documentation

◆ getDistanceBetweenProjectorCm()

int image_configuration.ImageConfiguration.getDistanceBetweenProjectorCm ( self)

Retrieve the distance between projectors in centimeters.

Returns
An integer specifying the distance between projectors.

◆ getGammaValue()

float image_configuration.ImageConfiguration.getGammaValue ( self)

Retrieve the gamma value for image display correction.

Returns
A float representing the gamma correction value.

◆ getImageFilePath()

str image_configuration.ImageConfiguration.getImageFilePath ( self)

Retrieve the path of the image file from environment variables.

Returns
A string representing the file path of the image.

◆ getProjectionWidthCm()

int image_configuration.ImageConfiguration.getProjectionWidthCm ( self)

Retrieve the projection width in centimeters.

Returns
An integer specifying the width of the projection.

◆ getSide()

str image_configuration.ImageConfiguration.getSide ( self)

Retrieve the 'SIDE' setting (e.g., "left" or "right").

Returns
A string representing the side setting.

Member Data Documentation

◆ configFilePath

image_configuration.ImageConfiguration.configFilePath = configFilePath

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