peak_icv_color_matrix_transformation_module.hpp

Go to the documentation of this file.

 
#pragma once
 
#include <peak_common/pipeline/modules/peak_common_iautofeature_module.hpp>
#include <peak_common/pipeline/modules/peak_common_imodule.hpp>
#include <peak_common/types/peak_common_interval.hpp>
#include <peak_icv/pipeline/detail/peak_icv_pipeline_utils.hpp>
#include <peak_icv/pipeline/types/peak_icv_color_correction_matrix.hpp>
#include <peak_icv/types/peak_icv_image.hpp>
#include <peak_icv_c/algorithms/preprocessing/peak_icv_color_matrix_transformation.h>
 
namespace peak
{
namespace pipeline
{
namespace features
{
class SaturationFeature;
class ColorCorrectionFeature;
} // namespace features
 
namespace detail
{
 
class ColorMatrixTransformationModule : public modules::IModule
{
public:
    ColorMatrixTransformationModule();
 
    ~ColorMatrixTransformationModule() override;
 
    ColorMatrixTransformationModule(const ColorMatrixTransformationModule& other) = delete;
 
    ColorMatrixTransformationModule(ColorMatrixTransformationModule&& other) noexcept;
 
    ColorMatrixTransformationModule& operator=(const ColorMatrixTransformationModule& other) = delete;
 
    ColorMatrixTransformationModule& operator=(ColorMatrixTransformationModule&& other) noexcept;
 
    void Serialize(peak::common::serialization::IArchive& archive) const override;
 
    void Deserialize(const peak::common::serialization::IArchive& archive) override;
 
    void SetEnabled(bool enabled) override;
 
    PEAK_COMMON_NO_DISCARD bool IsEnabled() const override;
 
    PEAK_COMMON_NO_DISCARD const char* GetType() const override;
 
    void ResetToDefault() override;
 
    void SetMatrix(const ColorCorrectionMatrix& matrix);
 
    PEAK_COMMON_NO_DISCARD ColorCorrectionMatrix GetMatrix() const;
 
    void SetSaturation(float saturation);
 
    PEAK_COMMON_NO_DISCARD float GetSaturation() const;
 
    PEAK_COMMON_NO_DISCARD peak::common::IntervalF GetSaturationRange() const;
 
    PEAK_COMMON_NO_DISCARD peak::icv::Image Process(const peak::icv::Image& input) const;
 
    PEAK_COMMON_NO_DISCARD peak::common::Any Process(const peak::common::Any& input) const override;
 
    void SetAutoFeatureModule(const std::shared_ptr<modules::IAutoFeature>& module);
 
private:
#ifndef DOXYGEN_SHOULD_SKIP_THIS
    friend features::SaturationFeature;
    friend features::ColorCorrectionFeature;
#endif
 
    PEAK_COMMON_NO_DISCARD ColorCorrectionMatrix FetchMatrix();
    void ApplyMatrix() const;
    void UpdateCCMInAutoFeatureModule() const;
    PEAK_COMMON_NO_DISCARD ColorCorrectionMatrix GetEffectiveMatrix() const;
    void SetSaturationEnabled(bool enabled);
    void SetColorCorrectionEnabled(bool enabled);
    PEAK_COMMON_NO_DISCARD bool IsSaturationEnabled() const;
    PEAK_COMMON_NO_DISCARD bool IsColorCorrectionEnabled() const;
 
    ColorCorrectionMatrix m_colorCorrectionMatrix{ "Matrix", { ColorCorrectionMatrix::Matrix::Identity() } };
    static constexpr auto saturationDefault = 1.0F;
 
    static constexpr auto saturationKey = "Saturation";
    static constexpr auto matrixKey = "ColorCorrection";
 
    peak_icv_color_matrix_transformation_handle m_handle{};
 
    bool m_saturationEnabled{ true };
    bool m_colorCorrectionEnabled{ true };
 
    float m_saturation{ saturationDefault };
    std::shared_ptr<modules::IAutoFeature> m_autoFeatureModule;
};
 
inline ColorMatrixTransformationModule::ColorMatrixTransformationModule()
{
    peak::icv::detail::ExecuteAndMapReturnCodes([&]() {
        return PEAK_ICV_C_ABI_PREFIX peak_icv_Preprocessing_ColorMatrixTransformation_Create(&m_handle);
    });
 
    m_colorCorrectionMatrix = FetchMatrix();
}
 
inline ColorMatrixTransformationModule::~ColorMatrixTransformationModule()
{
    if (m_handle != nullptr)
    {
        std::ignore = PEAK_ICV_C_ABI_PREFIX peak_icv_Preprocessing_ColorMatrixTransformation_Destroy(m_handle);
    }
}
 
inline ColorMatrixTransformationModule::ColorMatrixTransformationModule(ColorMatrixTransformationModule&& other) noexcept
    : m_colorCorrectionMatrix(std::move(other.m_colorCorrectionMatrix))
    , m_saturationEnabled(other.m_saturationEnabled)
    , m_colorCorrectionEnabled(other.m_colorCorrectionEnabled)
{
    m_handle = std::exchange(other.m_handle, nullptr);
}
 
inline ColorMatrixTransformationModule& ColorMatrixTransformationModule::operator=(ColorMatrixTransformationModule&& other) noexcept
{
    if (this != &other)
    {
        if (m_handle != nullptr)
        {
            peak::icv::detail::ExecuteAndMapReturnCodes([&] {
                return PEAK_ICV_C_ABI_PREFIX peak_icv_Preprocessing_ColorMatrixTransformation_Destroy(m_handle);
            });
        }
 
        m_handle = std::exchange(other.m_handle, nullptr);
        m_colorCorrectionEnabled = other.m_colorCorrectionEnabled;
        m_saturationEnabled = other.m_saturationEnabled;
        m_colorCorrectionMatrix = std::move(other.m_colorCorrectionMatrix);
    }
 
    return *this;
}
 
inline void ColorMatrixTransformationModule::Serialize(peak::common::serialization::IArchive& archive) const
{
    archive.SetInt("Version", 1);
 
    const auto saturationArchive = archive.CreateArchive();
    saturationArchive->SetBool("Enabled", IsColorCorrectionEnabled());
    saturationArchive->SetDouble("Value", GetSaturation());
    archive.SetArchive(saturationKey, saturationArchive);
 
    const auto matrixArchive = archive.CreateArchive();
    matrixArchive->SetBool("Enabled", IsColorCorrectionEnabled());
 
    m_colorCorrectionMatrix.Serialize(*matrixArchive);
    archive.SetArchive(matrixKey, matrixArchive);
}
 
inline void ColorMatrixTransformationModule::Deserialize(const peak::common::serialization::IArchive& archive)
{
    const auto version = archive.GetInt("Version");
 
    detail::ValidateVersion(version, GetType());
 
    const auto saturationArchive = archive.GetArchive(saturationKey);
    const auto matrixArchive = archive.GetArchive(matrixKey);
 
    SetColorCorrectionEnabled(saturationArchive->GetBool("Enabled"));
    SetSaturationEnabled(matrixArchive->GetBool("Enabled"));
 
    m_colorCorrectionMatrix.Deserialize(*matrixArchive);
    SetSaturation(static_cast<float>(saturationArchive->GetDouble("Value")));
 
    ApplyMatrix();
}
 
inline void ColorMatrixTransformationModule::SetEnabled(bool enabled)
{
    SetColorCorrectionEnabled(enabled);
    SetSaturationEnabled(enabled);
 
    UpdateCCMInAutoFeatureModule();
}
 
inline bool ColorMatrixTransformationModule::IsEnabled() const
{
    return m_colorCorrectionEnabled || m_saturationEnabled;
}
 
inline const char* ColorMatrixTransformationModule::GetType() const
{
    return "ColorMatrixTransformation";
}
 
inline void ColorMatrixTransformationModule::ResetToDefault()
{
    const auto identity = ColorCorrectionMatrix::Identity();
    std::copy(identity.cbegin(), identity.cend(), m_colorCorrectionMatrix.begin());
 
    if (m_colorCorrectionEnabled)
    {
        ApplyMatrix();
    }
 
    SetSaturation(saturationDefault);
}
 
inline ColorCorrectionMatrix ColorMatrixTransformationModule::GetMatrix() const
{
    return m_colorCorrectionMatrix;
}
 
inline void ColorMatrixTransformationModule::SetMatrix(const ColorCorrectionMatrix& matrix)
{
    std::copy(matrix.cbegin(), matrix.cend(), m_colorCorrectionMatrix.begin());
 
    if (m_colorCorrectionEnabled)
    {
        ApplyMatrix();
    }
}
 
inline void ColorMatrixTransformationModule::SetSaturation(float saturation)
{
    if (m_saturationEnabled)
    {
        peak::icv::detail::ExecuteAndMapReturnCodes([&] {
            return PEAK_ICV_C_ABI_PREFIX peak_icv_Preprocessing_ColorMatrixTransformation_SetSaturation(m_handle, saturation);
        });
        m_saturation = saturation;
        UpdateCCMInAutoFeatureModule();
    }
    else
    {
        m_saturation = saturation;
    }
}
 
PEAK_COMMON_NO_DISCARD inline float ColorMatrixTransformationModule::GetSaturation() const
{
    return m_saturation;
}
 
PEAK_COMMON_NO_DISCARD inline peak::common::IntervalF ColorMatrixTransformationModule::GetSaturationRange() const
{
    peak_common_interval_f intervalF;
    peak::icv::detail::ExecuteAndMapReturnCodes([&] {
        return PEAK_ICV_C_ABI_PREFIX peak_icv_Preprocessing_ColorMatrixTransformation_GetSaturationRange(m_handle, &intervalF);
    });
 
    return { intervalF.minimum, intervalF.maximum };
}
 
inline peak::icv::Image ColorMatrixTransformationModule::Process(const peak::icv::Image& input) const
{
    return Process(peak::common::Any(input)).AnyCast<peak::icv::Image>();
}
 
inline peak::common::Any ColorMatrixTransformationModule::Process(const peak::common::Any& input) const
{
    auto needsProcessing = [&] {
        bool value{};
        peak::icv::detail::ExecuteAndMapReturnCodes([&] {
            return PEAK_ICV_C_ABI_PREFIX peak_icv_Preprocessing_ColorMatrixTransformation_NeedsProcessing(m_handle, &value);
        });
        return value;
    };
 
    if (!IsEnabled() || !needsProcessing())
    {
        return input;
    }
 
    const auto& inputImage = input.AnyCast<peak::icv::Image>();
 
    const auto pixelFormat = inputImage.GetPixelFormat();
    const peak::common::PixelFormatInfo info(pixelFormat);
    const auto isColorImage = info.HasChannel(peak::common::Channel::Red) && info.HasChannel(peak::common::Channel::Green)
        && info.HasChannel(peak::common::Channel::Blue);
    if (!isColorImage || pixelFormat == peak::common::PixelFormat::RGB10p32 || pixelFormat == peak::common::PixelFormat::BGR10p32)
    {
        return input;
    }
 
    auto* const inputImageHandle = peak::common::detail::BackendAccessor<peak::icv::Image>::BackendHandle(inputImage);
 
    peak::icv::detail::ExecuteAndMapReturnCodes([&] {
        return PEAK_ICV_C_ABI_PREFIX peak_icv_Preprocessing_ColorMatrixTransformation_ProcessInplace(m_handle, inputImageHandle);
    });
 
    return peak::common::Any{ inputImage };
}
 
inline void ColorMatrixTransformationModule::UpdateCCMInAutoFeatureModule() const
{
    if (m_autoFeatureModule != nullptr)
    {
        std::array<float, 9> ccm{};
 
        const auto matrix = (m_saturationEnabled || m_colorCorrectionEnabled) ? GetEffectiveMatrix() :
                                                                                ColorCorrectionMatrix(ColorCorrectionMatrix::Identity());
        std::copy(matrix.cbegin(), matrix.cend(), ccm.begin());
 
        m_autoFeatureModule->SetColorCorrectionMatrix(ccm);
    }
}
 
inline void ColorMatrixTransformationModule::SetAutoFeatureModule(const std::shared_ptr<modules::IAutoFeature>& module)
{
    m_autoFeatureModule = module;
 
    UpdateCCMInAutoFeatureModule();
}
 
inline ColorCorrectionMatrix ColorMatrixTransformationModule::FetchMatrix()
{
    ColorCorrectionMatrix colorCorrectionMatrix{ m_colorCorrectionMatrix };
    peak::icv::detail::ExecuteAndMapReturnCodes([&] {
        return PEAK_ICV_C_ABI_PREFIX peak_icv_Preprocessing_ColorMatrixTransformation_GetColorCorrectionMatrix(
            m_handle, reinterpret_cast<peak_icv_color_correction_matrix*>(&colorCorrectionMatrix.At(0, 0)));
    });
 
    return colorCorrectionMatrix;
}
 
inline void ColorMatrixTransformationModule::ApplyMatrix() const
{
    auto matrix = m_colorCorrectionEnabled ? m_colorCorrectionMatrix : ColorCorrectionMatrix(ColorCorrectionMatrix::Identity());
    peak::icv::detail::ExecuteAndMapReturnCodes([&] {
        return PEAK_ICV_C_ABI_PREFIX peak_icv_Preprocessing_ColorMatrixTransformation_SetColorCorrectionMatrix(
            m_handle, *reinterpret_cast<peak_icv_color_correction_matrix*>(&matrix.At(0, 0)));
    });
 
    UpdateCCMInAutoFeatureModule();
}
 
inline ColorCorrectionMatrix ColorMatrixTransformationModule::GetEffectiveMatrix() const
{
    ColorCorrectionMatrix matrix{};
    peak::icv::detail::ExecuteAndMapReturnCodes([&] {
        return PEAK_ICV_C_ABI_PREFIX peak_icv_Preprocessing_ColorMatrixTransformation_GetEffectiveMatrix(
            m_handle, reinterpret_cast<peak_icv_color_correction_matrix*>(&matrix.At(0, 0)));
    });
    return matrix;
}
 
inline void ColorMatrixTransformationModule::SetSaturationEnabled(bool enabled)
{
    m_saturationEnabled = enabled;
 
    peak::icv::detail::ExecuteAndMapReturnCodes([&] {
        return PEAK_ICV_C_ABI_PREFIX peak_icv_Preprocessing_ColorMatrixTransformation_SetSaturation(
            m_handle, m_saturationEnabled ? m_saturation : saturationDefault);
    });
}
 
inline void ColorMatrixTransformationModule::SetColorCorrectionEnabled(bool enabled)
{
    m_colorCorrectionEnabled = enabled;
    ApplyMatrix();
}
 
inline bool ColorMatrixTransformationModule::IsSaturationEnabled() const
{
    return m_saturationEnabled;
}
 
inline bool ColorMatrixTransformationModule::IsColorCorrectionEnabled() const
{
    return m_colorCorrectionEnabled;
}
 
} // namespace detail
} // namespace pipeline 
} // namespace peak