debayer_conversion_policy.py

Go to the documentation of this file.

from __future__ import annotations
from enum import Enum
 
from ids_peak_icv.exceptions import NotSupportedException
 
 
class DebayerConversionPolicy(Enum):
    """!
    @brief
    Specifies the conditions under which the debayer module applies color conversion.
 
    @ingroup ids_peak_icv_python_pipeline_modules
    @since ids_peak_icv 1.0
    """
    BYPASS = 0
    """!
    @brief
    Do not convert images.
    
    @since ids_peak_icv 1.0
    """
 
    BAYER_ONLY = 1
    """!
    @brief
    Convert only Bayer-pattern images.
    
    @since ids_peak_icv 1.0
    """
 
    BAYER_AND_MONO = 2
    """!
    @brief
    Convert both Bayer-pattern and monochrome images.
    
    @since ids_peak_icv 1.0
    """
 
    @property
    def string_value(self) -> str:
        """!
        @brief
        Return the string identifier for this conversion policy.
        @since ids_peak_icv 1.0
        """
        mapping = {
            DebayerConversionPolicy.BYPASS: "Bypass",
            DebayerConversionPolicy.BAYER_ONLY: "BayerOnly",
            DebayerConversionPolicy.BAYER_AND_MONO: "BayerAndMono",
        }
        return mapping[self]
 
    @staticmethod
    def create_from_string_value(string_value: str) -> DebayerConversionPolicy:
        if string_value == "Bypass":
            return DebayerConversionPolicy.BYPASS
        if string_value == "BayerOnly":
            return DebayerConversionPolicy.BAYER_ONLY
        if string_value == "BayerAndMono":
            return DebayerConversionPolicy.BAYER_AND_MONO
 
        raise NotSupportedException(
            f"The given conversion conversion policy is not supported. Given: {string_value}")