My Project
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
ConfigReader.ConfigReader Class Reference

Public Member Functions

 __init__ (self, config_path)
 
 getImageName (self)
 
 getProjectedImageWidth (self)
 
 getProjectedOverlapWidth (self)
 
 getGamma (self)
 
 getImageSide (self)
 

Public Attributes

 config_parser
 

Detailed Description

@brief ConfigReader class for reading configuration parameters from a file.

This class uses the configparser module to read configuration parameters
from a specified configuration file.

Usage:
```
config_reader = ConfigReader('path/to/config.ini')
image_name = config_reader.getImageName()
projected_image_width = config_reader.getProjectedImageWidth()
projected_overlap_width = config_reader.getProjectedOverlapWidth()
gamma = config_reader.getGamma()
image_side = config_reader.getImageSide()
```

The configuration file should have a [DEFAULT] section with the following keys:
- 'image_name': Name of the image.
- 'projected_image_width': Width of the projected image.
- 'projected_overlap_width': Width of the projected image overlap.
- 'gamma': Gamma value for image processing.
- 'image_side': Side of the image.

@note Ensure that the specified configuration file exists and has the required keys.

Constructor & Destructor Documentation

◆ __init__()

ConfigReader.ConfigReader.__init__ (   self,
  config_path 
)
@brief Constructor for ConfigReader class.

@param config_path: Path to the configuration file.

Member Function Documentation

◆ getGamma()

ConfigReader.ConfigReader.getGamma (   self)
@brief Get the gamma value from the configuration.

@return: Gamma value as a float.

◆ getImageName()

ConfigReader.ConfigReader.getImageName (   self)
@brief Get the image name from the configuration.

@return: Image name as a string.

◆ getImageSide()

ConfigReader.ConfigReader.getImageSide (   self)
@brief Get the image side from the configuration.

@return: Image side as an integer.

◆ getProjectedImageWidth()

ConfigReader.ConfigReader.getProjectedImageWidth (   self)
@brief Get the projected image width from the configuration.

@return: Projected image width as an integer.

◆ getProjectedOverlapWidth()

ConfigReader.ConfigReader.getProjectedOverlapWidth (   self)
@brief Get the projected overlap width from the configuration.

@return: Projected overlap width as an integer.

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