#include <peak_icv/pipeline/detail/peak_icv_color_matrix_transformation_module.hpp>

Inheritance diagram for ColorMatrixTransformationModule:

[legend]

Public Member Functions
	ColorMatrixTransformationModule ()
	Creates an instance of class ColorMatrixTransformationModule with the default color correction matrix and saturation value.

	~ColorMatrixTransformationModule () override

	ColorMatrixTransformationModule (const ColorMatrixTransformationModule &other)=delete
	Copy constructor for class ColorMatrixTransformation is deleted.

	ColorMatrixTransformationModule (ColorMatrixTransformationModule &&other) noexcept

ColorMatrixTransformationModule &	operator= (const ColorMatrixTransformationModule &other)=delete
	Copy assignment for class ColorMatrixTransformation is deleted.

ColorMatrixTransformationModule &	operator= (ColorMatrixTransformationModule &&other) noexcept

void	Serialize (peak::common::serialization::IArchive &archive) const override
	Serializes the object's internal state into the provided archive.

void	Deserialize (const peak::common::serialization::IArchive &archive) override
	Restores the object's state from the provided archive.

void	SetEnabled (bool enabled) override
	Sets the enabled state of this module.

bool	IsEnabled () const override
	Checks if the module is currently enabled.

const char *	GetType () const override
	Returns the type of the module for serialization purposes.

void	ResetToDefault () override
	Resets the ColorCorrectionMatrix to the default and the saturation value to the default.

void	SetMatrix (const ColorCorrectionMatrix &matrix)
	Sets the ColorCorrectionMatrix.

ColorCorrectionMatrix	GetMatrix () const
	Returns the current ColorCorrectionMatrix.

void	SetSaturation (float saturation)
	Sets the Saturation.

float	GetSaturation () const
	Returns the current saturation value.

peak::common::IntervalF	GetSaturationRange () const
	Returns the saturation range.

peak::icv::Image	Process (const peak::icv::Image &input) const
	Applies the configured ColorCorrectionMatrix and saturation adjustment to the input image.

peak::common::Any	Process (const peak::common::Any &input) const override
	Applies the configured ColorCorrectionMatrix and saturation adjustment to the input image.

void	SetAutoFeatureModule (const std::shared_ptr< modules::IAutoFeature > &module)
	Sets the auto feature module that should take the color correction matrix into account for automatic white balancing.

Detailed Description

Color matrix transformation is an image pipeline module that applies a ColorCorrectionMatrix to an image.

Provides the features features::ColorCorrectionFeature and features::SaturationFeature

Since: ids_peak_icv 1.0

Definition at line 43 of file peak_icv_color_matrix_transformation_module.hpp.

Constructor & Destructor Documentation

◆ ColorMatrixTransformationModule() [1/3]

ColorMatrixTransformationModule ( )

inline

Creates an instance of class ColorMatrixTransformationModule with the default color correction matrix and saturation value.

Since: ids_peak_icv 1.0

Definition at line 277 of file peak_icv_color_matrix_transformation_module.hpp.

◆ ~ColorMatrixTransformationModule()

~ColorMatrixTransformationModule ( )

inlineoverride

Since: ids_peak_icv 1.0

Definition at line 286 of file peak_icv_color_matrix_transformation_module.hpp.

◆ ColorMatrixTransformationModule() [2/3]

ColorMatrixTransformationModule ( const ColorMatrixTransformationModule & other )

delete

Copy constructor for class ColorMatrixTransformation is deleted.

Note: If you need to copy a module, you can create a new one and copy the parameters via Serialize() and Deserialize().

Since: ids_peak_icv 1.0

◆ ColorMatrixTransformationModule() [3/3]

ColorMatrixTransformationModule ( ColorMatrixTransformationModule && other )

inlinenoexcept

Since: ids_peak_icv 1.0

Definition at line 294 of file peak_icv_color_matrix_transformation_module.hpp.

Member Function Documentation

◆ Deserialize()

void Deserialize ( const peak::common::serialization::IArchive & archive )

inlineoverridevirtual

Restores the object's state from the provided archive.

This function reads and applies all necessary parameters from the given archive to reconstruct the internal state of the object. It ensures that the object is restored to a valid and consistent state.

Parameters

archive The source archive containing the serialized parameters.

Exceptions

CorruptedException	If Archive is malformed, misses keys or the values are invalid
NotSupportedException	If the 'Version' entry indicates an unsupported version.

Note: This function requires that the archive contains all expected fields as produced by a corresponding Serialize() call.

Since: ids_peak_icv 1.0

Implements ISerializable.

Definition at line 338 of file peak_icv_color_matrix_transformation_module.hpp.

◆ GetMatrix()

ColorCorrectionMatrix GetMatrix ( ) const

inline

Returns the current ColorCorrectionMatrix.

Returns: The current ColorCorrectionMatrix.

Since: ids_peak_icv 1.0

Definition at line 387 of file peak_icv_color_matrix_transformation_module.hpp.

◆ GetSaturation()

float GetSaturation ( ) const

inline

Returns the current saturation value.

Returns: The current saturation.

Since: ids_peak_icv 1.0

Definition at line 418 of file peak_icv_color_matrix_transformation_module.hpp.

◆ GetSaturationRange()

peak::common::IntervalF GetSaturationRange ( ) const

inline

Returns the saturation range.

Returns: The saturation range.

Since: ids_peak_icv 1.0

Definition at line 423 of file peak_icv_color_matrix_transformation_module.hpp.

◆ GetType()

const char * GetType ( ) const

inlineoverridevirtual

Returns the type of the module for serialization purposes.

Returns: A string representing the module's type.

Since: ids_peak_icv 1.0

Implements IModule.

Definition at line 369 of file peak_icv_color_matrix_transformation_module.hpp.

◆ IsEnabled()

bool IsEnabled ( ) const

inlineoverridevirtual

Checks if the module is currently enabled.

Returns: True if the module is enabled, false otherwise.

Since: ids_peak_icv 1.0

Implements IModule.

Definition at line 364 of file peak_icv_color_matrix_transformation_module.hpp.

◆ operator=() [1/2]

ColorMatrixTransformationModule & operator= ( ColorMatrixTransformationModule && other )

inlinenoexcept

Since: ids_peak_icv 1.0

Definition at line 302 of file peak_icv_color_matrix_transformation_module.hpp.

◆ operator=() [2/2]

ColorMatrixTransformationModule & operator= ( const ColorMatrixTransformationModule & other )

delete

Copy assignment for class ColorMatrixTransformation is deleted.

Note: If you need to copy a module, you can create a new one and copy the parameters via Serialize() and Deserialize().

Since: ids_peak_icv 1.0

◆ Process() [1/2]

peak::common::Any Process ( const peak::common::Any & input ) const

inlineoverridevirtual

Applies the configured ColorCorrectionMatrix and saturation adjustment to the input image.

Note: Supported pixel formats: RGB8, RGB10, RGB12, BGR8, BGR10, BGR12, RGBa8, RGBa10, RGBa12, BGRa8, BGRa10, BGRa12. Images with other formats are passed through unmodified.; This operation disregards any specified image regions and processes the entire image.

Parameters

input The input image to be processed.

Returns: A new image with the color correction and saturation applied, or the original image if unsupported.

Exceptions

peak::common::InvalidCastException If the input cast to peak::icv::Image failed.

Since: ids_peak_icv 1.0

Implements IModule.

Definition at line 438 of file peak_icv_color_matrix_transformation_module.hpp.

◆ Process() [2/2]

peak::icv::Image Process ( const peak::icv::Image & input ) const

inline

Applies the configured ColorCorrectionMatrix and saturation adjustment to the input image.

Note: Supported pixel formats: RGB8, RGB10, RGB12, BGR8, BGR10, BGR12, RGBa8, RGBa10, RGBa12, BGRa8, BGRa10, BGRa12. Images with other formats are passed through unmodified.; This operation disregards any specified image regions and processes the entire image.

Parameters

input The input image to be processed.

Returns: A new image with the color correction and saturation applied, or the original image if unsupported.

Since: ids_peak_icv 1.0

Definition at line 433 of file peak_icv_color_matrix_transformation_module.hpp.

◆ ResetToDefault()

void ResetToDefault ( )

inlineoverridevirtual

Resets the ColorCorrectionMatrix to the default and the saturation value to the default.

Since: ids_peak_icv 1.0

Implements IModule.

Definition at line 374 of file peak_icv_color_matrix_transformation_module.hpp.

◆ Serialize()

void Serialize ( peak::common::serialization::IArchive & archive ) const

inlineoverridevirtual

Serializes the object's internal state into the provided archive.

This function populates the given archive with all parameters required to fully represent the current state of the object. It ensures that the object can be reconstructed or transmitted accurately by saving all relevant data members in a consistent and structured format.

Parameters

archive The target archive that will store the serialized parameters.