igain_module.py

Go to the documentation of this file.

from abc import abstractmethod
 
from ids_peak_common.pipeline.modules.imodule import IModule
 
 
class IGain(IModule):
    """!
    @brief
    Interface for modules that provide gain control functionality.
 
    A gain module consists of a master gain value applied to all channels,
    along with individual gain values for the red, green, and blue channels.
 
    @since ids_peak_common 1.1
    @ingroup ids_peak_common_python_pipeline_modules
    """
 
    @property
    @abstractmethod
    def master(self) -> float:
        """!
        @brief
        Retrieves the current master gain value.
 
        @return The master gain value.
 
        @since ids_peak_common 1.1
        """
        pass
 
    @master.setter
    @abstractmethod
    def master(self, value: float) -> None:
        """!
        @brief
        Sets the master gain value.
 
        This value is applied uniformly to all color channels.
 
        @param value: The master gain value to apply.
 
        @since ids_peak_common 1.1
        """
        pass
 
    @property
    @abstractmethod
    def red(self) -> float:
        """!
        @brief
        Retrieves the gain value for the red channel.
 
        @return The red channel gain value.
 
        @since ids_peak_common 1.1
        """
        pass
 
    @red.setter
    @abstractmethod
    def red(self, value: float) -> None:
        """!
        @brief
        Sets the gain value for the red channel.
 
        @param value: The gain value for the red channel.
 
        @since ids_peak_common 1.1
        """
        pass
 
    @property
    @abstractmethod
    def green(self) -> float:
        """!
        @brief
        Retrieves the gain value for the green channel.
 
        @return The green channel gain value.
 
        @since ids_peak_common 1.1
        """
        pass
 
    @green.setter
    @abstractmethod
    def green(self, value: float) -> None:
        """!
        @brief
        Sets the gain value for the green channel.
 
        @param value: The gain value for the green channel.
 
        @since ids_peak_common 1.1
        """
        pass
 
    @property
    @abstractmethod
    def blue(self) -> float:
        """!
        @brief
        Retrieves the gain value for the blue channel.
 
        @return The blue channel gain value.
 
        @since ids_peak_common 1.1
        """
        pass
 
    @blue.setter
    @abstractmethod
    def blue(self, value: float) -> None:
        """!
        @brief
        Sets the gain value for the blue channel.
 
        @param value: The gain value for the blue channel.
 
        @since ids_peak_common 1.1
        """
        pass