ColorMatrixTransformationModule Class Reference

Inheritance diagram for ColorMatrixTransformationModule:

Data Structures
class	Handle

Public Member Functions
	ColorMatrixTransformationModule ()
	Creates an instance of class ColorMatrixTransformationModule.
void	Dispose ()
	Releases all resources used by this class.
override void	Serialize (IArchive archive)
	Serializes the object's internal state into the provided archive.
override void	Deserialize (IArchive archive)
	Restores the object's state from the provided archive.
override void	ResetToDefault ()
	Resets all parameters to their default values.
override Image	Process (Image inputImage)
	Processes the input image and returns a color corrected and/or saturated output image.
override object	Process (object input)
	Processes the input image and returns a color corrected and/or saturated output image.
void	SetAutoFeatureModule (IAutoFeature? module)
	Sets the auto feature module that should take the color correction matrix into account for automatic white balancing.
bool	HasColorTemperature ()
	Returns whether a color temperature has been set.

Properties
override string	TypeId [get]
	The unique type identifier for this module implementation.This should be a unique string identifying the specific implementation of the module.
override bool	IsEnabled [get, set]
	Gets or sets whether the module is enabled.
ColorCorrectionMatrix	Matrix [get, set]
	The current Types.ColorCorrectionMatrix.
float	Saturation [get, set]
	The current saturation value.
IntervalF	SaturationRange [get]
	Gets the valid range for saturation.
ChromaticAdaptionAlgorithm	ChromaticAdaptionAlgorithm [get, set]
	The current algorithm used for chromatic adaptation.
ColorSpace	TargetColorSpace [get, set]
	The current target color space for the chromatic adaptation transformation.
uint?	ColorTemperature [get, set]
	The current source color temperature in Kelvin to be used for chromatic adaptation.
RangeU	ColorTemperatureRange [get]
	Gets the valid range for color temperature.
int	Version = 1 [get]
	The module version.

Detailed Description

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

Provides the features ColorCorrectionFeature, SaturationFeature and ChromaticAdaptionFeature

Default values:

• Matrix = Types.ColorCorrectionMatrix.Identity
• Saturation = 1.0f
• ChromaticAdaptionAlgorithm = Types.ChromaticAdaptionAlgorithm.Bradford
• ColorSpace = ColorSpace.SRGB_D65
• ColorTemperature = null (chromatic adaption won't be applied)

Since

IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

ColorMatrixTransformationModule()

ColorMatrixTransformationModule ( )

inline

Creates an instance of class ColorMatrixTransformationModule.

Member Function Documentation

Deserialize()

override void Deserialize ( IArchive archive )

inlinevirtual

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.

Note

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

Parameters

archive

The source archive containing the serialized parameters.

Exceptions

IcvCorruptedException	The archive is malformed, misses keys or the values are invalid.
IcvNotSupportedException	The Version entry indicates an unsupported version.
IcvOutOfRangeException	The values are outside of the valid range.

Reimplemented from ModuleBase.

Dispose()

void Dispose ( )

inline

Releases all resources used by this class.

HasColorTemperature()

bool HasColorTemperature ( )

inline

Returns whether a color temperature has been set.

Process() [1/2]

override Image Process ( Image inputImage )

inline

Processes the input image and returns a color corrected and/or saturated output 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.

Note

This operation disregards any specified image regions and processes the entire image.

Parameters

inputImage

The input image to be processed.

Returns

The input image after in-place color correction and/or saturation has been applied.

Process() [2/2]

override object Process ( object input )

inlinevirtual

Processes the input image and returns a color corrected and/or saturated output 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.

Note

This operation disregards any specified image regions and processes the entire image.

Parameters

input

The input image to be processed.

Returns

The input image after in-place color correction and/or saturation has been applied.

Reimplemented from ModuleBase.

ResetToDefault()

override void ResetToDefault ( )

inlinevirtual

Resets all parameters to their default values.

Default values:

• Matrix = Types.ColorCorrectionMatrix.Identity()
• Saturation = 1.0f
• ChromaticAdaptionAlgorithm = ChromaticAdaptionAlgorithm.Bradford
• ColorSpace = ColorSpace.SRGB_D65
• ColorTemperature = null (chromatic adaption won't be applied)

Note

The enabled state does not change when calling this function.

Reimplemented from ModuleBase.

Serialize()

override void Serialize ( IArchive archive )

inlinevirtual

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.

Reimplemented from ModuleBase.

SetAutoFeatureModule()

void SetAutoFeatureModule ( IAutoFeature? module )

inline

Sets the auto feature module that should take the color correction matrix into account for automatic white balancing.

Property Documentation

ChromaticAdaptionAlgorithm

ChromaticAdaptionAlgorithm ChromaticAdaptionAlgorithm

getset

The current algorithm used for chromatic adaptation.

ColorTemperature

uint? ColorTemperature

getset

The current source color temperature in Kelvin to be used for chromatic adaptation.

The initial color temperature is null. In this case, chromatic adaption does not apply.

Exceptions

IcvOutOfRangeException

The value is outside the valid range (see ColorTemperatureRange).

ColorTemperatureRange

RangeU ColorTemperatureRange

get

Gets the valid range for color temperature.

IsEnabled

override bool IsEnabled

getset

Gets or sets whether the module is enabled.

Implements IModule.

Matrix

ColorCorrectionMatrix Matrix

getset

The current Types.ColorCorrectionMatrix.

Saturation

float Saturation

getset

The current saturation value.

Exceptions

IcvOutOfRangeException

The value is outside the valid range (see SaturationRange).

SaturationRange

IntervalF SaturationRange

get

Gets the valid range for saturation.

TargetColorSpace

ColorSpace TargetColorSpace

getset

The current target color space for the chromatic adaptation transformation.

TypeId

override string TypeId

get

The unique type identifier for this module implementation.This should be a unique string identifying the specific implementation of the module.

Implements IModule.

Version

int Version = 1

getinherited

The module version.