Inheritance diagram for SaturationFeature:

Public Member Functions
	SaturationFeature (ColorMatrixTransformationModule module)
	Creates a SaturationFeature using an existing color matrix transformation module.

void	ResetToDefault ()
	Resets the saturation value to its default.

Properties
float	Value `[get, set]`
	The current saturation value.

IntervalF	Range `[get]`
	Gets the valid range for the saturation value.

bool	IsEnabled `[get, set]`
	Enables or disables the feature.

Detailed Description

Adjusts the saturation of an image by modifying a 3x3 Types.ColorCorrectionMatrix.

This feature modifies the image's color saturation by scaling the chrominance components of the color correction matrix. A higher saturation makes colors more vivid, while a lower value results in more muted tones.

Defaults

saturation = 1.0

See also: ColorCorrectionFeature, Types.ColorCorrectionMatrix

Since: IDSImaging.Peak.ICV 1.3

Constructor & Destructor Documentation

◆ SaturationFeature()

SaturationFeature ( ColorMatrixTransformationModule module )

inline

Creates a SaturationFeature using an existing color matrix transformation module.

Parameters

module Reference to the underlying ColorMatrixTransformationModule.

Member Function Documentation

◆ ResetToDefault()

void ResetToDefault ( )

inline

Resets the saturation value to its default.

Note: The enabled state does not change when calling this function.

Implements IFeature.

Property Documentation

◆ IsEnabled

bool IsEnabled

getset

Enables or disables the feature.

Implements IFeature.

◆ Range

IntervalF Range

get

Gets the valid range for the saturation value.

The returned interval specifies the minimum and maximum values that can be passed to Value.

◆ Value

float Value